Ejecutar un escaneo

Preparados, listos, escanear

Una vez que hayas importado e inicializado la biblioteca AxeDevTools, estás listo para escanear. Ejecuta un escaneo desde tus pruebas llamando a axe.scan().

Escaneo de muestra

Cuando estés listo para ejecutar un escaneo desde tus pruebas, llama a axe.scan(). En el siguiente ejemplo, verás cómo usar ScanResultHandler para subir resultados a Axe Developer Hub, aprobar o reprobar pruebas, y guardar resultados localmente para compartir con tu equipo e informar. Esta función se desglosa más adelante debajo del fragmento.

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

Desglose:

1. Desde el controlador de resultados, llama a uploadToDashboard() para enviar el escaneo más reciente a Axe Developer Hub. El escaneo se publicará desde la cuenta autenticada utilizada en la función init.
2. Desde el controlador de resultados, llama a getSerializedResult() para acceder a los resultados de la biblioteca localmente. Por ejemplo, puedes decidir reprobar la prueba cuando se encuentren fallos en los resultados del escaneo de accesibilidad. Esto no subirá tus resultados al servidor. No es necesario subir tus resultados para descargarlos localmente.
3. Desde el controlador de resultados, llama a saveResultToLocalStorage() para guardar los resultados como JSON en un archivo local en tu dispositivo de prueba. Para acceder al archivo guardado, consulta la documentación de Guardando Resultados Localmente.

Desinicializar

Una vez que la prueba se haya completado, llama a tearDown() sobre el objeto AxeDevTools que has creado para limpiar el estado de pruebas anteriores. Recomendamos poner esto en la función anotada de tu archivo de pruebas @After, pero también se puede llamar dentro de una prueba si es necesario.

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

¿Qué sigue?

Aprende más sobre subir los resultados del escaneo a Axe Developer Hub y guardar tus resultados localmente.