Cucumber-tests schrijven

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

Toegankelijkheidstests schrijven met Cucumber en Axe DevTools voor Web voor Java

Not for use with personal data

Vereisten

Om toegankelijkheidstests te schrijven en resultaten te produceren, moet je al een testbestand met Axe DevTools hebben aangemaakt en je keuze van Selenium WebDriver vooraf geïmporteerd en geïnitialiseerd. Als je dit nog niet hebt gedaan, lees deze handleiding voor instructies.

Configuratie

Voeg eerst Axe DevTools toe aan je configuratie

public class AppConfiguration {

    @Bean
    public static AxeWorld axeWorld() {
        return new AxeWorld();
    }
}

Voeg nu de vereiste stappen toe voor het gebruik van Axe DevTools

public class StepDefinitions {

    private AxeWorld axeWorld;

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

    private WebDriver webDriver;

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

    @After
    public void tearDown() throws Exception {
        webDriver.quit();
    }

    @When("^I visit \"([^\"]*)\"$")
    public void iVisit(String url) throws Throwable {
        webDriver.get(url);

    }
}

Tests schrijven

Voordat je een pagina kunt testen, moet je er toegang toe hebben. De eerste stap is om Selenium WebDriver te initiëren en een pagina te openen

WebDriver webDriver = new ChromeDriver();
webDriver.get("'https://broken-workshop.dequelabs.com'");

Vervolgens kun je een Axe DevTools-scan driver object maken en de WebDriver doorgeven

AxeDriver axeDriver = new AxeDriver(webDriver);

Voeg tenslotte de axeDriver toe aan je stapsdefinities

// Inject AxeWorld into your step definitions.
public StepDefinitions(AxeWorld axeWorld) {
  this.axeWorld = axeWorld;
}
// Provide the page to the Axe World
axeWorld.setPage(new axeDriver(webDriver));

Je kunt dan de pagina testen op toegankelijkheid. Op dit moment ondersteunt Axe DevTools Pico en Spring testing via Cucumber.

Gebruik

Toegankelijkheid Cucumber-stappen

De voorbeeldtoegankelijkheidscontroles hieronder gebruiken Then the page should be axe clean, maar alle controles werken verwisselbaar met Then the page should be audited for accessibility. Het verschil tussen deze twee is of de test faalt bij toegankelijkheidsschendingen met Then the page should be axe clean, tegenover niet falen met Then the page should be audited for accessibility.

Om een axe toegankelijkheid Cucumber stap te construeren, begin met de basisstap en voeg eventuele nodige clausules toe. Alle volgende clausules kunnen gecombineerd en afgestemd worden; ze moeten echter verschijnen in de aangegeven volgorde:

Then the page should be axe clean [including] [excluding] [according-to] [checking-rules/checking-only-rules] [skipping-rules]

Basisstap

De basistap is het kernonderdeel van de Cucumber-stap. Het is op zichzelf een complete stap en controleert de toegankelijkheid van de momenteel geladen pagina. De audited for accessibility stap logt toegankelijkheidsproblemen naar target/axe-report/accessibility-check.log en schrijft JSON-uitvoer van de resultaten naar target/axe-report/accessibility-check.json (gebruik AxeWorld.setReportingOptions om dat te veranderen). De axe clean stap schrijft geen rapport; deze faalt de test en vermeldt de overtredingen in het foutbericht.

Then the page should be axe clean
This step will cause test suite failures if accessibility violations are found
Then the page should be audited for accessibility
This step will require handling of violations outside of test suite failures, as this step does not trigger the suite to fail if violations are found.

Afbakening

Axe DevTools maakt het mogelijk om toegankelijkheidsscans op een inclusieve en exclusieve manier af te bakenen. Bovendien kunnen deze afbakeningen binnen elkaar werken om complexe enclaves en exclaves van afbakening te creëren. Deze afbakeningen werken op basis van CSS-selectors.

Insluitingsclausule

De inclusieclausule within "#selector" specificeert welke elementen op de pagina gecontroleerd moeten worden. Alleen elementen binnen de geselecteerde scope worden gescand. De inclusieclausule moet een geldige CSS-selector bevatten, omgeven door dubbele aanhalingstekens. Een komma in de clausule scheidt geen lijst van selectoren: het scheidt de stappen van een pad binnen een iframe, dus within "#checkout-frame, form" controleert de form binnen het #checkout-frame iframe. Een stap kan slechts één inclusieclausule hebben, dus om meerdere niet-verwante gebieden te controleren, gebruik een selector die een element omvat dat ze allemaal bevat, of schrijf een aparte stap voor elk gebied.

Then the page should be axe clean within "#selector"

Uitsluitingsclausule

De exclusieclausule excluding "#selector" specificeert welke elementen genegeerd moeten worden. Geen elementen binnen de geselecteerde scope worden gescand. De exclusieclausule moet een geldige CSS-selector bevatten, omgeven door dubbele aanhalingstekens. Net als bij de inclusieclausule, scheidt een komma de stappen van een pad binnen een iframe, dus excluding "#ad-frame, .banner" slaat het .banner element binnen het #ad-frame iframe over. Om verschillende niet-verwante gebieden over te slaan, gebruik een selector die ze allemaal omvat zonder een komma, zoals een gedeelde klasse.

Then the page should be axe clean excluding "#selector"

Insluiten en uitsluiten combineren

Om insluitings- en uitsluitingsclausules te combineren, gebruik de puntkomma (;) of het woord maar om ze te scheiden.

Then the page should be axe clean within "main"; excluding "aside"
Then the page should be axe clean within "main" but excluding "aside"

Configuratie van regels

Er zijn een paar manieren om je standaardregelconfiguratie te veranderen met behulp van de Cucumber API. Je kunt regels selecteren op basis van groepen door gebruik te maken van tags, of regels individueel selecteren op basis van hun regel-ID.

Regeltagclausule

De tag-clausule specificeert welke toegankelijkheidsstandaard (of standaarden) gebruikt moeten worden in de paginacontrole. Specificeer de toegankelijkheidsstandaarden bij naam (tag). Meerdere standaarden kunnen worden gespecificeerd wanneer gescheiden door komma's. Bijv. according to: wcag2a, section508

Alle tagnamen zijn gedocumenteerd naast een volledige lijst met regelbeschrijvingen die overeenkomen met elke tag.

Then the page should be axe clean according to: best-practice

Bepaalde regels extra controleren clausule

Deze clausule stelt je in staat om extra regels toe te voegen aan je bestaande regels. Je kunt een enkele regel specificeren via regel-ID, of een lijst van regels gescheiden door komma's. Zie de regelsdocumentatie voor een lijst van de regels en hun regel-ID's. Gebruik een puntkomma (;) of het woord and om de controleer-regelsclausule van eventuele voorafgaande clausule(s) te scheiden.

Then the page should be axe clean checking: color-contrast
Then the page should be axe clean according to: wcag2a; checking: color-contrast
Then the page should be axe clean according to: wcag2a and checking: color-contrast

Alleen gespecificeerde regels controleren clausule

Door het toevoegen van het woord only aan de controleer-regelsclausule, kun je de betekenis van de stap veranderen. Zoals eerder beschreven, specificeert de controleer-regelsclausule extra regels die moeten worden uitgevoerd. Alleen gespecificeerde regels worden gecontroleerd als het woord only wordt gebruikt. Zie de regelsdocumentatie voor een lijst van de regels en hun regel-ID's. Gebruik een puntkomma (;) of het woord and om de controleer-regelsclausule van eventuele voorafgaande clausule(s) te scheiden.

Then the page should be axe clean checking only: color-contrast

De alleen-controle-clausule en de tag-clausule stellen dezelfde optie in, dus wanneer een stap beide heeft, worden alleen de regels in de alleen-controle-clausule uitgevoerd.

Regels overslaan clausule

De overslaan-regels-clausule specificeert welke regels uit de bestaande regelconfiguratie overgeslagen moeten worden. Regels die moeten worden overgeslagen worden gespecificeerd door komma-gescheiden regel-ID's. Bekijk de regelsdocumentatie voor een lijst van de regels en hun regel-ID's. Gebruik een puntkomma (;) of het woord but om de overslaan-regels-clausule te scheiden van eventuele voorgaande clausule(s).

Combineer de overslaan-regels-clausule niet met een controle-regels-clausule in dezelfde stap. Beide stellen dezelfde optie in en de controle regels worden als laatste toegepast, dus de regels die je opgeeft om over te slaan, worden niet overgeslagen.

Then the page should be axe clean skipping: color-contrast
Then the page should be axe clean according to: wcag2a; skipping: color-contrast
Then the page should be axe clean according to: wcag2a but skipping: color-contrast

Regelsetselectieclausule

Toegankelijke getagde regelsets in de axeDriver via een Cucumber-clausule. Deze functionaliteit stelt je in staat om een regelset (bijv. 508, wcag2, wcag2.1) te specificeren om de toegankelijkheid van de pagina te controleren.

Then the page should be axe clean according to ruleset: wcag2.1

Gebruik Service

Krijg inzicht in de gebruikstrends van Axe DevTools binnen je organisatie

Standaard is de gebruiksdienst ingeschakeld en de standaard URL is https://usage.deque.com. Stel de omgevingsvariabele AXE_TRACK_USAGE in op false om deze uit te schakelen. Als je gebruiksgebeurtenissen Deque niet bereiken, stel dan de omgevingsvariabele AXE_METRICS_URL expliciet in.

Omgevingsvariabelen

Met deze omgevingsvariabelen kunt u de verbruiksdienst configureren en de eigenschappen van gerapporteerde gebeurtenissen wijzigen.

Naam Type Kan Override Beschrijving
AXE_DISTINCT_ID String — Een UUID-identificator die hetzelfde blijft voor de ingelogde gebruiker (tenzij deze wordt opnieuw gegenereerd). In Ruby is deze variabele genoemd DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Boolean — Stel in op true om de volledige axe-core-resultaten op te nemen in het testResults-object van elk evenement (standaard is false). Wordt alleen ondersteund door de CLI en de Node.js API's.
AXE_METRICS_URL String — De URL van het REST-gebruikendpunt (standaard is https://usage.deque.com)
AXE_TRACK_USAGE Boolean — Stel in op false om rapportage van de gebruiksdienst uit te schakelen. Rapportage is standaard ingeschakeld.
AXE_ACTOR String — Stel in op human of automation om te bepalen of gebeurtenissen een persoon of een geautomatiseerde pipeline registreren als uitvoerenden van de tests. Standaard wordt automation gedetecteerd vanuit algemene CI-omgevingsvariabelen. Ondersteund door de CLI, de Node.js API's en alleen de Ruby API.
AXE_APPLICATION String false De applicatie die werd gebruikt om toegankelijkheidsfouten te controleren
AXE_DEV_INSTANCE Boolean true Geeft aan of dit evenement afkomstig is van acties van een softwareontwikkelaar. Nuttig voor het markeren en later verwijderen van evenementen die tijdens ontwikkeling of testen zijn geregistreerd.
AXE_DEPARTMENT String true De afdeling van de gebruiker binnen de organisatie
AXE_KEYCLOAK_ID String false De Keycloak-ID van de gebruiker
AXE_LOGGED_IN Boolean false Registreert of de gebruiker is ingelogd op de toepassing onder test
AXE_ORGANIZATION String true De organisatie van de gebruiker. Om uw gebruik in Axe Reports weer te geven, stel dit in op de ID van uw organisatie (neem contact op met Deque om deze te verkrijgen).
AXE_SESSION_ID String false Een UUID die de sessie van de gebruiker identificeert
AXE_TEAMS String false De teams die de tests uitvoeren, als een JSON-array van { "id": "...", "name": "..." } objecten of het pad naar een JSON-bestand dat er een bevat. Een waarde doorgegeven aan de --set-teams optie van de CLI, een setTeams methode van de Node.js API, of de for_teams clausule of teams configuratie-eigenschap van de Ruby API heeft voorrang. Alleen ondersteund door de CLI, de Node.js API's en de Ruby API.
AXE_USER_ID String false De identiteit van een specifieke gebruiker, zoals een e-mailadres, naam of inlog-ID. Axe Reports telt unieke gebruikers op basis van deze waarde.
AXE_USER_JOB_ROLE String false De functie van de gebruiker
AXE_USER_STATUS String false Statusinformatie die u aan de gebruiker wilt koppelen

Volgende stappen

Voor verder gebruik van uw Axe DevTools-scanresultaten, zoals rapportage, raadpleeg de Axe DevTools Java Selenium pakket documentatie

Probleemoplossing

Als u problemen ondervindt bij het opzetten van uw toegankelijkheidstests, neem dan direct contact op met uw Deque-vertegenwoordiger, bereik ons via onze supportdesk, of stuur ons een e-mail. We helpen u graag op weg met uw inspanningen voor toegankelijkheidstesten.