API-Referenz für Selenium

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

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-Barrierefreiheitsprüfung für ein AxeDriver.

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

Erstellen Sie eine neue AxeSelenium-Barrierefreiheitsprüfung für ein AxeDriver.

Results run(final AxeDriver page)

Führen Sie Axe mit axe.run gegen die Seite aus.

page: AxeDevTools-Driver, der die Seite repräsentiert, auf der eine Barrierefreiheitsprüfung durchgeführt werden soll.

Gibt ein Ergebnisdokument zurück.

AxeSelenium include(final String cssSelector)

Einen Selektor einschließen.

cssSelector: Jeder gültige CSS-Selektor.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium include(final List<String> selector)

Einen iFrame-Selektor einschließen.

selector: Eine Liste von verschachtelten iFrame-Selektoren. Jeder Selektor repräsentiert einen CSS-Selektor für eine Verschachtelungsebene. Der letzte stellt einen CSS-Selektor für das Webelement im innersten iFrame zur Prüfung dar.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium exclude(final String cssSelector)

Einen Selektor ausschließen.

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

AxeSelenium exclude(final List<String> selector)

Einen Selektor ausschließen.

selector: Eine Liste von verschachtelten iFrame-Selektoren. Jeder Selektor repräsentiert einen CSS-Selektor für eine Verschachtelungsebene. Der letzte stellt einen CSS-Selektor für das Webelement im innersten iFrame zur Prüfung dar.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium accordingTo(final String... tags)

Gemäß Barrierefreiheits-Tags. Überprüfen Sie nur die angegebenen Barrierefreiheits-Tags. Diese Option ist nicht kompatibel mit AxeSelenium::checkingOnly Siehe Regelbeschreibungen.

tags: Liste von Tags zur Überprüfung.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium checkingOnly(final String... rules)

Nur Barrierefreiheitsregeln überprüfen. Diese Option ist nicht kompatibel mit AxeSelenium::accordingTo Siehe Regelbeschreibungen.

rules: Liste von Regeln zur Überprüfung.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium checking(final String... rules)

Barrierefreiheitsregeln überprüfen. Zusätzlich zu den angegebenen Tags auch bestimmte Regeln überprüfen. Siehe Regelbeschreibungen.

rules: Liste von Regeln zur Überprüfung.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium skipping(final String... rules)

Barrierefreiheitsregeln überspringen. Innerhalb der angegebenen Tags das Überprüfen bestimmter Regeln überspringen. Siehe Regelbeschreibungen.

rules: Liste von Regeln zur Überprüfung.

Gibt AxeSelenium für Method Chaining zurück.

AxeSelenium forConfig(final URL auditConfigPath)

Stellen Sie eine Auditsuite über ihre URL bereit.

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

Gibt AxeSelenium für Methodenkettung zurück.

AxeSelenium forConfig(final String auditConfigPath) throws MalformedURLException

Bereitstellen einer Audit-Suite durch ihren Speicherort im Dateisystem.

auditConfigPath: Der absolute Dateipfad der Audit-Suite.

Gibt AxeSelenium für Methodenkettung zurück.

Wirft MalformedURLException, wenn der Audit-Pfad ein ungültiger Dateisystempfad ist.

AxeSelenium forRuleset(final String rulesetId)

Spezifizieren Sie einen Regelsatz für die Barrierefreiheitsprüfung. Die Konfiguration einer Audit-Suite wird den angegebenen Regelsatz ändern. Siehe Regelsätze.

rulesetId: Die ID des Regelsatzes zur Konfiguration.

Gibt AxeSelenium für Methodenkettung zurück.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Spezifizieren Sie einen Regelsatz für die Barrierefreiheitsprüfung. Die Konfiguration einer Audit-Suite wird den angegebenen Regelsatz ändern. Siehe Regelsätze.

rulesetId: Die ID des Regelsatzes zur Konfiguration.

enableBestPractices: Ob die "Best-Practice"-Regeln aktiviert werden sollen.

AxeSelenium: für Methodenkettung.

AxeSelenium ignoring(final String selector, final String ruleId)

Verstöße für einen Selektor und eine gegebene Regel-ID ignorieren.

selector: Vom Axe DevTools Accessibility/Audit-Suite erzeugter Selektor.

ruleId: Regel-ID, die für den gegebenen Selektor ignoriert werden soll.

Gibt AxeSelenium für Methodenkettung zurück.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Protokolliert die Ergebnisse der Barrierefreiheitsprüfung nach Abschluss.

reportingOptions: Optionen zur Definition der Serialisierung und Persistenz der Barrierefreiheitsprüfung. Gibt AxeSelenium für Methodenkettung 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 unter Verwendung von AxeDriver.

Umschließt den Selenium-Webdriver, um spezifische Funktionen der axe-DevTools 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 die Eigenschaften des axe-Skripts wie Speicherort und Konfiguration. Singleton-Klasse, verwenden Sie AxeConfiguration.configure() zum Zugriff.

// 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-Barrierefreiheitsprüfung. Der einzige Weg, um eine AxeConfiguration Instanz zu erhalten.

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

static void reset()

Setzt die Voreinstellungen auf Standard zurück.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Stellen Sie eine Audit-Suite über ihre URL zur Verfügung.

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

Gibt AxeConfiguration für Methodenkettung zurück.

AxeConfiguration forAuditSuite(final String auditConfigPath) throws MalformedURLException

Bietet eine Audit Suite über ihren Speicherort im Dateisystem an.

auditConfigPath: Der absolute Dateipfad der Audit Suite.

Gibt AxeConfiguration für Methodenkette zurück.

Wirft MalformedURLException, wenn der Auditpfad ein ungültiger Dateipfad ist.

AxeConfiguration withAxeScript(URL axeScript)

Bietet ein Axe Core Script an, das für die Durchführung des Accessibility Checks verwendet wird.

axeScript: Die URL, die mit dem Axe Core Script verknüpft ist, das für den Accessibility Check verwendet werden soll.

Gibt AxeConfiguration für Methodenkette zurück.

AxeConfiguration forRuleset(final String rulesetId)

Wählen Sie das auszuführende Regelset aus

rulesetId: Eins der folgenden:

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

Gibt AxeConfiguration für Methodenkette zurück.

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Wählen Sie das auszuführende Regelset aus

rulesetId: Siehe oben für mögliche Werte.

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

Gibt AxeConfiguration für Methodenkette zurück.

String getTestSuiteName()

Ermittelt den Namen der Test Suite.

Gibt den Namen der Test Suite zurück.

AxeConfiguration testSuiteName(final String testSuiteName)

Setzt den Namen der Test Suite. Wird zur Generierung von Berichten verwendet.

testSuiteName: Der Name der Test Suite.

Gibt AxeConfiguration für Methodenkette zurück.

String getOutputDirectory()

Ermittelt das Verzeichnispfad der Berichts-Ausgabe.

Gibt den Verzeichnispfad der Ausgabe zurück.

AxeConfiguration outputDirectory(final String outputDirectory)

Legt das Verzeichnis fest, in dem Berichte gespeichert werden.

outputDirectory: Der Pfad zum Verzeichnis.

Gibt AxeConfiguration für Methodenkette zurück.

String getUserAgent()

Ermittelt den Wert, der als User-Agent verwendet wird.

Gibt den User-Agent zurück, der bei der Berichtserstellung verwendet wird.

AxeConfiguration userAgent(final String userAgent)

Setzt den Wert, der als User-Agent bei der Berichtserstellung verwendet wird. Beeinflusst nicht den tatsächlichen User-Agent bei der Ausführung von Axe.

userAgent: Der Wert des User-Agents.

Gibt AxeConfiguration für Methodenkette zurück.

String getTestMachine()

Gibt den Namen der Testmaschine zurück.

Gibt den Namen der Testmaschine zurück.

AxeConfiguration testMachine(final String testMachine)

Setzt den Namen der Testmaschine. Wird bei der Berichtserstellung verwendet.

testMachine: Der Name der Testmaschine.

Gibt AxeConfiguration für method chaining zurück.

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

IgnoredViolation(final String cssSelector, final String ruleId)

Erstellt eine zu ignorierende Verletzung.

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 implements ReportingOptions

Konfiguriert die Berichtseinstellungen. Übernimmt Vorgaben aus AxeConfiguration.

AxeReportingOptions()

Erstellt ein AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Holt die Standardoptionen.

Gibt ein Objekt mit Standardoptionen zurück.

String getSuiteTestName()

Ruft den konfigurierten Namen der Testsuite ab.

Gibt den Namen zurück.

AxeReportingOptions testSuiteName(final String testSuiteName)

Beschreibt das Test-Suite.

testSuiteName: Name der Test-Suite.

Gibt ReportingOptions für method chaining zurück.

String getUiState()

Ruft den konfigurierten UI-Zustand ab.

Gibt den Zustand zurück.

AxeReportingOptions uiState(final String uiState)

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

uiState: Zustand der Benutzeroberfläche.

Gibt ReportingOptions für method chaining zurück.

String getOutputDirectory()

Ruft das konfigurierte Ausgabeverzeichnis ab.

Gibt das Verzeichnis zurück.

AxeReportingOptions outputDirectory(final String outputDirectory)

Setzt das übergeordnete Ausgabeverzeichnis für den Barrierefreiheitsbericht.

outputDirectory: Verzeichnispfad.

Gibt ReportingOptions für method chaining zurück.

String getFileName()

Berechneter Dateiname aus konfigurierten Werten.

Gibt den Dateinamen zurück.

String getFilePath(final String extension)

Berechnet den Dateipfad aus 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 User-Agent, der für den Barrierefreiheitstest verwendet wurde.

userAgent: Name des User-Agents.

Gibt ReportingOptions für method chaining zurück.

String getTestMachine()

Ruft die konfigurierte Testmaschine ab.

Gibt die Testmaschine zurück.

AxeReportingOptions testMachine(final String testMachine)

Beschreiben Sie die Maschine, die für den Barrierefreiheitstest verwendet wurde.

testMachine: Name der Maschine.

Gibt ReportingOptions für method chaining zurück.

AxeReportingOptions lineNum(final String lineNum)

Geben Sie die Zeilennummer des aktuellen Tests an.

lineNum: Zeilennummer des aktuellen Tests.

Gibt ReportingOptions für method chaining zurück.

ReportingOptions lineNumIfEmpty(final String lineNum)

Geben Sie die Zeilennummer an, falls sie noch nicht festgelegt wurde.

lineNum: Zeilennummer des aktuellen Tests.

Gibt ReportingOptions für method chaining zurück.

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

Ausnahme, wenn der UI-Zustand fehlt.

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

Legt Ignorierungen für Verstöße fest.

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

Results filterIgnoredViolations(final Results results)

Filtert Ergebnisse, um ignorierte Verstöße zu entfernen.

results: Ergebnisse, die gefiltert werden sollen.

Gibt eingehende Ergebnisse zurück, gefiltert für ignorierte CSS-Selektoren + Regel-IDs.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Fügt einen ignorierten Verstoß hinzu.

cssSelector: CSS-Selektor, der durch das Ausführen der Barrierefreiheit/Prüfungs-Suite generiert wurde.

ruleId: Regel-ID, die durch das Ausführen der Barrierefreiheit/Prüfungs-Suite generiert wurde.

Gibt ResultsFilter für method chaining zurück.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Konfigurieren von Reporting-Optionen bei Verwendung von hamcrest matchers.

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

AxeDevtoolsReporter()

Erstellt ein AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Erstellt eine Zeichenfolgenrepräsentation der Barrierefreiheitsprüfung.

results: Ergebnisse der Prüfungsüberprüfung.

executedCommand: Befehl, der ausgeführt wurde, um Prüfungergebnisse zu erzeugen.

Gibt einen lesbaren Bericht der gefundenen Barrierefreiheitsverstöße zurück.

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

Berichten über die Barrierefreiheitsprüfung. Bericht nach Datum zur Ergebniss-Protokolldatei hinzufügen. Speichern Sie die vollständigen Ergebnisse als JSON-Datei.

reportingOptions: Optionen für das Protokollieren des Berichts.

results: Ergebnisse der Prüfungsüberprüfung.

executedCommand: Befehl, der ausgeführt wurde, um Prüfungergebnisse zu erzeugen.

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 die {@link TestResults}.

reportingOptions: Optionen, aus denen wir unsere Ergebnisse erstellen.

results: Ergebnisse aus der Ausführung von Axe.

Gibt den Test zurück

com.deque.html.axedevtools.reporter.ViolationsReporter

Berichtet nur über Verstöße.

com.deque.html.axedevtools.utils.FileUtils

Datei-Dienstprogramme für den internen Gebrauch.