Skip to main content

A nice way of implementing the Page Object pattern.

Project description

PyPI PyPI - Python Version GitHub Updates https://travis-ci.org/jsfehler/stere.svg?branch=master https://coveralls.io/repos/github/jsfehler/stere/badge.svg?branch=master https://api.codacy.com/project/badge/Grade/e791ab09e14c4483943a26a2fd180577 https://saucelabs.com/buildstatus/jsfehler

Stere is a library for writing Page Objects, designed to work on top of an existing automation library.

Design Philosophy

Many implementations of the Page Object model focus on removing the duplication of element locators inside tests. Stere goes one step further, offering a complete wrapper over the code that drives automation.

The goals of this project are to:

1 - Eliminate implementation code in test functions. Tests should read like a description of behaviour, not Selenium commands.

2 - Reduce the need for hand-written helper methods in Page Objects. Common actions should have universal solutions.

3 - Provide a simple pattern for writing maintainable Page Objects.

No automation abilities are built directly into the project; it completely relies on being hooked into other libraries. However, implementations using Splinter and Appium are available out of the box.

Basic Usage

Fundamentally, a Page Object is just a Python class.

A minimal Stere Page Object should:

1 - Subclass the Page class

2 - Declare Fields and Areas in the __init__ method

As an example, here’s the home page for Wikipedia:

from stere import Page
from stere.areas import Area, RepeatingArea
from stere.fields import Button, Input, Link, Root, Text


class WikipediaHome(Page):
    def __init__(self):
        self.search_form = Area(
            query=Input('id', 'searchInput'),
            submit=Button('xpath', '//*[@id="search-form"]/fieldset/button')
        )

        self.other_projects = RepeatingArea(
            root=Root('xpath', '//*[@class="other-project"]'),
            title=Link('xpath', '//*[@class="other-project-title"]'),
            tagline=Text('xpath', '//*[@class="other-project-tagline"]')
        )

The search form is represented as an Area with two Fields inside it.

A Field represents a single item, while an Area represents a unique collection of Fields.

The query and submit Fields didn’t have to be placed inside an Area. However, doing so allows you to use Area’s perform() method.

The links to other products are represented as a RepeatingArea . A RepeatingArea represents a non-unique collection of Fields on the page. Using the root argument as the non-unique selector, RepeatingArea will find all instances of said root, then build the appropriate number of Areas with all the other Fields inside.

It’s just as valid to declare each of the other products as a separate Area one at a time, like so:

self.commons = Area(
    root=Root('xpath', '//*[@class="other-project"][1]'),
    title=Link('xpath', '//*[@class="other-project-title"]'),
    tagline=Text('xpath', '//*[@class="other-project-tagline"]')
)

self.wikivoyage = Area(
    root=Root('xpath', '//*[@class="other-project"][2]'),
    title=Link('xpath', '//*[@class="other-project-title"]'),
    tagline=Text('xpath', '//*[@class="other-project-tagline"]')
)

Which style you pick depends entirely on how you want to model the page. RepeatingArea does the most good with collections where the number of areas and/or the contents of the areas can’t be predicted, such as inventory lists.

Using a Page Object in a test can be done like so:

def test_search_wikipedia():
    home = WikipediaHome()
    home.search_form.perform('kittens')

License

Distributed under the terms of the MIT license, “Stere” is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
stere-0.8.0-py3-none-any.whl (27.4 kB) Copy SHA256 hash SHA256 Wheel py3
stere-0.8.0.tar.gz (17.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page