Axe DevTools pour Web Cucumber

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

Cette gem s'appuie sur la étapes fournies par le readme de la gem axe-core-cucumber.

Installation et Utilisation

Assurez-vous d'avoir accès à Deque's registry. Sinon, refer to setup.

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

gem "axe-devtools-cucumber"

spec.add_dependency "axe-devtools-cucumber"

• Importez les définitions d'étapes proposées par la gem. Typiquement, vous pouvez le faire en ajoutant à un fichier de configuration cucumber existant sous features/support/env.rb.

require 'axe-cucumber-steps'

• Utilisez avec le WebDriver de votre choix.

API

Étape - Être Propre selon Axe (be axe clean)

L'étape be axe clean est le composant principal de l'intégration. C'est une étape complète en elle-même et vérifiera que la page actuellement chargée est propre selon axe en utilisant la configuration par défaut de axe.run (l'ensemble du document est vérifié en utilisant les règles par défaut).

Then the page should be axe clean

Étape - Auditer pour l'Accessibilité (be audited for accessibility)

Cette étape vous permet d'auditer l'accessibilité de votre site sans échouer la suite de tests. Pour les violations identifiés, 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 définitions d'étapes be axe clean et be audited for accessibility.

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 CSS selector valide doit être fourni et entouré de 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 le context parameter documentation.

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 CSS selector valide doit être fourni et entouré de 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 le context parameter documentation.

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é (Tag)

La clause de tag spécifie quelle norme d'accessibilité (ou quelles normes) doit être utilisée pour vérifier la page. Les normes d'accessibilité sont spécifiées par nom (tag). Plusieurs normes peuvent être spécifiées séparées par des virgules, par exemple, according to: wcag2a, section508. Les tag names are documented acceptables ainsi qu'un complete listing of rules correspondant à chaque tag.

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 tag de la clause précédente.

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

checking- Clause de Règles de Vérification

La clause de règles de vérification spécifie quelles supplémentaires règles exécuter (en plus des tags spécifiés, le cas échéant, ou de l'ensemble de règles par défaut). Les règles sont spécifiées par des identifiants de règles séparés par des virgules.

Then the page should be axe clean checking: ruleId

Pour une liste d'identifiants de règles valides, consultez le rules documentation.

Si vous le souhaitez, un point-virgule (;) ou le mot and peut être utilisé pour séparer la clause de 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 vraiment une clause séparée. Mais en ajoutant le mot only à la clause de règles de vérification, le sens de l'étape peut être modifié. Comme décrit ci-dessus, par défaut la clause de règles de vérification spécifie les règles supplémentaires à exécuter. Si le mot only est utilisé, alors seulement les règles spécifiées sont vérifiées.

Then the page should be axe clean checking only: ruleId

skipping- Clause de Règles Ignorées

La clause de règles ignorées spécifie quelles 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 identifiants de règles séparés par des virgules.

Then the page should be audited for accessibility skipping: ruleId

Pour une liste d'identifiants de règles valides, consultez le rules documentation.

Vous pouvez utiliser un point-virgule (;) ou le mot but pour séparer la clause de règles ignorées de la clause précédente, comme montré 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 uniquement disponibles pour l'étape - Auditer pour l'accessibilité

Le matcher be audited for accessibility offre un support pour deux clauses supplémentaires.

according to ruleset- Clause de Règleset

La clause de règleset [according to ruleset] aide à 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, invoquez la méthode chaînable logging results comme montré 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 associées grâce à l'enchaînement 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

Consultez advanced usage pour savoir comment configurer l'API pour :

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