Generieren von Berichten mit Java

In diesem Handbuch erfahren Sie, wie Sie den axe DevTools-Reporter zu Ihrem Testprojekt hinzufügen, das bereits axe DevTools for Web nutzt.

Voraussetzungen

Für die Integration des Reporters ist ein laufendes axe DevTools-Setup für Webtests erforderlich. Wenn Sie noch keine Scan-Ergebnisse von axe DevTools for Web erhalten, lesen Sie die Anleitung zum Einrichten von axe DevTools mit Java.

Sie müssen außerdem die ausführbare Reporterdatei abrufen, die Sie unter Binary Reporter auf der Downloadseite herunterladen können. Lesen Sie unbedingt den Abschnitt Binärdateien nach dem Download vorbereiten.

Einrichten des Reporters

Um den Reporter zu verwenden, muss er in einer eigenen Anweisung importiert werden. Ersetzen <binding> mit Selenium, Hamcrest oder Cucumber , je nachdem, welches Paket Sie in Ihrem Test-Setup verwenden.

import com.deque.html.axedevtools.<binding>.*;
import com.deque.html.axedevtools.<binding>.reporter.*;

Anschließend sind noch einige Initialisierungsanweisungen erforderlich. Ersetzen <reporter-binary> Mit dem Namen Ihrer ausführbaren Reporterdatei. Weitere Informationen zum Abrufen der ausführbaren Reporterdatei finden Sie oben unter Voraussetzungen . Der Name hängt vom Betriebssystem ab.

static String reporter = new File("src/test/resources/<reporter-binary>").getAbsolutePath();

Initialisieren Sie dann Ihre Berichtskonfiguration.

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

Geben Sie abschließend den Namen Ihrer Testsuite und das Ausgabeverzeichnis für die Protokolldatei an.

AxeConfiguration.configure()
    .testSuiteName("<suite-name>")
    .outputDirectory("<log-directory-location>");

Tests mit dem Reporter schreiben

Während Sie Scans durchführen und Tests schreiben, speichert die Protokollierungsfunktion Ihre Scan-Ergebnisse in einer Datei, sodass der Reporter darauf zugreifen und sie zusammenstellen kann. Fügen Sie für jeden Scan, für den Sie einen Bericht erstellen möchten, die Kettenmethode .logResults() hinzu. Hier können Sie Ihrem Bericht einen Namen geben, für zukünftige Referenz.

.logResults(_reportOptions.uiState("<scan-name>"))

Berichte erstellen

Schließlich, nachdem der Reporter konfiguriert und die Ergebnisse protokolliert wurden, kann der Reporter auf die Ergebnisse zugreifen und sie transformieren. Im Allgemeinen wird dieser Schritt ausgeführt, nachdem alle Scans in einer Testsuite abgeschlossen sind. Dieser Codeausschnitt führt die Reporter-Binärdatei aus. Der Reporter verwendet drei Argumente: den Speicherort der im AxeConfiguration eingerichteten Logger-Ergebnisse, das gewünschte Ziel für die ausgefüllten Berichte und das gewünschte Format. Für lokale Test-Setups empfehlen wir die Auswahl von html. Für die CI-Verwendung erstellt die xml Option JUnit-XML-Berichte, die mit vielen CI-Umgebungen kompatibel sind. Verwenden Sie csv zum Exportieren in andere Tools.

Runtime rt = Runtime.getRuntime();
String command = reporter + " <log-directory-location> <desired-destination> --format <desired-format>";
rt.exec(command);

Fehlerbehebung

Wenn die Probleme mit dem Reporter weiterhin bestehen, wenden Sie sich direkt an Ihren Deque-Vertreter, erreichen Sie uns über unseren Support-Desk oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne weiter.

Siehe auch

– Hochladen von JSON-Zugänglichkeitsergebnissen in axe Reports beschreibt, wie Sie Ihre Ergebnisse in axe Reports hochladen.

• Erhalten eines API-Schlüssels für axe Reports erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung von axe Reports zu beginnen.

– Berichte erstellen und filtern zeigt, wie Sie aus Ihren JSON-Zugänglichkeitsergebnissen Zugänglichkeitsberichte im CSV-, XML- oder HTML-Format erstellen können. Mit diesem Tool können Sie Ihre Ausgabe auch nach Schweregrad filtern. – So werden JSON-Ergebnisse auf der Festplatte gespeichert beschreibt die Dateibenennungskonventionen für JSON-Zugänglichkeitsergebnisse.