Référence API pour Selenium

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

Référence API pour AxeSelenium, AxeConfiguration et les classes associées de sélecteurs, de rapports et de résultats dans Axe DevTools pour Web Java

Not for use with personal data

Ce document est une référence pour les classes AxeSelenium et AxeConfiguration, ainsi que pour les types de sélecteurs, de rapports et de résultats qu'ils utilisent. La classe AxeSelenium devrait couvrir la plupart des cas d'utilisation, et AxeConfiguration devrait couvrir le reste.

Les exemples de cette page supposent que webDriver est votre WebDriver Selenium et que driver est un AxeDriver l'enveloppant.

com.deque.html.axedevtools.selenium.AxeSelenium

Configure un scan d'accessibilité et l'exécute. Chaque méthode de configuration renvoie la même instance de AxeSelenium, ce qui permet d'enchaîner les appels, et run(AxeDriver) effectue le scan.

Results results = new AxeSelenium()
    .include(".my-css-class")
    .skipping("aria-required-parent")
    .run(driver);

AxeSelenium()

Crée un scan AxeSelenium qui utilise les paramètres globaux AxeConfiguration, tels que le jeu de règles, le suite d'audit et le répertoire de sortie du rapport. Utilisez ce constructeur sauf si vous avez besoin de personnaliser le AxeBuilder sous-jacent.

public AxeSelenium();

Exemple

Results results = new AxeSelenium().run(driver);

AxeSelenium(AxeBuilder)

Crée un scan AxeSelenium qui s'exécute via le AxeBuilder que vous fournissez, à partir de l'intégration axe-core Selenium (com.deque.html.axecore.selenium.AxeBuilder). Utilisez-le pour accéder aux options AxeBuilder que AxeSelenium n'expose pas, comme le mode hérité. Les paramètres globaux AxeConfiguration s'appliquent toujours.

public AxeSelenium(AxeBuilder axeBuilder);

Paramètres

Nom Type Description
axeBuilder AxeBuilder Le générateur utilisé pour injecter axe-core dans la page et l'exécuter.

Exemple

import com.deque.html.axecore.selenium.AxeBuilder;

Results results = new AxeSelenium(new AxeBuilder().setLegacyMode())
    .run(driver);

run(AxeDriver)

Scanne la page actuellement affichée par page, en utilisant chaque option configurée sur ce AxeSelenium, et retourne les résultats. Les violations ignorées (voir AxeSelenium.ignoring(String, String)) sont retirées des résultats, et si logResults a été appelé, les fichiers de rapport sont écrits avant que run ne retourne.

Si axe-core signale une erreur lors du scan, run la génère au lieu de retourner des résultats.

public Results run(AxeDriver page);

Paramètres

Nom Type Description
page AxeDriver La page à scanner.

Renvois

Un objet Results (com.deque.html.axecore.results.Results) contenant les violations, les réussites, les éléments incomplets et les résultats inapplicables.

Exceptions

  • AxeRuntimeException (com.deque.html.axecore.results.AxeRuntimeException) lorsque axe-core retourne une erreur au lieu de résultats.
  • RuntimeException lorsque le scan lui-même échoue, par exemple lorsque axe.finishRun échoue ou lorsque le pilote ne peut pas passer d'une fenêtre à l'autre.

Exemple

webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);

if (!results.violationFree()) {
    System.out.println(results.getViolations().size() + " rules have violations");
}

runCommand()

Renvoie le script générique axe.run que AxeSelenium exécute dans le navigateur en mode hérité. Le script n'inclut pas le contexte ou les options de ce scan, et avec axe-core 4.3 ou plus (le mode par défaut, non-hérité), les scans s'exécutent via un ensemble d'appels différent. AxeSelenium transmet ce script au rapporteur, donc il est principalement utile lorsque vous construisez votre propre texte de rapport avec AxeDevtoolsReporter.generateReport.

public String runCommand();

Renvois

Le script, comme un String.

include(String)

Limite le scan aux éléments correspondant à un sélecteur CSS, et à leurs descendants. Chaque appel ajoute une autre zone au scan, donc pour tester plusieurs parties non liées de la page, appelez include une fois pour chacune. Un seul sélecteur séparé par des virgules (".sidebar, .some-class") fonctionne également, car il est passé au navigateur tel quel.

public AxeSelenium include(String cssSelector);

Paramètres

Nom Type Description
cssSelector String N'importe quel sélecteur CSS valide.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
    .include(".sidebar")
    .include(".some-class")
    .run(driver);

include(List\<String>)

Limite le scan à un élément à l'intérieur d'un ou plusieurs iFrames imbriqués. Chaque chaîne sauf la dernière correspond à un niveau d'imbrication d'iFrame ; la dernière correspond à l'élément à tester à l'intérieur de l'iFrame le plus intérieur. La liste décrit un chemin, pas plusieurs sélecteurs.

Comme il n'y a pas de surcharge include(String...), passer plus d'une chaîne à include produit également un seul sélecteur iFrame plutôt que des inclusions séparées : include("#parent-iframe", "#html") se résout en include(Object...) et signifie la même chose que l'exemple ci-dessous.

include(FromFrames) exprime la même chose plus explicitement et est la forme recommandée pour les nouveaux tests.

public AxeSelenium include(List<String> selector);

Paramètres

Nom Type Description
selector List\<String> Un sélecteur CSS par niveau d'imbrication d'iFrame, suivi par un sélecteur CSS pour l'élément à l'intérieur de l'iFrame le plus intérieur.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
    .include(Arrays.asList("#parent-iframe", "#html"))
    .run(driver);

include(FromFrames)

Limite le scan à un élément à l'intérieur d'un ou plusieurs iFrames imbriqués, en utilisant un sélecteur FromFrames explicite.

public AxeSelenium include(FromFrames fromFrames);

Paramètres

Nom Type Description
fromFrames FromFrames Chaque sélecteur sauf le dernier correspond à un niveau d'imbrication d'iFrame ; le dernier correspond à l'élément à tester à l'intérieur de l'iFrame le plus intérieur.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .include(new FromFrames("#payment-frame", "form"))
    .run(driver);

include(FromShadowDom)

Limite le scan à un élément à l'intérieur d'un ou plusieurs arbres DOM Shadow imbriqués, en utilisant un sélecteur FromShadowDom explicite.

public AxeSelenium include(FromShadowDom fromShadowDom);

Paramètres

Nom Type Description
fromShadowDom FromShadowDom Chaque sélecteur sauf le dernier correspond à un hôte de shadow ; le dernier correspond à l'élément à tester à l'intérieur de la racine shadow la plus intérieure.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .include(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

include(Object)

Limite le scan en utilisant un sélecteur fourni comme un seul objet. Java sélectionne cette surcharge uniquement lorsque le type statique de l'argument n'est pas l'un des types ci-dessus, comme une variable déclarée en tant que Object. Privilégiez les surcharges typées.

public AxeSelenium include(Object selector);

Paramètres

Nom Type Description
selector Object Une chaîne de sélecteurs CSS, une liste de chaînes, un sélecteur FromFrames ou un sélecteur FromShadowDom.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// The selector's type is chosen at runtime, so it's held as Object
Object scope = useFrame ? new FromFrames("#frame", "main") : "main";
Results results = new AxeSelenium()
    .include(scope)
    .run(driver);

include(Object...)

Limite le scan à l'aide d'un sélecteur qui mélange des sélecteurs CSS simples avec des sélecteurs FromFrames ou FromShadowDom, pour les cas que les autres surcharges ne peuvent pas exprimer. Tous les arguments ensemble forment un chemin unique vers un élément ; ils ne sont pas des inclusions séparées.

Cette surcharge est sélectionnée chaque fois que l'appel passe plus d'un argument. Passer un seul FromFrames ou FromShadowDom sélectionne include(FromFrames) ou include(FromShadowDom) à la place.

Pour atteindre un iFrame situé à l'intérieur d'une racine shadow, imbriquez le sélecteur FromShadowDom à l'intérieur du sélecteur FromFrames. L'inverse ne peut pas être exprimé, car FromShadowDom n'accepte que des chaînes.

public AxeSelenium include(Object... selector);

Paramètres

Nom Type Description
selector Object... Un ensemble mixte de sélecteurs CSS et d'objets sélecteurs formant un chemin unique vers l'élément à tester.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .include("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

exclude(String)

Supprime les éléments correspondant à un sélecteur CSS, et leurs descendants, du scan. Chaque appel enlève une autre zone, donc pour ignorer plusieurs parties non liées de la page, appelez exclude une fois pour chacune. Les exclusions s'appliquent en plus de tout appel include, ce qui vous permet de tester une région sauf une partie de celle-ci.

public AxeSelenium exclude(String cssSelector);

Paramètres

Nom Type Description
cssSelector String N'importe quel sélecteur CSS valide.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Test main, but skip the .cookie-banner and .ad-slot inside it
Results results = new AxeSelenium()
    .include("main")
    .exclude(".cookie-banner")
    .exclude(".ad-slot")
    .run(driver);

exclude(List\<String>)

Supprime un élément à l'intérieur d'un ou plusieurs iFrames imbriqués du scan. Chaque chaîne sauf la dernière correspond à un niveau d'imbrication d'iFrame ; la dernière correspond à l'élément à ignorer à l'intérieur de l'iFrame le plus intérieur. La liste décrit un chemin, pas plusieurs sélecteurs.

Comme il n'y a pas de surcharge exclude(String...), passer plus d'une chaîne à exclude produit également un seul sélecteur iFrame plutôt que des exclusions séparées : exclude(".iframe1", ".third-party-ad") se résout en exclude(Object...) et signifie la même chose que l'exemple ci-dessous.

exclude(FromFrames) exprime la même chose plus explicitement et est la forme recommandée pour les nouveaux tests.

public AxeSelenium exclude(List<String> selector);

Paramètres

Nom Type Description
selector List\<String> Un sélecteur CSS par niveau d'imbrication d'iFrame, suivi par un sélecteur CSS pour l'élément à l'intérieur de l'iFrame le plus intérieur.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Skip .third-party-ad inside the iframe matched by .iframe1
Results results = new AxeSelenium()
    .exclude(Arrays.asList(".iframe1", ".third-party-ad"))
    .run(driver);

exclude(FromFrames)

Supprime un élément à l'intérieur d'un ou plusieurs iFrames imbriqués du scan, en utilisant un sélecteur FromFrames explicite.

public AxeSelenium exclude(FromFrames fromFrames);

Paramètres

Nom Type Description
fromFrames FromFrames Chaque sélecteur sauf le dernier correspond à un niveau d'imbrication d'iFrame ; le dernier correspond à l'élément à ignorer à l'intérieur de l'iFrame le plus intérieur.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
    .exclude(new FromFrames("#payment-frame", "form"))
    .run(driver);

exclude(FromShadowDom)

Supprime un élément à l'intérieur d'un ou plusieurs arbres DOM Shadow imbriqués du scan, en utilisant un sélecteur FromShadowDom explicite.

public AxeSelenium exclude(FromShadowDom fromShadowDom);

Paramètres

Nom Type Description
fromShadowDom FromShadowDom Chaque sélecteur sauf le dernier correspond à un hôte de shadow ; le dernier correspond à l'élément à ignorer à l'intérieur de la racine shadow la plus intérieure.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Skip the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
    .exclude(new FromShadowDom(".app-header", "form#search"))
    .run(driver);

exclude(Object)

Supprime une zone du scan en utilisant un sélecteur fourni comme un seul objet. Java sélectionne cette surcharge uniquement lorsque le type statique de l'argument n'est pas l'un des types ci-dessus, comme une variable déclarée en tant que Object. Privilégiez les surcharges typées.

public AxeSelenium exclude(Object selector);

Paramètres

Nom Type Description
selector Object Une chaîne de sélecteurs CSS, une liste de chaînes, un sélecteur FromFrames ou un sélecteur FromShadowDom.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// The selector's type is chosen at runtime, so it's held as Object
Object skip = adInFrame ? new FromFrames("#ad-frame", ".ad") : ".ad";
Results results = new AxeSelenium()
    .exclude(skip)
    .run(driver);

exclude(Object...)

Supprime une zone du scan en utilisant un sélecteur qui mélange des sélecteurs CSS simples avec des sélecteurs FromFrames ou FromShadowDom, pour les cas que les autres surcharges ne peuvent pas exprimer. Tous les arguments ensemble forment un chemin unique vers un élément ; ils ne sont pas des exclusions séparées.

Cette surcharge est sélectionnée chaque fois que l'appel passe plus d'un argument. Passer un seul FromFrames ou FromShadowDom sélectionne exclude(FromFrames) ou exclude(FromShadowDom) à la place.

Pour atteindre un iFrame situé à l'intérieur d'une racine shadow, imbriquez le sélecteur FromShadowDom à l'intérieur du sélecteur FromFrames. L'inverse ne peut pas être exprimé, car FromShadowDom n'accepte que des chaînes.

public AxeSelenium exclude(Object... selector);

Paramètres

Nom Type Description
selector Object... Un ensemble mixte de sélecteurs CSS et d'objets sélecteurs formant un chemin unique vers l'élément à ignorer.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Skip .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
    .exclude("#frame", new FromShadowDom("#host", ".target"))
    .run(driver);

accordingTo(String...)

Exécute uniquement les règles qui portent au moins une des étiquettes données, telles que wcag2a ou best-practice. Utilisez-le pour tester contre une partie d'une norme, par exemple uniquement le WCAG 2.0 Niveau A, plutôt qu'un ensemble ensemble de règles complet.

accordingTo et checkingOnly définissent la même option, donc seul le dernier des deux appels prend effet. Un second appel accordingTo remplace également les étiquettes du premier, donc passez toutes les étiquettes en un seul appel.

public AxeSelenium accordingTo(String... tags);

Paramètres

Nom Type Description
tags String... Une ou plusieurs étiquettes axe-core. Voir Descriptions des Règles pour les étiquettes sur chaque règle.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Run only the WCAG 2.0 Level A and Section 508 rules
Results results = new AxeSelenium()
    .accordingTo("wcag2a", "section508")
    .run(driver);

checkingOnly(String...)

Exécute uniquement les règles nommées et aucune autre. Utilisez-le pour concentrer un test sur une ou deux règles, par exemple lors de la correction d'un problème spécifique.

checkingOnly et accordingTo définissent la même option, donc seule la dernière des deux appels prend effet. Un deuxième appel à checkingOnly remplace également les règles du premier, alors passez tous les identifiants de règle en un seul appel.

public AxeSelenium checkingOnly(String... rules);

Paramètres

Nom Type Description
rules String... Un ou plusieurs identifiants de règle axe-core. Voir Descriptions des Règles.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Run only the label and color-contrast rules
Results results = new AxeSelenium()
    .checkingOnly("label", "color-contrast")
    .run(driver);

checking(String...)

Active les règles nommées en plus des règles déjà sélectionnées par le jeu de règles ou par accordingTo. Utilisez-le pour ajouter une règle que les tags ou le jeu de règles sélectionnés omettent, comme une règle best-practice.

checking et skipping définissent la même option, donc seule la dernière des deux appels prend effet, et un deuxième appel à checking remplace les règles du premier. Passez tous les identifiants de règle en un seul appel, et ne combinez pas checking avec skipping dans le même scan.

public AxeSelenium checking(String... rules);

Paramètres

Nom Type Description
rules String... Un ou plusieurs identifiants de règle axe-core. Voir Descriptions des Règles.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Run the WCAG 2.0 Level A rules, plus the tabindex best-practice rule
Results results = new AxeSelenium()
    .accordingTo("wcag2a")
    .checking("tabindex")
    .run(driver);

skipping(String...)

Désactive les règles nommées, laissant en place le reste du jeu de règles sélectionné ou des tags. Utilisez-le pour désactiver complètement une règle ; pour supprimer la violation sur un élément et conserver les autres résultats de la règle, utilisez plutôt ignoring.

skipping et checking définissent la même option, donc seule la dernière des deux appels prend effet, et un deuxième appel à skipping remplace les règles du premier. Passez tous les identifiants de règle en un seul appel, et ne combinez pas skipping avec checking dans le même scan.

public AxeSelenium skipping(String... rules);

Paramètres

Nom Type Description
rules String... Un ou plusieurs identifiants de règle axe-core. Voir Descriptions des Règles.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Run the default ruleset without the color-contrast and image-alt rules
Results results = new AxeSelenium()
    .skipping("color-contrast", "image-alt")
    .run(driver);

forConfig(URL)

Sélectionne le suite d'audit (un fichier de configuration de règles JSON) avec lequel scanner, par URL. Cela définit le suite d'audit global sur AxeConfiguration, de sorte qu'il s'applique également à chaque scan ultérieur AxeSelenium, pas seulement à celui-ci.

Lorsqu'aucun suite d'audit n'est défini, Axe DevTools utilise le fichier nommé par la variable d'environnement AXE_RULESET_PATH ou, si cet élément n'est pas défini, une ressource config/axe-ruleset.json sur le classpath.

public AxeSelenium forConfig(URL auditConfigPath);

Paramètres

Nom Type Description
auditConfigPath URL L'URL du fichier de suite d'audit.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
Results results = new AxeSelenium()
    .forConfig(auditSuite)
    .run(driver);

forConfig(String)

Sélectionne le suite d'audit avec lequel scanner, par son chemin sur le système de fichiers. Comme forConfig(URL), il définit le suite d'audit global, il s'applique donc également aux scans ultérieurs.

public AxeSelenium forConfig(String auditConfigPath) throws MalformedURLException;

Paramètres

Nom Type Description
auditConfigPath String Le chemin du système de fichiers du fichier de suite d'audit.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exceptions

MalformedURLException si le chemin ne peut pas être converti en URL.

Exemple

Results results = new AxeSelenium()
    .forConfig("/opt/axe/my-audit-suite.json")
    .run(driver);

AxeSelenium.forRuleset(String)

Sélectionne le ensemble de règles avec lequel scanner, tel que wcag2.2 ou 508, avec les règles de bonnes pratiques désactivées. Le jeu de règles par défaut est wcag2.1. Si un suite d'audit est également configuré, il modifie le jeu de règles sélectionné.

Cela définit le jeu de règles global sur AxeConfiguration, donc il s'applique également à chaque scan ultérieur. Voir AxeConfiguration.forRuleset(String) pour la liste des identifiants de jeux de règles.

public AxeSelenium forRuleset(String rulesetId);

Paramètres

Nom Type Description
rulesetId String L'identifiant du jeu de règles.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .forRuleset("wcag2.2")
    .run(driver);

AxeSelenium.forRuleset(String, boolean)

Sélectionne le ensemble de règles avec lequel scanner, et si les règles de bonnes pratiques doivent également être exécutées. Sinon, il se comporte comme AxeSelenium.forRuleset(String), y compris en définissant le jeu de règles globalement.

public AxeSelenium forRuleset(String rulesetId, boolean enableBestPractices);

Paramètres

Nom Type Description
rulesetId String L'identifiant du jeu de règles.
enableBestPractices boolean true pour également exécuter les règles de bonnes pratiques.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// WCAG 2.1 rules plus best-practice rules
Results results = new AxeSelenium()
    .forRuleset("wcag2.1", true)
    .run(driver);

AxeSelenium.ignoring(String, String)

Supprime les violations d'une règle des résultats après le scan lorsque cette règle échoue pour un élément donné. La règle s'exécute toujours et rapporte toujours ses réussites. Un appel par règle est suffisant, car une correspondance supprime l'entrée entière de la règle. Ne l'appelez pas deux fois pour la même règle : si les deux sélecteurs correspondent aux éléments en échec, le scan génère un IllegalStateException.

Le filtrage fonctionne sur des règles entières : si un élément qui échoue la règle correspond au sélecteur, l'entrée entière de la règle est retirée des violations, y compris les échecs sur d'autres éléments. Pour les conserver, restreignez le scan avec exclude à la place.

The selector must match the element's target in the results exactly, written the way Java prints a list: the target selector inside square brackets, such as "[#sidebar]", or "[#frame, .ad]" for an element inside an iFrame. Copy it from a previous scan's results rather than writing it by hand.

public AxeSelenium ignoring(String attestSelector, String ruleId);

Paramètres

Nom Type Description
attestSelector String Le target de l'élément, tel qu'il apparaît dans les résultats.
ruleId String L'identifiant de la règle dont on doit ignorer la violation.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Ignore the known color-contrast violation on the sidebar
Results results = new AxeSelenium()
    .ignoring("[#sidebar]", "color-contrast")
    .run(driver);

disableIframeTesting()

Empêche Axe DevTools d'injecter axe-core dans les iFrames et de collecter les résultats à partir de ceux-ci, de sorte que seul le document de niveau supérieur soit testé. Utilisez-le lorsque le contenu des iFrames est hors de votre contrôle ou lorsque l'injection dans les iFrames entraîne des erreurs.

public AxeSelenium disableIframeTesting();

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .disableIframeTesting()
    .run(driver);

setTimeout(int)

Définit le temps, en secondes, que axe-core peut analyser la page avant que le scan échoue pour cause de dépassement de délai. La valeur par défaut est de 30 secondes. Augmentez-la pour les pages très grandes.

public AxeSelenium setTimeout(int timeout);

Paramètres

Nom Type Description
timeout int Le délai d'attente, en secondes.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .setTimeout(120)
    .run(driver);

logResults(AxeReportingOptions)

Écrit un rapport de ce scan lorsque run est terminé : un fichier .log répertoriant les violations et un fichier .json avec les résultats complets. Les noms et l'emplacement des fichiers proviennent de reportingOptions ; voir AxeReportingOptions. Sans cet appel, aucun fichier rapport n'est écrit.

Si reportingOptions n'a pas de numéro de ligne défini, Axe DevTools enregistre la ligne de votre test qui a appelé logResults.

public AxeSelenium logResults(AxeReportingOptions reportingOptions);

Paramètres

Nom Type Description
reportingOptions AxeReportingOptions Où écrire le rapport et comment décrire le test dedans.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

// Writes axe-reports/checkout-page-loaded.log and .json
AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("page-loaded")
    .outputDirectory("axe-reports");

Results results = new AxeSelenium()
    .logResults(options)
    .run(driver);

loggingConfigured()

Indique si logResults a été appelé sur ce AxeSelenium.

public boolean loggingConfigured();

Renvois

true si des options de rapport ont été définies.

enableTracking(boolean)

Active ou désactive le service d'utilisation pour ce AxeSelenium. Le service d'utilisation est activé par défaut. Lorsque la variable d'environnement AXE_TRACK_USAGE est définie, elle prend le pas et cette méthode n'a aucun effet : true active le service et toute autre valeur le désactive.

public AxeSelenium enableTracking(boolean state);

Paramètres

Nom Type Description
state boolean true pour envoyer des données d'utilisation, false pour arrêter de les envoyer.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .enableTracking(false)
    .run(driver);

trackingEnabled()

Indique si ce AxeSelenium envoie des données d'utilisation.

public boolean trackingEnabled();

Renvois

true si le service d'utilisation est activé.

setTrackingUrl(String)

Définit l'URL vers laquelle les données d'utilisation sont envoyées. La valeur par défaut est la variable d'environnement AXE_METRICS_URL, ou https://usage.deque.com lorsque celle-ci n'est pas définie. Lorsque AXE_METRICS_URL est définie, cette méthode n'a aucun effet.

public AxeSelenium setTrackingUrl(String url);

Paramètres

Nom Type Description
url String L'URL du service d'utilisation.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .setTrackingUrl("https://usage.example.com")
    .run(driver);

setDistinctId(String)

Définit l'ID distinct envoyé avec les données d'utilisation, ce qui permet au service d'utilisation de grouper les événements d'un utilisateur ou d'une machine. L'ID est enregistré dans ~/.deque/distinct_id, donc les exécutions ultérieures sur la même machine continuent à l'utiliser. Lorsque l'ID provient de la variable d'environnement AXE_DISTINCT_ID, cette méthode n'a aucun effet.

public AxeSelenium setDistinctId(String id);

Paramètres

Nom Type Description
id String L'ID distinct.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .setDistinctId("build-agent-7")
    .run(driver);

setAnalyticsComponentName(String)

Définit le nom de projet envoyé avec les données d'utilisation. Cela réinitialise également toutes les appels antérieurs de setTrackingUrl et enableTracking sur ce AxeSelenium à leurs valeurs par défaut, alors appelez-le avant ces méthodes. Un ID distinct défini avec setDistinctId est conservé.

public AxeSelenium setAnalyticsComponentName(String name);

Paramètres

Nom Type Description
name String Le nom du projet.

Renvois

Ce AxeSelenium, pour l'enchaînement des méthodes.

Exemple

Results results = new AxeSelenium()
    .setAnalyticsComponentName("storefront-tests")
    .setDistinctId("build-agent-7")
    .run(driver);

com.deque.html.axecore.args.FromFrames

Un sélecteur qui cible un élément à l'intérieur d'un ou plusieurs iFrames imbriqués. Passez-le à include ou exclude sur AxeSelenium.

import com.deque.html.axecore.args.FromFrames;

FromFrames(Object...)

Crée un sélecteur FromFrames à partir d'un chemin à travers des iFrames imbriqués vers un élément.

public FromFrames(Object... selectors);

Paramètres

Nom Type Description
selectors Object... Un sélecteur par niveau d'imbrication d'iFrame, suivi d'un sélecteur pour l'élément à l'intérieur de l'iFrame le plus interne. Chaque entrée est une chaîne sélectrice CSS, ou un sélecteur FromShadowDom lorsque l'iFrame elle-même réside à l'intérieur d'une racine d'ombre.

Exemple

// The form inside #inner-frame, which is inside #outer-frame
FromFrames checkoutForm = new FromFrames("#outer-frame", "#inner-frame", "form");

// The main element inside an iframe that lives in the shadow root attached to #widget
FromFrames widgetFrame = new FromFrames(new FromShadowDom("#widget", "iframe"), "main");

getFromFrames()

Renvoie les sélecteurs qui composent le chemin à travers les iFrames imbriqués.

public List<Object> getFromFrames();

Renvois

Les sélecteurs, comme un List\<Object>.

setFromFrames(Object...)

Remplace les sélecteurs qui composent le chemin à travers les iFrames imbriqués.

public void setFromFrames(Object... fromFrames);

Paramètres

Nom Type Description
fromFrames Object... Le nouveau chemin, dans la même forme que le constructeur prend.

Exemple

FromFrames selector = new FromFrames("#frame", "form");
selector.setFromFrames("#frame", "nav");

com.deque.html.axecore.args.FromShadowDom

Un sélecteur qui cible un élément à l'intérieur d'un ou plusieurs arbres DOM shadow imbriqués. Passez-le à include ou exclude sur AxeSelenium.

import com.deque.html.axecore.args.FromShadowDom;

FromShadowDom(String...)

Crée un sélecteur FromShadowDom à partir d'un chemin à travers des racines shadow imbriquées vers un élément.

public FromShadowDom(String... selectors);

Paramètres

Nom Type Description
selectors String... Un sélecteur par hôte de shadow, suivi d'un sélecteur pour l'élément à l'intérieur de la racine la plus interne du shadow.

Exemple

// The button inside the shadow root of .dialog, which is inside the shadow root of app-shell
FromShadowDom closeButton = new FromShadowDom("app-shell", ".dialog", "button.close");

getFromShadowDom()

Retourne les sélecteurs qui composent le chemin à travers les racines imbriquées du shadow.

public List<String> getFromShadowDom();

Renvois

Les sélecteurs, comme un List\<String>.

setFromShadowDom(String...)

Remplace les sélecteurs qui composent le chemin à travers les racines imbriquées du shadow.

public void setFromShadowDom(String... fromShadowDom);

Paramètres

Nom Type Description
fromShadowDom String... Le nouveau chemin, dans la même forme que le constructeur prend.

Exemple

FromShadowDom selector = new FromShadowDom("app-shell", "nav");
selector.setFromShadowDom("app-shell", "footer");

com.deque.html.axedevtools.selenium.AxeDriver

Enveloppe un Selenium WebDriver afin qu'Axe DevTools puisse injecter axe-core dans la page qu'il contrôle. Chaque AxeSelenium scan, et chaque matcher Hamcrest, prend un AxeDriver. Continuez à utiliser votre WebDriver pour naviguer et interagir avec la page.

AxeDriver(WebDriver)

Crée un AxeDriver pour un Selenium WebDriver.

public AxeDriver(WebDriver webDriver);

Paramètres

Nom Type Description
webDriver WebDriver Le Selenium WebDriver contrôlant la page à vérifier.

Exemple

WebDriver webDriver = new ChromeDriver();
AxeDriver driver = new AxeDriver(webDriver);

webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);

com.deque.html.axedevtools.selenium.AxeConfiguration

Contient les paramètres applicables à chaque scan de la série de tests : le script axe-core, la suite d'audit, l'ensemble de règles et les valeurs par défaut utilisées dans les rapports. Il y a une instance partagée que vous obtenez avec AxeConfiguration.configure(). Configurez-la une fois avant que les tests ne commencent.

Les méthodes sur AxeSelenium comme forRuleset et forConfig modifient aussi cette instance partagée.

// Code runs once before any tests are run
public void setupOnce() {
  AxeConfiguration.configure()
    .withAxeScript(axeURL)
    .forAuditSuite(auditURL)
    .forRuleset("508")
    .outputDirectory("my-axe-results");
}

configure()

Retourne l'instance partagée AxeConfiguration. Cette méthode statique est le seul moyen d'obtenir un AxeConfiguration.

public static AxeConfiguration configure();

Renvois

Le AxeConfiguration partagé.

Exemple

AxeConfiguration config = AxeConfiguration.configure();

reset()

Remplace la configuration partagée par une nouvelle avec des paramètres par défaut. Utilisez-la entre les classes de tests qui ont besoin de paramètres globaux différents. Un AxeConfiguration obtenu avant d'appeler reset conserve ses anciens paramètres, alors appelez à nouveau configure() après.

public static void reset();

Exemple

@AfterClass
public static void tearDown() {
    AxeConfiguration.reset();
}

forAuditSuite(URL)

Sélectionne la suite d'audit (un fichier de configuration de règles JSON) pour chaque scan, par URL. Lorsqu'aucune suite d'audit n'est définie, Axe DevTools utilise le fichier nommé par la variable d'environnement AXE_RULESET_PATH ou, si elle n'est pas définie, une ressource config/axe-ruleset.json dans le classpath.

public AxeConfiguration forAuditSuite(URL auditConfigPath);

Paramètres

Nom Type Description
auditConfigPath URL L'URL du fichier de suite d'audit.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure()
    .forAuditSuite(getClass().getResource("/config/my-audit-suite.json"));

forAuditSuite(String)

Sélectionne la suite d'audit pour chaque scan, par son chemin sur le système de fichiers.

public AxeConfiguration forAuditSuite(String auditConfigPath) throws MalformedURLException;

Paramètres

Nom Type Description
auditConfigPath String Le chemin du système de fichiers du fichier de suite d'audit.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exceptions

MalformedURLException si le chemin ne peut pas être converti en URL.

Exemple

AxeConfiguration.configure()
    .forAuditSuite("/opt/axe/my-audit-suite.json");

withAxeScript(URL)

Sélectionne le script axe-core à injecter dans la page, au lieu de celui intégré avec Axe DevTools. Utilisez-le pour verrouiller une version spécifique d'axe-core.

public AxeConfiguration withAxeScript(URL axeScript);

Paramètres

Nom Type Description
axeScript URL L'URL du script axe-core.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure()
    .withAxeScript(getClass().getResource("/axe.min.js"));

AxeConfiguration.forRuleset(String)

Sélectionne le ensemble de règles pour chaque scan, avec les règles de bonnes pratiques désactivées. L'ensemble de règles par défaut est wcag2.1.

public AxeConfiguration forRuleset(String rulesetId);

Paramètres

Nom Type Description
rulesetId String L'un des identifiants d'ensemble de règles ci-dessous.

Les identifiants d'ensemble de règles sont :

  • wcag2
  • wcag2.1
  • wcag2.2
  • wcag2aaa
  • wcag2.1aaa
  • wcag2.2aaa
  • 508
  • ttv5
  • en301549
  • rgaav4

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().forRuleset("wcag2.2");

AxeConfiguration.forRuleset(String, boolean)

Sélectionne le ensemble de règles pour chaque scan, et si les règles de bonnes pratiques doivent également être exécutées.

public AxeConfiguration forRuleset(String rulesetId, boolean enableBestPractices);

Paramètres

Nom Type Description
rulesetId String Voir AxeConfiguration.forRuleset(String) pour les identifiants d'ensemble de règles.
enableBestPractices boolean true pour également exécuter les règles de bonnes pratiques.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().forRuleset("508", true);

getTestSuiteName()

Retourne le nom de la suite de tests par défaut utilisé dans les rapports. Le défaut est axe-run.

public String getTestSuiteName();

AxeConfiguration.testSuiteName(String)

Définit le nom de la suite de tests par défaut utilisé dans les noms de fichiers de rapport et le contenu des rapports. Une valeur AxeReportingOptions.testSuiteName(String) la remplace pour un rapport.

public AxeConfiguration testSuiteName(String testSuiteName);

Paramètres

Nom Type Description
testSuiteName String Le nom de la suite de tests.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().testSuiteName("storefront");

AxeConfiguration.getOutputDirectory()

Retourne le répertoire par défaut où les rapports sont écrits. Le défaut est axe-reports.

public String getOutputDirectory();

AxeConfiguration.outputDirectory(String)

Définit le répertoire par défaut où les rapports sont écrits. Les répertoires manquants sont créés lorsqu'un rapport est écrit. Une valeur AxeReportingOptions.outputDirectory(String) la remplace pour un rapport.

public AxeConfiguration outputDirectory(String outputDirectory);

Paramètres

Nom Type Description
outputDirectory String Le chemin du répertoire.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().outputDirectory("target/axe-reports");

AxeConfiguration.getUserAgent()

Retourne l'agent utilisateur par défaut enregistré dans les rapports, ou null si aucun n'est défini.

public String getUserAgent();

AxeConfiguration.userAgent(String)

Définit l'agent utilisateur par défaut enregistré dans les rapports. C'est uniquement une étiquette et ne change pas l'agent utilisateur envoyé par le navigateur. Une valeur AxeReportingOptions.userAgent(String) la remplace pour un rapport.

public AxeConfiguration userAgent(String userAgent);

Paramètres

Nom Type Description
userAgent String L'agent utilisateur à enregistrer.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().userAgent("Chrome 130 headless");

AxeConfiguration.getTestMachine()

Retourne le nom de la machine de test par défaut enregistré dans les rapports, ou null si aucun n'est défini.

public String getTestMachine();

AxeConfiguration.testMachine(String)

Définit le nom de la machine de test par défaut enregistré dans les rapports. Une valeur AxeReportingOptions.testMachine(String) la remplace pour un rapport.

public AxeConfiguration testMachine(String testMachine);

Paramètres

Nom Type Description
testMachine String Le nom de la machine de test.

Renvois

Ce AxeConfiguration, pour l'enchaînement des méthodes.

Exemple

AxeConfiguration.configure().testMachine(System.getenv("HOSTNAME"));

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions

Décrit un rapport : où l'écrire, et la suite de tests, l'état de l'interface utilisateur, l'agent utilisateur, la machine de test et le numéro de ligne à y enregistrer. Transmettez-le à logResults. Il implémente ReportingOptions.

Toute valeur que vous ne définissez pas revient au paramètre correspondant AxeConfiguration. Les fichiers de rapport sont nommés <test suite name>-<UI state>.log et .json, donnez donc à chaque vérification d'une suite de tests son propre état d'interface utilisateur, sinon le rapport ultérieur écrase le précédent.

AxeReportingOptions()

Crée un AxeReportingOptions sans valeurs définies, donc chaque valeur provient de AxeConfiguration jusqu'à ce que vous la définissiez. L'état de l'interface utilisateur n'a pas de valeur par défaut et doit être défini avant qu'un rapport ne soit écrit.

public AxeReportingOptions();

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .uiState("home-page");

defaultAuditReportingOptions()

Retourne de nouvelles options avec le répertoire de sortie target/axe-report, le nom de la suite de tests accessibility, et l'état de l'interface utilisateur check, donc le rapport est écrit à target/axe-report/accessibility-check.log et .json. Ce sont les options que le matcher Hamcrest isAuditedForAccessibility() utilise lorsque vous n'appelez pas logResults.

public static AxeReportingOptions defaultAuditReportingOptions();

Renvois

Un nouveau AxeReportingOptions.

Exemple

Results results = new AxeSelenium()
    .logResults(AxeReportingOptions.defaultAuditReportingOptions())
    .run(driver);

getSuiteTestName()

Retourne le nom de la suite de tests pour ce rapport, ou le défaut AxeConfiguration si aucun n'est défini.

public String getSuiteTestName();

AxeReportingOptions.testSuiteName(String)

Définit le nom de la suite de tests pour ce rapport. C'est la première partie des noms de fichiers de rapport.

public AxeReportingOptions testSuiteName(String testSuiteName);

Paramètres

Nom Type Description
testSuiteName String Le nom de la suite de tests.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("payment-step");

getUiState()

Retourne l'état de l'interface utilisateur pour ce rapport.

public String getUiState();

Exceptions

MissingUIStateException si aucun état de l'interface utilisateur n'a été défini.

uiState(String)

Définit l'état de l'interface utilisateur pour ce rapport : un nom court pour ce à quoi ressemblait la page lorsqu'elle a été vérifiée, tel que menu-open ou form-errors. C'est la deuxième partie des noms de fichiers de rapport, et c'est requis : écrire un rapport sans cela génère MissingUIStateException.

public AxeReportingOptions uiState(String uiState);

Paramètres

Nom Type Description
uiState String Le nom de l'état de l'interface utilisateur.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

webDriver.findElement(By.id("menu-button")).click();

Results results = new AxeSelenium()
    .logResults(new AxeReportingOptions().uiState("menu-open"))
    .run(driver);

AxeReportingOptions.getOutputDirectory()

Retourne le répertoire où ce rapport est écrit, ou le défaut AxeConfiguration si aucun n'est défini.

public String getOutputDirectory();

AxeReportingOptions.outputDirectory(String)

Définit le répertoire où ce rapport est écrit. Les répertoires manquants sont créés lorsque le rapport est écrit.

public AxeReportingOptions outputDirectory(String outputDirectory);

Paramètres

Nom Type Description
outputDirectory String Le chemin du répertoire.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .outputDirectory("target/axe-reports/checkout")
    .uiState("cart");

getFileName()

Retourne le nom du fichier de rapport sans extension : le nom de la suite de tests et l'état de l'interface utilisateur joints par un tiret, suivis d'un horodatage si useUniqueFilename est activé.

public String getFileName();

getFilePath(String)

Retourne le chemin complet d'un fichier de rapport : le répertoire de sortie, un /, le nom du fichier, et extension.

public String getFilePath(String extension);

Paramètres

Nom Type Description
extension String L'extension du fichier, y compris le point initial, tel que .json.

Renvois

Le chemin du fichier.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("checkout")
    .uiState("cart")
    .outputDirectory("axe-reports");

String jsonPath = options.getFilePath(".json"); // axe-reports/checkout-cart.json

useUniqueFilename(boolean)

Ajoute un horodatage UTC aux noms de fichiers du rapport, afin que l'exécution de la même vérification génère de nouveaux fichiers au lieu d'écraser le rapport précédent.

Cette méthode renvoie l'interface ReportingOptions plutôt que AxeReportingOptions, il faut donc l'appeler comme une déclaration séparée, comme dans l'exemple, plutôt que dans une chaîne que vous assignez à un AxeReportingOptions ou que vous passez à logResults. Les noms de fichiers .log et .json sont construits séparément, de sorte que leurs horodatages peuvent légèrement différer.

public ReportingOptions useUniqueFilename(boolean uniqueFilename);

Paramètres

Nom Type Description
uniqueFilename boolean true pour ajouter un horodatage aux noms de fichiers.

Renvois

Cet objet, typé comme ReportingOptions.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .testSuiteName("nightly")
    .uiState("home");
options.useUniqueFilename(true);

AxeReportingOptions.getUserAgent()

Renvoie l'agent utilisateur enregistré dans ce rapport, ou le AxeConfiguration par défaut si aucun n'est défini.

public String getUserAgent();

AxeReportingOptions.userAgent(String)

Définit l'agent utilisateur enregistré dans ce rapport. Ce n'est qu'une étiquette et cela ne change pas l'agent utilisateur envoyé par le navigateur.

public AxeReportingOptions userAgent(String userAgent);

Paramètres

Nom Type Description
userAgent String L'agent utilisateur à enregistrer.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

String userAgent = (String) ((JavascriptExecutor) webDriver).executeScript("return navigator.userAgent");
AxeReportingOptions options = new AxeReportingOptions()
    .userAgent(userAgent)
    .uiState("home");

AxeReportingOptions.getTestMachine()

Renvoie le nom de l'ordinateur de test enregistré dans ce rapport, ou le AxeConfiguration par défaut si aucun n'est défini.

public String getTestMachine();

AxeReportingOptions.testMachine(String)

Définit le nom de l'ordinateur de test enregistré dans ce rapport.

public AxeReportingOptions testMachine(String testMachine);

Paramètres

Nom Type Description
testMachine String Le nom de la machine de test.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .testMachine("ci-linux-04")
    .uiState("home");

getLineNum()

Renvoie le numéro de ligne de test enregistré dans ce rapport, ou null si aucun n'est défini.

public String getLineNum();

lineNum(String)

Définit le numéro de ligne de test enregistré dans ce rapport, remplaçant toute valeur déjà définie. Vous en avez rarement besoin : logResults enregistre automatiquement la ligne d'appel lorsque aucun numéro de ligne n'est défini.

public AxeReportingOptions lineNum(String lineNum);

Paramètres

Nom Type Description
lineNum String Le numéro de ligne.

Renvois

Ce AxeReportingOptions, pour l'enchaînement des méthodes.

Exemple

AxeReportingOptions options = new AxeReportingOptions()
    .lineNum("42")
    .uiState("home");

lineNumIfEmpty(String)

Définit le numéro de ligne de test uniquement si aucun n'est encore défini. logResults l'utilise pour enregistrer la ligne d'appel sans écraser une valeur que vous avez définie avec lineNum.

Cette méthode renvoie l'interface ReportingOptions plutôt que AxeReportingOptions, il faut donc l'appeler comme une déclaration séparée plutôt que dans une chaîne que vous assignez à un AxeReportingOptions ou que vous passez à logResults.

public ReportingOptions lineNumIfEmpty(String lineNum);

Paramètres

Nom Type Description
lineNum String Le numéro de ligne.

Renvois

Cet objet, typé comme ReportingOptions.

com.deque.html.axedevtools.selenium.reporter.MissingUIStateException

Un RuntimeException lancé lorsqu'un rapport est écrit avec des options de rapport n'ayant pas d'état UI, avec le message « Veuillez fournir l'état UI de la page actuelle en test ». Pour l'éviter, appelez uiState sur chaque AxeReportingOptions que vous passez à logResults.

com.deque.html.axedevtools.selenium.results.ResultsFilter

Contient les paires élément et règle à exclure des résultats. Chaque AxeSelenium crée son propre ResultsFilter, que vous ajoutez avec AxeSelenium.ignoring(String, String) plutôt que de le créer vous-même. Vous pouvez également utiliser un ResultsFilter directement pour filtrer un objet Results que vous avez déjà.

filterIgnoredViolations(Results)

Supprime les violations ignorées de results. L'entrée entière d'une règle est supprimée des violations lorsque l'ID de la règle correspond et qu'un de ses nœuds a un target égal à un sélecteur ignoré, même si d'autres nœuds ne correspondent pas. L'objet Results que vous passez est modifié et retourné.

public Results filterIgnoredViolations(Results results);

Paramètres

Nom Type Description
results Results Les résultats à filtrer.

Renvois

Le même objet Results, avec les violations ignorées supprimées.

Exemple

Results results = new AxeSelenium().run(driver);

new ResultsFilter()
    .ignoring("[#legacy-widget]", "aria-allowed-attr")
    .filterIgnoredViolations(results);

ResultsFilter.ignoring(String, String)

Ajoute une paire élément et règle à ignorer. Le sélecteur doit correspondre exactement à un target d'un nœud, sous la forme "[#sidebar]"; voir AxeSelenium.ignoring(String, String).

public ResultsFilter ignoring(String cssSelector, String ruleId);

Paramètres

Nom Type Description
cssSelector String Le target de l'élément, tel qu'il apparaît dans les résultats.
ruleId String L'identifiant de la règle dont on doit ignorer la violation.

Renvois

Ce ResultsFilter, pour l'enchaînement des méthodes.

Exemple

ResultsFilter filter = new ResultsFilter()
    .ignoring("[#sidebar]", "color-contrast")
    .ignoring("[.third-party-iframe]", "frame-title");

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Écrit les fichiers de rapport .log et .json pour une analyse. AxeSelenium et les matchers Hamcrest l'utilisent pour vous lorsque vous appelez logResults; utilisez-le directement uniquement pour faire un rapport sur Results que vous avez déjà.

AxeDevtoolsReporter()

Crée un AxeDevtoolsReporter.

public AxeDevtoolsReporter();

Exemple

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();

generateReport(Results, String)

Renvoie un résumé en texte brut des violations dans results : le texte d'aide et l'URL de chaque règle, la cible de chaque nœud affecté et les vérifications à corriger, suivis par la commande qui a produit les résultats. Ceci est le texte écrit dans le fichier .log, et le texte que le matcher Hamcrest isAxeClean() affiche lorsqu'une assertion échoue.

public String generateReport(Results results, String executedCommand);

Paramètres

Nom Type Description
results Results Les résultats de l'analyse.
executedCommand String Le texte de commande à inclure dans le rapport, par exemple de runCommand().

Renvois

Le texte du rapport.

Exemple

AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);

String report = new AxeDevtoolsReporter().generateReport(results, axe.runCommand());
System.out.println(report);

report(ReportingOptions, Results, String)

Écrit le rapport pour results dans deux fichiers au chemin donné par reportingOptions : un fichier .log avec le texte generateReport et un fichier .json avec les résultats complets. Si reportingOptions est null, rien n'est écrit.

public void report(ReportingOptions reportingOptions, Results results, String executedCommand);

Paramètres

Nom Type Description
reportingOptions ReportingOptions Où écrire le rapport, généralement un AxeReportingOptions.
results Results Les résultats de l'analyse.
executedCommand String La commande qui a produit les résultats.

Exceptions

MissingUIStateException si reportingOptions n'a pas d'état UI, ou un RuntimeException si les fichiers ne peuvent pas être écrits.

Exemple

AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);

new AxeDevtoolsReporter().report(
    new AxeReportingOptions().uiState("after-login"),
    results,
    axe.runCommand());

com.deque.html.axedevtools.utils.FileUtils

Assistants de fichier qu'Axe DevTools utilise en interne pour lire et écrire des fichiers de rapport. Il n'est pas destiné à être utilisé dans vos tests.