Scan durchführen

Auf die Plätze, fertig, los

Nachdem Sie die Bibliothek importiert und initialisiert haben, können Sie mit dem Scannen beginnen. AxeDevTools 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, aufrufen axe.scan(). Im folgenden Beispiel sehen Sie, wie Sie mit ScanResultHandler Ergebnisse in das mobile Dashboard hochladen, Tests bestehen oder nicht bestehen und Ergebnisse lokal speichern, um sie mit Ihrem Team zu teilen und Berichte zu erstellen. Diese Funktion wird weiter unten im Codeausschnitt näher erläutert.

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

Aufschlüsselung:

1. Rufen Sie vom Ergebnishandler aus uploadToDashboard() auf, um den neuesten Scan an das Dashboard zu senden. Der Scan wird vom authentifizierten Konto aus veröffentlicht, das in der init Funktion verwendet wird.
2. Rufen Sie vom Ergebnishandler aus getSerializedResult() auf, um lokal auf die Ergebnisse der Bibliothek zuzugreifen. Sie können beispielsweise festlegen, dass der Test fehlschlägt, wenn in den Ergebnissen des Barrierefreiheitsscans Fehler gefunden werden. Dadurch werden Ihre Ergebnisse nicht auf den Server hochgeladen. Das Hochladen Ihrer Ergebnisse ist nicht erforderlich, um sie lokal herunterzuladen.
3. Rufen Sie vom Ergebnishandler aus saveResultToLocalStorage() auf, um die Ergebnisse als JSON in einer lokalen Datei auf Ihrem Testgerät zu speichern. Informationen zum Zugriff auf die gespeicherte Datei finden Sie in der Dokumentation zum Lokalen Speichern von Ergebnissen.

Deinitialisieren

Sobald der Test abgeschlossen ist, rufen Sie tearDown() das von Ihnen erstellte Objekt AxeDevTools auf, um den Status vorheriger Tests zu löschen. Wir empfehlen, dies in die kommentierte Funktion Ihrer Testdatei einzufügen @After , es kann jedoch bei Bedarf auch innerhalb eines Tests aufgerufen werden.

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

Wie geht es weiter?

Erfahren Sie mehr über das Hochladen von Scanergebnissen auf das mobile Dashboard und lokale Speicherung Ihrer Ergebnisse.