Axe DevTools for Web CLI configureren

De vlaggen die in dit artikel worden beschreven, zijn beschikbaar voor axe <url>, axe spec en axe bulk-spec. Wanneer je een van deze vlaggen instelt, wordt de waarde opgeslagen in de voorkeursbestand en wordt het de standaardinstelling voor alle volgende uitvoeringen. Om voorkeuren interactief weer te geven of te wijzigen, inclusief het resetten van waarden die geen overeenkomstige vlag hebben, gebruik je axe config-selenium.

Browseropties

--accept-untrusted

Beveelt de browser om niet-vertrouwde SSL-certificaten te accepteren. Gebruik dit bij het testen van pagina's op lokale ontwikkelservers of interne omgevingen die zelf-ondertekende certificaten gebruiken. Het doorgeven van deze vlag slaat acceptUntrustedCertificates: true op in de voorkeursbestand. Om het te resetten naar false, voer axe config-selenium uit en beantwoord Nee wanneer daarom wordt gevraagd, of bewerk het voorkeurenbestand direct.

axe <url> --accept-untrusted

--browser <name>

Geeft aan welke browser te gebruiken. De overeenkomstige WebDriver moet geïnstalleerd zijn en beschikbaar zijn op je $PATH. Geldige waarden zijn: firefox (standaard), chrome, safari, edge, ie.

axe <url> --browser chrome

Als je een foutmelding krijgt bij het starten van de browser tijdens je eerste uitvoering, is GeckoDriver (Firefox's WebDriver) mogelijk niet geïnstalleerd. Probeer in plaats daarvan --browser chrome, die meestal zonder extra installatie op de meeste systemen werkt.

Het doorgeven van deze vlag slaat de browsernaam op in de voorkeursbestand. Alle volgende uitvoeringen, inclusief uitvoeringen zonder --browser, zullen de opgeslagen browser gebruiken. Om de opgeslagen browser te wijzigen, voer axe config-selenium uit en kies een andere browser bij de prompt, of bewerk de voorkeursbestand direct.

--headless

Start de browser in de headless-modus (geen zichtbare venster). De standaardinstelling is false.

axe <url> --headless

--remote-server <url>

Verbindt met een externe WebDriver-server in plaats van een lokale browser te starten. De server moet een W3C WebDriver-compatibel eindpunt exposen, zoals een Selenium Grid, BrowserStack, of Sauce Labs remote.

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

--window-size <width,height>

Stelt de grootte van het browservenster in pixels in. Dit bepaalt ook de viewportgrootte in headless-modus, wat nuttig is voor het testen van responsieve lay-outs.

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

Tijdopties

--page-timeout <ms>

Maximale tijd in milliseconden (ms) om te wachten op het laden van een pagina alvorens te falen. Standaard is 60.000 ms (60 seconden). Verhoog dit voor langzaam ladende pagina's of netwerkomgevingen met hoge latentie.

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

Tijd in milliseconden om te pauzeren na het voltooien van een analyse voordat wordt doorgegaan naar de volgende actie in een workflow. Standaard is 2.000 ms (2 seconden).

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

--post-get-pause <ms>

Tijd in milliseconden om te pauzeren na het laden van een pagina en voordat de scan begint. Standaard is 2.000 ms (2 seconden). Verhoog dit als dynamische inhoud meer tijd nodig heeft om te renderen voordat het scannen begint.

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

--post-script-pause <ms>

Tijd in milliseconden om te pauzeren na het uitvoeren van een workflow script-actie en voordat wordt doorgegaan naar de volgende actie. Standaard is 2.000 ms (2 seconden).

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

--script-timeout <ms>

Maximale tijd in milliseconden om te wachten tot een workflow script klaar is met uitvoeren. Standaard is 60.000 ms (60 seconden).

axe spec workflow.yml --script-timeout 120000

Gebruikstracering

Axe DevTools CLI bevat de @deque/metrics-library, die anonieme gebruiksgegevens naar Deque stuurt. Deze gegevens bevatten samengevoegde informatie zoals overtredingentellingen, regeltellingen en de versie van de axe-core engine. Het bevat geen URL's, paginainhoud of enige persoonlijk identificeerbare informatie.

Een unieke ID is een waarde die is opgeslagen in het voorkeurenbestand en wordt gebruikt om gebeurtenissen over meerdere CLI-runs te correleren zonder de gebruiker te identificeren. Je kunt tracking wijzigen of uitschakelen met de onderstaande opties. Om deze waarden in te stellen zonder de CLI te gebruiken, gebruik je de gebruikersdienstomgeving variabelen.

--enable-tracking <state>

Stelt in of uitschakelen van het verzenden van gebruiksgegevens naar de metriekbibliotheek. Geef true door om in te schakelen of false om uit te schakelen. De overeenkomstige omgevingsvariabele is AXE_TRACK_USAGE — zie Gebruikersdienstomgeving Variabelen.

axe <url> --enable-tracking false

--set-distinct-id <id>

Wijzigt het unieke ID dat wordt gebruikt om gebruiksgebeurtenissen te correleren. Het ID wordt opgeslagen in het voorkeurenbestand en wordt over uitvoeringen heen gebruikt. De overeenkomstige omgevingsvariabele is AXE_DISTINCT_ID — zie Gebruikersdienstomgeving Variabelen.

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

--set-tracking-url <url>

Wijzigt het eindpunt waar gebruiksstatistieken naar worden verzonden. Gebruik dit als je organisatie de telemetrie via een interne proxy routeert. De overeenkomstige omgevingsvariabele is AXE_METRICS_URL — zie Gebruikersdienstomgeving Variabelen.

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

Gebruikersdienstomgeving Variabelen

Naast CLI-vlaggen kun je de gebruiksdienst configureren en eigenschappen instellen op gerapporteerde gebeurtenissen met behulp van omgevingsvariabelen. De Kan Overriden kolom geeft aan of de waarde van de omgevingsvariabele een waarde die al programmatisch is ingesteld via de metriekbibliotheek kan overschrijven. Een streepje (—) geeft aan dat het concept niet van toepassing is op die variabele.

axe config-selenium

Gebruik axe config-selenium om standaarden interactief in te stellen. Je wordt gevraagd om waarden in te voeren voor browser, time-out en andere instellingen. Jouw antwoorden worden opgeslagen in het voorkeurenbestand en worden de standaarden voor alle volgende CLI-runs.

$ 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

Gebruik de --show vlag om de huidige opgeslagen instellingen te bekijken zonder de interactieve prompt in te voeren:

axe config-selenium --show

Voorkeursbestand

Alle configureerbare standaarden worden opgeslagen in een JSON-bestand op:

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

Een typisch bestand ziet er als volgt uit:

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

Je kunt dit bestand direct bewerken als alternatief voor het gebruik van axe config-selenium of het doorgeven van vlaggen op de opdrachtregel. Dit is handig voor het resetten van booleaanse waarden zoals acceptUntrustedCertificates zonder de interactieve prompt uit te voeren.