Utilisation avancée de l'API avec Ruby

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Not for use with personal data

Ce document décrit les règles personnalisées, les options de création de rapports et le service d'usage avec Ruby.

Règles personnalisées

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

note

Si vous n'avez pas encore de règles personnalisées et que vous souhaitez commencer avec un ensemble de règles personnalisées vide, créez un axe-ruleset.json fichier dans le répertoire local avec un objet JavaScript vide, par exemple : {}.

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

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

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

AXE_RULESET_PATH Définissez la variable d'environnement pour modifier axe-ruleset.jsonl'emplacement de votre :

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

Configuration des règles personnalisées via axe DevTools Configuration

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

Tous les paramètres ci-dessous sont facultatifs. Vous pouvez omettre l' AxeDevTools.configure intégralité de l'invocation 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 axe DevTools Configuration

L'appel axe-devtools-* gems enable logging test results. Use the AxeDevTools.Configure pour établir une configuration globale pour la création de 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 :

Attribut	Valeur par défaut	Description
ui_state (obligatoire)		Attribut à passer dans `options` l'objet.
output_directory (facultatif)	`axe-reports`	Nom du répertoire dans lequel les rapports doivent être générés.
test_machine (facultatif)		Valeur pour décrire l'endroit où le test est exécuté. Par exemple, `CircleCI`, `TesterMachine01`
test_suite_name (facultatif)	`axe-a11yCheck`	Nom de la suite pour les tests. Par exemple , `My Module Test Suite`
user_agent (facultatif)	null	Passez un agent utilisateur cible. Par exemple, Google Chrome.
Verbeux (facultatif)	false	Indicateur pour activer/désactiver la journalisation détaillée de la trace de la pile et des messages.

Notez également que toutes les options ci-dessus pour AxeDevTools.configure peuvent être transmises 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échargement des résultats d'accessibilité JSON dans les rapports axe décrit comment télécharger vos résultats dans les rapports axe.
Obtention d'une clé API Axe Reports explique comment obtenir une clé API pour commencer à utiliser Axe Reports.
Création et filtrage de rapports montre comment vous pouvez créer des rapports d'accessibilité au format 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.

Service d'utilisation

Vous pouvez obtenir un aperçu des tendances d'utilisation d'axe DevTools au sein de votre organisation grâce au service d'utilisation.

Par défaut, le service d'utilisation est désactivé 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 de configuration spécifiques au service d'utilisation sont :

Attribut	Valeur par défaut	Description
Activer le suivi	vrai	Option permettant d'activer le suivi de l'utilisation.
setTrackingUrl	`https://usage.deque.com`	Option permettant de remplacer l'URL de suivi.

Notez également 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

Configuration des options du service d'utilisation avec des variables d'environnement

De plus, les Options du Service d'Utilisation peuvent être configurées en tant que variables d’environnement.