Riferimento API per Selenium

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

com.deque.html.axedevtools.selenium.AxeSelenium

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

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

AxeSelenium()

Crea un nuovo controllo di accessibilità AxeSelenium per un axe Driver.

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

Crea un nuovo controllo di accessibilità AxeSelenium per un axe Driver.

Results run(final AxeDriver page)

Esegui axe sulla pagina utilizzando axe.run.

page: Driver AxeDevTools 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 il concatenamento dei metodi.

AxeSelenium include(elenco finale<String> selettore)

Includere un selettore iFrame.

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

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium exclude(final String cssSelector)

Escludi un selettore.

cssSelector: Qualsiasi selettore CSS valido. Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium esclude(elenco finale<String> selettore)

Escludi un selettore.

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

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium accordingTo(final String... tags)

In base ai tag di accessibilità. Controlla solo i tag di accessibilità specificati. Questa opzione non è compatibile con AxeSelenium::checkingOnly Vedere Descrizione delle regole.

tags: Elenco dei tag da controllare.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium checkingOnly(final String... rules)

Verifica solo le regole di accessibilità. Questa opzione non è compatibile con AxeSelenium::accordingTo Vedere Descrizione delle regole.

rules: Elenco delle regole per la verifica.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium checking(final String... rules)

Controlla le regole di accessibilità. Oltre ai tag forniti, controlla anche alcune regole. Vedere Descrizione delle regole.

rules: Elenco delle regole per la verifica.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium skipping(final String... rules)

Saltando le regole di accessibilità. Tra i tag specificati, salta il controllo di determinate regole. Vedere Descrizione delle regole.

rules: Elenco delle regole per la verifica.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium forConfig(final URL auditConfigPath)

Fornire una suite di audit tramite il suo URL.

auditConfigPath: l'URL associato alla suite di audit.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium forConfig(final String auditConfigPath) Lancia MalformedURLException

Fornire una suite di audit in base alla sua posizione nel file system.

auditConfigPath: Percorso assoluto del file della suite di audit.

Restituisce AxeSelenium per il concatenamento dei metodi.

Lancia MalformedURLException se il percorso di audit è un percorso del file system non valido.

AxeSelenium forRuleset(final String rulesetId)

Specificare un set di regole per il controllo di accessibilità. La configurazione di una suite di audit modificherà il set di regole specificato. Vedere Insiemi di regole.

rulesetId: ID del set di regole per la configurazione.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Specificare un set di regole per il controllo di accessibilità. La configurazione di una suite di audit modificherà il set di regole specificato. Vedere Insiemi di regole.

rulesetId: ID del set di regole per la configurazione.

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

AxeSelenium: per il concatenamento dei metodi.

AxeSelenium ignoring(final String selector, final String ruleId)

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

selector: Selettore prodotto dalla suite axe DevTools Accessibility/Audit.

ruleId: ID regola da ignorare per il specificato selettore.

Restituisce AxeSelenium per il concatenamento dei metodi.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Registrare i risultati del controllo di accessibilità al termine.

reportingOptions: Opzioni che definiscono la serializzazione e la persistenza del controllo di accessibilità. Restituisce AxeSelenium per il concatenamento 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

Interagisci con una pagina utilizzando AxeDriver.

Avvolge il driver web 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 di axe DevTools come la posizione del file e la configurazione. Classe Singleton, utilizzare questo 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()

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

Restituisce un oggetto di configurazione per configurare la suite di audit a livello globale.

static void reset()

Ripristina le preferenze predefinite.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Fornire una suite di audit tramite il suo URL.

auditConfigPath: l'URL associato alla suite di audit.

Restituisce AxeConfiguration per il concatenamento dei metodi.

AxeConfiguration forAuditSuite(final String auditConfigPath) Lancia MalformedURLException

Fornire una suite di audit in base alla sua posizione nel file system.

auditConfigPath: Percorso assoluto del file della suite di audit.

Restituisce AxeConfiguration per il concatenamento dei metodi.

Lancia MalformedURLException se il percorso di audit è un percorso del file system non valido.

AxeConfiguration withAxeScript(URL axeScript)

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

axeScript: URL associato allo script axe Core 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 di:

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

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 possibili valori.

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

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getTestSuiteName()

Ottiene il nome della suite di test.

Restituisce il nome della suite di test.

AxeConfiguration testSuiteName(final String testSuiteName)

Imposta il nome della suite di test. Utilizzato nella generazione di report.

testSuiteName: Nome della suite di test.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getOutputDirectory()

Ottiene la directory di output del report.

Restituisce il percorso della directory di output.

AxeConfiguration outputDirectory(final String outputDirectory)

Imposta la directory in cui salvare i report.

outputDirectory: Percorso della directory.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getUserAgent()

Ottiene il valore utilizzato come user agent.

Restituisce l'agente utente utilizzato nella generazione del report.

AxeConfiguration userAgent(final String userAgent)

Imposta il valore utilizzato come agente utente durante la generazione di un report. Non influisce sull'agente utente effettivo utilizzato durante l'esecuzione di axe.

userAgent: Il valore dell'agente utente.

Restituisce AxeConfiguration per il concatenamento dei metodi.

String getTestMachine()

Ottiene il nome della macchina di prova.

Restituisce il nome della macchina di prova.

AxeConfiguration testMachine(final String testMachine)

Imposta il nome della macchina di prova. Utilizzato nella generazione di report.

testMachine: Nome della macchina di prova.

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. Esegue il confronto con l'obiettivo di ciascun nodo.

ruleId: ID della regola da ignorare

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

Configura le opzioni di reporting. 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 dell'interfaccia utente configurata.

Restituisce lo stato.

AxeReportingOptions uiState(final String uiState)

Descrivere lo stato dell'interfaccia utente durante il controllo di accessibilità.

uiState: Stato dell'interfaccia utente.

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 radice outputDirectory per generare il report di accessibilità.

outputDirectory: Percorso della directory.

Restituisce ReportingOptions per il concatenamento dei metodi.

String getFileName()

Nome file calcolato in base ai valori configurati.

Restituisce il nome del file

String getFilePath(final String extension)

Calcola il percorso del file in base ai valori configurati.

Restituisce il percorso.

String getUserAgent()

Ottiene l'agente utente configurato.

Restituisce l'agente utente.

AxeReportingOptions userAgent(final String userAgent)

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

userAgent: Nome dell'agente utente.

Restituisce ReportingOptions per il concatenamento dei metodi.

String getTestMachine()

Recupera la macchina di prova configurata.

Restituisce la macchina di prova.

AxeReportingOptions testMachine(final String testMachine)

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

testMachine: Nome della macchina.

Restituisce ReportingOptions per il concatenamento dei metodi.

AxeReportingOptions lineNum(final String lineNum)

Specificare il numero di riga del test corrente.

lineNum: Numero di riga del test corrente.

Restituisce ReportingOptions per il concatenamento dei metodi.

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 il concatenamento dei metodi.

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 risultati in arrivo, 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 Accessibility/Audit.

ruleId: ID regola prodotto eseguendo la suite Accessibility/Audit.

Restituisce ResultsFilter per il concatenamento dei metodi.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configurare le opzioni di reporting quando si utilizzano i hamcrest matchers.

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

AxeDevtoolsReporter()

Costruisci un AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Crea una rappresentazione stringa del controllo di accessibilità.

results: Risultati del controllo di audit.

executedCommand: Comando eseguito per produrre risultati di audit.

Restituisce un report leggibile delle violazioni di accessibilità rilevate.

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

Relazione sul controllo dell'accessibilità. Allega il report al file di registro dei risultati in base alla data. Memorizza i risultati completi come file JSON.

reportingOptions: Opzioni per il log del report.

results: Risultati del controllo di audit.

executedCommand: Comando eseguito per produrre risultati di audit.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Genera un TestResults da un Results e un ReportingOptions. Utilizzato 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

Segnalazioni di sole violazioni.

com.deque.html.axedevtools.utils.FileUtils

Utilità di file per uso interno.