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

From MozillaWiki
< B2G‎ | QA‎ | Automation
Jump to navigation Jump to search
 
(7 intermediate revisions by 2 users not shown)
Line 3: Line 3:
<br>
<br>
<br>
<br>
It is also recommended to review Geo's draft of [https://github.com/geoelectric/ui_auto_best_practice/blob/master/uiabp.md automation best practices], which gives a theoretical overview of writing automation tests.


= [[B2G/QA/Automation/Style Guide/General Concepts|General Concepts]] =  
== General Disclaimer ==
= [[B2G/QA/Automation/Style Guide/Howtos| How-Tos ]] =
As we develop more knowledge some tests might fall behind the standards in this style guide. It can be tempting to want to fix all of the outdated style but in order to keep patches/pulls small (see above!) we are happy to have new and old standards of code sit side by side. As we regularly review and update tests the project will be brought completely up to our current standards.


= [[B2G/QA/Automation/Style_Guide/Python_Script_Style|Python Script Style Guide]] =
Or if you prefer, file a [https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox%20OS&component=Gaia%3A%3AUI%20Tests Bugzilla issue] to have a section of code addressed separately to the job you are doing.


= [[B2G/QA/Automation/Style Guide/Best Practices|Best Practices]] =
== Outside Test Consumers ==
* Be aware if you change or remove the Gaia UI test API, that outside consumers might get broken.


= Use of Libraries =
Current outside consumers of Gaiatest are:
* [https://github.com/Mozilla-TWQA/MTBF-Driver MTBF]
* [https://github.com/mozilla-b2g/gaia/tree/master/tests/python/gaia-ui-tests/gaiatest/tests/accessibility a11y]
* [https://github.com/JonHylands/power-tests Power-tests]
* [https://github.com/mozilla/marketplace-tests-gaia/tree/master/marketplacetests Marketplace tests]
* [https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette/Run_ImageMagick_Tool_with_Python_Marionette Imagecompare] tests
* [https://arewefastyet.com/#machine=26 awfy]


= Submission and Review =
== [[B2G/QA/Automation/Style Guide/General Concepts|General Concepts]] ==
== [[B2G/QA/Automation/Style Guide/Howtos| How-Tos ]] ==
 
== [[B2G/QA/Automation/Style_Guide/Python_Script_Style|Python Script Style Guide]] ==
 
== [[B2G/QA/Automation/Style Guide/Best Practices|Best Practices]] ==
 
== [[B2G/QA/Automation/Style_Guide/Avoiding_Duplication|Avoiding Duplication]] ==
 
== [[B2G/QA/Automation/Style_Guide/Submission_Review|Submission and Review]] ==
 
== [https://github.com/geoelectric/ui_auto_best_practice/blob/master/uiabp.md Further Reading] ==

Latest revision as of 16:08, 12 November 2015

The goal of this style guide is to provide rules to write ui-automation code that is clear and effective. It is a fork of this webqa page.

General Disclaimer

As we develop more knowledge some tests might fall behind the standards in this style guide. It can be tempting to want to fix all of the outdated style but in order to keep patches/pulls small (see above!) we are happy to have new and old standards of code sit side by side. As we regularly review and update tests the project will be brought completely up to our current standards.

Or if you prefer, file a Bugzilla issue to have a section of code addressed separately to the job you are doing.

Outside Test Consumers

  • Be aware if you change or remove the Gaia UI test API, that outside consumers might get broken.

Current outside consumers of Gaiatest are:

General Concepts

How-Tos

Python Script Style Guide

Best Practices

Avoiding Duplication

Submission and Review

Further Reading