Referência da API para Selenium

Este documento é uma referência para os tipos fornecidos pelo pacote selenium. A classe AxeSelenium deve cobrir a maioria dos casos de uso, e AxeConfiguration deve cobrir o restante.

com.deque.html.axedevtools.selenium.AxeSelenium

Configura como o axe é executado e realmente executa axe.

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

AxeSelenium()

Cria uma nova verificação de acessibilidade AxeSelenium para um AxeDriver.

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

Cria uma nova verificação de acessibilidade AxeSelenium para um AxeDriver.

Results run(final AxeDriver page)

Executa axe na página usando axe.run.

page: Driver AxeDevTools representando a página para realizar uma verificação de acessibilidade.

Retorna um documento de resultados.

AxeSelenium include(final String cssSelector)

Inclui um seletor.

cssSelector: Qualquer seletor CSS válido.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium include(final List<String> selector)

Inclui um seletor de iFrame.

selector: Uma lista de seletores de iFrame aninhados. Cada seletor representará um seletor CSS para um nível de aninhamento. O último representará um seletor CSS para o elemento web dentro do iFrame mais interno para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium exclude(final String cssSelector)

Exclui um seletor.

cssSelector: Qualquer seletor CSS válido. Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium exclude(final List<String> selector)

Exclui um seletor.

selector: Uma lista de seletores de iFrame aninhados. Cada seletor representará um seletor CSS para um nível de aninhamento. O último representará um seletor CSS para o elemento web dentro do iFrame mais interno para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium accordingTo(final String... tags)

De acordo com tags de acessibilidade. Verifique apenas as tags de acessibilidade especificadas. Esta opção é incompatível com AxeSelenium::checkingOnly Veja Descrições de Regras.

tags: Lista de tags para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium checkingOnly(final String... rules)

Verificando apenas as regras de acessibilidade. Esta opção é incompatível com AxeSelenium::accordingTo Veja Descrições de Regras.

rules: Lista de regras para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium checking(final String... rules)

Verifique as regras de acessibilidade. Além das tags dadas, verifique também certas regras. Veja Descrições de Regras.

rules: Lista de regras para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium skipping(final String... rules)

Pular regras de acessibilidade. Dentro das tags dadas, pule a verificação de certas regras. Veja Descrições de Regras.

rules: Lista de regras para verificação.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium forConfig(final URL auditConfigPath)

Fornece um conjunto de auditoria por sua URL.

auditConfigPath: o URL associado ao conjunto de auditoria.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium forConfig(final String auditConfigPath) lança MalformedURLException

Forneça um conjunto de auditoria pela sua localização no sistema de arquivos.

auditConfigPath: O caminho absoluto do arquivo do conjunto de auditoria.

Retorna AxeSelenium para encadeamento de métodos.

Lança MalformedURLException se o caminho da auditoria for um caminho inválido no sistema de arquivos.

AxeSelenium forRuleset(final String rulesetId)

Especifique um conjunto de regras para a verificação de acessibilidade. Configurar um conjunto de auditoria modificará o conjunto de regras especificado. Veja Conjuntos de regras.

rulesetId: O ID do conjunto de regras para configuração.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium forRuleset(final String rulesetId, final boolean enableBestPractices)

Especifique um conjunto de regras para a verificação de acessibilidade. Configurar um conjunto de auditoria modificará o conjunto de regras especificado. Veja Conjuntos de regras.

rulesetId: O ID do conjunto de regras para configuração.

enableBestPractices: Se as regras de "melhores práticas" devem ser ativadas ou não.

AxeSelenium: para encadeamento de métodos.

AxeSelenium ignorando(final String selector, final String ruleId)

Ignore violações para um seletor e um determinado ID de regra.

selector: Seletor produzido pelo Axe DevTools Accessibility/Audit suite.

ruleId: ID de regra a ser ignorado para o seletor fornecido.

Retorna AxeSelenium para encadeamento de métodos.

AxeSelenium logResults(final AxeReportingOptions reportingOptions)

Registra os resultados da verificação de acessibilidade ao concluir.

reportingOptions: Opções que definem a serialização e a persistência da verificação de acessibilidade. Retorna AxeSelenium para encadeamento de métodos.

boolean loggingConfigured()

Se o registro foi configurado ou não.

Retorna Se o registro foi configurado ou não.

com.deque.html.axedevtools.selenium.AxeDriver

Interagir com uma página usando AxeDriver.

Envolve o driver web do selenium para fornecer funcionalidade específica do axe-DevTools.

AxeDriver(final WebDriver webDriver)

Crie um AxeDriver a partir de um Selenium WebDriver.

webDriver: Um Selenium WebDriver para a página que deve ser verificada.

com.deque.html.axedevtools.selenium.AxeConfiguration

Configurar propriedades do script axe, como localização do arquivo e configuração. Classe Singleton, use AxeConfiguration.configure() para acessar.

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

Configure uma verificação de acessibilidade axe. A única maneira de obter uma instância de AxeConfiguration.

Retorna um objeto de configuração para configurar o conjunto de auditoria globalmente.

static void reset()

Reseta para as preferências padrão.

AxeConfiguration forAuditSuite(final URL auditConfigPath)

Forneça um conjunto de auditoria pelo seu URL.

auditConfigPath: o URL associado ao conjunto de auditoria.

Retorna AxeConfiguration para encadeamento de métodos.

AxeConfiguration paraAuditSuite(final String auditConfigPath) lança MalformedURLException

Forneça uma suíte de auditoria pelo seu local no sistema de arquivos.

auditConfigPath: O caminho absoluto do arquivo da suíte de auditoria.

Retorna AxeConfiguration para encadeamento de métodos.

Lança MalformedURLException se o caminho de auditoria for um caminho inválido do sistema de arquivos.

AxeConfiguration comAxeScript(URL axeScript)

Forneça um script de núcleo axe a ser usado para realizar a Verificação de Acessibilidade.

axeScript: O URL associado ao script do núcleo axe a ser usado para a Verificação de Acessibilidade.

Retorna AxeConfiguration para encadeamento de métodos.

AxeConfiguration paraRegras(final String rulesetId)

Escolha qual conjunto de regras executar

rulesetId: Um dos seguintes:

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

Retorna AxeConfiguration para encadeamento de métodos.

AxeConfiguration paraRegras(final String rulesetId, final boolean enableBestPractices)

Escolha qual conjunto de regras executar

rulesetId: Veja acima para valores possíveis.

enableBestPractices: Se devem ou não ser ativadas as regras de "melhores práticas".

Retorna AxeConfiguration para encadeamento de métodos.

String obterNomeSuíteDeTeste()

Obtém o nome da suíte de testes.

Retorna o nome da suíte de testes.

AxeConfiguration nomeSuíteDeTeste(final String testSuiteName)

Define o nome da suíte de testes. Usado na geração de relatórios.

testSuiteName: O nome da suíte de testes.

Retorna AxeConfiguration para encadeamento de métodos.

String obterDiretorioDeSaída()

Obtém o diretório de saída do relatório.

Retorna o caminho do diretório de saída.

AxeConfiguration diretorioDeSaida(final String outputDirectory)

Define o diretório para salvar relatórios.

outputDirectory: O caminho para o diretório.

Retorna AxeConfiguration para encadeamento de métodos.

String obterAgenteUsuario()

Obtém o valor usado como agente de usuário.

Retorna o agente de usuário usado na geração de relatórios.

AxeConfiguration agenteUsuario(final String userAgent)

Define o valor usado como agente de usuário ao gerar um relatório. Não afeta o agente de usuário real usado ao executar o axe.

userAgent: O valor do agente de usuário.

Retorna AxeConfiguration para encadeamento de métodos.

String getTestMachine()

Obtém o nome da máquina de teste.

Retorna o nome da máquina de teste.

AxeConfiguration testMachine(final String testMachine)

Define o nome da máquina de teste. Usado na geração de relatórios.

testMachine: O nome da máquina de teste.

Retorna AxeConfiguration para encadeamento de métodos.

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

IgnoredViolation(final String cssSelector, final String ruleId)

Cria uma violação a ser ignorada.

cssSelector: Seletor do nó a ser ignorado. Compara com o alvo de cada nó.

ruleId: ID da regra a ser ignorada

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

Configura opções de relatórios. Utiliza padrões de AxeConfiguration.

AxeReportingOptions()

Cria um AxeReportingOptions

static AxeReportingOptions defaultAuditReportingOptions()

Obtém as opções padrão.

Retorna o objeto com opções padrões.

String getSuiteTestName()

Obtém o nome da suíte de teste configurada.

Retorna o nome.

AxeReportingOptions testSuiteName(final String testSuiteName)

Descreva a suíte de teste.

testSuiteName: Nome da suíte de teste.

Retorna ReportingOptions para encadeamento de métodos.

String getUiState()

Obtém o estado da interface do usuário configurado.

Retorna o estado.

AxeReportingOptions uiState(final String uiState)

Descreva o estado da interface do usuário durante a verificação de acessibilidade.

uiState: Estado da interface do usuário.

Retorna ReportingOptions para encadeamento de métodos.

String getOutputDirectory()

Obtém o diretório de saída configurado.

Retorna o diretório.

AxeReportingOptions outputDirectory(final String outputDirectory)

Define o diretório raiz para saída do relatório de acessibilidade.

outputDirectory: Caminho do diretório.

Retorna ReportingOptions para encadeamento de métodos.

String getFileName()

Nome do arquivo calculado a partir dos valores configurados.

Retorna o nome do arquivo

String getFilePath(final String extension)

Calcula o caminho do arquivo a partir dos valores configurados.

Retorna o caminho.

String getUserAgent()

Obtém o user agent configurado.

Retorna o user agent.

AxeReportingOptions userAgent(final String userAgent)

Descreva o agente de usuário utilizado para realizar o teste de acessibilidade.

userAgent: Nome do agente de usuário.

Retorna ReportingOptions para encadeamento de métodos.

String getTestMachine()

Obtém a máquina de teste configurada.

Retorna a máquina de teste.

AxeReportingOptions testMachine(final String testMachine)

Descreva a máquina utilizada para realizar o teste de acessibilidade.

testMachine: Nome da máquina.

Retorna ReportingOptions para encadeamento de métodos.

AxeReportingOptions lineNum(final String lineNum)

Especifique o número da linha do teste atual.

lineNum: Número da linha do teste atual.

Retorna ReportingOptions para encadeamento de métodos.

ReportingOptions lineNumIfEmpty(final String lineNum)

Especifique o número da linha, se ainda não tiver sido definido.

lineNum: Número da linha do teste atual.

Retorna ReportingOptions para encadeamento de métodos.

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

Exceção para quando o estado da interface do usuário está ausente.

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

Define violações a serem ignoradas.

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 resultados para remover violações ignoradas.

results: resultados a filtrar.

Retorna resultados de entrada, filtrados para seletores CSS ignorados + IDs de regras.

ResultsFilter ignoring(final String cssSelector, final String ruleId)

Adiciona uma violação ignorada.

cssSelector: Seletor CSS produzido ao executar a suíte de Acessibilidade/Auditoria.

ruleId: ID da regra produzido ao executar a suíte de Acessibilidade/Auditoria.

Retorna ResultsFilter para encadeamento de métodos.

com.deque.html.axedevtools.reporter.AxeDevtoolsReporter

Configure opções de relatório ao usar correspondências hamcrest.

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

AxeDevtoolsReporter()

Construa um AxeDevtoolsReporter

String generateReport(final Results results, final String executedCommand)

Crie uma representação em string da verificação de acessibilidade.

results: Resultados da verificação de auditoria.

executedCommand: Comando executado para produzir resultados da auditoria.

Retorna um relatório legível das violações de acessibilidade encontradas.

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

Relate sobre a verificação de acessibilidade. Anexe o relatório ao arquivo de log de resultados por data. Armazene os resultados completos como um arquivo JSON.

reportingOptions: Opções para registrar o relatório.

results: Resultados da verificação de auditoria.

executedCommand: Comando executado para produzir resultados da auditoria.

com.deque.html.axedevtools.reporter.TestResultsGenerator

Gera um TestResults a partir de um Results e ReportingOptions. Utilizado com o AxeDevtoolsReporter

TestResults generate(final ReportingOptions reportingOptions, final Results results)

Gera o {@link TestResults}.

reportingOptions: Opções das quais criamos nossos resultados.

results: Resultados executados pelo axe.

Retorna o teste

com.deque.html.axedevtools.reporter.ViolationsReporter

Relata apenas as violações.

com.deque.html.axedevtools.utils.FileUtils

Utilitários de arquivos para uso interno.