pypom-form 0.3.1

How does it work?

Whith pypom_form you have just to:

• instanciate a page object instance whose class inherits from BaseFormPage provided by pypom_form

• declare the schema model

And you will be ready for interacting with your page driving the browser with your form just typing:

page.title = 'the title'
page.title

assuming that you have a title field in your form.

page.getWidgetRegion('state').filter('virg').select('Virginia')

Code samples

The following code samples assumes that there is a navigation fixture providing the page instance built with a Splinter driver but you can build by yourself a page instance following the PyPOM documentation:

• http://pypom.readthedocs.io/en/latest/

Schema definition:

import colander

from pypom_form.form import BaseFormPage


class BaseEditSchema(colander.MappingSchema):
    """ This is the base edit mapping common for all pages """

    name = colander.SchemaNode(
        colander.String(),
        selector=('id', 'name-widget'),
    )


class BaseEditPage(BaseFormPage):
    """ This is the base edit class """

    schema_factory = BaseEditSchema

And assuming you have a page instance you can interact with the above page just setting an attribute:

@pytest_bdd.when(pytest_bdd.parsers.parse(
    'I set {name} as name field'))
def fill_name(navigation, name):
    page = navigation.page
    page.name = name

You can also define other pages with extended schema, for example an integer type:

class AnotherPageEditSchema(BaseEditSchema):

    duration = colander.SchemaNode(
        colander.Int(),
        missing=0,
        selector=('id',
                  'duration-widget'),
        validator=colander.Range(0, 9999))

but you can create also field types like colander.Bool or any other colander supported types.

And the test:

@pytest_bdd.when(pytest_bdd.parsers.cfparse(
    'I set {duration:Number} as Alarm duration',
    extra_types=dict(Number=int)))
def fill_alarm_duration(navigation, duration):
    page = navigation.page
    page.duration = duration

You might notice that in the above example you are setting an integer duration and not a string. So you can perform page.duration += 10 for example.

You can also define custom widgets on fields if the default implementation does not match the one available on your application (for example a non standard checkbox for a boolean widget), for example a pretend MyBooleanWidget:

mybool = colander.SchemaNode(
    colander.Bool(),
    missing=False,
    selector=(
        'id',
        'mybool-widget'
    ),
    pypom_widget=MyBoolWidget()
)

Also chained calls are supported (eg: set the title, perform the pretend submit method and then set a boolean):

page.set('title', 'the title'). \
    .submit(). \
    .set('mybool', False)

or bulk updates. All changes occurs following the fields order at schema level:

page.update(**{'title': 'the title', 'mybool': True})

The update or raw_update can be used in test preconditions creation. Assuming you have a generic given step with parametrized with a complex configuration you can pass the raw json data and the raw_update will take care about the data conversion from browser model (eg: string) to the page model (strings, integers, datetimes, etc):

@pytest_bdd.given(pytest_bdd.parsers.cfparse(
    'I have a CAN bus protocol configured with:\n{raw_conf:json}',
    extra_types=dict(json=json.loads)))
def create_can_protocol(navigation, base_url, raw_conf):
    """ create a can protocol
    """

    navigation. \
        visit_page('CANBusProtocolsPage'). \
        wait_for_full_spinner(). \
        click_add(). \
        raw_update(**raw_conf). \
        save(). \
        wait_for_success_pop_up_appears(). \
        click_on_ok_pop_up()

assuming that the raw_conf is specified in json format in the .feature file, for example:

@UI @edit @CANBusParameter
Scenario: Add a CAN bus parameter
  Given I am logged in as Administrator
  And I have a CAN bus protocol configured with:
      {"name": "The name",
       "baudrate": "250",
       ...
      }
  And ...

As you can see in the above code examples there is no need to perform wait calls before interacting with a form on page load because each widget is able to wait until its controlled input element is ready. Wait logics are already defined on widget level and you can override them.

0.3.1 (2017-10-24)

• Added a raw_dump method to get all the fields serialized.

0.3.0 (2017-10-10)

• Added a dump method to get all the fields in bulk.

0.2.3 (2017-09-14)

• Now you can override automatically generated methods and invoke super inside them

0.2.2 (2017-07-03)

• Moved test_fields.py to right location.

• Don’t override update and raw_update methods on pages and regions if already exist.

0.2.1 (2017-06-01)

• Update email project

0.2.0 (2017-01-24)

Features

• Added serialize and deserialize methods on widgets base implementation for advanced usage. This way you can implement complex/composed widgets more easily just overriding the above methods (eg: perform an intermediate conversion from page model data to browser or widget internal representation data)

• Added an ObjectType field for advanced usage when you have to implement complex or composed widgets

• Added support for readonly fields. If a field is marked as read only, no browser interaction will be performed

0.1.0 (2017-01-03)

0.0.1 (2016-12-22)

• Initial release