Riferimento API per Selenium

Questo documento è un riferimento per i tipi forniti dal pacchetto selenium. La classe AxeSelenium dovrebbe coprire la maggior parte dei casi d'uso, e AxeConfiguration dovrebbe coprire il resto.

com.deque.html.axedevtools.selenium.AxeSelenium

Configura il modo in cui axe viene eseguito ed esegue effettivamente axe.

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

AxeSelenium()

Crea un nuovo controllo di accessibilità AxeSelenium per un AxeDriver.

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

Crea un nuovo controllo di accessibilità AxeSelenium per un AxeDriver.

Risultati run(final AxeDriver page)

Esegui axe sulla pagina usando axe.run.

page: AxeDevTools Driver che rappresenta la pagina su cui eseguire un controllo a11y.

Restituisce un documento di risultati.

AxeSelenium include(final String cssSelector)

Includi un selettore.

cssSelector: Qualsiasi selettore CSS valido.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium include(final List<String> selector)

Includi un selettore iFrame.

selector: Un elenco di selettori iFrame nidificati. Ogni selettore rappresenterà un selettore CSS per un livello di nidificazione. L'ultimo rappresenterà un selettore CSS per l'elemento web all'interno dell'iFrame più interno per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium exclude(final String cssSelector)

Escludi un selettore.

cssSelector: Qualsiasi selettore CSS valido. Restituisce AxeSelenium per concatenare metodi.

AxeSelenium exclude(final List<String> selector)

Escludi un selettore.

selector: Un elenco di selettori iFrame nidificati. Ogni selettore rappresenterà un selettore CSS per un livello di nidificazione. L'ultimo rappresenterà un selettore CSS per l'elemento web all'interno dell'iFrame più interno per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium accordingTo(final String... tags)

Secondo i tag di accessibilità. Controlla solo i tag di accessibilità specificati. Questa opzione è incompatibile con AxeSelenium::checkingOnly Vedi Descrizioni delle Regole.

tags: Elenco dei tag per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium checkingOnly(final String... rules)

Controlla solo le regole di accessibilità. Questa opzione è incompatibile con AxeSelenium::accordingTo Vedi Descrizioni delle Regole.

rules: Elenco delle regole per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium checking(final String... rules)

Controlla le regole di accessibilità. Oltre ai tag forniti, controlla anche alcune regole. Vedi Descrizioni delle Regole.

rules: Elenco delle regole per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium skipping(final String... rules)

Salta le regole di accessibilità. Tra i tag forniti, salta il controllo di alcune regole. Vedi Descrizioni delle Regole.

rules: Elenco delle regole per il controllo.

Restituisce AxeSelenium per concatenare metodi.

AxeSelenium forConfig(final URL auditConfigPath)

Fornisci un suite di audit tramite il suo URL.

auditConfigPath: l'URL associato alla suite di audit.

Restituisce AxeSelenium per il chaining dei metodi.

AxeSelenium forConfig(final String auditConfigPath) genera MalformedURLException

Fornire una suite di audit tramite la sua posizione nel file system.

auditConfigPath: il percorso assoluto del file della suite di audit.

Restituisce AxeSelenium per il chaining dei metodi.

Genera MalformedURLException se il percorso dell'audit è un percorso di file system non valido.

AxeSelenium forRuleset(final String rulesetId)

Specifica un set di regole per il controllo dell'accessibilità. Configurare una suite di audit modificherà il set di regole specificato. Vedi Set di regole.

rulesetId: L'id del set di regole per la configurazione.

Restituisce AxeSelenium per il chaining dei metodi.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Specifica un set di regole per il controllo dell'accessibilità. Configurare una suite di audit modificherà il set di regole specificato. Vedi Set di regole.

rulesetId: L'id del set di regole per la configurazione.

enableBestPractices: Se attivare o meno le regole di "best-practice".

AxeSelenium: per il chaining dei metodi.

AxeSelenium ignorando(final String selector, final String ruleId)

Ignora le violazioni per un selettore e un dato id di regola.

selector: Selettore prodotto dalla suite di accessibilità/Audit di Axe DevTools.

ruleId: Id di regola da ignorare per il selettore specificato.

Restituisce AxeSelenium per il chaining dei metodi.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Registra i risultati del controllo di accessibilità al completamento.

reportingOptions: Opzioni che definiscono la serializzazione e la persistenza del controllo di accessibilità. Restituisce AxeSelenium per il chaining dei metodi.

boolean loggingConfigured()

Se la registrazione è stata configurata o meno.

Restituisce Se la registrazione è stata configurata o meno.

com.deque.html.axedevtools.selenium.AxeDriver

Interagire con una pagina usando AxeDriver.

Avvolge il web driver di Selenium per fornire funzionalità specifiche di axe-DevTools.

AxeDriver(final WebDriver webDriver)

Crea un AxeDriver da un Selenium WebDriver.

webDriver: Un Selenium WebDriver per la pagina che deve essere controllata.

com.deque.html.axedevtools.selenium.AxeConfiguration

Configura le proprietà dello script axe come la posizione del file e la configurazione. Classe singleton, usa AxeConfiguration.configure() per accedere.

// 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()

Configura un controllo di accessibilità axe. L'unico modo per ottenere un'istanza di AxeConfiguration.

Restituisce Un oggetto di configurazione per configurare globalmente la suite di audit.

static void reset()

Reimposta alle preferenze predefinite.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Fornisci una suite di audit tramite il suo URL.

auditConfigPath: l'URL associato alla suite di audit.

Restituisce AxeConfiguration per il chaining dei metodi.

AxeConfiguration forAuditSuite(final String auditConfigPath) throws MalformedURLException

Fornisce un pacchetto di audit in base alla sua posizione nel file system.

auditConfigPath: Il percorso assoluto del pacchetto di audit.

Restituisce AxeConfiguration per il concatenamento dei metodi.

Lancia MalformedURLException se il percorso dell'audit è un percorso non valido nel file system.

AxeConfiguration withAxeScript(URL axeScript)

Fornisce uno script core axe da utilizzare per eseguire il controllo di accessibilità.

axeScript: L'URL associato allo script core axe da utilizzare per il controllo di accessibilità.

Restituisce AxeConfiguration per il concatenamento dei metodi.

AxeConfiguration forRuleset(final String rulesetId)

Scegli quale set di regole eseguire

rulesetId: Uno dei seguenti:

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

Restituisce AxeConfiguration per il concatenamento dei metodi.

AxeConfiguration forRuleset(final String rulesetId, final boolean enableBestPractices)

Scegli quale set di regole eseguire

rulesetId: Vedi sopra per i valori possibili.

enableBestPractices: Se attivare o meno le regole di "migliori pratiche".

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getTestSuiteName()

Ottiene il nome del pacchetto di test.

Restituisce Il nome del pacchetto di test.

AxeConfiguration testSuiteName(final String testSuiteName)

Imposta il nome del pacchetto di test. Usato per generare rapporti.

testSuiteName: Il nome del pacchetto di test.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getOutputDirectory()

Ottiene la directory di output del rapporto.

Restituisce Il percorso della directory di output.

AxeConfiguration outputDirectory(final String outputDirectory)

Imposta la directory in cui salvare i rapporti.

outputDirectory: Il percorso della directory.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getUserAgent()

Ottiene il valore utilizzato come user agent.

Restituisce L'user agent utilizzato nella generazione dei rapporti.

AxeConfiguration userAgent(final String userAgent)

Imposta il valore usato come user agent durante la generazione di un rapporto. Non influisce sull'user agent effettivo utilizzato durante l'esecuzione di axe.

userAgent: Il valore dell'user agent.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getTestMachine()

Ottiene il nome della macchina di test.

Restituisce il nome della macchina di test.

AxeConfiguration testMachine(final String testMachine)

Imposta il nome della macchina di test. Utilizzato nella generazione dei report.

testMachine: Il nome della macchina di test.

Restituisce AxeConfiguration per il concatenamento dei metodi.

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

IgnoredViolation(final String cssSelector, final String ruleId)

Crea una violazione da ignorare.

cssSelector: Selettore del nodo da ignorare. Confronta con il target di ciascun nodo.

ruleId: ID della regola da ignorare

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

Configura le opzioni di reportistica. Prende i valori predefiniti da AxeConfiguration.

AxeReportingOptions()

Crea un AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Ottiene le opzioni predefinite.

Restituisce l'oggetto delle opzioni predefinite.

String getSuiteTestName()

Ottiene il nome della suite di test configurata.

Restituisce il nome.

AxeReportingOptions testSuiteName(final String testSuiteName)

Descrivere la suite di test.

testSuiteName: Nome della suite di test.

Restituisce ReportingOptions per il concatenamento dei metodi.

String getUiState()

Ottiene lo stato UI configurato.

Restituisce lo stato.

AxeReportingOptions uiState(final String uiState)

Descrivere lo stato dell'UI durante il controllo dell'accessibilità.

uiState: Stato dell'UI.

Restituisce ReportingOptions per il concatenamento dei metodi.

String getOutputDirectory()

Ottiene la directory di output configurata.

Restituisce la directory.

AxeReportingOptions outputDirectory(final String outputDirectory)

Imposta la directory di output principale per generare il report di accessibilità.

outputDirectory: Percorso della directory.

Restituisce ReportingOptions per il concatenamento dei metodi.

String getFileName()

Nome file calcolato dai valori configurati.

Restituisce il nome del file.

String getFilePath(final String extension)

Calcola il percorso del file dai valori configurati.

Restituisce il percorso.

String getUserAgent()

Ottiene l'user agent configurato.

Restituisce l'user agent.

AxeReportingOptions userAgent(final String userAgent)

Descrivi l'agente utente utilizzato per eseguire il test di accessibilità.

userAgent: Nome dell'agente utente.

Restituisce ReportingOptions per concatenazione.

String getTestMachine()

Ottiene la macchina di test configurata.

Restituisce la macchina di test.

AxeReportingOptions testMachine(final String testMachine)

Descrivi la macchina utilizzata per eseguire il test di accessibilità.

testMachine: Nome della macchina.

Restituisce ReportingOptions per concatenazione.

AxeReportingOptions lineNum(final String lineNum)

Specificare il numero di riga del test corrente.

lineNum: Numero di riga del test corrente.

Restituisce ReportingOptions per concatenazione.

ReportingOptions lineNumIfEmpty(final String lineNum)

Specificare il numero di riga, se non è già stato impostato.

lineNum: Numero di riga del test corrente.

Restituisce ReportingOptions per concatenazione.

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

Eccezione quando manca lo stato dell'interfaccia utente.

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

Imposta le violazioni da ignorare.

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

Results filterIgnoredViolations(final Results results)

Filtra i risultati per rimuovere le violazioni ignorate.

results: risultati da filtrare.

Restituisce i risultati in ingresso, filtrati per selettori CSS ignorati + ID delle regole.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Aggiungi una violazione ignorata.

cssSelector: Selettore CSS prodotto eseguendo la suite di Accessibilità/Audit.

ruleId: ID della regola prodotto eseguendo la suite di Accessibilità/Audit.

Restituisce ResultsFilter per concatenazione.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configura le opzioni di reportistica quando si usano i matcher di hamcrest.

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

AxeDevtoolsReporter()

Costruisci un AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Crea una rappresentazione in stringa del controllo di accessibilità.

results: Risultati dal controllo di audit.

executedCommand: Comando eseguito per produrre i risultati dell'audit.

Restituisce un report leggibile delle violazioni di accessibilità trovate.

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

Esegui il report sul controllo di accessibilità. Aggiungi il report al file di log dei risultati per data. Memorizza i risultati completi come file JSON.

reportingOptions: Opzioni per registrare il report.

results: Risultati dal controllo di audit.

executedCommand: Comando eseguito per produrre i risultati dell'audit.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Genera un TestResults da un Results e un ReportingOptions. Usato con il AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Genera il {@link TestResults}.

reportingOptions: Opzioni da cui creiamo i nostri risultati.

results: Risultati dall'esecuzione di axe.

Restituisce Il test

com.deque.html.axedevtools.reporter.ViolationsReporter

Riporta solo le violazioni.

com.deque.html.axedevtools.utils.FileUtils

Utilità di file per uso interno.