Référence de l'API axe-devtools-behave

Ce package intègre Axe DevTools dans Behave, un framework de test python semblable à Cucumber.

Utilisation

Avant de pouvoir utiliser axe-devtools-behave, vous devez configurer quelques éléments.

Tout d'abord, vous devez configurer l'ouverture et la fermeture d'un navigateur, via features/environment.py :

# features/environment.py

import behave_webdriver

def before_all(context):
    context.behave_driver = behave_webdriver.Chrome()

def after_all(context):
    # cleanup after tests run
    context.behave_driver.quit()

Ensuite, vous devez importer axe-devtools-behave, ce qui peut être fait dans features/steps/axe.py :

# features/steps/axe.py

from axe_devtools_behave import *

Maintenant, vous pouvez utiliser axe-devtools-behave dans vos fichiers de fonctionnalités.

Le package axe-devtools-behave utilise behave-webdriver, donc toutes les étapes de cette bibliothèque sont importées et disponibles.

Étapes Cucumber d'Accessibilité

Les exemples de vérifications d'accessibilité ci-dessous utilisent Then the page should be axe clean, mais tous les contrôles fonctionnent de manière interchangeable avec Then the page should be audited for accessibility.

La différence est que should be axe clean exécute axe et échoue le test s'il y a des violations, tandis que should be audited for accessibility exécute axe et enregistre les résultats dans un répertoire axe-reports. should be audited for accessibility n'échoue jamais.

Pour construire une étape Cucumber d'accessibilité axe, commencez par l'étape de base, et ajoutez-y toutes les clauses nécessaires. Toutes les clauses suivantes peuvent être combinées; cependant, elles doivent apparaître dans l'ordre spécifié :

Then the page should be axe clean [including] [excluding] [according-to] [checking-rules/checking-only-rules] [skipping-rules]

Étape de Base

    Then the page should be axe clean

L'étape de base est le composant central de l'étape Cucumber. C'est une étape complète en elle-même et elle vérifie que la page actuellement chargée est accessible en utilisant la configuration par défaut de axe.a11yCheck (la vérification de l'ensemble du document utilise les règles par défaut).

Clause d'Inclusion

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

La clause d'inclusion (within "#selector") spécifie quels éléments vérifier sur la page. La clause d'inclusion doit inclure un Sélecteur CSS valide entouré de guillemets doubles. Utilisez des sélecteurs composés pour sélectionner plusieurs éléments. Par exemple, within "#header, .footer"

Clause d'Exclusion

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

La clause d'exclusion (excluding "#selector") spécifie quels éléments du document ignorer. Fournissez un Sélecteur CSS valide entouré de guillemets doubles. Utilisez des sélecteurs composés pour sélectionner plusieurs éléments. Par exemple, excluding "#widget, .ad"

Utilisez le point-virgule (;) ou le mot but pour séparer la clause d'exclusion de la clause d'inclusion si elle est présente.

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

Clause du Standard d'Accessibilité (Tag)

    Then the page should be axe clean according to: tag-name

La clause de tag spécifie quel standard d'accessibilité (ou quels standards) utiliser dans la vérification de la page. Spécifiez les standards d'accessibilité par nom (tag). Plusieurs standards peuvent être spécifiés lorsqu'ils sont séparés par des virgules. Par exemple, according to: wcag2a, section508

les noms de tags sont documentés acceptables en plus d'un(e) liste complète des descriptions de règles qui correspond à chaque tag.

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

Clause des Règles de Vérification

    Then the page should be axe clean checking: ruleId

La clause des règles de vérification spécifie toute(s) règle(s) supplémentaire à exécuter (en plus des tags spécifiés ou de l'ensemble de règles par défaut). Les règles sont spécifiées par des IDs de règle séparés par des virgules.

Voir Descriptions des Règles pour une liste des IDs de règle valides.

Utilisez un point-virgule (;) ou le mot and 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 axe clean according to: wcag2a and checking: color-contrast

Clause des Règles Exclusives

    Then the page should be axe clean checking only: ruleId

Cette clause n'est pas séparée. En ajoutant le mot only à la clause des règles de vérification, vous pouvez changer le sens de l'étape. Comme décrit précédemment, la clause des règles de vérification spécifie des règles supplémentaires à exécuter par défaut. Seules les règles spécifiées sont vérifiées si le mot only est utilisé.

Clause des Règles à Ignorer

    Then the page should be axe clean skipping: ruleId

La clause des règles à ignorer spécifie quelles règles doivent être ignorées. Spécifiez le standard d'accessibilité à utiliser (via la clause de tag) tout en ignorant une règle particulière. Spécifiez les règles par des IDs de règle séparés par des virgules.

Voir Descriptions des Règles pour une liste des IDs de règle valides

Utilisez un point-virgule (;) ou le mot but pour séparer la clause des règles à ignorer de la clause précédente.

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

Ensembles de règles étiquetées

Accédez aux ensembles de règles étiquetées via une clause Cucumber. Cette fonctionnalité permet aux développeurs de spécifier un ensemble de règles (par exemple : 508, wcag2, wcag2.1) pour auditer l'accessibilité d'une page.

Le code suivant démontre la syntaxe Gherkin de Cucumber nécessaire pour évaluer un ensemble de règles spécifique lors de l'analyse :

Scenario: Test Page with options
  When I visit "http://abcdcomputech.dequecloud.com/"
  Then the page should be audited for accessibility within "title" according to ruleset: wcag2.1