Een scan uitvoeren

Klaar, start, scan

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

Voorbeeldscan

Als je klaar bent om een scan uit te voeren binnen je tests, roep dan aan axe.scan(). In het onderstaande voorbeeld zie je hoe je de ScanResultHandler kunt gebruiken om resultaten te uploaden naar axe Developer Hub, tests te laten slagen of falen en resultaten lokaal op te slaan om te delen met je team en te rapporteren. Deze functie wordt verderop in de snippet 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 resultaatverwerker, roep aan uploadToDashboard() om de nieuwste scan te verzenden naar axe Developer Hub. De scan wordt gepubliceerd vanuit het geauthenticeerde account dat wordt gebruikt in de init functie.
2. Vanuit de resultaatverwerker, roep aan getSerializedResult() om de resultaten van de bibliotheek lokaal te benaderen. Je kunt er bijvoorbeeld voor kiezen om de test te laten falen wanneer in de toegankelijkheidsscan resultaten worden gevonden. 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 resultaatverwerker, roep aan saveResultToLocalStorage() om de resultaten als JSON op te slaan in een lokaal bestand op je testapparaat. Raadpleeg de documentatie voor Resultaten Lokaal Opslaanom toegang te krijgen tot het opgeslagen bestand.

De-initialiseren

Zodra de test is voltooid, roep aan tearDown() op het AxeDevTools object dat je hebt aangemaakt om de status 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 scanresultaten uploaden naar axe Developer Hub en je resultaten lokaal opslaan.