axe-devtools-robot API-Referenz

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

API-Referenz für das axe-devtools-robot-Paket für Robot Framework-basierte Python-Tests

Not for use with personal data

Diese Bibliothek ermöglicht es Axe DevTools, Barrierefreiheit mit Robot Framework zu testen.

axe_devtools_robot.AxeRobot

Erweitert SeleniumLibrary, sodass alle Schlüsselwörter, die für SeleniumLibrary verfügbar sind, auch für AxeRobotverfügbar sind.

Importieren Sie die Bibliothek im Einstellungsbereich Ihres Test-Suites:

*** Settings ***
Library  axe_devtools_robot.AxeRobot

Analyze

Führen Sie axe-core auf der Seite aus und lassen Sie den Test fehlschlagen, wenn Verstöße vorliegen.

Audit For Accessibility

Führen Sie axe-core auf der Seite aus und speichern Sie die Ergebnisse im axe-reports -Verzeichnis. Sowohl eine .log -Datei (Verstoßbericht) als auch eine .json -Datei (vollständige Ergebnisse) werden geschrieben. Bricht nie ab.

Within

Bestimmen Sie einen Teil der Seite, den axe-core analysieren soll.

selectors: Ein oder mehrere CSS-Selektoren für einzuschließende Elemente.

Excluding

Bestimmen Sie einen Teil der Seite, den axe-core bei der Analyse überspringen soll.

selectors: Ein oder mehrere CSS-Selektoren für auszuschließende Elemente.

According To

Geben Sie Regeln (nach Tag) an, die von axe-core ausgeführt werden sollen.

tags: Ein oder mehrere Tag-Namen. Siehe axe-core-Tags für eine Liste gültiger Tags.

According To Ruleset

Verwenden Sie einen spezifischen Regelsatz für den axe-core-Lauf.

ruleset: ID des zu verwendenden Regelsatzes. Verfügbare Regelsätze: wcag2, wcag2.1, wcag2.2, wcag2aaa, wcag2.1aaa, wcag2.2aaa, 508, en301549, ttv5, rgaav4.

enable_best_practices: Ob Regeln aktiviert werden sollen, die mit best-practicegetaggt sind. Standardmäßig False.

Checking Only

Geben Sie Regeln (nach ID) an, die von axe-core ausgeführt werden sollen. Nur die angegebenen Regeln werden verwendet.

rules: Eine oder mehrere Regel-IDs. Siehe Regelbeschreibungen für eine Liste gültiger IDs.

Skipping

Deaktivieren Sie bestimmte Regeln vom axe-core-Lauf.

rules: Eine oder mehrere Regel-IDs.

Zur Verwendung von id CSS-Selektoren

Robot Framework behandelt den # -Zeichen als speziell. Wenn Sie nicht Ihre #maskieren, wird Robot den Rest der Zeile als Kommentar interpretieren.

In der Praxis bedeutet dies, dass Sie \# verwenden müssen, anstatt einfach nur #.

Siehe Roboterdokumentation für weitere Details.

Beispiel

*** Settings ***
Library  axe_devtools_robot.AxeRobot
Suite Setup  Set Log Level  DEBUG


*** Test Cases ***
Analyzes
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Analyze
Audits
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Audit For Accessibility

Uses Within
  Open Browser  http://localhost:8000/example-page.html  Chrome
  Within  body
  Analyze
Close browsers
  Close All Browsers