API-Referenz für Selenium

Dieses Dokument ist eine Referenz für die vom selenium Paket bereitgestellten Typen. Die AxeSelenium Klasse sollte die meisten Anwendungsfälle abdecken und AxeConfiguration den Rest abdecken.

com.deque.html.axedevtools.selenium.AxeSelenium

Konfiguriert, wie Axe ausgeführt wird und führt Axe tatsächlich aus.

Results = new AxeSelenium()
    .include(".my-css-class")
    .skipping("aria-required-parent")
    .run(driver);

AxeSelenium()

Erstellen Sie eine neue AxeSelenium-Zugänglichkeitsprüfung für einen axe Driver.

AxeSelenium(final AxeBuilder axeBuilder, final AxeConfiguration axeConfiguration, final ResultsFilter resultsFilter, final AxeDevtoolsReporter reporter)

Erstellen Sie eine neue AxeSelenium-Zugänglichkeitsprüfung für einen axe Driver.

Results run(final AxeDriver page)

Führen Sie axe mit axe.run für die Seite aus.

page: AxeDevTools Driver, der die Seite darstellt, auf der eine a11y-Prüfung durchgeführt werden soll.

Gibt ein Ergebnisdokument zurück.

AxeSelenium include(final String cssSelector)

Fügen Sie einen Selektor ein.

cssSelector: Jeder gültige CSS-Selektor.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium include(final List<String> Selektor)

Fügen Sie einen iFrame-Selektor ein.

selector: Eine Liste verschachtelter iFrame-Selektoren. Jeder Selektor stellt einen CSS-Selektor für eine Verschachtelungsebene dar. Letzteres stellt zur Überprüfung einen CSS-Selektor für das Webelement im innersten iFrame dar.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium exclude(final String cssSelector)

Einen Selektor ausschließen.

cssSelector: Jeder gültige CSS-Selektor. Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium exclude(final List<String> Selektor)

Einen Selektor ausschließen.

selector: Eine Liste verschachtelter iFrame-Selektoren. Jeder Selektor stellt einen CSS-Selektor für eine Verschachtelungsebene dar. Letzteres stellt zur Überprüfung einen CSS-Selektor für das Webelement im innersten iFrame dar.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium accordingTo(final String... tags)

Gemäß den Zugänglichkeits-Tags. Überprüfen Sie nur die angegebenen Zugänglichkeits-Tags. Diese Option ist inkompatibel mit AxeSelenium::checkingOnly Siehe Regelbeschreibungen.

tags: Liste der zu prüfenden Tags.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium checkingOnly(final String... rules)

Es werden nur die Zugänglichkeitsregeln überprüft. Diese Option ist inkompatibel mit AxeSelenium::accordingTo Siehe Regelbeschreibungen.

rules: Liste der zu prüfenden Regeln.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium checking(final String... rules)

Überprüfen Sie die Zugänglichkeitsregeln. Überprüfen Sie neben den vorgegebenen Tags auch bestimmte Regeln. Siehe Regelbeschreibungen.

rules: Liste der zu prüfenden Regeln.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium skipping(final String... rules)

Barrierefreiheitsregeln werden übersprungen. Überspringe innerhalb der angegebenen Tags die Überprüfung bestimmter Regeln. Siehe Regelbeschreibungen.

rules: Liste der zu prüfenden Regeln.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium forConfig(final URL auditConfigPath)

Stellen Sie eine Audit-Suite über seine URL bereit.

auditConfigPath: die mit der Audit-Suite verknüpfte URL.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium forConfig(final String auditConfigPath) Löst MalformedURLException aus

Stellen Sie eine Audit-Suite anhand seiner Speicherorts im Dateisystem bereit.

auditConfigPath: Der absolute Dateipfad der Audit-Suite.

Gibt AxeSelenium für die Methodenverkettung zurück.

Wirft MalformedURLException eine Ausnahme, wenn der Prüfpfad ein ungültiger Dateisystempfad ist.

AxeSelenium forRuleset(final String rulesetId)

Geben Sie einen Regelsatz für die Barrierefreiheitsprüfung an. Durch die Konfiguration einer Audit-Suite wird der angegebene Regelsatz geändert. Siehe Regelsätze.

rulesetId: Die ID des Regelsatzes für die Konfiguration.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Geben Sie einen Regelsatz für die Barrierefreiheitsprüfung an. Durch die Konfiguration einer Audit-Suite wird der angegebene Regelsatz geändert. Siehe Regelsätze.

rulesetId: Die ID des Regelsatzes für die Konfiguration.

enableBestPractices: Ob „Best Practice“-Regeln aktiviert werden sollen oder nicht.

AxeSelenium: zur Methodenverkettung.

AxeSelenium ignoring(final String selector, final String ruleId)

Ignorieren Sie Verstöße für einen Selektor und eine bestimmte Regel-ID.

selector: Selektor erstellt durch die Accessibility/Audit-Suite von axe DevTools.

ruleIdZu ignorierende Regel-ID für den angegebenen Selektor.

Gibt AxeSelenium für die Methodenverkettung zurück.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Protokollieren Sie die Ergebnisse der Barrierefreiheitsprüfung nach Abschluss.

reportingOptionsOptionen, die die Serialisierung und Persistenz der Zugänglichkeitsprüfung definieren. Gibt AxeSelenium für die Methodenverkettung zurück.

boolean loggingConfigured()

Ob die Protokollierung konfiguriert wurde oder nicht.

Gibt zurück, ob die Protokollierung konfiguriert wurde oder nicht.

com.deque.html.axedevtools.selenium.AxeDriver

Interagieren Sie mit einer Seite mithilfe von AxeDriver.

Umschließt den Selenium WebDriver, um axe-DevTools-spezifische Funktionalität bereitzustellen.

AxeDriver(final WebDriver webDriver)

Erstellen Sie einen AxeDriver aus einem Selenium WebDriver.

webDriver: Ein Selenium WebDriver für die Seite, die überprüft werden soll.

com.deque.html.axedevtools.selenium.AxeConfiguration

Konfigurieren Sie axe-Skripteigenschaften wie Dateispeicherort und Konfiguration. Singleton-Klasse, AxeConfiguration.configure() für den Zugriff verwenden Sie.

// Code runs once before any tests are run
public void setupOnce() {
  AxeConfiguration.configure()
    .withAxeScript(axeURL)
    .forAuditPath(auditURL)
    .forRuleset("508")
    .outputDirectory("my-axe-results");
}

static AxeConfiguration configure()

Konfigurieren Sie eine Axe-Zugänglichkeitsprüfung. Die einzige Möglichkeit, eine AxeConfiguration Instanz zu erhalten.

Gibt ein Konfigurationsobjekt zurück, um die Audit-Suite global zu konfigurieren.

static void reset()

Setzt die Standardeinstellungen zurück.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Stellen Sie eine Audit-Suite über seine URL bereit.

auditConfigPath: die mit der Audit-Suite verknüpfte URL.

Gibt AxeConfiguration für die Methodenverkettung zurück.

AxeConfiguration forAuditSuite(final String auditConfigPath) Löst MalformedURLException aus

Stellen Sie eine Audit-Suite anhand seiner Speicherorts im Dateisystem bereit.

auditConfigPath: Der absolute Dateipfad der Audit-Suite.

Gibt AxeConfiguration für die Methodenverkettung zurück.

Wirft MalformedURLException eine Ausnahme, wenn der Prüfpfad ein ungültiger Dateisystempfad ist.

AxeConfiguration withAxeScript(URL axeScript)

Stellen Sie ein Axe-Core-Skript bereit, das zur Durchführung der Barrierefreiheitsprüfung verwendet werden soll.

axeScript: Die mit dem Axe Core-Skript verknüpfte URL, die für die Barrierefreiheitsprüfung verwendet werden soll.

Gibt AxeConfiguration für die Methodenverkettung zurück.

AxeConfiguration forRuleset(final String rulesetId)

Auswählen des auszuführenden Regelsatzes

rulesetId: Einer von:

• wcag2
• wcag2.1
• wcag2.2
• wcag2aaa
• wcag2.1aaa
• wcag2.2aaa
• 508
• ttv5
• en301549

Gibt AxeConfiguration für die Methodenverkettung zurück.

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Auswählen des auszuführenden Regelsatzes

rulesetId: Mögliche Werte finden Sie oben .

enableBestPractices: Ob „Best Practice“-Regeln aktiviert werden sollen oder nicht.

Gibt AxeConfiguration für die Methodenverkettung zurück.

String getTestSuiteName()

Ruft den Namen der Testsuite ab.

Gibt den Namen der Testsuite zurück.

AxeConfiguration testSuiteName(final String testSuiteName)

Legt den Namen der Testsuite fest. Wird zum Generieren von Berichten verwendet.

testSuiteName: Der Name der Testsuite.

Gibt AxeConfiguration für die Methodenverkettung zurück.

String getOutputDirectory()

Ruft das Ausgabeverzeichnis des Berichts ab.

Gibt den Ausgabeverzeichnispfad zurück.

AxeConfiguration outputDirectory(final String outputDirectory)

Legen Sie das Verzeichnis fest, in dem Berichte gespeichert werden sollen.

outputDirectory: Der Pfad zum Verzeichnis.

Gibt AxeConfiguration für die Methodenverkettung zurück.

String getUserAgent()

Ruft den als Benutzeragent verwendeten Wert ab.

Gibt den bei der Berichterstellung verwendeten Benutzeragenten zurück.

AxeConfiguration userAgent(final String userAgent)

Legt den Wert fest, der beim Generieren eines Berichts als Benutzeragent verwendet wird. Beeinflusst nicht den tatsächlichen Benutzeragenten, der beim Ausführen von Axe verwendet wird.

userAgent: Der Wert des Benutzeragenten.

Gibt AxeConfiguration für die Methodenverkettung zurück.

String getTestMachine()

Ruft den Namen der Testmaschine ab.

Gibt den Namen der Testmaschine zurück.

AxeConfiguration testMachine(final String testMachine)

Legt den Namen der Testmaschine fest. Wird bei der Berichterstellung verwendet.

testMachine: Der Name der Testmaschine.

Gibt AxeConfiguration für die Methodenverkettung zurück.

com.deque.html.axedevtools.selenium.results.IgnoredViolation

IgnoredViolation(final String cssSelector, final String ruleId)

Erstellen Sie einen zu ignorierenden Verstoß.

cssSelector: Selektor des zu ignorierenden Knotens. Vergleicht mit dem Ziel jedes Knotens.

ruleId: ID der zu ignorierenden Regel

com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions implementiert ReportingOptions

Konfiguriert Berichtsoptionen. Übernimmt Standardwerte von AxeConfiguration.

AxeReportingOptions()

Erstellt ein AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Ruft die Standardoptionen ab.

Gibt das standardmäßige Optionsobjekt zurück.

String getSuiteTestName()

Ruft den konfigurierten Testsuitenamen ab.

Gibt den Namen zurück.

AxeReportingOptions testSuiteName(final String testSuiteName)

Beschreiben Sie die Testsuite.

testSuiteName: Name der Testsuite.

Gibt ReportingOptions für die Methodenverkettung zurück.

String getUiState()

Ruft den konfigurierten UI-Zustand ab.

Gibt den Status zurück.

AxeReportingOptions uiState(final String uiState)

Beschreiben Sie den Zustand der Benutzeroberfläche während der Barrierefreiheitsprüfung.

uiState: Status der Benutzeroberfläche.

Gibt ReportingOptions für die Methodenverkettung zurück.

String getOutputDirectory()

Ruft das konfigurierte Ausgabeverzeichnis ab.

Gibt das Verzeichnis zurück.

AxeReportingOptions outputDirectory(final String outputDirectory)

Legen Sie das Stammausgabeverzeichnis für die Ausgabe des Zugänglichkeitsberichts fest.

outputDirectory: Verzeichnispfad.

Gibt ReportingOptions für die Methodenverkettung zurück.

String getFileName()

Dateiname aus den konfigurierten Werten berechnet.

Gibt den Dateinamen zurück

String getFilePath(final String extension)

Berechnet den Dateipfad aus den konfigurierten Werten.

Gibt den Pfad zurück.

String getUserAgent()

Ruft den konfigurierten Benutzeragenten ab.

Gibt den Benutzeragenten zurück.

AxeReportingOptions userAgent(final String userAgent)

Beschreiben Sie den Benutzeragenten, der zum Durchführen des Zugänglichkeitstests verwendet wurde.

userAgent: Name des Benutzeragenten.

Gibt ReportingOptions für die Methodenverkettung zurück.

String getTestMachine()

Holt die konfigurierte Testmaschine.

Gibt die Testmaschine zurück.

AxeReportingOptions testMachine(final String testMachine)

Beschreiben Sie die Maschine, die zum Durchführen des Barrierefreiheitstests verwendet wurde.

testMachine: Maschinenname.

Gibt ReportingOptions für die Methodenverkettung zurück.

AxeReportingOptions lineNum(final String lineNum)

Geben Sie die Zeilennummer des aktuellen Tests an.

lineNum: Zeilennummer des aktuellen Tests.

Gibt ReportingOptions für die Methodenverkettung zurück.

ReportingOptions lineNumIfEmpty(final String lineNum)

Geben Sie die Zeilennummer an, sofern diese nicht bereits festgelegt wurde.

lineNum: Zeilennummer des aktuellen Tests.

Gibt ReportingOptions für die Methodenverkettung zurück.

com.deque.html.axedevtools.selenium.reporter.MissingUIStateException

Ausnahme, wenn der UI-Zustand fehlt.

com.deque.html.axedevtools.selenium.results.ResultsFilter

Legt fest, welche Verstöße ignoriert werden sollen.

ResultsFilter filter = new ResultsFilter()
    .ignoring(".third-party-iframe", "label");
Results results = new AxeSelenium(axe, configuration, filter, reporter)
    .run(driver);

Results filterIgnoredViolations(final Results results)

Filtere die Ergebnisse, um ignorierte Verstöße zu entfernen.

results: zu filternde Ergebnisse.

Zeigt eingehende Ergebnisse, gefiltert nach ignorierten CSS-Selektoren + Regel-IDs.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Füge einen ignorierten Verstoß hinzu.

cssSelector: CSS-Selektor, der durch Ausführen der Accessibility/Audit-Suite erstellt wurde.

ruleId: Regel-ID, die durch Ausführen der Accessibility/Audit-Suite erstellt wurde.

Gibt ResultsFilter für Methodenverkettung zurück.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Konfigurieren Sie Berichtsoptionen, wenn Sie Hamcrest-Matcher verwenden.

AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();
assertThat(axeDevtoolsSelenium, isAxeClean(axeSelenium, reporter));

AxeDevtoolsReporter()

Konstruieren Sie ein AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Erstellen Sie eine Zeichenfolgendarstellung der Barrierefreiheitsprüfung.

results: Ergebnisse der Auditprüfung.

executedCommand: ausgeführter Befehl für Audit-Ergebnissen.

Gibt einen lesbaren Bericht über gefundene Barrierefreiheitsverletzungen zurück.

void report(final ReportingOptions reportingOptions, final Results results, final String executedCommand)

Bericht zur Barrierefreiheitsprüfung. Bericht nach Datum an die Ergebnisprotokolldatei anhängen. Speichern Sie die vollständigen Ergebnisse als JSON-Datei.

reportingOptions: Optionen zum Loggen des Berichts.

results: Ergebnisse der Auditprüfung.

executedCommand: ausgeführter Befehl für Audit-Ergebnissen.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Generiert ein TestResults aus einem Results und ReportingOptions. Verwendet mit dem AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Generiert das {@link TestResults}.

reportingOptions: Optionen, aus denen wir unsere Ergebnisse erstellen.

results: Ergebnisse aus laufender axe.

Gibt zurück den Test

com.deque.html.axedevtools.reporter.ViolationsReporter

Berichtet ausschließlich über Verstöße.

com.deque.html.axedevtools.utils.FileUtils

Datei-Hilfsprogramme für den internen Gebrauch.