Skip to content
This repository has been archived by the owner on Jan 18, 2024. It is now read-only.

Latest commit

 

History

History
55 lines (39 loc) · 3.12 KB

GENERALSTEPSFORRUNNINGRULESETS.md

File metadata and controls

55 lines (39 loc) · 3.12 KB
Raw

General Steps for Running Rulesets

Here, we include a more general discussion about what to consider when running rulesets in your project. The general steps to run rulesets are:

  1. Configure Parameters
  2. View Setup
  3. Run Rulesets
  4. Process Results

Configure Parameters

Having some base parameters might be useful:

  • View Name: A name should be given to the view being tested. This name should be specific and descriptive enough to help scale (ie working with hundreds of views). See View Setup for the definition of a view.
  • JIRA Project Name: Many companies use JIRA and bugs can be filed appropriately using this parameter.
  • Report Title: A report title is helpful if a report will be created with the results. In some case, multiple views might be aggregated into a single report to help make the results more digestable.

View Setup

View: A View is a set of webpages that all share certain characteristics. For example, many companies have a search capability for items to purchase. A View might be defined based on this search results page including the following characteristics: H1 contains Laptop, at least 5 items appear in the search results section, the header/footer landmark are present, a nav for the breadcrumb and left navigation are present, etc. Notice that a particular view may not have the same exact html code each time it is loaded.

View setup may include any of the following:

  • Using a specific user (ie sign in).
  • Assuming certain transactions have been made.
  • Interacting with multiple webpages by entering input, clicking buttons, etc.
  • Browser interactions like resize, scroll, etc.
  • Triggering special flows (ie modifying configuration settings or opting into an experiment).

Run Rulesets

Many of our ruleset runner examples demonstrate how to run one ruleset at a time. However, in practice, it is often easier to combine the results of multiple rulesets into a single JSON object.

Process Results

After the results are created, they can be used to do the following:

  • Highlight errors and take screenshots
  • Store results in a database
  • Convert JSON results to an HTML Report

Highlighting errors and taking screenshots can help people quickly find, file and fix issues to improve quality. Results can be stored in a database for tracking, which can also be surfaced via a quality dashboard. Converting the JSON results to an HTML report is another way to help people digest the information. If these HTML reports are uploaded to a central location, then quality dashboards can also link directly to these HTML reports.

  • The Chrome Extension example demonstrates how to highlight errors. Some hooks are in place to upload the results via a POST call, after which the results might be stored.
  • The Java with Selenium/TestNG example demonstrates how to highlight errors, take screenshots and create an HTML Report.