Fix excludes for accessibility audit tests #1803
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes the accessibility audit tests so we can exclude multiple different selectors from tests. Previously the selector `.app-phase-banner__wrapper` was in the list of things to exclude, but was not being excluded (see [comment from @hannalaakso in PR #784][1]). It isn't clear from the `axe-puppeteer` documentation, but `AxePuppeteer.exclude` accepts only one argument, which is either a string or a list of strings. If a list of strings is provided, this is used to select an element within an iframe [[2]]. So to exclude several different elements, we need to call `.exclude` multiple times. The easiest way to call `.exclude` multiple times for each test is to create a function (replacing the `thingsToExclude` object), which this commit does. This is required to upgrade `axe-core` to version 3.5.0 or greater. The tests we passing before this commit because the rule ['all page content must be contained by landmarks'][3] was not working fully: it treated regions as being part of the `html` element (and thus not covered by `.include('body')`) [[4]]. [1]: https://github.com/alphagov/govuk-design-system/pull/784/files#r260285048 [2]: https://deque.com/axe/core-documentation/api-documentation/#context-parameter [3]: https://dequeuniversity.com/rules/axe/4.3/region [4]: dequelabs/axe-core#1980
|
✔️ You can preview this change here: 🔨 Explore the source changes: 87dbe10 🔍 Inspect the deploy log: https://app.netlify.com/sites/govuk-design-system-preview/deploys/610911582ae8a600074e0bdb 😎 Browse the preview: https://deploy-preview-1803--govuk-design-system-preview.netlify.app |
vanitabarrett
approved these changes
Aug 3, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes the accessibility audit tests so we can exclude multiple different selectors from tests. Previously the selector
.app-phase-banner__wrapperwas in the list of things to exclude, but was not being excluded (see comment from @hannalaakso in PR #784).This change is needed to be able to bump
axe-coreor@axe-core/puppeteer.Details
It isn't clear from the
axe-puppeteerdocumentation, butAxePuppeteer.excludeaccepts only one argument, which is either a string or a list of strings. If a list of strings is provided, this is used to select an element within an iframe [2]. So to exclude several different elements, we need to call.excludemultiple times.The easiest way to call
.excludemultiple times for each test is to create a function (replacing thethingsToExcludeobject), which this commit does.This is required to upgrade
axe-coreto version 3.5.0 or greater. The tests we passing before this commit because the rule 'all page content must be contained by landmarks' was not working fully: it treated regions as being part of thehtmlelement (and thus not covered by.include('body')) [4].