Exécuter une analyse

À vos marques, prêts, scannez

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

Exemple d'analyse

Lorsque vous êtes prêt à exécuter une analyse à partir de vos tests, appelez axe.scan(). Dans l'exemple ci-dessous, vous verrez comment utiliser le ScanResultHandler pour télécharger les résultats sur le tableau de bord mobile, réussir ou échouer aux tests et enregistrer les résultats localement pour les partager avec votre équipe et créer des rapports. Cette fonction est détaillée plus bas dans le fragment de code.

private fun a11yScan() {

    val scanResultHandler = axe.scan()

    //1. Upload it to the 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")
}

Analyse détaillée :

1. À partir du gestionnaire de résultats, appelez uploadToDashboard() pour envoyer la dernière analyse au tableau de bord. L'analyse sera publiée à partir du compte authentifié utilisé dans init la fonction.
2. À partir du gestionnaire de résultats, appelez getSerializedResult() la méthode pour accéder aux résultats de la bibliothèque localement. Par exemple, vous pouvez choisir de faire échouer le test lorsque des échecs sont détectés dans les résultats de l’analyse d’accessibilité. Cela ne téléversera pas vos résultats sur le serveur. L'envoi de vos résultats n'est pas nécessaire pour les enregistrer localement.
3. À partir du gestionnaire de résultats, appelez saveResultToLocalStorage() la méthode pour enregistrer les résultats au format JSON dans un fichier local sur votre périphérique de test. Pour accéder au fichier enregistré, reportez-vous à la documentation de Enregistrement des résultats localement.

Désinitialiser

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

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

Quelle est la prochaine étape ?

En savoir plus sur le téléchargement des résultats d'analyse sur le tableau de bord mobile et l'enregistrement de vos résultats localement.