Einen Scan durchführen

Bereit, fertig, scannen

Sobald Sie die AxeDevTools-Bibliothek importiert und initialisiert haben, sind Sie bereit zum Scannen. Führen Sie einen Scan innerhalb Ihrer Tests durch, indem Sie axe.scan() aufrufen.

Beispielscan

Wenn Sie bereit sind, einen Scan innerhalb Ihrer Tests auszuführen, rufen Sie axe.scan() auf. Im folgenden Beispiel sehen Sie, wie Sie das ScanResultHandler verwenden, um Ergebnisse in den Axe Developer Hub hochzuladen, Tests zu bestehen oder zu scheitern und Ergebnisse lokal zu speichern, um sie mit Ihrem Team zu teilen und zu berichten. Diese Funktion wird weiter unten im Snippet aufgeschlüsselt.

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

Aufschlüsselung:

1. Vom Ergebnis-Handler aus rufen Sie uploadToDashboard() auf, um den neuesten Scan an Axe Developer Hub zu senden. Der Scan wird vom authentifizierten Konto veröffentlicht, das in der init-Funktion verwendet wird.
2. Vom Ergebnis-Handler aus rufen Sie getSerializedResult() auf, um auf die Ergebnisse der Bibliothek lokal zuzugreifen. Zum Beispiel können Sie den Test scheitern lassen, wenn Fehler in den Barrierefreiheitsscan-Ergebnissen gefunden werden. Dies wird Ihre Ergebnisse nicht auf den Server hochladen. Das Hochladen Ihrer Ergebnisse ist nicht erforderlich, um sie lokal herunterzuladen.
3. Vom Ergebnis-Handler aus rufen Sie saveResultToLocalStorage() auf, um die Ergebnisse als JSON in einer lokalen Datei auf Ihrem Testgerät zu speichern. Um auf die gespeicherte Datei zuzugreifen, konsultieren Sie die Dokumentation für Ergebnisse lokal speichern.

Deinitialisieren

Sobald der Test abgeschlossen ist, rufen Sie tearDown() auf das von Ihnen erstellte AxeDevTools-Objekt auf, um den Zustand früherer Tests zu löschen. Wir empfehlen, dies in die mit @After annotierte Funktion Ihrer Testdatei zu integrieren, aber es kann auch bei Bedarf innerhalb eines Tests aufgerufen werden.

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

Was kommt als Nächstes?

Erfahren Sie mehr über Scan-Ergebnisse in den Axe Developer Hub hochladen und Ihre Ergebnisse lokal speichern.