Skip to main content

audits.yml

The audits.yml file defines how audit checks are performed using Test Evolve.

enabled​

ruby
2022.1.0
nodejs
2022.1.0
enabled: true

Enable audit checks during a test run.

optiondescription
trueperforms an audit check when specified during the test run
falseignores any audit checks during the test run

source​

ruby
2022.1.0
nodejs
2022.1.0
source: lighthouse

Specify which accessibility testing integration will be used.

languagesourcedescription
Ruby Jsaxeperforms accessibility check with Deque Axe
Ruby Jslighthouseperforms audit checks with Lighthouse

lighthouse​

ruby
2022.1.0
nodejs
2022.1.0

If you have configured source to be lighthouse, then the lighthouse section defines the thresholds for lighthouse scores.

performance_threshold​

ruby
2022.1.0
nodejs
2022.1.0
performance_threshold: 90

The performance score threshold (out of 100). If any performance score in any check during a Scenario is lower than the number specified here, the test status will be failed.

accessibility_threshold​

ruby
2022.1.0
nodejs
2022.1.0
accessibility_threshold: 90

The accessibility score threshold (out of 100). If any accessibility score in any check during a Scenario is lower than the number specified here, the test status will be failed.

best_practices_threshold​

ruby
2022.1.0
nodejs
2022.1.0
best_practices_threshold: 90

The best practices score threshold (out of 100). If any best practices score in any check during a Scenario is lower than the number specified here, the test status will be failed.

seo_threshold​

ruby
2022.1.0
nodejs
2022.1.0
seo_threshold: 90

The SEO score threshold (out of 100). If any SEO score in any check during a Scenario is lower than the number specified here, the test status will be failed.

axe​

ruby
2023.0.0
nodejs
2023.0.1

If you have configured source to be axe, then the axe section defines the configuration for the axe audit checks.

standards​

ruby
2023.0.0
nodejs
2023.0.1
standards: [section508]

Specify the accessibility standards to perform the Axe audit against.

Valid standards: wcag2a, wcag2aa, wcag2aaa, wcag21a, wcag21aa, wcag22aa, best-practice, ACT, section508, experimental

*Leaving the array of values empty will perform the Axe check against ALL standards.

Example audits.yml​

default_config/audits.yml
&defaults_audits

enabled: true
source: lighthouse

lighthouse:
  performance_threshold: 90
  accessibility_threshold: 90
  best_practices_threshold: 90
  seo_threshold: 90

axe:
  standards: []