Configuration d'Axe DevTools pour Web CLI

Les indicateurs décrits dans cet article sont disponibles pour axe <url>, axe spec et axe bulk-spec. Lorsque vous définissez l'un de ces indicateurs, la valeur est enregistrée dans le préférences et devient la valeur par défaut pour toutes les exécutions suivantes. Pour afficher ou modifier les préférences de manière interactive, y compris la réinitialisation des valeurs qui n'ont pas d'indicateur correspondant, utilisez axe config-selenium.

Options du navigateur

--accept-untrusted

Indique au navigateur d'accepter les certificats SSL non fiables. Utilisez ceci lors du test de pages sur des serveurs de développement locaux ou des environnements internes utilisant des certificats auto-signés. Passer cet indicateur enregistre acceptUntrustedCertificates: true dans le préférences. Pour le réinitialiser à false, exécutez axe config-selenium et répondez Non lorsqu'on vous y invite, ou modifiez directement le fichier de préférences.

axe <url> --accept-untrusted

--browser <name>

Spécifie quel navigateur utiliser. Le WebDriver correspondant doit être installé et disponible sur votre $PATH. Les valeurs valides sont : firefox (par défaut), chrome, safari, edge, ie.

axe <url> --browser chrome

Si vous rencontrez une erreur de lancement de navigateur lors de votre première exécution, il se peut que GeckoDriver (le WebDriver de Firefox) ne soit pas installé. Essayez --browser chrome à la place, qui fonctionne généralement sans configuration supplémentaire sur la plupart des systèmes.

Passer cet indicateur enregistre le nom du navigateur dans le préférences. Toutes les exécutions suivantes, y compris celles sans --browser, utiliseront le navigateur enregistré. Pour changer le navigateur enregistré, exécutez axe config-selenium et choisissez un autre navigateur à l'invite, ou modifiez directement le préférences.

--headless

Lance le navigateur en mode sans tête (pas de fenêtre visible). La valeur par défaut est false.

axe <url> --headless

--remote-server <url>

Se connecte à un serveur WebDriver distant au lieu de lancer un navigateur local. Le serveur doit exposer un point de terminaison compatible W3C WebDriver, tel qu'une grille Selenium, BrowserStack ou un remote Sauce Labs.

axe <url> --remote-server https://hub.browserstack.com/wd/hub

--window-size <width,height>

Définit la taille de la fenêtre du navigateur en pixels. Cela contrôle également la taille de la fenêtre d'affichage en mode sans interface, ce qui le rend utile pour tester les mises en page responsives.

axe <url> --window-size 1280,900

Options de temporisation

--page-timeout <ms>

Temps maximum en millisecondes (ms) à attendre pour qu'une page charge avant de la considérer comme échouée. La valeur par défaut est 60 000 ms (60 secondes). Augmentez cette valeur pour les pages se chargeant lentement ou les environnements réseau à retard élevé.

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

Temps en millisecondes à patienter après avoir complété une analyse avant de passer à l'action suivante dans un flux de travail. La valeur par défaut est 2 000 ms (2 secondes).

axe spec workflow.yml --post-analyze-pause 5000

--post-get-pause <ms>

Temps en millisecondes à patienter après le chargement d'une page et avant de commencer l'analyse. La valeur par défaut est 2 000 ms (2 secondes). Augmentez ceci si le contenu dynamique a besoin de plus de temps pour se rendre avant que l'analyse ne commence.

axe <url> --post-get-pause 5000

--post-script-pause <ms>

Temps en millisecondes à patienter après l'exécution d'une action d'un script de workflow et avant de continuer à l'action suivante. La valeur par défaut est 2 000 ms (2 secondes).

axe spec workflow.yml --post-script-pause 5000

--script-timeout <ms>

Temps maximum en millisecondes à attendre que l'exécution d'un script de workflow se termine. La valeur par défaut est 60 000 ms (60 secondes).

axe spec workflow.yml --script-timeout 120000

Suivi de l'utilisation

Axe DevTools CLI inclut le @deque/metrics-library, qui envoie des données d'utilisation anonymes à Deque. Ces données incluent des informations agrégées telles que le nombre de violations, le nombre de règles, et la version du moteur axe-core. Elles n'incluent pas les URL, le contenu des pages, ou toute information personnellement identifiable.

Un ID distinct est une valeur stockée dans le fichier de préférences utilisée pour corréler les événements à travers plusieurs exécutions de CLI sans identifier l'utilisateur. Vous pouvez modifier ou désactiver le suivi avec les options ci-dessous. Pour définir ces valeurs sans utiliser la CLI, utilisez le variables d'environnement de service d'utilisation.

--enable-tracking <state>

Active ou désactive l'envoi de données d'utilisation à la bibliothèque de métriques. Le suivi est activé par défaut ; passez false pour le désactiver. La variable d'environnement correspondante est AXE_TRACK_USAGE — voir Variables d'environnement de service d'utilisation.

axe <url> --enable-tracking false

--set-distinct-id <id>

Modifie l'ID distinct utilisé pour corréler les événements d'utilisation. L'ID est stocké dans le fichier de préférences et utilisé lors des exécutions. La variable d'environnement correspondante est AXE_DISTINCT_ID — voir Variables d'environnement de service d'utilisation.

axe <url> --set-distinct-id my-team-id

--set-tracking-url <url>

Change le point de terminaison où les métriques d'utilisation sont envoyées. Utilisez cela si votre organisation transfère de la télémétrie via un proxy interne. La variable d'environnement correspondante est AXE_METRICS_URL — voir Variables d'environnement de service d'utilisation.

axe <url> --set-tracking-url https://metrics.example.com/collect

Variables d'environnement de service d'utilisation

En plus des indicateurs CLI, vous pouvez configurer le service d'utilisation et définir des propriétés sur les événements signalés en utilisant des variables d'environnement. La colonne Peut remplacer indique si la valeur de la variable d'environnement peut remplacer une valeur déjà définie par programme via la bibliothèque de métriques. Un tiret (—) indique que le concept ne s'applique pas à cette variable.

axe config-selenium

Utilisez axe config-selenium pour configurer les paramètres par défaut de manière interactive. Vous serez invité à entrer des valeurs pour le navigateur, le délai d'attente et d'autres réglages. Vos réponses sont enregistrées dans le fichier de préférences et deviennent les valeurs par défaut pour toutes les exécutions CLI suivantes.

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

Pour voir les paramètres enregistrés actuels sans entrer dans l'invite interactive, utilisez l'indicateur --show :

axe config-selenium --show

Fichier de préférences

Tous les paramètres par défaut configurables sont stockés dans un fichier JSON à l'emplacement :

~/.config/preferences/com.deque.axe.devtools.cli.pref

Un fichier typique ressemble à ceci :

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

Vous pouvez modifier ce fichier directement comme alternative à l'utilisation de axe config-selenium ou au passage d'indicateurs sur la ligne de commande. Cela est utile pour réinitialiser des valeurs booléennes comme acceptUntrustedCertificates sans exécuter l'invite interactive.