QA/Execution/Web Testing/Docs/Automation/StyleGuide

The goal of the style guide is to try provide rules to write code that looks the same no matter what project. It is a guide and is always up for discussion by the team. I have created templates based on the details below.

All Files

File Headers

• At the top of each file should have python file header

    #!/usr/bin/env python

• Each file should have a completed copy of the MPL
• Each file should pass PEP8 except for line length, see below.
  • I.e. parameters should have a comma and a space e.g.

    # Good
    def method(self, parameter) 

    # Bad
    def method(self,parameter)

• • Lines should try not to have more than 100 characters.
  • 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.

    # Good
    class TestThisSite:
    
    # Bad
    class test_this_site:

Page Objects

General

• All Page Objects should inherit from Page in page.py.
• Page Objects should not do asserts. This should be done within the test.
• Each Page should be grouped within one module.
• If using mutliple words to describe a module separate them with underscores '_'

   test_search.py

• Timeout time should be taken from pytest-mozwebqa via page.py's timeout property.

Locators

• • Locator variables should be prefixed with _ to show that it is "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.

    @property
    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.

    @property
    def page_title(self):
        return self.selenium.get_title()

• We should use locators in the following order of preference (there will be exceptions):
  • ID
  • Name
  • CSS
  • XPath
• Locators should include the strategy instead of using implied strategies.

    # Good
    _my_locator = "id=content"
    
    # Bad
    _my_locator = "content"

• CSS locators should use whitespace for readability when using direct descendants.

    # Good
    _my_locator = "css=#content > p > a"
    
    # Bad
    _my_locator = "css=#content>p>a"

Actions

• Methods that perform actions on the page should indicate the action in the method name.

    # Good
    def click_report_with_length(length)

    # Bad
    def report_length(length)

Tests

• Module names should be called test_ and then behavioral areas.

   test_search_positive.py

• Test method signature should include mozwebqa to use pytest-mozwebqa plugin.

    def test_example(self, mozwebqa):

• Test method names should always show the intent of the test case.

    # Good
    def test_that_advanced_search_does_not_find_item(self, mozwebqa):

    # Bad
    def test_advanced_search(self, mozwebqa):

• Tests should handle the asserts -- not the page objects.

Size of patches

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.