Skip to main content

selenium page objects and other utilities for test creation

Project description

holmium.core

ci coveralls pypi docs license

Introduction

holmium.core provides utilities for simplifying the creation and maintenance of tests that rely on Selenium.

Nothing beats an example. Conventionally automated tests integrating with python-selenium are written similarly to the following code block (using seleniumhq.org).

import selenium.webdriver
import unittest


class SeleniumHQTest(unittest.TestCase):
    def setUp(self):
        self.driver = selenium.webdriver.Firefox()
        self.url = "http://seleniumhq.org"

    def test_header_links(self):
        self.driver.get(self.url)
        elements = self.driver.find_elements_by_css_selector("div#main_navbar ul li>a")
        self.assertTrue(len(elements) > 0)
        for element in elements:
            self.assertTrue(element.is_displayed())
        expected_link_list = [
          "About",
          "Blog",
          "Documentation",
          "Downloads",
          "English",
          "Projects",
          "Support",
        ]
        actual_link_list = [el.text for el in elements]
        self.assertEqual(sorted(expected_link_list), sorted(actual_link_list))

    def test_projects_selenium_heading(self):
        self.driver.get(self.url)
        projects_link = self.driver.find_element_by_css_selector(
            "nav>a[href='./projects']"
        )
        projects_link.click()
        heading = self.driver.find_element_by_css_selector("p.lead")
        self.assertEqual(heading.text, "Selenium has many projects that combine to form a versatile testing system.")

    def tearDown(self):
        if self.driver:
            self.driver.quit()


if __name__ == "__main__":
    unittest.main()

The above example does what most selenium tests do:

  • initialize a webdriver upon setUp

  • query for one or more web elements using either class name, id, css_selector or xpath

  • assert on the number of occurrences / value of certain elements.

  • tear down the webdriver after each test case

It suffers from the typical web development problem of coupling the test case with the HTML plumbing of the page its testing rather than the functionality its meant to exercise. The concept of PageObjects reduces this coupling and allow for test authors to separate the layout of the page under test and the functional behavior being tested. This separation also results in more maintainable test code (i.e. if an element name changes - all tests don’t have to be updated, just the PageObject).

Lets take the above test case for a spin with holmium. Take note of the following:

  • The initialization and reset of the webdriver is delegated to the TestCase base class (alternatively the class could subclass unittest.TestCase and be run with the holmium nose plugin).

  • the page elements are accessed in the test only via Element & ElementMap.

import unittest

from holmium.core import Element, ElementMap, Locators, Page, TestCase


class SeleniumHQPage(Page):
        nav_links = ElementMap(Locators.CSS_SELECTOR, "div#main_navbar ul li>a")
        header_text = Element(Locators.CSS_SELECTOR, "p.lead")


class SeleniumHQTest(TestCase):
        def setUp(self):
                self.page = SeleniumHQPage(self.driver, "http://seleniumhq.org")

        def test_header_links(self):
                self.assertTrue(len(self.page.nav_links) > 0)
                self.assertElementsDisplayed(self.page.nav_links)
                self.assertEqual(
                        sorted(
                                [
                                        "About",
                                        "Blog",
                                        "Documentation",
                                        "Downloads",
                                        "English",
                                        "Projects",
                                        "Support",
                                ]
                        ),
                        sorted(self.page.nav_links.keys()),
                )

        def test_projects_selenium_heading(self):
                self.page.nav_links["Projects"].click()
                self.assertElementTextEqual(
                        self.page.header_text,
                        "Selenium has many projects that combine to form a versatile testing system.",
                )


if __name__ == "__main__":
        unittest.main()

Which can then be executed in a few different ways as shown below.

HO_BROWSER=firefox python test_selenium_hq.py

Feature Summary

  • Automatic provisioning and configuration of webdriver instances based on environment variables

  • Shorthand assertions for web pages (TestCase)

  • Declarative model for defining pages, sections, page elements and element collections (Page Objects)

Changelog

v1.1.0

Release Date: 2023-02-28

  • Chores

    • Remove dependency on six & ordereddict

    • Upgrade syntax to python 3.7+

    • Automate pypi release process

v1.0.0

Release Date: 2023-02-27

  • Breaking Changes

    • Remove support for python < 3

    • Remove support for nose plugin

    • Remove support for cucumber tests

v0.8.5

Release Date: 2016-09-06

  • Extra options for assertConditionWithWait #42

v0.8.4

Release Date: 2016-09-01

  • Bug fix: assertConditionWithWait #40

v0.8.3

Release Date: 2016-08-12

  • Bug fix: Fix for IE with remote #38

  • Bug fix: StaleElementReferenceException handling #33

v0.8.2

Release Date: 2015-12-22

  • New filter_by argument that accepts conditions

v0.8.1

Release Date: 2015-10-30

  • Bug fix: Fix setup requirements for python 3.x #30

v0.8

Release Date: 2015-06-07

  • No functional Change

v0.7.9

Release Date: 2015-05-30

  • Bug fix: Support for phantom 1.9.x #29

v0.7.8

Release Date: 2014-11-02

  • Bug fix: AttributeError when comparing with None #26

  • Bug fix: Negative indexing in sections #27

v0.7.7

Release Date: 2014-09-05

  • Bug fix: IE Driver initialization #24

v0.7.6

Release Date: 2014-07-14

  • Hot fix: broken installation due to missing requirements

v0.7.5

Release Date: 2014-07-14

  • Bug fix for StaleElementReferenceException in WebDriverWait

  • Support for using holmium.core.coniditions objects as context managers

  • Additional conditions ANY and ALL for element collections.

v0.7.4

Release Date: 2014-04-24

  • Bug fix: Sections weren’t working for index > 1 #22

v0.7.3

Release Date: 2014-03-14

  • Add missing timeout from Section

v0.7.2

Release Date: 2014-02-22

  • exclude packaging tests

v0.7.1

Release Date: 2014-02-18

  • Fix packaging problem with versioneer

v0.7

Release Date: 2014-02-10

  • Built-in conditions for explicit waits

  • New assertion assertConditionWithWait

  • Change behavior of only_if to not check is_displayed by default.

  • Tweaks

  • Allow passing a filename for nose argument --holmium-capabilities

  • Change versioning to use versioneer

  • Explicit py3k support with six

  • Make primitive lists and maps wrapped in pageobjects behave.

v0.6.2

Release Date: 2014-01-15

v0.6.1

Release Date: 2013-12-23

  • Bug fix issue 18 for facet clobbering when page inheritance was involved

  • Bug fix issue 17 for case of no browser specified

  • new assertion for TestCase class : assertElementAttributeEqual

v0.6

Release Date: 2013-12-14

  • Lazy driver initialization. The webdriver is created when the test first accesses it.

  • Support for using multiple browsers (drivers) in test cases. The original self.driver is still available along with a self.drivers list which lazily initializes new drivers as they are accessed via index. drivers[0] == driver.

  • New environment variable / nose option to force browser(s) to be shutdown and restarted between tests. (it is disabled by default, but cookies are still always cleared between tests)

  • New assertions added to the TestCase base class

  • Documentation cleanups

  • Bug fixes for default timeout/only_if arugment for Element/Elements/ElementMap

v0.5.2

Release Date: 2013-12-09

  • PyPy support

  • Allow customization of WebElements by exposing ElementEnhancer

v0.5.1

Release Date: 2013-12-01

  • Re-added python 2.6 support

v0.5.0

Release Date: 2013-12-01

  • Python 3.3 now supported and tested.

v0.4.2

Release Date: 2013-12-01

  • New parameter only_if (callable that accepts the webelement that was found) accepted by Element, Elements, ElementMap that allows for waiting for an element to become valid according to the response of only_if. The callable will be checked uptil the timeout parameter set on the Element.

v0.4.1

Release Date: 2013-11-29

  • Bug fix for config module being reused between test runs.

v0.4

Release Date: 2013-11-28

v0.3.4

Release Date: 2013-11-21

  • Added support to ignore ssl certificate errors on chrome, firefox & phantomjs

  • code cleanup

  • improved test coverage

v0.3.3

Release Date: 2013-10-29

  • Improved back reference access in Config object by allowing variable references without requiring a prefix of default or the environment name. The resolution order is current environment and then default.

    For example, the following config will resolve login_url as http://mysite.com/login and profile_url as http://mysite.com/profile/prod_user respectively, when holmium.environment is set to production

    config = { "default" : {
                    "login_url" : "{{url}}/login"
                    , "profile_url":"{{url}}/profiles/{{username}}"}
              , "production": {
                    "url": "http://mysite.com"
                    , "username":"prod_user"}
            }

v0.3.2

Release Date: 2013-10-10

  • Fluent response from page objects only when page method returns None

v0.3.1

Release Date: 2013-09-17

  • Allow indexing of Sections objects

v0.3

Release Date: 2013-09-16

v0.2

Release Date: 2013-09-11

v0.1.8.4

Release Date: 2013-09-04

  • Bug Fix : installation via pip was failing due to missing HISTORY.rst file.

v0.1.8.3

Release Date: 2013-08-12

  • Bug fix

    • improved error handling and logging for missing/malformed config file.

v0.1.8

Release Date: 2013-03-18

  • Added iphone/android/phantomjs to supported browsers

  • Bug fix

    • fixed phantomjs build in travis

Project details


Download files

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

Source Distribution

holmium.core-1.1.0.tar.gz (84.4 kB view details)

Uploaded Source

Built Distribution

holmium.core-1.1.0-py2.py3-none-any.whl (26.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file holmium.core-1.1.0.tar.gz.

File metadata

  • Download URL: holmium.core-1.1.0.tar.gz
  • Upload date:
  • Size: 84.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for holmium.core-1.1.0.tar.gz
Algorithm Hash digest
SHA256 3f1898891f42e931e86f4a2e5fc0c2cc354dc4078e927b767cef9cae3974341e
MD5 dc32a643ca67957c4846783281719006
BLAKE2b-256 b516864a8307a526f22515c41508315fd035f1f82c9b9ff87edbec67b9f601ac

See more details on using hashes here.

File details

Details for the file holmium.core-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for holmium.core-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1c1861b9556d670a4614acf8f42d264627ef701cabfc01f3d66c18fea13448d4
MD5 feb17c9df76f7b12742df2fdb86f10a4
BLAKE2b-256 f486dc40655684a25476d28d987e71644ac5adb420c0bb77fc03cdfa7e13265e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page