Référence API pour Selenium

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

com.deque.html.axedevtools.selenium.AxeSelenium

Configure comment axe est utilisé et exécute axe réellement.

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

AxeSelenium()

Créez un nouveau contrôle d'accessibilité AxeSelenium pour un AxeDriver.

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

Créez un nouveau contrôle d'accessibilité AxeSelenium pour un AxeDriver.

Résultats run(final AxeDriver page)

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

page : AxeDevTools Driver représentant la page sur laquelle effectuer un contrôle 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 l'enchaînement des méthodes.

AxeSelenium include(final List<String> selector)

Inclure un sélecteur d'iFrame.

selector : Une liste de sélecteurs d'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 à l'intérieur du cadre le plus profond pour le contrôle.

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

AxeSelenium exclude(final String cssSelector)

Exclure un sélecteur.

cssSelector : Tout sélecteur CSS valide. Renvoie AxeSelenium pour l'enchaînement des méthodes.

AxeSelenium exclude(final List<String> selector)

Exclure un sélecteur.

selector : Une liste de sélecteurs d'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 à l'intérieur du cadre le plus profond pour le contrôle.

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

AxeSelenium accordingTo(final String... tags)

Selon les tags d'accessibilité. Vérifiez uniquement les tags d'accessibilité spécifiés. Cette option est incompatible avec AxeSelenium::checkingOnly Voir Descriptions des Règles.

tags : Liste des tags pour le contrôle.

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

AxeSelenium checkingOnly(final String... rules)

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

rules : Liste des règles pour le contrôle.

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

AxeSelenium checking(final String... rules)

Vérification des règles d'accessibilité. En plus des tags donnés, vérifiez également certaines règles. Voir Descriptions des Règles.

rules : Liste des règles pour le contrôle.

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

AxeSelenium skipping(final String... rules)

Ignore des règles d'accessibilité. À partir des tags donnés, ignorez la vérification de certaines règles. Voir Descriptions des Règles.

rules : Liste des règles pour le contrôle.

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

AxeSelenium forConfig(final URL auditConfigPath)

Fournir une suite d'audit par son URL.

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

Retourne AxeSelenium pour l'enchaînement des 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 absolu du fichier de la suite d'audit.

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

Lance MalformedURLException si le chemin d'audit est un chemin de système de fichiers invalide.

AxeSelenium forRuleset(final String rulesetId)

Spécifiez un ensemble de règles pour la vérification de l'accessibilité. Configurer 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.

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

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Spécifiez un ensemble de règles pour la vérification de l'accessibilité. Configurer 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 oui ou non activer les règles "bonnes pratiques".

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

AxeSelenium ignoring(final String selector, final String ruleId)

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

selector : Sélecteur produit par Axe DevTools Accessibility/Audit suite.

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

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

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Enregistrez les résultats de la vérification de l'accessibilité une fois terminée.

reportingOptions : Options définissant la sérialisation et la persistance de la vérification de l'accessibilité. Retourne AxeSelenium pour l'enchaînement des méthodes.

boolean loggingConfigured()

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

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

com.deque.html.axedevtools.selenium.AxeDriver

Interagissez avec une page à l'aide de AxeDriver.

Enveloppe le driver 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()

Configurez une vérification de l'accessibilité axe. Le seul moyen d'obtenir une instance de AxeConfiguration.

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

static void reset()

Réinitialise aux 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.

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

AxeConfiguration forAuditSuite(final String auditConfigPath) throws MalformedURLException

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

auditConfigPath : Le chemin absolu du fichier de la suite d'audit.

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

Lance une MalformedURLException si le chemin d'audit est un chemin de système de fichiers invalide.

AxeConfiguration withAxeScript(URL axeScript)

Fournit un script axe core à utiliser pour réaliser la vérification d'accessibilité.

axeScript : L'URL associée au script axe core à utiliser pour la vérification d'accessibilité.

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

AxeConfiguration forRuleset(final String rulesetId)

Choisissez quel ensemble de règles exécuter

rulesetId : L'un des suivants :

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

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

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Choisissez quel ensemble de règles exécuter

rulesetId : Voir ci-dessus pour les valeurs possibles.

enableBestPractices : Activer ou non les règles de "meilleures pratiques".

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

String getTestSuiteName()

Obtient le nom de la suite de tests.

Retourne 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 l'enchaînement des méthodes.

String getOutputDirectory()

Obtient le répertoire de sortie des rapports.

Retourne le chemin du répertoire de sortie.

AxeConfiguration outputDirectory(final String outputDirectory)

Définir le répertoire pour enregistrer les rapports.

outputDirectory : Le chemin vers le répertoire.

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

String getUserAgent()

Obtient la valeur utilisée comme agent utilisateur.

Retourne l'agent utilisateur utilisé dans la génération des rapports.

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 l'enchaînement des 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 l'enchaînement de méthodes.

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

IgnoredViolation(final String cssSelector, final String ruleId)

Créer une violation à ignorer.

cssSelector : Sélecteur du nœud à ignorer. Compare 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 rapport. 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 des 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 l'enchaînement de méthodes.

String getUiState()

Obtient l'état de l'UI configuré.

Renvoie l'état.

AxeReportingOptions uiState(final String uiState)

Décrit l'état de l'UI lors de la vérification d'accessibilité.

uiState : État de l'UI.

Renvoie ReportingOptions pour l'enchaînement de méthodes.

String getOutputDirectory()

Obtient le répertoire de sortie configuré.

Renvoie le répertoire.

AxeReportingOptions outputDirectory(final String outputDirectory)

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

outputDirectory : Chemin du répertoire.

Renvoie ReportingOptions pour l'enchaînement de méthodes.

String getFileName()

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

Renvoie le nom de 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 réaliser le test d'accessibilité.

userAgent: Nom de l'agent utilisateur.

Renvoie ReportingOptions pour l'enchaînement des méthodes.

String getTestMachine()

Obtient la machine de test configurée.

Renvoie la machine de test.

AxeReportingOptions testMachine(final String testMachine)

Décrivez la machine utilisée pour réaliser le test d'accessibilité.

testMachine: Nom de la machine.

Renvoie ReportingOptions pour l'enchaînement des 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 l'enchaînement des méthodes.

ReportingOptions lineNumIfEmpty(final String lineNum)

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

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

Renvoie ReportingOptions pour l'enchaînement des méthodes.

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

Exception pour quand 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)

Filtrer 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 et IDs de règle ignorés.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Ajoutez une violation ignorée.

cssSelector: Sélecteur CSS produit par l'exécution de la suite d'Accessibilité/Audit.

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

Renvoie ResultsFilter pour l'enchaînement des 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éez une représentation sous forme de chaîne du contrôle d'accessibilité.

results: Résultats de la vérification d'audit.

executedCommand: Commande exécutée pour produire les résultats de l'audit.

Renvoie un rapport lisible des violations d'accessibilité trouvées.

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

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

reportingOptions: Options pour l'enregistrement du rapport.

results: Résultats de la vérification d'audit.

executedCommand: Commande exécutée pour produire les résultats de l'audit.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Génère un TestResults à partir d'un Results et d'un 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.

Renvoie le test

com.deque.html.axedevtools.reporter.ViolationsReporter

Rapporte uniquement les violations.

com.deque.html.axedevtools.utils.FileUtils

Utilitaires de fichiers à usage interne.