QA/Mozmill Test Automation/Test Modules Refactor: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 35: Line 35:


== Refactoring  ==
== Refactoring  ==
; Timeouts & Delays
* gDelay: replace with a discrete int value
* gTimeout: replace with TIMEOUT


=== Constants  ===
== Style Guidelines ==
All ''unchanging'' variables should be declared as constants. All constants should be named in ALL_CAPS with whitespace indicated by an underscore (_). All constants should be declared directly the ''required modules'' block and setupModule() function.
; Timeouts & Delays
* Proposed Guidelines:
** Delay: Use discrete value
** Timeout: Use global TIMEOUT
* Henrik: Timeouts should be encapsulated within a global shared module
* Geo: Use default params where appropriate, wrapper functions where not


<pre>* ***** END LICENSE BLOCK ***** */
; Constants
 
* Proposed Guidelines:
// Include required modules
** Exist between ''requires'' and ''setupModule()''
var utils = require("../../shared-modules/utils");
** const SOME_CONSTANT = value;
 
* Geo: All ''unchanging'' variables as constants
const TIMEOUT = 5000;
 
var setupModule = function() { </pre>
 
; gDelay
All instances of gDelay should be removed and replaced with a discrete integer.
 
; gTimeout
All instances of gTimeout should be renamed to TIMEOUT

Revision as of 18:45, 8 November 2010

Overview

Lead: Anthony Hughes
Co-workers: TBD
Dates: TBD
Status: In process of determining style guidelines
Repository Location: TBD
Tracking Bug(s) bug 604700
Documentation: Draft Proposal

Project Details

Summary

The purpose of this project is to ensure all tests are implemented using an agreed style guideline. The workflow of this project will mostly be parallel with the Shared Modules Refactor project. This project will be rolled out in multiple phases.

Phase I

Goal: Refactor "lowest-hanging-fruit" changes
Dependencies: Agreed upon style guidelines

Refactoring

Timeouts & Delays
  • gDelay: replace with a discrete int value
  • gTimeout: replace with TIMEOUT

Style Guidelines

Timeouts & Delays
  • Proposed Guidelines:
    • Delay: Use discrete value
    • Timeout: Use global TIMEOUT
  • Henrik: Timeouts should be encapsulated within a global shared module
  • Geo: Use default params where appropriate, wrapper functions where not
Constants
  • Proposed Guidelines:
    • Exist between requires and setupModule()
    • const SOME_CONSTANT = value;
  • Geo: All unchanging variables as constants
Retrieved from "https://wiki.allizom.org/index.php?title=QA/Mozmill_Test_Automation/Test_Modules_Refactor&oldid=266246"