QA/Mozmill Test Automation/Test Modules Refactor

From MozillaWiki
Jump to navigation Jump to search

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

Constants

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.

* ***** END LICENSE BLOCK ***** */

// Include required modules 
var utils = require("../../shared-modules/utils");

const TIMEOUT = 5000;

var setupModule = function() { 
gDelay

All instances of gDelay should be removed and replaced with a discrete integer.

gTimeout

All instances of gTimeout should be renamed to TIMEOUT