Effectuer une analyse

Prêt, partez, analysez

Une fois que vous avez importé et initialisé la bibliothèque AxeDevTools, vous êtes prêt à analyser. Effectuez une analyse depuis vos tests en appelant axe.scan().

Exemple d'analyse

Lorsque vous êtes prêt à effectuer une analyse depuis vos tests, appelez axe.scan(). Dans l'exemple ci-dessous, vous verrez comment utiliser ScanResultHandler pour télécharger les résultats sur Axe Developer Hub, valider ou invalider les tests, et enregistrer les résultats localement pour les partager avec votre équipe et pour le reporting. Cette fonction est expliquée plus en détail après l'extrait.

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

Explication :

1. Depuis le gestionnaire de résultats, appelez uploadToDashboard() pour envoyer la dernière analyse à Axe Developer Hub. L'analyse sera publiée depuis le compte authentifié utilisé dans la fonction init.
2. Depuis le gestionnaire de résultats, appelez getSerializedResult() pour accéder aux résultats de la bibliothèque localement. Par exemple, vous pouvez choisir d'invalider le test si des erreurs sont trouvées dans les résultats de l'analyse d'accessibilité. Cela n'enverra pas vos résultats sur le serveur. L'envoi de vos résultats n'est pas nécessaire pour les télécharger localement.
3. Depuis le gestionnaire de résultats, appelez saveResultToLocalStorage() pour enregistrer les résultats au format JSON dans un fichier local sur votre appareil de test. Pour accéder au fichier enregistré, consultez la documentation pour Enregistrement des résultats localement.

Désinitialisation

Une fois le test terminé, appelez tearDown() sur l'objet AxeDevTools que vous avez créé pour effacer l'état des tests précédents. Nous recommandons de placer cela dans la fonction annotée @After de votre fichier de test, mais cela peut également être appelé dans un test si nécessaire.

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

Et ensuite ?

En savoir plus sur téléchargement des résultats de l'analyse sur Axe Developer Hub et enregistrer vos résultats localement.