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:

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.

Style Guidelines

The Mozmill Style Guide v1.0 has been created. The following refactoring work is an effort to implement those guidelines throughout the mozmill-tests repository. This refactoring will be implemented in multiple phases, outlined below.

Refactoring

Phase I

Goal: Implement lowest hanging fruit

Phase II

Goal: Bring tests in-line with Shared Module Refactor

Outstanding Items

Discussion here

Arrays
  • Block style
    • What style?
    • Single Index
    • Multiple Index
    • Multiple Index, Multiple Object
Sleep()
  • When is sleep() ok? Is it ever ok?
Local Test Pages
const LOCAL_TEST_PAGES = [
  { url: 'some url', id: 'some id' },
  { url: 'some url', id: 'some id' }
];
  • Should always be declared as a constant Array
  • Use array block formatting
  • Name "LOCAL_TEST_PAGES"
Test Files API Module
  • We should have a module specific to loading of test files
Parameter in setupModule() & teardownModule()
  • Is module needed, wanted?
Error Messages
"Expected <element> to be <state>"

"Expected password-save notification bar to be visible"
  • Messages should be positive in nature
  • <element> should be what the element represents
  • <state> should be what state we expect that element to be in
Parameter Naming
  • param or aParam?
  • Example: label or aLabel
  • the latter is common in Mozilla coding styles
Scope of Constants
  • Global or within the tightest scope?
Review Guidelines

What are our "golden-rule" guidelines for different review states?

  • r?
  • r+
  • r-
  • feedback?
  • feedback+
  • feedback-
Retrieved from "https://wiki.allizom.org/index.php?title=QA/Mozmill_Test_Automation/Test_Modules_Refactor&oldid=272550"