QA/Execution/Web Testing/Docs/Automation/StyleGuide: Difference between revisions

** Indenting should be a soft tab (4 spaces) as common with in Python. Do not mix tabs and spaces!

** There should be no whitespace at the end of the file (as per PEP8)

** Comments should be on the line above. Remember to update comments when changing code so that code matches the comments.

** Class names should be in Pascal style as this is Python idiomatic.

** Locator variables should be prefixed with _ to show that it is "[http://docs.python.org/tutorial/classes.html#private-variables private]".

** Variables should be descriptive of the area and not clash with any properties.

** Suffix of _locator.

** Accessing Locators should be done through a property method as this keeps the locator as readonly.

     def search_box(self):

         return self.search_box_locator

* This approach can also be used with get_* calls with Selenium making it more idiomatic for the call.

    def page_title(self):

        return self.selenium.get_title()

** CSS

* Locators should include the strategy instead of using implied strategies.

 

* With Webdriver, use a Python tuple:

In some circumstances, for example where a header/navigation is common across the website, we will use a page region. The page region is a child class of the base Page Object, which is inherited by all page objects. This means that the navigation can be reached from any page object and herein lies the DRY!

Referring to this page region with a property makes it very readable and concise from within the test. Clicking home during a test would be performed like this:

     page_obj.header.click_login()

     test_search_positive.py

To make sure that we can review your patch as quickly and efficiently as possibly we would like patches to have 1 test in them and the necessary changes to the Page Objects. This also limits the chances of merge conflicts later.