MozillaWiki

B2G/QA/Automation/Style Guide/Python Script Style: Difference between revisions

Page Discussion

B2G/QA/Automation/Style Guide/Python Script Style (view source)

Revision as of 16:37, 10 November 2015

569 bytes removed ,  10 November 2015
Moved away the external consumer parts and fixed nits
(→‎Variable naming: content added)
(Moved away the external consumer parts and fixed nits)
 
(21 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.


== Use testvars.json <njpark> ==
== Using High-Level Methods ==
Using test variable file when running gaiatest can avoid defining variables inside the script.  The testvars template is located [http://mxr.mozilla.org/gaia/source/tests/python/gaia-ui-tests/gaiatest/testvars_template.json here].
* 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.
<br>
Make sure to fill in the appropriate section if you're planning to use it, and supply the name and location of the .json file as the parameter to the '''gaiatest''' command with '''--testvars=''' option.
<br><br>
If you want to access the varable value defined in the .json file, you can do as the following example:
<br>
<source lang="python">
<source lang="python">
test_phone_number = self.testvars['remote_phone_number']
# Good
</source>
messages.send_an_sms_to_yourself()
If you need to access the sub-variable, consider below example as well:
<source lang="python">
self.testvars['plivo']['auth_id'],
self.testvars['plivo']['auth_token'],
self.testvars['plivo']['phone_number']
</source>


== Using high-level methods ==
# Bad
TBD - jlorenzo
messages.open_sms_app()
* In a test, make sure to only have steps that are high level (for instance: messages.send_an_sms_to_yourself() instead of detailing every single tap and click)
messages.create_new_sms(receiver)
== Avoid sleep() calls <njpark> ==
messages.type_content(content)
Sleep methods can be used as follows:
messages.send()
<source python>
import time
time.sleep(seconds)
</source>
</source>
<br>
However, sleep() calls should be used very sparingly, only when there is no other way to delay the action of Marionette.  Using sleep() when Wait() can accomplish the same thing would be bad for following reasons:
* Sleep() does not care about the UI changes in app.  If you're using sleep() to just 'wait enough', you'll run into problems when the app behavior changes and requires more/less time to wait.
* Sleep() does not care about the phone performance.  If the speed of the execution changes because of the changes in memory allocation or running on a newer/older devices, it will still wait for specified time.
<br>
When you have to use the sleep() call, make sure to put in the comment explaining why other methods won't work.


== Variable naming <jlorenzo> ==
== Variable Naming ==
* Name your variables with units.  
* Name your variables with units.  
<source python>
<source lang="python">
# good
# Good
timeout_in_seconds, width_in_pixels
timeout_in_seconds, width_in_pixels
# bad
 
# Bad
timeout, width
timeout, width
</source>
</source>
* Don't shorten variable names.  
* Don't shorten variable names.  
<source python>
<source lang="python">
# good
# Good
self.time_out_error_time = 1000
self.time_out_error_time = 1000
# bad
 
# Bad
self.t_out_err_tim = 1000
self.t_out_err_tim = 1000
</source>
</source>


== Making test multi-locale <njpark> ==  
== 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 156: 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)
== Be aware of outside consumers of ui-test ==
TBD - mwargers   
* Be aware if you change the Gaia UI test API, that outside consumers (mtbf, etc) might get broken
Jlorenzo
Confirmed users
213

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/1104431...1105032"