Skip to content

Latest commit

 

History

History
128 lines (61 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

128 lines (61 loc) · 3.42 KB
Raw

Pull request general verifications

Branch naming convention

Example: feature/LUSTEF-Zad12

Every file

Remove commented out lines of code and empty lines

Remove // Commented lines and empty lines

Enable file formatting

By default, file formatting should be already uploaded to Eclipse.

Name of java package. Always small letters

The prefix of a unique package name is always written in all-lowercase ASCII letters.

Example com.example.selenium.cmu.cs.bovik.cheese

Name of java class

Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).

Example:

  • class Raster;

  • class ImageSprite;

Name of methods

Methods should be verbs, in mixed case with the first letter lowercase, with the first letter of each internal word capitalized.

Example:

  • run();

  • runFast();

  • getBackground();

Inside Test file

List of rules during code review for file structure - Test class files

Test business steps

Validate all business test case steps

No Selenium operations in Test Classes

Test Class file can only execute methods/actions from Page class.

As the result of this, Test class can use only asserts against this Page methods

Test method naming convention

Inside Page file

List of rules during code review for file structure - Page class files

No junit/test operation in file

As Page class file mimics actions on web page, therefore no "test" operation can be done here.

For any test action, Test class with test methods can be used.

Method/actions naming convention.

Method convention described in details, link: Naming convention

Method/actions can exit when all tasks are finished

Some actions such as click might need to:

  • wait to load pagegetDriver().waitForPageLoaded();

  • return new Page object.

No explicitly sleep steps

It is not allowed to use Thread.sleep steps.

Instead of this pleas use waitUntil

List available waitUntils:

  • getDriver().waitForPageLoaded();

  • getDriver().waitForElement(selector);

  • getDriver().waitForElementVisible(selector);

  • getDriver().waitUntilElementIsClickable(selector);

Selector variable - CSS , id, class

Type of selector: every type ( By.cssSelector , By.className , ... ) except By.xpath

private static final By selectorResultBanner = By.cssSelector("#hdtb-msb-vis");

Link to css selector tutorial

Selector variable type convention

Type of variable: private static final

private static final By selectorResultBanner = By.cssSelector("#hdtb-msb-vis");

Selector variable naming convention

Naming: selector[ElementName]

private static final By selectorResultBanner = By.cssSelector("#hdtb-msb-vis");