Metadata-Version: 1.1
Name: holmium.core
Version: 0.4.2
Summary: selenium page objects and other utilities for test creation
Home-page: https://holmiumcore.readthedocs.org/en/latest/
Author: Ali-Akber Saifee
Author-email: ali@mig33global.com
License: MIT
Description: .. _PageObjects: http://code.google.com/p/selenium/wiki/PageObjects
        .. |travis-ci| image:: https://secure.travis-ci.org/alisaifee/holmium.core.png?branch=py3k
            :target: https://travis-ci.org/#!/alisaifee/holmium.core?branch=py3k 
        .. |coveralls| image:: https://coveralls.io/repos/alisaifee/holmium.core/badge.png?branch=py3k 
            :target: https://coveralls.io/r/alisaifee/holmium.core?branch=py3k 
        
        .. |pypi| image:: https://pypip.in/v/holmium.core/badge.png
            :target: https://crate.io/packages/holmium.core/
        
        ************
        holmium.core
        ************
        |travis-ci| |coveralls| |pypi|
        
        
        ************
        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).
        
        .. code-block:: python
        
            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.
        
        
        .. code-block:: python
        
            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.
        
        .. code-block:: bash
        
            # 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
        
        
        .. :changelog:
        .. _Deprecated old class names: http://holmiumcore.readthedocs.org/en/latest/core.html#deprecated-classes 
        .. _Config object: http://holmiumcore.readthedocs.org/en/latest/internals.html#holmium.core.Config
        .. _Section object: https://holmiumcore.readthedocs.org/en/latest/usage.html#sections 
        .. _Facets: http://holmiumcore.readthedocs.org/en/latest/usage.html#page-facets 
        .. _Cucumber Features: http://holmiumcore.readthedocs.org/en/latest/cucumber.html 
        .. _fresher: https://github.com/lddubeau/fresher 
        
        *******
        History
        *******
        
        0.4.2 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.
        
        0.4.1 2013-11-29
        ================
        * Bug fix for config module being reused between test runs. 
        
        0.4 2013-11-28
        ==============
        * Old style class names removed (`Deprecated old class names`_)
        * Introduced `Facets`_
        * Introduced `Cucumber Features`_ integration with `fresher`_.
        * General refactoring and code cleanup.
        
        0.3.4 2013-11-21
        ================
        * Added support to ignore ssl certificate errors on chrome, firefox & phantomjs 
        * code cleanup
        * improved test coverage 
        
        
        0.3.3 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**
        
          .. code-block:: python 
        
            config = { "default" : { 
                            "login_url" : "{{url}}/login"
                            , "profile_url":"{{url}}/profiles/{{username}}"}
                      , "production": {
                            "url": "http://mysite.com"
                            , "username":"prod_user"} 
                    }
        
        
        0.3.2 2013-10-10
        ================
        * Fluent response from page objects only when page method returns None
        
        0.3.1 2013-09-17
        ================
        * Allow indexing of Sections objects 
        
        0.3 2013-09-16
        ==============
        * Bug Fix for instantiating multiple instances of the same the Page object
          (https://github.com/alisaifee/holmium.core/issues/4)
        * `Section object`_ introduced 
        
        0.2 2013-09-11
        ==============
        * `Deprecated old class names`_ (PageObject, PageElement, PageElements, PageElementMap & HolmiumTestCase) 
        * Added more tests for holmium.core.TestCase 
        * New `Config object`_. 
        
        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
        
        
        
        
        
        
        
        
        
        
        
        
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 2.7
