Een scan uitvoeren

Klaar, start, scan

Zodra je de AxeDevTools-bibliotheek hebt geïmporteerd en geïnitialiseerd, ben je klaar om te scannen. Voer een scan uit binnen je tests door axe.scan() aan te roepen.

Voorbeeldscan

Wanneer je klaar bent om een scan vanuit je tests uit te voeren, roep je axe.scan() aan. In het onderstaande voorbeeld zie je hoe je de ScanResultHandler gebruikt om resultaten naar Axe Developer Hub te uploaden, tests te passeren of te laten falen, en resultaten lokaal op te slaan om te delen met je team en voor rapportage. Deze functie wordt verderop onder de codefragment uiteengezet.

private fun a11yScan() {

    val scanResultHandler = axe.scan()

    //1. Upload it to both Developer Hub and the Mobile Dashboard
    scanResultHandler?.uploadToDashboard()

    //2. Use the results in your test suite
    val result: AxeResult? = scanResultHandler?.getSerializedResult()
    result?.axeRuleResults?.forEach { result ->
        if(result.status == AxeStatus.PASS) {
            ...
        }
        else if(result.status == AxeStatus.FAIL) {
            ...
        }
        else if(result.status == AxeStatus.INCOMPLETE) {
            ...
        }
    }

    //3. Save the result JSON to a local file for later use
    scanResultHandler?.saveResultToLocalStorage("your_file_prefix")
}

Uiteenzetting:

1. Vanuit de resultatenhandler roep je uploadToDashboard() aan om de laatste scan naar Axe Developer Hub te sturen. De scan wordt gepubliceerd vanuit het geauthenticeerde account dat in de init functie is gebruikt.
2. Vanuit de resultatenhandler roep je getSerializedResult() aan om lokaal toegang te krijgen tot de resultaten van de bibliotheek. Je kunt er bijvoorbeeld voor kiezen om de test te laten falen wanneer er fouten worden gevonden in de toegankelijkheidsscanresultaten. Dit zal je resultaten niet uploaden naar de server. Het is niet vereist om je resultaten te uploaden om ze lokaal te kunnen downloaden.
3. Vanuit de resultatenhandler roep je saveResultToLocalStorage() aan om de resultaten als JSON op te slaan in een lokaal bestand op je testapparaat. Raadpleeg de documentatie voor Resultaten Lokaal Opslaan om toegang te krijgen tot het opgeslagen bestand.

De-initialiseren

Zodra de test is voltooid, roep je tearDown() aan op het AxeDevTools-object dat je hebt gemaakt om de staat van vorige tests te wissen. We raden aan om dit in de @After geannoteerde functie van je testbestand te plaatsen, maar het kan ook binnen een test worden aangeroepen indien nodig.

@After
fun tearDown() {
    axe.tearDown()
}

Wat is de volgende stap?

Lees meer over scanuitslagen uploaden naar Axe Developer Hub en je resultaten lokaal opslaan.