Esegui una scansione

Pronti, partenza, scansione

Una volta che hai importato e inizializzato la libreria AxeDevTools, sei pronto per eseguire la scansione. Esegui una scansione all'interno dei tuoi test chiamando axe.scan().

Scansione di esempio

Quando sei pronto per eseguire una scansione all'interno dei tuoi test, chiama axe.scan(). Nell'esempio qui sotto, vedrai come utilizzare ScanResultHandler per caricare i risultati su Axe Developer Hub, superare o fallire i test e salvare i risultati localmente per condividerli con il tuo team e per il reporting. Questa funzione è ulteriormente suddivisa sotto al frammento.

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")
}

Dettaglio:

1. Dal gestore dei risultati, chiama uploadToDashboard() per inviare l'ultima scansione a Axe Developer Hub. La scansione sarà pubblicata dall'account autenticato utilizzato nella funzione init.
2. Dal gestore dei risultati, chiama getSerializedResult() per accedere ai risultati della libreria localmente. Ad esempio, potresti scegliere di far fallire il test quando vengono trovati errori nei risultati della scansione di accessibilità. Questo non caricherà i tuoi risultati sul server. Caricare i tuoi risultati non è necessario per scaricarli localmente.
3. Dal gestore dei risultati, chiama saveResultToLocalStorage() per salvare i risultati come JSON in un file locale sul tuo dispositivo di test. Per accedere al file salvato, fai riferimento alla documentazione per Salvare i risultati localmente.

Deinizializza

Una volta completato il test, chiama tearDown() sull'oggetto AxeDevTools che hai creato per cancellare lo stato dei test precedenti. Consigliamo di inserire questo nella funzione annotata del tuo file di test @After, ma può anche essere chiamato all'interno di un test se necessario.

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

E adesso?

Scopri di più su caricare i risultati della scansione su Axe Developer Hub e salvare i risultati localmente.