Konfiguration von Axe DevTools für Web CLI

Die in diesem Artikel beschriebenen Flags sind verfügbar für axe <url>, axe specund axe bulk-spec. Wenn Sie eines dieser Flags setzen, wird der Wert in der Einstellungsdatei gespeichert und wird zum Standard für alle nachfolgenden Ausführungen. Um Einstellungen interaktiv anzuzeigen oder zu ändern, einschließlich der Rücksetzung von Werten, die keinem korrespondierenden Flag zugeordnet sind, verwenden Sie axe config-selenium.

Browseroptionen

--accept-untrusted

Weist den Browser an, nicht vertrauenswürdige SSL-Zertifikate zu akzeptieren. Verwenden Sie dies, wenn Sie Seiten auf lokalen Entwicklungsservern oder internen Umgebungen testen, die selbstsignierte Zertifikate verwenden. Durch die Übergabe dieses Flags wird acceptUntrustedCertificates: true in der Einstellungsdateigespeichert. Um es zurückzusetzen auf false, führen Sie axe config-selenium aus und antworten Sie mit Nein , wenn Sie dazu aufgefordert werden, oder bearbeiten Sie direkt die Einstellungsdatei.

axe <url> --accept-untrusted

--browser <name>

Gibt an, welcher Browser verwendet werden soll. Der entsprechende WebDriver muss installiert und verfügbar sein auf Ihrem $PATH. Gültige Werte sind: firefox (Standard), chrome, safari, edge, ie.

axe <url> --browser chrome

Wenn bei Ihrem ersten Start ein Browser-Startfehler auftritt, ist möglicherweise GeckoDriver (der WebDriver von Firefox) nicht installiert. Versuchen Sie es mit --browser chrome anstelle dessen, was in der Regel ohne zusätzliche Einrichtung auf den meisten Systemen funktioniert.

Die Übergabe dieses Flags speichert den Browsernamen in der Einstellungsdatei. Alle nachfolgenden Ausführungen, einschließlich solcher ohne --browser, werden den gespeicherten Browser verwenden. Um den gespeicherten Browser zu ändern, führen Sie axe config-selenium aus und wählen Sie einen anderen Browser bei der Eingabeaufforderung, oder bearbeiten Sie die Einstellungsdatei direkt.

--headless

Startet den Browser im Headless-Modus (kein sichtbares Fenster). Der Standard ist false.

axe <url> --headless

--remote-server <url>

Verbindet sich mit einem Remote-WebDriver-Server anstelle des Starts eines lokalen Browsers. Der Server muss einen kompatiblen W3C-WebDriver-Endpunkt bereitstellen, wie z. B. ein Selenium Grid, BrowserStack oder Sauce Labs Remote.

axe <url> --remote-server https://hub.browserstack.com/wd/hub

--window-size <width,height>

Legt die Browserfenstergröße in Pixel fest. Dies steuert auch die Viewport-Größe im Headless-Modus, was nützlich für das Testen von responsiven Layouts ist.

axe <url> --window-size 1280,900

Zeiteinstellungen

--page-timeout <ms>

Maximale Zeit in Millisekunden (ms), um auf das Laden einer Seite zu warten, bevor ein Fehler auftritt. Der Standardwert ist 60.000 ms (60 Sekunden). Erhöhen Sie diesen Wert für Seiten mit langsamer Ladezeit oder in Netzwerken mit hoher Latenz.

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

Zeit in Millisekunden zum Pausieren nach Abschluss einer Analyse, bevor zur nächsten Aktion in einem Workflow übergegangen wird. Standardwert ist 2.000 ms (2 Sekunden).

axe spec workflow.yml --post-analyze-pause 5000

--post-get-pause <ms>

Zeit in Millisekunden zum Pausieren nach dem Laden einer Seite und bevor der Scan beginnt. Standardwert ist 2.000 ms (2 Sekunden). Erhöhen Sie diesen Wert, wenn dynamische Inhalte mehr Zeit benötigen, um vor dem Start des Scans zu rendern.

axe <url> --post-get-pause 5000

--post-script-pause <ms>

Zeit in Millisekunden zum Pausieren nach der Ausführung einer Workflow-Skriptaktion und bevor zur nächsten Aktion übergegangen wird. Standardwert ist 2.000 ms (2 Sekunden).

axe spec workflow.yml --post-script-pause 5000

--script-timeout <ms>

Maximale Zeit in Millisekunden, um auf die Fertigstellung eines Workflow-Skripts zu warten. Der Standardwert ist 60.000 ms (60 Sekunden).

axe spec workflow.yml --script-timeout 120000

Nutzungsverfolgung

Axe DevTools CLI beinhaltet die @deque/metrics-library, die anonyme Nutzungsdaten an Deque sendet. Diese Daten umfassen aggregierte Informationen wie Anzahl der Verstöße, Anzahl der Regeln und Version der axe-core-Engine. Sie enthalten keine URLs, Seiteninhalte oder persönlich identifizierbare Informationen.

Eine unterschiedliche ID ist ein Wert, der in der Einstellungsdatei gespeichert wird, um Ereignisse über mehrere CLI-Durchläufe hinweg ohne Identifizierung des Benutzers zu korrelieren. Sie können die Verfolgung mit den untenstehenden Optionen ändern oder deaktivieren. Um die Verfolgung vollständig zu deaktivieren, ohne das CLI zu benutzen, setzen Sie die Umgebungsvariable AXE_TRACK_USAGE=false.

--enable-tracking <state>

Aktiviert oder deaktiviert das Senden von Nutzungsdaten an die Metrikbibliothek. Übergeben Sie true zum Aktivieren oder false zum Deaktivieren.

axe <url> --enable-tracking false

--set-distinct-id <id>

Ändert die eindeutige ID, die zur Korrelation von Nutzungsevents verwendet wird. Die ID wird in der Einstellungsdatei gespeichert und über mehrere Durchläufe hinweg genutzt.

axe <url> --set-distinct-id my-team-id

--set-tracking-url <url>

Ändert den Endpunkt, an den die Nutzungsmetriken gesendet werden. Verwenden Sie dies, wenn Ihre Organisation Telemetrie über einen internen Proxy leitet.

axe <url> --set-tracking-url https://metrics.example.com/collect

axe config-selenium

Verwenden Sie axe config-selenium , um die Standardeinstellungen interaktiv zu konfigurieren. Sie werden aufgefordert, Werte für den Browser, das Timeout und andere Einstellungen einzugeben. Ihre Antworten werden in der Einstellungsdatei gespeichert und werden zu den Standardeinstellungen für alle nachfolgenden CLI-Läufe.

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

Um die aktuell gespeicherten Einstellungen ohne Eingabeaufforderung anzuzeigen, verwenden Sie das --show -Flag:

axe config-selenium --show

Einstellungsdatei

Alle konfigurierbaren Standardwerte werden in einer JSON-Datei gespeichert unter:

~/.config/preferences/com.deque.axe.devtools.cli.pref

Eine typische Datei sieht so aus:

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

Sie können diese Datei direkt bearbeiten, als Alternative zur Nutzung von axe config-selenium oder zur Übergabe von Flags in der Befehlszeile. Dies ist nützlich, um boolesche Werte wie acceptUntrustedCertificates zurückzusetzen, ohne die interaktive Eingabeaufforderung auszuführen.