Référence API pour Selenium

Ce document est une référence pour les types fournis par le selenium package. AxeSelenium La classe devrait couvrir la plupart des cas d'utilisation et AxeConfiguration devrait couvrir le reste.

com.deque.html.axedevtools.selenium.AxeSelenium

Configure comment axe s'exécute et le lance effectivement.

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

AxeSelenium()

Créez une nouvelle vérification d'accessibilité AxeSelenium pour un Axe Driver.

AxeSelenium(final AxeBuilder axeBuilder, final AxeConfiguration axeConfiguration, final ResultsFilter resultsFilter, final AxeDevtoolsReporter reporter)

Créez une nouvelle vérification d'accessibilité AxeSelenium pour un Axe Driver.

Results run(final AxeDriver page)

Exécutez axe sur la page en utilisant axe.run.

page : Pilote AxeDevTools représentant la page sur laquelle effectuer un audit d'accessibilité.

Renvoie un document de résultats.

AxeSelenium include(final String cssSelector)

Inclure un sélecteur.

cssSelector : Tout sélecteur CSS valide.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium inclure(liste finale<String> sélecteur)

Inclure un sélecteur iFrame.

selector:Une liste de sélecteurs iFrame imbriqués. Chaque sélecteur représentera un sélecteur CSS pour un niveau d'imbrication. Le dernier représentera un sélecteur CSS pour l'élément Web dans l'iFrame le plus interne pour vérification.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium exclude(final String cssSelector)

Exclure un sélecteur.

cssSelector : Tout sélecteur CSS valide. Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium exclure(liste finale<String> sélecteur)

Exclure un sélecteur.

selector:Une liste de sélecteurs iFrame imbriqués. Chaque sélecteur représentera un sélecteur CSS pour un niveau d'imbrication. Le dernier représentera un sélecteur CSS pour l'élément Web dans l'iFrame le plus interne pour vérification.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium accordingTo(final String... tags)

Selon les balises d'accessibilité. Vérifiez uniquement les balises d’accessibilité spécifiées. Cette option est incompatible avec AxeSelenium::checkingOnly Voir Descriptions des règles.

tags: Liste des balises à vérifier.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium checkingOnly(final String... rules)

Vérification uniquement des règles d'accessibilité. Cette option est incompatible avec AxeSelenium::accordingTo Voir Descriptions des règles.

rules : Liste des règles de vérification.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium checking(final String... rules)

Vérifiez les règles d'accessibilité. En plus des étiquettes données, vérifiez également certaines règles. Voir Descriptions des règles.

rules : Liste des règles de vérification.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium skipping(final String... rules)

Ignorer les règles d'accessibilité. À partir des balises données, permet de sauter la vérification de certaines règles. Voir Descriptions des règles.

rules : Liste des règles de vérification.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium forConfig(final URL auditConfigPath)

Fournir une suite d'audit par son URL.

auditConfigPath : l'URL associée à la suite d'audit.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium forConfig(final String auditConfigPath) Lance MalformedURLException

Fournir une suite d'audit par son emplacement sur le système de fichiers.

auditConfigPath : Le chemin d'accès absolu au fichier de la suite d'audit.

Renvoie AxeSelenium pour le chaînage de méthodes.

Renvoie MalformedURLException si le chemin d'audit est un chemin de système de fichiers non valide.

AxeSelenium forRuleset(final String rulesetId)

Spécifiez un ensemble de règles pour la vérification de l'accessibilité. La configuration d’une suite d’audit modifiera l’ensemble de règles spécifié. Voir Ensembles de règles.

rulesetId : L'identifiant de l'ensemble de règles pour la configuration.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Spécifiez un ensemble de règles pour la vérification de l'accessibilité. La configuration d’une suite d’audit modifiera l’ensemble de règles spécifié. Voir Ensembles de règles.

rulesetId : L'identifiant de l'ensemble de règles pour la configuration.

enableBestPractices: Si on doit activer ou non les règles de « meilleures pratiques ».

AxeSelenium : pour le chaînage de méthodes.

AxeSelenium ignoring(final String selector, final String ruleId)

Ignorer les violations pour un sélecteur et un identifiant de règle donné.

selector : Sélecteur produit par la suite logicielle axe DevTools Accessibility/Audit.

ruleId : ID de règle à ignorer pour le sélecteur donné.

Renvoie AxeSelenium pour le chaînage de méthodes.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Enregistrer les résultats du contrôle d’accessibilité une fois terminé.

reportingOptions : Options définissant la sérialisation et la persistance du contrôle d'accessibilité. Renvoie AxeSelenium pour le chaînage de méthodes.

boolean loggingConfigured()

Si la journalisation a été configurée ou non.

Renvoie si la journalisation a été configurée ou non.

com.deque.html.axedevtools.selenium.AxeDriver

Interagissez avec une page en utilisant AxeDriver.

Encapsule le pilote Web Selenium pour fournir des fonctionnalités spécifiques à axe-DevTools.

AxeDriver(final WebDriver webDriver)

Créez un AxeDriver à partir d'un Selenium WebDriver.

webDriver: Un Selenium WebDriver pour la page qui doit être vérifiée.

com.deque.html.axedevtools.selenium.AxeConfiguration

Configurez les propriétés du script axe telles que l'emplacement du fichier et la configuration. Classe singleton, utilisez AxeConfiguration.configure() pour accéder.

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

static AxeConfiguration configure()

Configurer une vérification d'accessibilité axe. La seule façon d'obtenir une AxeConfiguration instance.

Renvoie un objet de configuration pour configurer la suite d'audit globalement.

static void reset()

Réinitialise les préférences par défaut.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Fournir une suite d'audit par son URL.

auditConfigPath : l'URL associée à la suite d'audit.

Renvoie AxeConfiguration pour le chaînage de méthodes.

AxeConfiguration forAuditSuite(final String auditConfigPath) lance MalformedURLException

Fournir une suite d'audit par son emplacement sur le système de fichiers.

auditConfigPath : Le chemin d'accès absolu au fichier de la suite d'audit.

Renvoie AxeConfiguration pour le chaînage de méthodes.

Renvoie MalformedURLException si le chemin d'audit est un chemin de système de fichiers non valide.

AxeConfiguration withAxeScript(URL axeScript)

Fournissez un script de base axe à utiliser pour effectuer la vérification de l'accessibilité.

axeScript : L'URL associée au script axe Core à utiliser pour la vérification de l'accessibilité.

Renvoie AxeConfiguration pour le chaînage de méthodes.

AxeConfiguration forRuleset(final String rulesetId)

Choisissez le jeu de règles à exécuter

rulesetId: Un des :

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

Renvoie AxeConfiguration pour le chaînage de méthodes.

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Choisissez le jeu de règles à exécuter

rulesetId: Voir [ci-dessus] (#axeconfiguration-forrulesetfinal-string-rulesetid) pour les valeurs possibles.

enableBestPractices: Si on doit activer ou non les règles de « meilleures pratiques ».

Renvoie AxeConfiguration pour le chaînage de méthodes.

String getTestSuiteName()

Obtient le nom de la suite de tests.

Renvoie le nom de la suite de tests.

AxeConfiguration testSuiteName(final String testSuiteName)

Définit le nom de la suite de tests. Utilisé pour générer des rapports.

testSuiteName: Le nom de la suite de tests.

Renvoie AxeConfiguration pour le chaînage de méthodes.

String getOutputDirectory()

Obtient le répertoire de sortie du rapport.

Renvoie le chemin du répertoire de sortie.

AxeConfiguration outputDirectory(final String outputDirectory)

Définissez le répertoire dans lequel enregistrer les rapports.

outputDirectory : Le chemin vers le répertoire.

Renvoie AxeConfiguration pour le chaînage de méthodes.

String getUserAgent()

Obtient la valeur utilisée comme agent utilisateur.

Renvoie l'agent utilisateur utilisé dans la génération de rapport.

AxeConfiguration userAgent(final String userAgent)

Définit la valeur utilisée comme agent utilisateur lors de la génération d'un rapport. N'affecte pas l'agent utilisateur réel utilisé lors de l'exécution d'axe.

userAgent : La valeur de l'agent utilisateur.

Renvoie AxeConfiguration pour le chaînage de méthodes.

String getTestMachine()

Obtient le nom de la machine de test.

Renvoie le nom de la machine de test.

AxeConfiguration testMachine(final String testMachine)

Définit le nom de la machine de test. Utilisé dans la génération de rapports.

testMachine: Le nom de la machine de test.

Renvoie AxeConfiguration pour le chaînage de méthodes.

com.deque.html.axedevtools.selenium.results.IgnoredViolation

IgnoredViolation(final String cssSelector, final String ruleId)

Créez une violation à ignorer.

cssSelector : Sélecteur du nœud à ignorer. Effectue une comparaison avec la cible de chaque nœud.

ruleId : ID de la règle à ignorer

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions implémente ReportingOptions

Configure les options de rapportage. Prend les valeurs par défaut de AxeConfiguration.

AxeReportingOptions()

Crée un AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Obtient les options par défaut.

Renvoie l'objet d'options par défaut.

String getSuiteTestName()

Obtient le nom de la suite de tests configurée.

Renvoie le nom.

AxeReportingOptions testSuiteName(final String testSuiteName)

Décrit la suite de tests.

testSuiteName : Nom de la suite de tests.

Renvoie ReportingOptions pour le chaînage de méthodes.

String getUiState()

Obtient l'état de l'interface utilisateur configuré.

Renvoie l'état.

AxeReportingOptions uiState(final String uiState)

Décrit l’état de l’interface utilisateur lors de la vérification d’accessibilité.

uiState:État de l'interface utilisateur.

Renvoie ReportingOptions pour le chaînage de méthodes.

String getOutputDirectory()

Obtient le répertoire de sortie configuré.

Renvoie le répertoire.

AxeReportingOptions outputDirectory(final String outputDirectory)

Définissez le répertoire de sortie racine pour générer le rapport d'accessibilité.

outputDirectory: Chemin du répertoire.

Renvoie ReportingOptions pour le chaînage de méthodes.

String getFileName()

Nom de fichier calculé à partir des valeurs configurées.

Renvoie le nom du fichier

String getFilePath(final String extension)

Calcule le chemin du fichier à partir des valeurs configurées.

Renvoie le chemin.

String getUserAgent()

Obtient l'agent utilisateur configuré.

Renvoie l'agent utilisateur.

AxeReportingOptions userAgent(final String userAgent)

Décrivez l'agent utilisateur utilisé pour effectuer le test d'accessibilité.

userAgent : Nom de l'agent utilisateur.

Renvoie ReportingOptions pour le chaînage de méthodes.

String getTestMachine()

Récupère la machine de test configurée.

Renvoie la machine de test.

AxeReportingOptions testMachine(final String testMachine)

Décrivez la machine utilisée pour effectuer le test d’accessibilité.

testMachine : Nom de la machine.

Renvoie ReportingOptions pour le chaînage de méthodes.

AxeReportingOptions lineNum(final String lineNum)

Spécifiez le numéro de ligne du test en cours.

lineNum : Numéro de ligne du test en cours.

Renvoie ReportingOptions pour le chaînage de méthodes.

ReportingOptions lineNumIfEmpty(final String lineNum)

Spécifiez le numéro de ligne, s'il n'a pas déjà été défini.

lineNum : Numéro de ligne du test en cours.

Renvoie ReportingOptions pour le chaînage de méthodes.

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

Exception lorsque l’état de l’interface utilisateur est manquant.

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

Définit les violations à ignorer.

ResultsFilter filter = new ResultsFilter()
    .ignoring(".third-party-iframe", "label");
Results results = new AxeSelenium(axe, configuration, filter, reporter)
    .run(driver);

Results filterIgnoredViolations(final Results results)

Filtrez les résultats pour supprimer les violations ignorées.

results : résultats à filtrer.

Renvoie les résultats entrants, filtrés pour les sélecteurs CSS ignorés + les identifiants de règle.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Ajouter une violation ignorée.

cssSelector : Sélecteur CSS produit en exécutant la suite Accessibility/Audit.

ruleId : ID de règle produit par l'exécution de la suite Accessibilité/Audit.

Renvoie ResultsFilter pour le chaînage de méthodes.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configurez les options de rapport lors de l'utilisation des Matchers Hamcrest.

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));

AxeDevtoolsReporter()

Construisez un AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Créer une représentation sous forme de chaîne de la vérification d’accessibilité.

results : Résultats du contrôle d'audit.

executedCommand : Commande exécutée pour produire des résultats d'audit.

Renvoie un rapport compréhensible des violations d'accessibilité détectées.

void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)

Rapport sur le contrôle d'accessibilité. Ajouter par date le rapport au fichier journal des résultats. Stocker les résultats complets sous forme de fichier JSON.

reportingOptions : Options de journalisation du rapport.

results : Résultats du contrôle d'audit.

executedCommand : Commande exécutée pour produire des résultats d'audit.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Génère un TestResults à partir d'un Results et ReportingOptions. Utilisé avec le AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Génère le {@link TestResults}.

reportingOptions: Options à partir desquelles nous créons nos résultats.

results: Résultats de l'exécution de axe DevTools.

Renvoie le test

com.deque.html.axedevtools.reporter.ViolationsReporter

Signale uniquement les violations.

com.deque.html.axedevtools.utils.FileUtils

Utilitaires de fichiers à usage interne.