Utilisation avancée de l'API avec Ruby

Ce document aborde les règles personnalisées, les options de rapport et le service d'utilisation avec Ruby.

Règles personnalisées

Vous pouvez spécifier des règles axe personnalisées dans un fichier JSON.

Configurer les règles personnalisées via une variable d'environnement

La configuration par défaut attend que l'emplacement du fichier des règles personnalisées soit config/axe-ruleset.json, relatif au répertoire de travail actuel.

Vous pouvez remplacer cet emplacement avec la variable d'environnement AXE_RULESET_PATH ou manuellement via la configuration Axe DevTools.

Définissez la variable d'environnement AXE_RULESET_PATH pour changer l'emplacement de votre axe-ruleset.json :

AXE_RULESET_PATH=/path/to/your/axe-ruleset.json

Configuration des règles personnalisées via la configuration Axe DevTools

Un objet de configuration est disponible pour définir un emplacement de règle personnalisée en utilisant la méthode AxeDevTools.configure si vous ne souhaitez pas travailler avec la variable d'environnement AXE_RULESET_PATH.

Tous les paramètres ci-dessous sont facultatifs. Vous pouvez omettre l'invocation de AxeDevTools.configure pour utiliser les valeurs par défaut d'origine.

AxeDevTools.configure do |config|
  # path to json configuration providing custom rules and checks
  # set defaults to "config/axe-ruleset.json"
  config.axe_ruleset_path = "config/axe-ruleset.json"

  # Configure user pre-defined standard rule sets. Custom
  # rules override these rule sets. See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md
  config.rule_set_id = '508'
end

Options de rapport

Configuration des options de rapport avec la configuration Axe DevTools

Les gems axe-devtools-* permettent d'enregistrer les résultats des tests. Utilisez l'invocation AxeDevTools.Configure pour configurer une configuration globale pour les rapports :

AxeDevTools.configure do |config|
  config.output_directory: 'my-results',
  config.test_machine: 'my-server',
  config.test_suite_name: 'Accessibility Tests For Application',
  config.user_agent: 'Headless Chrome'
end

expect(page).to be_audited_for_accessibility.logging_results({
  ui_state: 'Landing Page Load',
})

La configuration des rapports peut prendre les propriétés suivantes :

Notez également que toutes les options ci-dessus pour AxeDevTools.configure peuvent être passées lors de la configuration du WebDriver de votre choix. Par exemple :

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.axe_config_path = 'config/my-ruleset.json'
end

Voir aussi

• Télécharger les résultats d'accessibilité JSON vers Axe Reports décrit comment télécharger vos résultats vers Axe Reports.
• Obtenir une clé API pour Axe Reports explique comment obtenir une clé API pour commencer à utiliser Axe Reports.
• Création et filtrage des rapports montre comment vous pouvez créer des rapports d'accessibilité en CSV, XML ou HTML à partir de vos résultats d'accessibilité JSON. Vous pouvez également filtrer votre sortie par gravité à l'aide de cet outil.
• Comment les résultats JSON sont stockés sur le disque décrit les conventions de nommage des fichiers pour les résultats d'accessibilité JSON.
• Utiliser la CLI pour envoyer des résultats d'accessibilité à Axe Developer Hub montre comment vous pouvez télécharger vos fichiers de résultats .json vers Axe Developer Hub.

Service d'utilisation

Vous pouvez obtenir un aperçu des tendances d'utilisation d'Axe DevTools au sein de votre organisation avec le service d'utilisation.

Par défaut, le service d'utilisation est activé, et l'URL de suivi est https://usage.deque.com.

Configuration des options du service d'utilisation avec la configuration AxeDevTools

Les gems axe-devtools-* permettent de configurer le service d'utilisation via une configuration globale :

AxeDevTools.configure do |config|
  config.setTrackingUrl: 'https://usage.deque.com',
end

Les propriétés spécifiques de configuration du service d'utilisation sont :

De plus, notez que toutes les options ci-dessus pour AxeDevTools.configure peuvent également être transmises lors de la configuration du WebDriver de votre choix. Par exemple, pour Capybara :

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.enableTracking = false
end

Configurer les options du service d'utilisation avec des variables d'environnement

En outre, les options du service d'utilisation peuvent être configurées via des variables d'environnement.