Confirmed users
213
edits
B2G/QA/Automation/Style Guide/Python Script Style: Difference between revisions
B2G/QA/Automation/Style Guide/Python Script Style (view source)
Revision as of 16:37, 10 November 2015
, 10 November 2015Moved away the external consumer parts and fixed nits
(→Using high-level methods: added) |
(Moved away the external consumer parts and fixed nits) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 70: | Line 70: | ||
# Bad | # Bad | ||
class test_this_site: | class test_this_site: | ||
</source> | |||
== Locators == | |||
* Locator variables should be prefixed with <code>_</code> 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. | |||
* Should have a suffix of <code>_locator</code>. | |||
* Accessing locators should be done through a property or method as this keeps the locator as read-only. | |||
<source lang="python"> | |||
@property | |||
def search_term(self): | |||
return self.marionette.find_element(*self._search_box_locator).value | |||
</source> | |||
* We should use locators in the following order of preference (there will be exceptions): | |||
** ID | |||
** Name | |||
** Class name | |||
** CSS selector | |||
** XPath | |||
* CSS locators should use whitespace for readability when using direct descendants. | |||
<source lang="python"> | |||
# Good | |||
_my_locator = "css=#content > p > a" | |||
# Bad | |||
_my_locator = "css=#content>p>a" | |||
</source> | |||
* Use Python tuples to define locators: | |||
<source lang="python"> | |||
# Good | |||
_my_locator = (By.ID, "content") | |||
</source> | </source> | ||
| Line 85: | Line 119: | ||
* Actions should wait for the appropriate action to complete. This could be an implicit or explicit wait. For example, clicking a login button might explicitly wait for a username field to be visible. | * Actions should wait for the appropriate action to complete. This could be an implicit or explicit wait. For example, clicking a login button might explicitly wait for a username field to be visible. | ||
== Using | == Using High-Level Methods == | ||
* | * A test script should remain a short entry point which leads to more details (like the main() function of a program). Don't detail every single tap and wait, in the test. Use methods that reflect a user's intent rather than a sequence of small steps the user has to do. The details of how to fulfill that intent will be in the page classes. | ||
<source lang="python"> | |||
# Good | |||
<source python> | |||
# | |||
messages.send_an_sms_to_yourself() | messages.send_an_sms_to_yourself() | ||
# | |||
# Bad | |||
messages.open_sms_app() | messages.open_sms_app() | ||
messages.create_new_sms(receiver) | messages.create_new_sms(receiver) | ||
| Line 99: | Line 132: | ||
</source> | </source> | ||
== Variable | == Variable Naming == | ||
* Name your variables with units. | * Name your variables with units. | ||
<source python> | <source lang="python"> | ||
# | # Good | ||
timeout_in_seconds, width_in_pixels | timeout_in_seconds, width_in_pixels | ||
# | |||
# Bad | |||
timeout, width | timeout, width | ||
</source> | </source> | ||
* Don't shorten variable names. | * Don't shorten variable names. | ||
<source python> | <source lang="python"> | ||
# | # Good | ||
self.time_out_error_time = 1000 | self.time_out_error_time = 1000 | ||
# | |||
# Bad | |||
self.t_out_err_tim = 1000 | self.t_out_err_tim = 1000 | ||
</source> | </source> | ||
== Making | == Making Tests Locale Independent == | ||
It is recommended to make the test scripts (and especially the helper methods) locale independent, because this enables us to test devices in RTL locale. There are still some sections in gaiatest where it checks for the displayed English text, but unless one cannot avoid it, data-l10n-id attribute should be checked in place of any raw text comparison. | It is recommended to make the test scripts (and especially the helper methods) locale independent, because this enables us to test devices in RTL locale. There are still some sections in gaiatest where it checks for the displayed English text, but unless one cannot avoid it, data-l10n-id attribute should be checked in place of any raw text comparison. | ||
<source python> | <source lang="python"> | ||
# below method will not work in a non-English locale, | # below method will not work in a non-English locale, | ||
| Line 137: | Line 172: | ||
* We can check for the raw text in order to verify the user input (i.e., a phone number entered in the dialer app) | * We can check for the raw text in order to verify the user input (i.e., a phone number entered in the dialer app) | ||
* We check the data-l10n-id for any string that comes from Gaia only (i.e., an error message) | * We check the data-l10n-id for any string that comes from Gaia only (i.e., an error message) | ||