Skip to content

docs: Update end_to_end_test docs with glRunA11yTests helper

Paul Slaughter requested to merge ps-docs-gl-run-a11y-helper into main

What does this MR do?

This MR updates our a11y end-to-end testing docs to promote the glRunA11yTests helper.

What is the helper for?

In Add a11y axe tests to GlBadge component (!3917 - merged) it was difficult to figure out which a11y test was failing because they all run under the same it. The helper glRunA11yTests encapsulates logging the name of the test and calling glCheckA11y.

The log before the tests is a big win. Otherwise it's hard to know which test fails when there's a failure:

glRunA11yTests_log

This is a Two-Way-Door decision and we might not like this helper so let's use this MR to figure out if this is helpful or not 😄

Edited by Paul Slaughter

Merge request reports