Référence API pour Cucumber

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 la classe AxeWorld dans Axe DevTools pour Web Java

Not for use with personal data

Ce document est une référence pour la classe AxeWorld dans le package com.deque.html.axedevtools.cucumber. Contrairement aux packages Selenium et Hamcrest, le package Cucumber n’a pas de classe builder ou matcher pour la configuration des portées et des règles. Ces options sont plutôt exprimées directement dans le texte des étapes Gherkin, comme décrit dans Écrire des tests Cucumber. La classe AxeWorld ne contient que l'état et la configuration que les étapes Gherkin ne peuvent pas exprimer, tels que la page à vérifier, les paramètres d'analyse, les options de rapport personnalisé et le délai d'attente de axe-core.

com.deque.html.axedevtools.cucumber.AxeWorld

Contient la page et la configuration utilisées par le Étapes d'accessibilité Cucumber lors de la vérification de l'accessibilité. Votre cadre d'injection de dépendances crée le AxeWorld (PicoContainer, par exemple, en crée un par scénario) et le transmet à la fois à vos définitions d'étapes et aux étapes Axe DevTools, donc tout ce que vous définissez sur lui dans un hook @Before ou une étape précédente s'applique aux étapes d'accessibilité dans le même scénario.

Les paramètres sont lus chaque fois qu'une étape d'accessibilité s'exécute. Rien n'est vérifié ou envoyé lorsque vous appelez les setters.

public StepDefinitions(AxeWorld axeWorld) {
    this.axeWorld = axeWorld;
}

@Before
public void setup() {
    webDriver = new ChromeDriver();
    axeWorld.setPage(new AxeDriver(webDriver));
}

AxeWorld()

Crée un AxeWorld sans page et sans configuration. Vous ne l’appelez normalement pas vous-même : déclarez un paramètre AxeWorld dans le constructeur de votre classe de définitions d'étapes, et votre cadre d'injection de dépendances créée et partage l'instance.

public AxeWorld();

getPage()

Renvoie la page que les étapes d'accessibilité vérifient, ou null si setPage n'a pas été appelé.

public AxeDriver getPage();

Renvoie

Le AxeDriver défini sur ce monde.

setPage(AxeDriver)

Définit la page que les étapes d'accessibilité vérifient. Appelez-le avant que toute étape d'accessibilité ne s'exécute, généralement dans un hook @Before. Les étapes vérifient quelle que soit la page que le WebDriver enveloppé affiche lorsque l'étape s'exécute, donc naviguez avec votre WebDriver dans les étapes précédentes comme d'habitude.

public void setPage(AxeDriver page);

Paramètres

Nom Type Description
page AxeDriver La page à vérifier, enveloppant votre Selenium WebDriver.

Exemple

@Before
public void setup() {
    webDriver = new ChromeDriver();
    axeWorld.setPage(new AxeDriver(webDriver));
}

enableAnalytics(boolean)

Active ou désactive le service d'utilisation pour les étapes d'accessibilité. Lorsque vous ne l'appelez pas, le service d'utilisation est activé. Lorsque la variable d'environnement AXE_TRACK_USAGE est définie, elle prévaut et cette méthode n'a aucun effet : true active le service et toute autre valeur le désactive.

public void enableAnalytics(boolean state);

Paramètres

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

Exemple

@Before
public void setup() {
    axeWorld.enableAnalytics(false);
}

setAnalyticsUrl(String)

Définit l'URL à 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 quand elle n'est pas définie. Lorsque AXE_METRICS_URL est définie, cette méthode n'a aucun effet.

public void setAnalyticsUrl(String url);

Paramètres

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

Exemple

axeWorld.setAnalyticsUrl("https://usage.example.com");

setAnalyticsDistinctId(String)

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

public void setAnalyticsDistinctId(String did);

Paramètres

Nom Type Description
did String L'identifiant distinct.

Exemple

axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));

setAnalyticsComponentName(String)

Définit le nom du projet envoyé avec les données d'utilisation.

Les étapes d'accessibilité appliquent le nom du composant après les autres paramètres d’analyse, et le définir réinitialise l'URL et la valeur de enableAnalytics à leurs valeurs par défaut. Ainsi, lorsque vous définissez un nom de composant, toute valeur de setAnalyticsUrl ou de enableAnalytics sur le même AxeWorld n'a aucun effet. Une valeur setAnalyticsDistinctId est conservée, car l'identifiant distinct est enregistré dans un fichier.

public void setAnalyticsComponentName(String name);

Paramètres

Nom Type Description
name String Le nom du projet.

Exemple

axeWorld.setAnalyticsComponentName("storefront-features");

setReportingOptions(AxeReportingOptions)

Définit où l'étape Then the page should be audited for accessibility écrit son rapport, et comment elle décrit le test. Sans cela, cette étape écrit vers target/axe-report/accessibility-check.log et .json. Voir AxeReportingOptions pour les options. Les options que vous passez remplacent entièrement les valeurs par défaut : toute valeur que vous ne définissez pas revient à AxeConfiguration (les rapports vont à axe-reports à moins que vous ne définissiez outputDirectory), et vous devez définir uiState.

Cela n'a aucun effet sur l'étape Then the page should be axe clean, qui n'écrit pas de rapport.

public void setReportingOptions(AxeReportingOptions reportingOptions);

Paramètres

Nom Type Description
reportingOptions AxeReportingOptions Les options de rapport à utiliser.

Exemple

@Before
public void setup(Scenario scenario) {
    axeWorld.setReportingOptions(new AxeReportingOptions()
        .outputDirectory("target/axe-report")
        .testSuiteName("checkout")
        .uiState(scenario.getName().replaceAll("\\W+", "-")));
}

setTimeout(int)

Définit la durée, en secondes, pendant laquelle axe-core peut analyser la page avant que l'étape ne se termine par un délai d'attente. La valeur par défaut est de 30 secondes. Augmentez-la pour les pages très volumineuses.

public void setTimeout(int timeout);

Paramètres

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

Exemple

axeWorld.setTimeout(120);