Berichte mit Java erstellen

Dieser Leitfaden beschreibt das Hinzufügen des Axe DevTools-Berichts zu Ihrem Testprojekt, das bereits Axe DevTools for Web verwendet.

Voraussetzungen

Die Integration des Berichts setzt eine laufende Axe DevTools for Web-Testumgebung voraus. Wenn Sie noch keine Axe DevTools for Web-Scanergebnisse erhalten, lesen Sie den Leitfaden, wie Sie Axe DevTools einrichten mit Java einrichten.

Sie müssen auch das ausführbare Berichtsprogramm erhalten, das von Binary-Bericht auf der Downloadseite heruntergeladen werden kann. Sehen Sie sich unbedingt den Abschnitt Vorbereitung der Binärdateien nach dem Download an.

Einrichten des Berichts

Um den Reporter zu verwenden, muss er in seiner eigenen Anweisung importiert werden. Ersetzen Sie <binding> durch selenium, hamcrest oder cucumber, je nachdem, welches Paket Sie in Ihrer Testeinrichtung verwenden.

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

Dann sind ein paar Initialisierungsanweisungen erforderlich. Ersetzen Sie <reporter-binary> durch den Namen Ihrer Reporter-Datei. Weitere Informationen zum Erhalt der Reporter-Datei finden Sie oben unter Voraussetzungen. Ihr Name hängt vom Betriebssystem ab.

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

Dann initialisieren Sie Ihre Berichtskonfiguration

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

Und schließlich geben Sie den Namen Ihres Test-Suites und das Verzeichnis der Protokolldateiausgabe an

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

Tests mit dem Bericht schreiben

Während Scans durchgeführt und Tests geschrieben werden, speichert der Logger Ihre Scanergebnisse in einer Datei, damit der Bericht darauf zugreifen und sie zusammenstellen kann. Für jeden Scan, für den Sie einen Bericht erstellen möchten, fügen Sie die .logResults()-Kettenmethode hinzu. Hier können Sie Ihren Bericht für zukünftige Referenz benennen.

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

Berichte erstellen

Schließlich, mit dem konfigurierten Bericht und protokollierten Ergebnissen, kann der Bericht auf die Ergebnisse zugreifen und sie transformieren. In der Regel wird dieser Schritt durchgeführt, nachdem alle Scans in einer Test-Suite abgeschlossen sind. Dieses Code-Snippet führt das Berichtsprogramm aus. Der Bericht benötigt drei Argumente: den Speicherort der Logger-Ergebnisse, die in der AxeConfiguration eingerichtet wurden, das gewünschte Ziel für die fertigen Berichte und ihr gewünschtes Format. Für lokale Testumgebungen empfehlen wir die Auswahl von html. Für die Verwendung in CI-Umgebungen erzeugt die xml-Option JUnit-XML-Berichte, die mit vielen CI-Umgebungen kompatibel sind. Für den Export in andere Tools verwenden Sie csv.

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

Fehlerbehebung

Wenn weiterhin Probleme mit dem Bericht auftreten, wenden Sie sich direkt an Ihren Deque-Ansprechpartner, erreichen Sie uns über unser Support Desk, oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne.

Siehe auch

• Hochladen von JSON-Zugänglichkeitsergebnissen zu den Axe-Berichten beschreibt, wie Sie Ihre Ergebnisse in Axe-Berichte hochladen können.
• Erhalten eines Axe-Berichts-API-Schlüssels erklärt, wie Sie einen API-Schlüssel erhalten, um mit der Verwendung der Axe-Berichte zu beginnen.
• Erstellen und Filtern von Berichten zeigt, wie Sie Barriereberichte in CSV, XML oder HTML aus Ihren JSON-Barrierefreiheitsergebnissen erstellen können. Sie können Ihre Ausgabe auch nach Schweregrad filtern, indem Sie dieses Tool verwenden.
• Wie JSON-Ergebnisse auf der Festplatte gespeichert werden beschreibt die Namenskonventionen für JSON-Barrierefreiheitsergebnisse.
• Verwenden des CLI zum Senden von Zugänglichkeitsergebnissen an die Axe Developer Hub zeigt, wie Sie Ihre .json Ergebnisdateien zu Axe Developer Hub hochladen können.