Selenium-Tests schreiben

Diese Konfiguration von Axe DevTools bindet sich nicht von Haus aus an eine Assertionsbibliothek. Dies ermöglicht sowohl einfache Barrierefreiheitstests als auch vollständige Testanpassung und die Verwendung mit benutzerdefinierten Assertions.

Voraussetzungen

Um Axe DevTools Java Selenium nutzen und damit Ergebnisse erzielen zu können, müssen Sie bereits eine Testdatei mit Axe DevTools erstellt und Ihren gewünschten Selenium WebDriver importiert und initialisiert haben. Falls Sie diesen Schritt noch nicht abgeschlossen haben, lesen Sie zunächst diesem Leitfaden, um zu erfahren, wie das geht.

Einen Scan durchführen

Mit dieser Konfiguration erfordert ein grundlegender Barrierefreiheitsscan nur drei Codezeilen. Ersetzen Sie in Ihrer Testdatei <URL> durch die gewünschte Webadresse der zu testenden Seite. Die Scan-Ergebnisse werden in der results-Variable gespeichert

webdriver.get("<URL>");
Results results = axeSelenium.run(axedriver);
webdriver.quit();

Verwendung der Scan-Ergebnisse

Nachdem Sie den Scan durchgeführt haben, möchten Sie möglicherweise etwas mit den Ergebnissen machen. Die einfachste Option besteht darin, die Ergebnisse in der Konsole auszugeben.

System.out.print(results);

Sie können die Ergebnisse auch verwenden, um auf Barrierefreiheitsverletzungen zu prüfen. Der einfachste Weg, dies zu tun, ist mit einer Aussage wie dieser:

if (!results.violationFree()) { 
    //do something, like throw an exception
}

Weitere Informationen zur Nutzung des Ergebnisobjekts für benutzerdefinierte Tests finden Sie auf der Seite über die Ergebnisse verwenden.

Beispiel-Testdatei

Diese Testdatei arbeitet mit den gleichen Bausteinen, die in importieren und initialisieren behandelt werden, sowie mit dem Leitfaden zum Schreiben von Tests auf dieser Seite.

import com.deque.html.axedevtools.selenium.*;
import com.deque.html.axedevtools.selenium.results.*;

import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;

public class Example {
    public static void main(final String[] args) {
        AxeSelenium axeselenium = new AxeSelenium();
        WebDriver webdriver = new ChromeDriver();
        AxeDriver axedriver = new AxeDriver(wd);

        webdriver.get("<URL>");

        Results results = axeselenium.run(axedriver);

        webdriver.quit();

        if (!results.violationFree()) {
            int violationCount = results.getViolations().size();
            System.out.printf("Found %d violations!\n", violationCount);
            System.exit(1);
        }

        System.out.println("No violations found!");
    }
}

In diesem Beispiel werden Chrome und ChromeDriver verwendet. Diese können durch jeden anderen Selenium-Browsertreiber und Browser ersetzt werden. Falls diese Testdatei Barrierefreiheitsprobleme findet, gibt sie die Anzahl der gefundenen Verstöße aus und beendet sich mit dem Statuscode 1 (Fehler). Um diese Testdatei in Ihrer eigenen Umgebung zu verwenden, müssen Sie eine URL in die Zeile einfügen

webdriver.get("<URL>");

Zusätzliche Referenz

Zusätzlich zur oben beschriebenen Grundnutzung bietet Axe DevTools Java Selenium mehrere Verkettungsmethoden, um die Art und Weise, wie der Scan durchgeführt wird, zu verändern. Diese Methoden können den Umfang und das Regelset des Scans auf jede gewünschte Konfiguration anpassen. Standardmäßig wird die gesamte Seite gescannt und auf Barrierefreiheitsverletzungen gemäß den WCAG 2.1 Level AA Richtlinien geprüft, wobei Best-Practice- und experimentelle Regeln deaktiviert sind. Die Einstellungen dieser Kettenmethoden bleiben auf dem AxeSelenium-Objekt bestehen, und include und exclude fügen jedes Mal, wenn Sie sie aufrufen, den vorherigen Bereichen hinzu, sodass bei einer zweiten, anders konfigurierten Überprüfung das erste Scan-Setup übertragen wird. Erstellen Sie ein neues AxeSelenium für jeden anders konfigurierten Scan.

Scoping

Standardmäßig wird die gesamte Seite gescannt. Axe DevTools unterstützt jedoch die Möglichkeit, bestimmte Bereiche einer Seite mit seinen Scoping-Verkettungsmethoden zu scannen. Diese Scoping-Methoden ändern effektiv die „Fläche“ der zu scannenden Seite auf die gewünschte Zielregion(en). Zusätzlich ist eine Methode zum Ignorieren von Verstößen verfügbar. Diese Methode verkleinert nicht die Fläche des Scans; sie ignoriert Verstöße gegen eine Regel, wenn diese Regel bei einem bestimmten Element fehlschlägt, und der Rest der Seite wird wie gewohnt weiter überprüft. Alle diese Methoden funktionieren basierend auf CSS-Selektoren. Der Bereich jedes CSS-Selectors auf einer bestimmten Seite kann mit dem „Element untersuchen“-Widget der Entwickler-Tools Ihres Browsers bestimmt werden.

Scoping-Methoden

Wie oben erläutert, ändern diese Methoden effektiv die Oberfläche der zu scannenden Seite. Es gibt zwei Methoden in dieser Kategorie: eine „inklusive“ Methode und eine „exklusive“ Methode. Sie können miteinander verkettet werden, um mehrere Enklaven und Exklaven der Scanning-Oberfläche zu erstellen.

Scoping - Eingeschlossen

Die include-Scoping-Verkettungsmethode ändert den Scan so, dass er nur innerhalb des durch die CSS-Selektoren angegebenen Seitenbereichs ausgeführt wird. Es gibt mehrere Möglichkeiten, die include-Methode zu verwenden: Einzelbereich, Mehrfachbereich, zusammengesetzter Bereich und IFrame-Scoping.

Diese Methode kann mit einem einzelnen Selektor wie folgt verwendet werden:

axeselenium.include("#selector1").run(axedriver);

Dieser Scan wird nur innerhalb des Bereichs von Selektor 1 durchgeführt

Sie können einen Scan mit mehreren Scopes einrichten:

axeselenium.include("#selector1").include("#selector2").run(axedriver);

Dieser Aufruf wird innerhalb des Bereichs von Selektor 1 und Selektor 2 scannen. Sie können entweder durch Kommata getrennt oder in einem separaten include-Aufruf angegeben werden.

Verbundscoping kann mit der folgenden Syntax erreicht werden:

axeselenium.include("#selector1 .selector2").run(axedriver);

Dieses Verbundscoping führt dazu, dass nur Elemente mit Selektor 2 innerhalb von Selektor 1 gescannt werden. Dies wird erreicht, indem die Selektoren nicht durch Kommas getrennt werden.

Um innerhalb eines IFrames ein Scoping vorzunehmen, kann ein List<String> übergeben werden. Der innerhalb des IFrames zu scannende Umfang wird als zusätzlicher Parameter übergeben.

axeselenium.include(Arrays.asList(new String[] {"#frame1", "#selector1"})).run(axedriver);

Dieser Scan wird auf Elemente innerhalb von Selektor 1 ausgeführt, das sich innerhalb von Frame 1 befindet.

Das Scoping innerhalb mehrerer IFrames funktioniert genauso wie die normale Mehrfachauswahl. Rufen Sie einfach include erneut auf.

axeselenium.include(Arrays.asList(new String[] {"#frame1", "#selector1"}))
    .include(Arrays.asList(new String[] {"#frame2", "#selector2"})).run(axedriver);

Dieser Scan wird nur innerhalb von Selektor 1 innerhalb von Frame 1 und Selektor 2 innerhalb von Frame 2 durchgeführt.

Es ist auch möglich, innerhalb verschachtelter IFrames ein Scoping vorzunehmen:

axeselenium.include(Arrays.asList(new String[] {"#frame1", "#frame2", "#selector1"})).run(axedriver);

Dieser Scan wird innerhalb des Umfangs von Selektor 1 innerhalb von Frame 2 durchgeführt, der sich selbst innerhalb von Frame 1 befindet.

Scoping - Ausschließen

Zusätzlich zur include-Verkettungsmethode verfügt diese API über eine exclude-Methode. Diese Methode ändert den Scan so, dass nur Elemente außerhalb des angegebenen Bereichs gescannt werden. Ihre Einrichtung und Verwendung sind identisch mit der include-Methode, daher beziehen Sie sich auf den obigen Abschnitt für weitere Details und Beispiele, wie sie verwendet werden kann. Ein wichtiger Punkt, den Sie sich merken sollten, ist, dass die include- und exclude-Methoden miteinander verkettet werden können, um komplexe Bereiche viel einfacher zu erstellen, als nur mit include oder exclude.

Dieses Beispiel zeigt eine Möglichkeit, die include- und exclude-Methoden zu kombinieren:

axeselenium.include("#selector1").exclude("#selector2").run(axedriver);

Dieser Scan wird nur auf dem Teil der Seite durchgeführt, der sich innerhalb von Selektor 1 befindet, der nicht auch innerhalb von Selektor 2 liegt.

Scoping - Verstöße ignorieren

Die letzte mit dem Scoping zusammenhängende Verkettungsmethode ist die Ignorieren-Ergebnisse-Methode. Diese Methode ändert den gesamten Umfang des Scans nicht; sie ignoriert Verstöße gegen eine Regel, wenn diese Regel bei einem bestimmten Element fehlschlägt. Sie funktioniert, indem Sie den target des Elements, das ignoriert werden soll, so angeben, wie es in den Ergebnissen erscheint, kombiniert mit der Regel, gegen die es verstößt. Das Ziel wird in der Art geschrieben, wie Java eine Liste ausgibt, mit dem Selektor in eckigen Klammern, wie z. B. "[.sidebar]". Ein ignoring-Aufruf pro Regel genügt, da ein Treffer den gesamten Eintrag der Regel entfernt. Rufen Sie ihn nicht zweimal für dieselbe Regel auf: Wenn beide Ziele auf fehlerhafte Elemente treffen, erzeugt der Scan eine IllegalStateException.

axeselenium.ignoring("[.sidebar]", "color-contrast").ignoring("[#branded-content]", "image-alt").run(axedriver);

Dieser Scan wird den Farbkontrastverstoß in der Seitenleiste und den Verstoß gegen den alternativen Text für Bilder im Markenmagazin-Bild ignorieren. Wenn das Ziel einem Element entspricht, das gegen die Regel verstößt, wird der gesamte Eintrag der Regel aus den Verstößen entfernt, einschließlich der Fehler bei anderen Elementen. Siehe AxeSelenium.ignoring(String, String) im API-Referenz.

Regeln

Es gibt drei Möglichkeiten, Ihre Regelkonfiguration für jeden Scan zu ändern. Diese unterschiedlichen Methoden ermöglichen eine unterschiedliche Granularität bei der Auswahl der Regeln, die getestet werden sollen. Die am wenigsten granulare Regelset-Methode wählt ein Regelset oder eine größere Gruppe von Regeln basierend auf den allgemeinen Barrierefreiheitsstandards aus. Die etwas granularere Regelset-Standards-Methode, auch als Tags bekannt, wählt Regeln aus, basierend darauf, in welchen Bereichen eines größeren Barrierefreiheitsstandards sie fallen. Schließlich gibt es drei Optionen zur Konfiguration mit jeweils einer Regel. Insgesamt ermöglichen Ihnen diese Kettenmethoden, Ihren Scan fein abzustimmen, um genau die Regeln auszuführen, die Sie möchten.

Für Informationen zu axe-core-Regeln, besuchen Sie die Regelsatz-Übersichtsseite.

Regelsatz-Auswahl

Diese Methode wählt Regeln nach ihrer am meisten aggregierten Zuordnung aus – einem Regelset. Ein Regelset ist eine Sammlung aller Regeln, die einem branchenweiten Barrierefreiheitsstandard entsprechen. Regelsets für WCAG 2.0, 2.1 und 2.2; ADA Section 508; Trusted Tester v5; EN 301 549; und RGAA. Zusätzlich können Best-Practice-Regeln mit einem booleschen Schalter aktiviert werden.

Regelsets bestehen oft aus mehreren Tags, die nach spezifischeren Unterscheidungen gruppierte Regeln darstellen. Zum Beispiel enthält das wcag2-Regelset alle Regeln, die mit wcag2a WCAG 2.0 Niveau A, wcag2aa WCAG 2.0 Niveau AA und wcag2aaa WCAG 2.0 Niveau AAA markiert sind.

Verwenden Sie diese Option, wenn Sie ein Regelset unverändert auswählen möchten.

axeselenium.forRuleset("wcag2.1").run(axedriver);

Dieser Scan wird nur mit WCAG 2.1-Regeln ausgeführt.

Um Best-Practice-Regeln zu aktivieren, verwenden Sie die zweite Form von forRuleset.

axeselenium.forRuleset("wcag2.1", true).run(axedriver);

Standardauswahl

Die Methode der Barrierefreiheitsstandard- oder Tag-Kette ermöglicht eine etwas größere Granularität innerhalb der Regelsets von axe-core. Für WCAG-basierte Regeln können Sie mit dieser Methode nur die Regeln auswählen, die mit Einzel-A oder Doppel-A markiert sind. Diese Liste zeigt die verfügbaren Tagnamen und ihre entsprechenden Standards auf.

Diese Option ist besonders nützlich, wenn nur ein bestimmter Teil eines Regelsets getestet werden soll, beispielsweise nur die Einzel-A-Regeln unter WCAG 2.0.

Obwohl nicht explizit als Teil eines Barrierefreiheitsstandards definiert, bieten wir eine Reihe von Regeln an, die wir als „Best Practices“ bezeichnen. Auch wenn sie nicht zwingend erforderlich sind, wird das Testen mit diesen Regeln helfen, Ihre Website so fair wie möglich nutzbar zu machen.

Ein einzelner Standard kann wie folgt ausgewählt werden:

axeselenium.accordingTo("wcag2a").run(axedriver);

Dieser Scan wird nur mit Regeln ausgeführt, die unter WCAG 2.0 Niveau A markiert sind.

Zusätzlich können mehrere Tags angegeben werden, um mehrere Barrierefreiheitsstandards auszuwählen:

axeselenium.accordingTo("wcag2a", "section508").run(axedriver);

Diese Scans werden sowohl die Regeln ausführen, die unter WCAG 2.0 Niveau A als auch ADA Section 508 markiert sind.

Regelauswahl

Schließlich können Sie Ihr Regelset durch einzelne Regeln verändern. Für Informationen über die Namen aller axe-core-Regeln und was jede Regel testet, siehe die axe-core Regelbeschreibungsdokumentation.

Diese Methoden funktionieren gut, wenn Ihre gewünschte Endgruppe von Regeln sich nur um einige individuelle Regeln von einem bestehenden Regelsatz oder einer Norm/Tag unterscheidet. Um einen komplett benutzerdefinierten Regelsatz zu erstellen, schauen Sie sich unsere Optionen für benutzerdefinierte Regeln an.

Zusätzliche Regeln überprüfen

Die Prüfkettenmethode ermöglicht es Ihnen, zusätzliche Regeln zum Testen hinzuzufügen, zusätzlich zu Ihrem Standardregelset.

Diese Methode kann verwendet werden, um eine einzelne zusätzliche Regel zu überprüfen:

axeselenium.checking("label").run(axedriver);

wo der Scan mit dem Standard-Regelsatz zusammen mit der Regel „label“ durchgeführt wird.

Um mehrere zusätzliche Regeln zu überprüfen, geben Sie alle in einem Anruf weiter. Ein zweiter checking-Anruf ersetzt die Regeln des ersten Anrufs anstatt sie hinzuzufügen.

axeselenium.checking("label", "tabindex").run(axedriver);

wo der Scan mit dem Standard-Regelsatz zusammen mit den Regeln „label“ und „tabindex“ durchgeführt wird.

Es kann auch verwendet werden, um eine oder mehrere Regeln zu einem bestimmten Tag hinzuzufügen:

axeselenium.accordingTo("wcag2a").checking("tabindex").run(axedriver);

wo der Scan anhand der WCAG 2.0 Level A-Regeln durchgeführt wird, mit der zusätzlichen Regel „tabindex“.

Regeln überspringen

Ähnlich wie die Überprüfungsmethode ändert auch die Überspringenmethode die Standardregeln nach den angegebenen Regel(n). Anstatt sie jedoch dem Regelset hinzuzufügen, entfernt die Überspringenmethode die angegebenen Regel(n) aus denen, die zum Testen der Seite verwendet werden. Ihre Einrichtung und Verwendung ist identisch mit der Überprüfungsmethode; beziehen Sie sich daher für weitere Details und Beispiele, wie sie zu verwenden ist, auf den obigen Abschnitt.

axeselenium.accordingTo("wcag2a").skipping("label").run(axedriver);

Dieses Beispiel zeigt einen Scan, der gegen die WCAG 2.0-Level A-Regeln testet, mit der Entfernung der „label“-Regel.

Die Überprüfungs- und Überspringenmethoden setzen dieselbe Option, sodass nur der letzte der beiden Anrufe in einer Kette wirksam wird. Kombinieren Sie sie nicht im selben Scan.

Nur Prüfung

Die Nur-Prüfungsmethode überprüft nur die angegebene(n) Regel(n). Jede Regel, die nicht explizit angegeben wird, wird im Scan nicht berücksichtigt.

Diese Kettenmethode kann verwendet werden, um eine einzelne Regel anzugeben:

axeselenium.checkingOnly("tabindex").run(axedriver);

wo der Scan nur mit der Regel „tabindex“ durchgeführt wird.

Um mehr als eine Regel zu spezifizieren, geben Sie alle in einem Anruf weiter. Ein zweiter checkingOnly-Anruf ersetzt die Regeln des ersten. checkingOnly und accordingTo setzen auch dieselbe Option, sodass nur die letzte der beiden wirksam wird.

axeselenium.checkingOnly("label", "tabindex").run(axedriver);

wo der Scan nur mit den Regeln „label“ und „tabindex“ durchgeführt wird.

Deaktivierung iframePrüfungen

Auf instabilen Seiten können Iframes Probleme verursachen. Axe muss in jeden Frame injiziert und in jedem Frame gleich konfiguriert werden. Wenn Iframes hinzugefügt oder entfernt werden, während AxeSelenium::run Ihre Seite prüft, können Ausnahmen ausgelöst oder unerwartetes Verhalten auftreten. Als Sicherheitsmaßnahme bietet AxeSelenium eine Methode, um alle Iframe-Interaktionen zu deaktivieren, AxeSelenium::disableIframeTesting. Wenn aktiviert, wird axe-core nicht in Iframes der Seite injiziert, noch wird es in besagten Iframes ausgeführt. Nur die oberste Seite wird überprüft.

Es kann folgendermaßen verwendet werden:

axeselenium.disableIframeTesting().run(axedriver);

Nutzungsdienst

Erhalten Sie Einblicke in die Nutzungstrends von Axe DevTools in Ihrem Unternehmen

Der Nutzungsdienst kann über Umgebungsvariablen oder Methoden zur Laufzeit konfiguriert werden. Wenn beides verwendet wird, werden die Werte aus den Methoden verwendet. Hinweis: Nicht alle Datenfelder des Nutzungsdienstes können über Methoden gesetzt werden.

Standardmäßig ist der Nutzungsdienst aktiviert und die Ergebnisse werden an https://usage.deque.com gesendet. Setzen Sie die AXE_TRACK_USAGE-Umgebungsvariable auf false, um ihn zu deaktivieren. Wenn Ihre Nutzungsereignisse Deque nicht erreichen, setzen Sie die AXE_METRICS_URL-Umgebungsvariable explizit.

Umgebungsvariablen

Diese Umgebungsvariablen ermöglichen es Ihnen, den Nutzungsdienst zu konfigurieren und die Eigenschaften der gemeldeten Ereignisse zu ändern.

Tracking aktivieren

Diese Methode ermöglicht es Benutzern, die Datenübermittlung an den Nutzungsdienst zu aktivieren oder zu deaktivieren. Das Senden ist standardmäßig aktiviert.

.enableTracking(boolean state)

Tracking-URL festlegen

Diese Methode erlaubt es Benutzern zu ändern, wohin die Nutzungsmetriken gesendet werden. Standardmäßig zu https://usage.deque.com

.setTrackingUrl(String url)

Eindeutige ID festlegen

Diese Methode erlaubt es Benutzern, die gespeicherte/verwendete eindeutige ID zu ändern

.setDistinctId(String distinctId)

Nächste Schritte

Sobald Sie Tests mit Axe DevTools schreiben, lesen Sie mehr über Ergebnisse verwenden, um detailliertere benutzerdefinierte Tests zu schreiben, oder lesen Sie über den Berichterstatter verwenden, um Berichte über die Barrierefreiheits-Scans zu erstellen.

Fehlerbehebung

Wenn Sie Probleme bei der Einrichtung Ihrer Zugänglichkeitstests haben, kontaktieren Sie Ihren Deque-Vertreter direkt, erreichen Sie uns über unser Support Desk oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne, Ihre Barrierefreiheits-Testbemühungen in Gang zu bringen.