holmium.core

Introduction

holmium.core provides utility classes to simplify writing pageobjects for webpages using 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#header ul>li")
        self.assertTrue(len(elements) > 0)
        expected_link_list = ["Projects", "Download", "Documentation", "Support", "About"]
        actual_link_list = [el.text for el in elements]
        self.assertEquals( sorted(expected_link_list), sorted(actual_link_list))

    def test_about_selenium_heading(self):
        self.driver.get(self.url)
        about_link = self.driver.find_element_by_css_selector("div#header ul>li#menu_about>a")
        about_link.click()
        heading = self.driver.find_element_by_css_selector("#mainContent>h2")
        self.assertEquals(heading.text, "About Selenium")

    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 occurances / 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 excercise. 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 dont 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.

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

class SeleniumHQPage(Page):
    nav_links = ElementMap( Locators.CSS_SELECTOR
                                        , "div#header ul>li"
                                        , key = lambda element : element.find_element_by_tag_name("a").text
                                        , value = lambda element: element.find_element_by_tag_name("a") )

    header_text = Element(Locators.CSS_SELECTOR, "#mainContent>h2")


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.assertEquals( sorted(["Projects", "Download", "Documentation", "Support", "About"])
                        ,  sorted(self.page.nav_links.keys() ) )

    def test_about_selenium_heading(self):
        self.page.nav_links["About"].click()
        self.assertEquals(self.page.header_text.text, "About Selenium")

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

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

# if using TestCase as the base class run as:
export HO_BROWSER=firefox;nosetests test_selenium_hq.py
# or..
export HO_BROWSER=firefox;python test_selenium_hq.py
# if using unittest.TestCase as the base class run as:
nosetests test_selenium_hq.py --holmium-browser=firefox

History

0.2 2013-09-11

Deprecated old class names. More information at : http://holmiumcore.readthedocs.org/en/latest/core.html#deprecated-classes
Added more tests for holmium.core.TestCase
New Config object. more information at : http://holmiumcore.readthedocs.org/en/latest/internals.html#holmium.core.Config

0.1.8.4 2013-09-04

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

0.1.8.3 2013-08-12

Bug fix
- improved error handling and logging for missing/malformed config file.

0.1.8 2013-03-18

Added iphone/android/phantomjs to supported browsers
Bug fix
- fixed phantomjs build in travis

Metadata

Release files for holmium.core 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for holmium.core 0.2
File	Size	Uploaded
holmium.core-0.2.tar.gz	42.7 kB	Sep 11, 2013	Details

Built distribution (wheel)

Table of built distributions (wheels) for holmium.core 0.2
File	Interpreter	ABI	Platform	Reset
holmium.core-0.2-py2.7.egg 44.6 kB Sep 11, 2013	Legacy Egg format	-	-	Details

Total release size: 87.3 kB

Release files / holmium.core-0.2.tar.gz

Download URL	holmium.core-0.2.tar.gz
Size	42.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`ffca17be450b0d9d67cff57dd1aaf9b24d41d5c47728d44101113ed9ef5e80b4`
BLAKE2b-256 checksum How to use checksums	`c5114b061ebdf239058acaaec8f9066cf4bcdceb2c2b8aaa9a016018cf417580`
Upload date	Sep 11, 2013
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / holmium.core-0.2-py2.7.egg

Download URL	holmium.core-0.2-py2.7.egg
Size	44.6 kB
Tags	Egg
SHA-256 checksum How to use checksums	`e964fe6f02acf8e31240539e49cd7fa90529c4ca79c55fcc61977998cb65b018`
BLAKE2b-256 checksum How to use checksums	`1b08c08d9761c068ee005aaf441ec6cc772b077cf9b54b3b79572423d1ecc72b`
Upload date	Sep 11, 2013
Uploaded using Trusted Publishing? What is trusted publishing?	No