Executar uma Verificação

Preparar, apontar, verificar

Depois de importar e inicializar a biblioteca AxeDevTools, você está pronto para escanear. Execute uma verificação dentro de seus testes chamando axe.scan().

Exemplo de verificação

Quando estiver pronto para executar uma verificação dentro de seus testes, chame axe.scan(). No exemplo abaixo, você verá como usar o ScanResultHandler para enviar resultados para o Axe Developer Hub, aprovar ou reprovar testes e salvar resultados localmente para compartilhar com sua equipe e relatar. Esta função é detalhada mais adiante abaixo do trecho de código.

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

Detalhamento:

1. A partir do manipulador de resultados, chame uploadToDashboard() para enviar a verificação mais recente para o Axe Developer Hub. A verificação será publicada a partir da conta autenticada usada na função init.
2. A partir do manipulador de resultados, chame getSerializedResult() para acessar os resultados da biblioteca localmente. Por exemplo, você pode optar por reprovar o teste quando falhas forem encontradas nos resultados da verificação de acessibilidade. Isso não enviará seus resultados para o servidor. Carregar seus resultados não é necessário para baixá-los localmente.
3. A partir do manipulador de resultados, chame saveResultToLocalStorage() para salvar os resultados como JSON em um arquivo local no seu dispositivo de teste. Para acessar o arquivo salvo, consulte a documentação para Salvando Resultados Localmente.

Desinicializar

Depois que o teste for concluído, chame tearDown() no objeto AxeDevTools que você criou para limpar o estado dos testes anteriores. Recomendamos colocar isso na função anotada @After do seu arquivo de testes, mas também pode ser chamado dentro de um teste se necessário.

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

O que vem a seguir?

Saiba mais sobre enviar resultados de verificação para o Axe Developer Hub e salvar seus resultados localmente.