Page Object Prototypes Overview

Contents

• Page Object Prototypes Overview

  • Overview

  • FormObject

    • Attributes

    • Methods

  • ModalObject

    • Attributes

    • Methods

  • NavObject

    • Attributes

    • Methods

  • WebPageObject

    • Attributes

    • Methods

Overview

The webdriver_test_tools package includes pre-defined subclasses of BasePage for common components like forms and navbars. These classes define common methods and attributes to reduce the amount of code needed to create page objects.

Prototype classes support simplified YAML representations as well as pure Python. This page is an overview of available prototypes and their attributes and pre-defined methods. For details on syntax and example usages, see Page Object Prototype Syntax.

FormObject

The FormObject prototype is used to represent forms, their inputs, and their submit button.

Attributes

FormObject subclasses define the following attributes:

• FORM_LOCATOR: WebDriver locator tuple for the form element

• SUBMIT_LOCATOR: WebDriver locator tuple for the submit button

FormObject subclasses may also have the following optional attribute:

• SUBMIT_SUCCESS_CLASS: Page object class representing the page/modal/etc that is expected to appear on successful submission

FormObject subclasses will have the following attributes at runtime. These are populated based on the contents of YAML_FILE or INPUT_DICT:

• inputs: A dictionary mapping input names to the corresponding InputObject instances

Methods

• FormObject.fill_inputs: Fill form inputs

• FormObject.get_input_values: Get the current values of form inputs

• FormObject.submit_is_enabled: Checks if the submit button is enabled

• FormObject.click_submit: Click the submit button

ModalObject

The ModalObject prototype is used to represent modals, their body content, and their close button.

Attributes

ModalObject subclasses define the following attributes:

• MODAL_LOCATOR: WebDriver locator tuple for the modal element

• CLOSE_LOCATOR: WebDriver locator tuple for the modal close button

ModalObject subclasses may also have the following optional attribute:

• MODAL_BODY_CLASS: Page object class representing the contents of the modal body

Methods

• ModalObject.is_displayed: Checks if the modal is currently visible

• ModalObject.click_close_button: Click the modal’s close button

• ModalObject.get_modal_body: Returns an instance of the class defined in MODAL_BODY_CLASS (or None if not set)

NavObject

The NavObject prototype is used to represent navbars.

Attributes

NavObject subclasses may define the following optional attributes:

• FIXED: (Default: True) True if the navbar is fixed to the window

• COLLAPSIBLE: (Default: False) True if the navbar is collapsible (e.g. uses a hamburger menu)

If COLLAPSIBLE is set to True, subclasses should define the following attributes:

• MENU_LOCATOR: Locator for the collapsible menu element

• EXPAND_BUTTON_LOCATOR: Locator for the button that expands the nav menu

• COLLAPSE_BUTTON_LOCATOR: (Optional) Locator for the button that collapses the nav menu. Leave unset if this is the same as EXPAND_BUTTON_LOCATOR

NavObject subclasses will have the following attributes at runtime. These are populated based on the contents of YAML_FILE or LINK_DICTS:

• links: A dictionary mapping link names to the corresponding NavLinkObject instances

Methods

All NavObject subclasses have the following methods:

• NavObject.click_link: Click a link in the navbar

• NavObject.hover_over_link: Hover over a link in the navbar

Collapsible NavObject subclasses have additional methods:

• NavObject.click_expand_button: Click the button to expand the nav menu

• NavObject.click_collapse_button: Click the button to collapse the nav menu

• NavObject.is_expanded: Check if the nav menu is expanded

WebPageObject

The WebPageObject prototype is used to represent entire pages.

Attributes

WebPageObject subclasses define the following attribute:

• PAGE_URL: Full URL to the page

WebPageObject subclasses may also have the following optional attribute:

• PAGE_FILENAME: Filename of the page (or path relative to a base URL configured in a project’s SiteConfig)

Methods

• WebPageObject.get_page_title: Returns the title of the current page