Axe DevTools pour Web Cucumber

Le axe-devtools-cucumber gem fournit des définitions d'étapes personnalisées pour évaluer si une page donnée est axe clean.

Cette gemme développe les étapes fournies par le readme de la gemme axe-core-cucumber.

Installation et utilisation

Assurez-vous d'avoir accès au [registre de Deque][configuration du registre npm]. Dans le cas contraire, [reportez-vous à la configuration][].

• Ajoutez axe-devtools-cucumber à votre fichier Gemfile ou gemspec et exécutez bundle install.

gem "axe-devtools-cucumber"

spec.add_dependency "axe-devtools-cucumber"

• Exiger les définitions d'étapes proposées par le gem. En règle générale, vous pouvez le faire en ajoutant un fichier de configuration de Cucumber existant sous features/support/env.rb.

require 'axe-cucumber-steps'

• Utiliser avec le [WebDriver][axe devtools gems] de votre choix.

API

Étape - Soyez conforme (be axe clean)

L'étape be axe clean est le composant central de l'intégration. Il s'agit d'une étape complète en soi qui vérifiera que la page actuellement chargée est axe clean en utilisant la configuration par défaut de [axe.run][axe-run] (le document entier est vérifié en utilisant les règles par défaut).

Then the page should be axe clean

Étape - Audit d'accessibilité (be audited for accessibility)

Cette étape vous permet d'auditer l'accessibilité de votre site sans faire échouer la suite de tests. Pour les éléments identifiés violations , les matchers convertiront l'exemple de test en pending et afficheront les violations détaillées.

Then the page should be audited for accessibility [including]
[excluding] [according to/according to ruleset] [checking rules/checking-only-rules]
[skipping rules] [logging results for]

Clauses

Les clauses sont des méthodes chaînables pour les be axe clean définitions d'étapes be audited for accessibility et.

Les clauses configurables permettent une plus grande granularité dans les tests et les attentes.

within- Clause d'inclusion

La clause d'inclusion (within "#selector") spécifie quels éléments de la page doivent être vérifiés. Un [sélecteur CSS][sélecteur CSS] valide doit être fourni et placé entre guillemets doubles. Les sélecteurs composés peuvent être utilisés pour sélectionner plusieurs éléments, par exemple within "#header, .footer". Pour plus d'informations, consultez la [documentation des paramètres de contexte][context-param].

Then the page should be axe clean within "#selector"

excluding- Clause d'exclusion

La clause d'exclusion (excluding "#selector") spécifie quels éléments du document doivent être ignorés. Un [sélecteur CSS][sélecteur CSS] valide doit être fourni et placé entre guillemets doubles. Les sélecteurs composés peuvent être utilisés pour sélectionner plusieurs éléments, par exemple, excluding "#widget, .ad". Pour plus d'informations, consultez la [documentation des paramètres de contexte][context-param].

Then the page should be audited for accessibility excluding "#selector"

Si vous le souhaitez, un point-virgule (;) ou le mot but peut être utilisé pour séparer la clause d'exclusion de la clause d'inclusion (si présente).

Then the page should be audited for accessibility within "main"; excluding "aside"
Then the page should be axe clean within "main" but excluding "aside"

according to- Clause de norme d'accessibilité (Étiquette)

La clause d'étiquette spécifie quelle norme (ou quelles normes) d'accessibilité doivent être utilisées pour vérifier la page. Les normes d'accessibilité sont spécifiées par nom (balise). Plusieurs normes peuvent être spécifiées en les séparant par des virgules, par exemple, according to: wcag2a, section508. Les [noms de balises acceptables sont documentés][options-param] ainsi qu'une [liste complète des règles][règles] qui correspondent à chaque balise.

Then the page should be audited for accessibility according to: tag-name

Si vous le souhaitez, un point-virgule (;) peut être utilisé pour séparer la clause de balise de la clause précédente.

Then the page should be axe clean within "#header"; according to: best-practice

checking- Clause de vérification des règles

La clause de vérification des règles spécifie quelles règles supplémentaires doivent être exécutées (en plus des balises spécifiées, le cas échéant, ou de l'ensemble de règles par défaut). Les règles sont spécifiées par des ID de règle séparés par des virgules.

Then the page should be axe clean checking: ruleId

Pour obtenir une liste des identifiants de règles valides, consultez la [documentation de règles][rules].

Si vous le souhaitez, un point-virgule (;) ou le mot and peut être utilisé pour séparer la clause des règles de vérification de la clause précédente.

Then the page should be axe clean according to: wcag2a; checking: color-contrast
Then the page should be audited for accessibility according to: wcag2a and checking: color-contrast

checking only- Clause de règles exclusives

Cette clause n’est pas réellement une clause distincte. Mais plutôt, en ajoutant le mot only à la clause des règles de vérification, le sens de l'étape peut être modifié. Comme décrit ci-dessus, par défaut, la clause de vérification des règles spécifie des règles supplémentaires à exécuter. Si le mot only est utilisé, seules les règles spécifiées sont vérifiées.

Then the page should be axe clean checking only: ruleId

skipping- Clause relative aux règles ignorées

La clause skipping-rules spécifie les règles à ignorer. Cela permet de fournir une norme d'accessibilité (via la clause de tag) tout en ignorant une règle particulière. Les règles sont spécifiées par des ID de règle séparés par des virgules.

Then the page should be audited for accessibility skipping: ruleId

Pour obtenir une liste des identifiants de règles valides, consultez la [documentation de règles][rules].

Vous pouvez utiliser un point-virgule (;) ou le mot but pour séparer la clause des règles de saut de la clause précédente, comme indiqué ci-dessous :

Then the page should be axe clean according to: wcag2a; skipping: accesskeys
Then the page should be audited for accessibility according to: wcag2a but skipping: accesskeys

Clauses disponibles uniquement pour l'étape - Être audité pour l'accessibilité

Le be audited for accessibility matcher prend en charge deux clauses supplémentaires.

according to ruleset- Clause d'ensemble de règles

La clause d'ensemble de règles [according to ruleset] permet de spécifier un seul ensemble de règles (par exemple, 508, wcag2, wcag21) à utiliser pour vérifier la page.

Then the page should be axe clean according to ruleset: wcag2

logging results- Clause de résultats de journalisation

Pour enregistrer les résultats du matcher de base et des clauses, appelez la méthode chaînable logging results comme indiqué ci-dessous. La clause logging results for: report_name permet de spécifier le nom du rapport généré à la fin de l'exécution de l'étape.

Then the page should be audited for accessibility logging results for: axe_report_of_my_site

Interopérabilité entre les clauses

Toutes les clauses décrites peuvent être combinées et enchaînées avec le chaînage de méthodes. Voici quelques exemples.

Then the page should be audited for accessibility within "main, header" but excluding "footer"

Then the page should be axe clean excluding "#sidebar" according to: wcag2a, wcag2aa but skipping: color-contrast

Then the page should be audited for accessibility checking only: document-title, label

Then the page should be axe clean according to: best-practice and checking: aria-roles, definition-list

Utilisation avancée de l'API

Reportez-vous à [utilisation avancée][] pour voir comment configurer l'API pour :

• Règles personnalisées
• Chemin personnalisé vers la source de axe
• Enregistrement d'utilisation
• Reporting

[attest npm registry setup] : https://dequeuniversity.com/guide/attest/2.11/getting-started/npm-setup/ [se référer à la configuration] : rb-access-setup#required-access--setup [axe devtools gems] : rb-introduction#axe-devtools-gems [axe-run] : https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axerun [context-param] : https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter [options-param] : https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter [rules] : https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md [sélecteur css] : https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Getting_started/Selectors [utilisation avancée] : rb-advanced-usage