Referência da API para Selenium
Referência de API para AxeSelenium, AxeConfiguration e as classes relacionadas de seletor, relatórios e resultados no Axe DevTools para Web Java
Este documento é uma referência para as classes AxeSelenium e AxeConfiguration, e para os tipos de seletor, relatório e resultados que elas utilizam. A classe AxeSelenium deve cobrir a maioria dos casos de uso, e AxeConfiguration deve cobrir o restante.
Os exemplos nesta página presumem que webDriver é o seu Selenium WebDriver e que driver é um AxeDriver que o encapsula.
com.deque.html.axedevtools.selenium.AxeSelenium
Configura e executa uma varredura de acessibilidade. Cada método de configuração retorna a mesma instância de AxeSelenium, permitindo chamadas encadeadas, e run(AxeDriver) executa a varredura.
Results results = new AxeSelenium()
.include(".my-css-class")
.skipping("aria-required-parent")
.run(driver);AxeSelenium()
Cria uma varredura AxeSelenium que usa as configurações AxeConfiguration globais, como o conjunto de regras, suíte de auditoria e diretório de saída de relatórios. Use este construtor a menos que precise personalizar o AxeBuilder subjacente.
public AxeSelenium();Exemplo
Results results = new AxeSelenium().run(driver);AxeSelenium(AxeBuilder)
Cria uma varredura AxeSelenium que utiliza o AxeBuilder que você fornece, a partir da integração do axe-core com Selenium (com.deque.html.axecore.selenium.AxeBuilder). Use-o para acessar opções de AxeBuilder que AxeSelenium não expõe, como o modo legado. As configurações AxeConfiguration globais ainda se aplicam.
public AxeSelenium(AxeBuilder axeBuilder);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
axeBuilder |
AxeBuilder |
O construtor usado para injetar o axe-core na página e executá-lo. |
Exemplo
import com.deque.html.axecore.selenium.AxeBuilder;
Results results = new AxeSelenium(new AxeBuilder().setLegacyMode())
.run(driver);run(AxeDriver)
Verifica a página que page mostra atualmente, usando todas as opções configuradas neste AxeSelenium, e retorna os resultados. Violações ignoradas (veja AxeSelenium.ignoring(String, String)) são removidas dos resultados, e, se logResults foi chamado, os arquivos de relatório são gravados antes de run retornar.
Se o axe-core relatar um erro durante a varredura, run o lança em vez de retornar resultados.
public Results run(AxeDriver page);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
page |
AxeDriver |
A página a ser verificada. |
Retornos
Um objeto Results (com.deque.html.axecore.results.Results) contendo as violações, passagens, resultados incompletos e inaplicáveis.
Exceções
AxeRuntimeException(com.deque.html.axecore.results.AxeRuntimeException) quando axe-core retorna um erro em vez de resultados.RuntimeExceptionquando a varredura em si falhar, por exemplo, quandoaxe.finishRunfalhar ou o driver não conseguir alternar entre janelas.
Exemplo
webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);
if (!results.violationFree()) {
System.out.println(results.getViolations().size() + " rules have violations");
}runCommand()
Retorna o script genérico axe.run que AxeSelenium executa no navegador no modo legado. O script não inclui o contexto ou as opções desta varredura, e com axe-core 4.3 ou posterior (o modo padrão, não legado) as varreduras são executadas por um conjunto diferente de chamadas. AxeSelenium passa este script para o relator, então ele é principalmente útil quando você constrói seu próprio texto de relatório com AxeDevtoolsReporter.generateReport.
public String runCommand();Retornos
O script, como um String.
include(String)
Limita a varredura aos elementos correspondentes a um seletor CSS e seus descendentes. Cada chamada adiciona outra área à varredura, então, para testar várias partes não relacionadas da página, chame include uma vez para cada uma. Um único seletor separado por vírgulas (".sidebar, .some-class") também funciona, pois é passado para o navegador como está.
public AxeSelenium include(String cssSelector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
cssSelector |
String |
Qualquer seletor CSS válido. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test .sidebar and .some-class, which are both in the top-level document
Results results = new AxeSelenium()
.include(".sidebar")
.include(".some-class")
.run(driver);include(List\<String>)
Limita a varredura a um elemento dentro de um ou mais iFrames aninhados. Cada string, exceto a última, corresponde a um nível de aninhamento de iFrame; a última corresponde ao elemento a ser testado dentro do iFrame mais interno. A lista descreve um caminho, não vários seletores.
Como não há uma sobrecarga de include(String...), passar mais de uma string para include também produz um único seletor de iFrame em vez de inclusões separadas: include("#parent-iframe", "#html") se resolve em include(Object...) e significa o mesmo que o exemplo abaixo.
include(FromFrames) expressa a mesma coisa de forma mais explícita e é a forma recomendada para novos testes.
public AxeSelenium include(List<String> selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
List\<String> |
Um seletor CSS por nível de aninhamento de iFrame, seguido por um seletor CSS para o elemento dentro do iFrame mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test #html inside the iframe matched by #parent-iframe
Results results = new AxeSelenium()
.include(Arrays.asList("#parent-iframe", "#html"))
.run(driver);include(FromFrames)
Limita a varredura a um elemento dentro de um ou mais iFrames aninhados, usando um seletor FromFrames explícito.
public AxeSelenium include(FromFrames fromFrames);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromFrames |
FromFrames |
Cada seletor, exceto o último, corresponde a um nível de aninhamento de iFrame; o último corresponde ao elemento a ser testado dentro do iFrame mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.include(new FromFrames("#payment-frame", "form"))
.run(driver);include(FromShadowDom)
Limita a varredura a um elemento dentro de uma ou mais árvores de shadow DOM aninhadas, usando um seletor FromShadowDom explícito.
public AxeSelenium include(FromShadowDom fromShadowDom);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromShadowDom |
FromShadowDom |
Cada seletor, exceto o último, corresponde a um host de shadow; o último corresponde ao elemento a ser testado dentro do shadow root mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
.include(new FromShadowDom(".app-header", "form#search"))
.run(driver);include(Object)
Limita a varredura usando um seletor fornecido como um único objeto. O Java seleciona esta sobrecarga apenas quando o tipo estático do argumento não é um dos tipos acima, como uma variável declarada como Object. Prefira as sobrecargas tipadas.
public AxeSelenium include(Object selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
Object |
Uma string de seletor CSS, uma lista de strings, um seletor FromFrames, ou um seletor FromShadowDom. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// The selector's type is chosen at runtime, so it's held as Object
Object scope = useFrame ? new FromFrames("#frame", "main") : "main";
Results results = new AxeSelenium()
.include(scope)
.run(driver);include(Object...)
Limita a varredura usando um seletor que combina seletores CSS simples com seletores FromFrames ou FromShadowDom, para casos que as outras sobrecargas não podem expressar. Todos os argumentos juntos formam um caminho único para um elemento; eles não são inclusões separadas.
Esta sobrecarga é selecionada sempre que a chamada passa mais de um argumento. Passar um único FromFrames ou FromShadowDom seleciona include(FromFrames) ou include(FromShadowDom) em vez disso.
Para alcançar um iFrame que vive dentro de um shadow root, aninhe o seletor FromShadowDom dentro do seletor FromFrames. O inverso não pode ser expresso, pois FromShadowDom aceita apenas strings.
public AxeSelenium include(Object... selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
Object... |
Um conjunto misto de seletores CSS e objetos de seletor formando um caminho único para o elemento a ser testado. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
.include("#frame", new FromShadowDom("#host", ".target"))
.run(driver);exclude(String)
Remove os elementos correspondentes a um seletor CSS e seus descendentes da varredura. Cada chamada remove outra área, então, para pular várias partes não relacionadas da página, chame exclude uma vez para cada uma. As exclusões se aplicam além de quaisquer chamadas de include, o que permite que você teste uma região exceto por parte dela.
public AxeSelenium exclude(String cssSelector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
cssSelector |
String |
Qualquer seletor CSS válido. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Test main, but skip the .cookie-banner and .ad-slot inside it
Results results = new AxeSelenium()
.include("main")
.exclude(".cookie-banner")
.exclude(".ad-slot")
.run(driver);exclude(List\<String>)
Remove um elemento dentro de um ou mais iFrames aninhados da varredura. Cada string, exceto a última, corresponde a um nível de aninhamento de iFrame; a última corresponde ao elemento a ser ignorado dentro do iFrame mais interno. A lista descreve um caminho, não vários seletores.
Como não há uma sobrecarga de exclude(String...), passar mais de uma string para exclude também produz um único seletor de iFrame em vez de exclusões separadas: exclude(".iframe1", ".third-party-ad") se resolve em exclude(Object...) e significa o mesmo que o exemplo abaixo.
exclude(FromFrames) expressa a mesma coisa de forma mais explícita e é a forma recomendada para novos testes.
public AxeSelenium exclude(List<String> selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
List\<String> |
Um seletor CSS por nível de aninhamento de iFrame, seguido por um seletor CSS para o elemento dentro do iFrame mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Skip .third-party-ad inside the iframe matched by .iframe1
Results results = new AxeSelenium()
.exclude(Arrays.asList(".iframe1", ".third-party-ad"))
.run(driver);exclude(FromFrames)
Remove um elemento dentro de um ou mais iFrames aninhados da varredura, usando um seletor FromFrames explícito.
public AxeSelenium exclude(FromFrames fromFrames);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromFrames |
FromFrames |
Cada seletor, exceto o último, corresponde a um nível de aninhamento de iFrame; o último corresponde ao elemento a ser ignorado dentro do iFrame mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Skip the form inside the #payment-frame iframe
Results results = new AxeSelenium()
.exclude(new FromFrames("#payment-frame", "form"))
.run(driver);exclude(FromShadowDom)
Remove um elemento dentro de uma ou mais árvores de shadow DOM aninhadas da varredura, usando um seletor FromShadowDom explícito.
public AxeSelenium exclude(FromShadowDom fromShadowDom);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromShadowDom |
FromShadowDom |
Cada seletor, exceto o último, corresponde a um host de shadow; o último corresponde ao elemento a ser ignorado dentro do shadow root mais interno. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Skip the #search form inside the shadow root attached to .app-header
Results results = new AxeSelenium()
.exclude(new FromShadowDom(".app-header", "form#search"))
.run(driver);exclude(Object)
Remove uma área da varredura usando um seletor fornecido como um único objeto. O Java seleciona esta sobrecarga apenas quando o tipo estático do argumento não é um dos tipos acima, como uma variável declarada como Object. Prefira as sobrecargas tipadas.
public AxeSelenium exclude(Object selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
Object |
Uma string de seletor CSS, uma lista de strings, um seletor FromFrames, ou um seletor FromShadowDom. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// The selector's type is chosen at runtime, so it's held as Object
Object skip = adInFrame ? new FromFrames("#ad-frame", ".ad") : ".ad";
Results results = new AxeSelenium()
.exclude(skip)
.run(driver);exclude(Object...)
Remove uma área da varredura usando um seletor que combina seletores CSS simples com seletores FromFrames ou FromShadowDom, para casos que as outras sobrecargas não podem expressar. Todos os argumentos juntos formam um caminho único para um elemento; eles não são exclusões separadas.
Esta sobrecarga é selecionada sempre que a chamada passa mais de um argumento. Passar um único FromFrames ou FromShadowDom seleciona exclude(FromFrames) ou exclude(FromShadowDom) em vez disso.
Para alcançar um iFrame que vive dentro de um shadow root, aninhe o seletor FromShadowDom dentro do seletor FromFrames. O inverso não pode ser expresso, pois FromShadowDom aceita apenas strings.
public AxeSelenium exclude(Object... selector);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selector |
Object... |
Um conjunto misto de seletores CSS e objetos de seletor formando um caminho único para o elemento a ser ignorado. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Skip .target inside the shadow root attached to #host, inside the #frame iframe
Results results = new AxeSelenium()
.exclude("#frame", new FromShadowDom("#host", ".target"))
.run(driver);accordingTo(String...)
Executa apenas as regras que possuem pelo menos uma das tags dadas, como wcag2a ou best-practice. Use-o para testar contra parte de um padrão, por exemplo, apenas o WCAG 2.0 Nível A, em vez de um conjunto de regras inteiro.
accordingTo e checkingOnly definem a mesma opção, então apenas a última das duas chamadas terá efeito. Uma segunda chamada accordingTo também substitui as tags da primeira, por isso passe todas as tags em uma única chamada.
public AxeSelenium accordingTo(String... tags);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
tags |
String... |
Uma ou mais tags axe-core. Veja Descrições de Regras para as tags em cada regra. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Run only the WCAG 2.0 Level A and Section 508 rules
Results results = new AxeSelenium()
.accordingTo("wcag2a", "section508")
.run(driver);checkingOnly(String...)
Executa apenas as regras nomeadas e nenhuma outra. Use-o para focar um teste em uma ou duas regras, por exemplo, ao solucionar um problema específico.
checkingOnly e accordingTo definem a mesma opção, então apenas a última das duas chamadas terá efeito. Uma segunda chamada de checkingOnly também substitui as regras da primeira, por isso passe todos os IDs das regras em uma única chamada.
public AxeSelenium checkingOnly(String... rules);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rules |
String... |
Um ou mais IDs de regras do axe-core. Veja Descrições de Regras. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Run only the label and color-contrast rules
Results results = new AxeSelenium()
.checkingOnly("label", "color-contrast")
.run(driver);checking(String...)
Ativa as regras nomeadas além das regras já selecionadas pelo conjunto de regras ou por accordingTo. Use isso para adicionar uma regra que as tags ou o conjunto de regras selecionado deixam de fora, como uma regra best-practice.
checking e skipping definem a mesma opção, então apenas a última das duas chamadas terá efeito, e uma segunda chamada de checking substitui as regras da primeira. Passe todos os IDs das regras em uma única chamada e não combine checking com skipping na mesma verificação.
public AxeSelenium checking(String... rules);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rules |
String... |
Um ou mais IDs de regras do axe-core. Veja Descrições de Regras. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Run the WCAG 2.0 Level A rules, plus the tabindex best-practice rule
Results results = new AxeSelenium()
.accordingTo("wcag2a")
.checking("tabindex")
.run(driver);skipping(String...)
Desativa as regras nomeadas, mantendo o restante do conjunto de regras ou tags escolhido. Use isso para desativar completamente uma regra; para retirar a violação de um elemento e manter os outros resultados da regra, use ignoring em vez disso.
skipping e checking definem a mesma opção, então apenas a última das duas chamadas terá efeito, e uma segunda chamada de skipping substitui as regras da primeira. Passe todos os IDs das regras em uma única chamada e não combine skipping com checking na mesma verificação.
public AxeSelenium skipping(String... rules);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rules |
String... |
Um ou mais IDs de regras do axe-core. Veja Descrições de Regras. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Run the default ruleset without the color-contrast and image-alt rules
Results results = new AxeSelenium()
.skipping("color-contrast", "image-alt")
.run(driver);forConfig(URL)
Seleciona o conjunto de auditoria (um arquivo de configuração de regras JSON) para escanear, pelo URL. Isso define o conjunto de auditoria global em AxeConfiguration, então também se aplica a todas as verificações AxeSelenium posteriores, não apenas a esta.
Quando nenhum conjunto de auditoria está definido, o Axe DevTools usa o arquivo nomeado pela variável de ambiente AXE_RULESET_PATH ou, se não estiver definida, um recurso config/axe-ruleset.json no classpath.
public AxeSelenium forConfig(URL auditConfigPath);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
auditConfigPath |
URL |
URL do arquivo de conjunto de auditoria. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
URL auditSuite = getClass().getResource("/config/my-audit-suite.json");
Results results = new AxeSelenium()
.forConfig(auditSuite)
.run(driver);forConfig(String)
Seleciona o conjunto de auditoria para escanear, pelo seu caminho no sistema de arquivos. Como forConfig(URL), ele configura o conjunto de auditoria global, então também se aplica a verificações posteriores.
public AxeSelenium forConfig(String auditConfigPath) throws MalformedURLException;Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
auditConfigPath |
String |
Caminho no sistema de arquivos do arquivo de conjunto de auditoria. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exceções
MalformedURLException se o caminho não puder ser convertido em um URL.
Exemplo
Results results = new AxeSelenium()
.forConfig("/opt/axe/my-audit-suite.json")
.run(driver);AxeSelenium.forRuleset(String)
Seleciona o conjunto de regras para escanear, como wcag2.2 ou 508, com as regras de melhores práticas desativadas. O conjunto de regras padrão é o wcag2.1. Se um conjunto de auditoria também estiver configurado, ele modifica o conjunto de regras selecionado.
Isso define o conjunto de regras global em AxeConfiguration, então também se aplica a todas as verificações posteriores. Veja AxeConfiguration.forRuleset(String) para a lista de IDs de conjuntos de regras.
public AxeSelenium forRuleset(String rulesetId);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rulesetId |
String |
ID do conjunto de regras. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.forRuleset("wcag2.2")
.run(driver);AxeSelenium.forRuleset(String, boolean)
Seleciona o conjunto de regras para escanear e se também deve executar as regras de melhores práticas. Caso contrário, se comporta como AxeSelenium.forRuleset(String), incluindo definir o conjunto de regras globalmente.
public AxeSelenium forRuleset(String rulesetId, boolean enableBestPractices);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rulesetId |
String |
ID do conjunto de regras. |
enableBestPractices |
boolean |
true para também executar regras de melhores práticas. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// WCAG 2.1 rules plus best-practice rules
Results results = new AxeSelenium()
.forRuleset("wcag2.1", true)
.run(driver);AxeSelenium.ignoring(String, String)
Remove as violações de uma regra dos resultados após a verificação quando essa regra falha em um determinado elemento. A regra ainda é executada e ainda relata seus sucessos. Uma chamada por regra é suficiente, porque uma correspondência remove toda a entrada da regra. Não o chame duas vezes para a mesma regra: se ambos os seletores corresponderem a elementos falhos, a verificação gera um IllegalStateException.
A filtragem funciona em regras inteiras: se algum elemento que falha na regra corresponder ao seletor, toda a entrada da regra é removida das violações, incluindo falhas em outros elementos. Para mantê-los, reduza a verificação com exclude em vez disso.
O seletor deve corresponder exatamente ao target do elemento nos resultados, escrito da maneira como o Java imprime uma lista: o seletor de destino entre colchetes, como "[#sidebar]", ou "[#frame, .ad]" para um elemento dentro de um iFrame. Copie dos resultados de uma verificação anterior em vez de escrevê-lo manualmente.
public AxeSelenium ignoring(String attestSelector, String ruleId);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
attestSelector |
String |
O target do elemento, conforme aparece nos resultados. |
ruleId |
String |
ID da regra cuja violação ignorar. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Ignore the known color-contrast violation on the sidebar
Results results = new AxeSelenium()
.ignoring("[#sidebar]", "color-contrast")
.run(driver);disableIframeTesting()
Impede que o Axe DevTools injete axe-core em iFrames e colete resultados deles, portanto, apenas o documento de nível superior é testado. Use-o quando o conteúdo do iFrame estiver fora do seu controle ou quando a injeção nos iFrames causar erros.
public AxeSelenium disableIframeTesting();Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.disableIframeTesting()
.run(driver);setTimeout(int)
Define por quanto tempo, em segundos, o axe-core pode analisar a página antes que a verificação falhe por timeout. O padrão é 30 segundos. Aumente-o para páginas muito grandes.
public AxeSelenium setTimeout(int timeout);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
timeout |
int |
O timeout, em segundos. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.setTimeout(120)
.run(driver);logResults(AxeReportingOptions)
Escreve um relatório desta verificação quando run é concluído: um arquivo .log listando as violações e um arquivo .json com os resultados completos. Os nomes e a localização dos arquivos vêm de reportingOptions; veja AxeReportingOptions. Sem esta chamada, nenhum arquivo de relatório é gerado.
Se reportingOptions não tem número de linha definido, o Axe DevTools registra a linha do seu teste que chamou logResults.
public AxeSelenium logResults(AxeReportingOptions reportingOptions);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
reportingOptions |
AxeReportingOptions |
Onde escrever o relatório e como descrever o teste nele. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
// Writes axe-reports/checkout-page-loaded.log and .json
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("page-loaded")
.outputDirectory("axe-reports");
Results results = new AxeSelenium()
.logResults(options)
.run(driver);loggingConfigured()
Relata se logResults foi chamado neste AxeSelenium.
public boolean loggingConfigured();Retornos
true se as opções de relatório foram definidas.
enableTracking(boolean)
Liga ou desliga o serviço de uso para este AxeSelenium. O serviço de uso está ligado por padrão. Quando a variável de ambiente AXE_TRACK_USAGE está definida, ela tem precedência e este método não tem efeito: true liga o serviço e qualquer outro valor o desliga.
public AxeSelenium enableTracking(boolean state);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
state |
boolean |
true para enviar dados de uso, false para parar de enviá-los. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.enableTracking(false)
.run(driver);trackingEnabled()
Informa se este AxeSelenium envia dados de uso.
public boolean trackingEnabled();Retornos
true se o serviço de uso estiver ativado.
setTrackingUrl(String)
Define o URL para o qual os dados de uso são enviados. O padrão é a variável de ambiente AXE_METRICS_URL, ou https://usage.deque.com quando essa não está definida. Quando AXE_METRICS_URL está definido, este método não tem efeito.
public AxeSelenium setTrackingUrl(String url);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
url |
String |
URL do serviço de uso. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.setTrackingUrl("https://usage.example.com")
.run(driver);setDistinctId(String)
Define o ID distinto enviado com os dados de uso, o que permite que o serviço de uso agrupe os eventos de um usuário ou máquina. O ID é salvo em ~/.deque/distinct_id, então execuções posteriores na mesma máquina continuam a usá-lo. Quando o ID veio da variável de ambiente AXE_DISTINCT_ID, este método não tem efeito.
public AxeSelenium setDistinctId(String id);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
id |
String |
O ID distinto. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.setDistinctId("build-agent-7")
.run(driver);setAnalyticsComponentName(String)
Define o nome do projeto enviado com os dados de uso. Isso também redefine quaisquer chamadas anteriores de setTrackingUrl e enableTracking neste AxeSelenium para seus padrões, então chame isso antes desses métodos. Um ID distinto definido com setDistinctId é mantido.
public AxeSelenium setAnalyticsComponentName(String name);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
name |
String |
O nome do projeto. |
Retornos
Este AxeSelenium, para encadeamento de métodos.
Exemplo
Results results = new AxeSelenium()
.setAnalyticsComponentName("storefront-tests")
.setDistinctId("build-agent-7")
.run(driver);com.deque.html.axecore.args.FromFrames
Um seletor que visa um elemento dentro de um ou mais iFrames aninhados. Passe-o para include ou exclude em AxeSelenium.
import com.deque.html.axecore.args.FromFrames;FromFrames(Object...)
Cria um seletor FromFrames a partir de um caminho através de iFrames aninhados até um elemento.
public FromFrames(Object... selectors);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selectors |
Object... |
Um seletor por nível de aninhamento de iFrame, seguido por um seletor para o elemento dentro do iFrame mais interno. Cada entrada é uma string de seletor CSS, ou um seletor FromShadowDom quando o próprio iFrame reside dentro de um shadow root. |
Exemplo
// The form inside #inner-frame, which is inside #outer-frame
FromFrames checkoutForm = new FromFrames("#outer-frame", "#inner-frame", "form");
// The main element inside an iframe that lives in the shadow root attached to #widget
FromFrames widgetFrame = new FromFrames(new FromShadowDom("#widget", "iframe"), "main");getFromFrames()
Retorna os seletores que compõem o caminho através dos iFrames aninhados.
public List<Object> getFromFrames();Retornos
Os seletores, como um List\<Object>.
setFromFrames(Object...)
Substitui os seletores que compõem o caminho através dos iFrames aninhados.
public void setFromFrames(Object... fromFrames);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromFrames |
Object... |
O novo caminho, na mesma forma que o construtor toma. |
Exemplo
FromFrames selector = new FromFrames("#frame", "form");
selector.setFromFrames("#frame", "nav");com.deque.html.axecore.args.FromShadowDom
Um seletor que visa um elemento dentro de uma ou mais árvores de shadow DOM aninhadas. Passe-o para include ou exclude em AxeSelenium.
import com.deque.html.axecore.args.FromShadowDom;FromShadowDom(String...)
Cria um seletor FromShadowDom a partir de um caminho através de raízes de shadow aninhadas até um elemento.
public FromShadowDom(String... selectors);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
selectors |
String... |
Um seletor por host sombra, seguido por um seletor para o elemento dentro da raiz sombra mais interna. |
Exemplo
// The button inside the shadow root of .dialog, which is inside the shadow root of app-shell
FromShadowDom closeButton = new FromShadowDom("app-shell", ".dialog", "button.close");getFromShadowDom()
Retorna os seletores que compõem o caminho através das raízes sombras aninhadas.
public List<String> getFromShadowDom();Retornos
Os seletores, como um List\<String>.
setFromShadowDom(String...)
Substitui os seletores que compõem o caminho através das raízes sombras aninhadas.
public void setFromShadowDom(String... fromShadowDom);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
fromShadowDom |
String... |
O novo caminho, na mesma forma que o construtor toma. |
Exemplo
FromShadowDom selector = new FromShadowDom("app-shell", "nav");
selector.setFromShadowDom("app-shell", "footer");com.deque.html.axedevtools.selenium.AxeDriver
Envolve um Selenium WebDriver para que o Axe DevTools possa injetar axe-core na página que ele controla. Cada varredura AxeSelenium, e cada matcher Hamcrest, recebe um AxeDriver. Continue usando seu WebDriver para navegar e interagir com a página.
AxeDriver(WebDriver)
Cria um AxeDriver para um Selenium WebDriver.
public AxeDriver(WebDriver webDriver);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
webDriver |
WebDriver |
O Selenium WebDriver controla a página a ser verificada. |
Exemplo
WebDriver webDriver = new ChromeDriver();
AxeDriver driver = new AxeDriver(webDriver);
webDriver.get("https://example.com");
Results results = new AxeSelenium().run(driver);com.deque.html.axedevtools.selenium.AxeConfiguration
Mantém configurações que se aplicam a cada varredura na execução do teste: o script axe-core, a suíte de auditoria, o conjunto de regras e os padrões usados nos relatórios. Há uma instância compartilhada, que você obtém com AxeConfiguration.configure(). Configure-a uma vez, antes de executar quaisquer testes.
Os métodos em AxeSelenium, como forRuleset e forConfig, também alteram essa instância compartilhada.
// Code runs once before any tests are run
public void setupOnce() {
AxeConfiguration.configure()
.withAxeScript(axeURL)
.forAuditSuite(auditURL)
.forRuleset("508")
.outputDirectory("my-axe-results");
}configure()
Retorna a instância compartilhada AxeConfiguration. Este método estático é a única maneira de obter um AxeConfiguration.
public static AxeConfiguration configure();Retornos
O compartilhado AxeConfiguration.
Exemplo
AxeConfiguration config = AxeConfiguration.configure();reset()
Substitui a configuração compartilhada por uma nova que tem configurações padrão. Use-a entre classes de teste que precisam de diferentes configurações globais. Um AxeConfiguration que você obteve antes de chamar reset mantém suas configurações antigas, então, chame configure() novamente depois.
public static void reset();Exemplo
@AfterClass
public static void tearDown() {
AxeConfiguration.reset();
}forAuditSuite(URL)
Seleciona a suíte de auditoria (um arquivo de configuração de regras JSON) para cada varredura, por URL. Quando nenhuma suíte de auditoria é definida, o Axe DevTools usa o arquivo nomeado pela variável de ambiente AXE_RULESET_PATH ou, se isso não estiver definido, um recurso config/axe-ruleset.json no classpath.
public AxeConfiguration forAuditSuite(URL auditConfigPath);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
auditConfigPath |
URL |
URL do arquivo de conjunto de auditoria. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure()
.forAuditSuite(getClass().getResource("/config/my-audit-suite.json"));forAuditSuite(String)
Seleciona a suíte de auditoria para cada varredura, pelo seu caminho no sistema de arquivos.
public AxeConfiguration forAuditSuite(String auditConfigPath) throws MalformedURLException;Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
auditConfigPath |
String |
Caminho no sistema de arquivos do arquivo de conjunto de auditoria. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exceções
MalformedURLException se o caminho não puder ser convertido em um URL.
Exemplo
AxeConfiguration.configure()
.forAuditSuite("/opt/axe/my-audit-suite.json");withAxeScript(URL)
Seleciona o script axe-core a ser injetado na página, em vez do que vem junto com o Axe DevTools. Use-o para fixar uma build específica do axe-core.
public AxeConfiguration withAxeScript(URL axeScript);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
axeScript |
URL |
A URL do script axe-core. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure()
.withAxeScript(getClass().getResource("/axe.min.js"));AxeConfiguration.forRuleset(String)
Seleciona o conjunto de regras para cada varredura, com as regras de melhores práticas desativadas. O conjunto de regras padrão é wcag2.1.
public AxeConfiguration forRuleset(String rulesetId);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rulesetId |
String |
Um dos IDs do conjunto de regras abaixo. |
Os IDs do conjunto de regras são:
wcag2wcag2.1wcag2.2wcag2aaawcag2.1aaawcag2.2aaa508ttv5en301549rgaav4
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().forRuleset("wcag2.2");AxeConfiguration.forRuleset(String, boolean)
Seleciona o conjunto de regras para cada varredura, e se também deve executar regras de melhores práticas.
public AxeConfiguration forRuleset(String rulesetId, boolean enableBestPractices);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
rulesetId |
String |
Veja AxeConfiguration.forRuleset(String) para os IDs do conjunto de regras. |
enableBestPractices |
boolean |
true para também executar regras de melhores práticas. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().forRuleset("508", true);getTestSuiteName()
Retorna o nome padrão da suíte de testes usado nos relatórios. O padrão é axe-run.
public String getTestSuiteName();AxeConfiguration.testSuiteName(String)
Define o nome padrão da suíte de testes usado nos nomes de arquivos e conteúdos dos relatórios. Um valor AxeReportingOptions.testSuiteName(String) o substitui para um relatório.
public AxeConfiguration testSuiteName(String testSuiteName);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
testSuiteName |
String |
O nome da suíte de testes. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().testSuiteName("storefront");AxeConfiguration.getOutputDirectory()
Retorna o diretório padrão onde os relatórios são gravados. O padrão é axe-reports.
public String getOutputDirectory();AxeConfiguration.outputDirectory(String)
Define o diretório padrão onde os relatórios são gravados. Diretórios ausentes são criados quando um relatório é gravado. Um valor AxeReportingOptions.outputDirectory(String) o substitui para um relatório.
public AxeConfiguration outputDirectory(String outputDirectory);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
outputDirectory |
String |
O caminho do diretório. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().outputDirectory("target/axe-reports");AxeConfiguration.getUserAgent()
Retorna o agente de usuário padrão registrado nos relatórios, ou null se nenhum estiver definido.
public String getUserAgent();AxeConfiguration.userAgent(String)
Define o agente de usuário padrão registrado nos relatórios. É apenas um rótulo e não altera o agente de usuário que o navegador envia. Um valor AxeReportingOptions.userAgent(String) o substitui para um relatório.
public AxeConfiguration userAgent(String userAgent);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
userAgent |
String |
O agente de usuário a ser registrado. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().userAgent("Chrome 130 headless");AxeConfiguration.getTestMachine()
Retorna o nome da máquina de teste padrão registrado nos relatórios, ou null se nenhum estiver definido.
public String getTestMachine();AxeConfiguration.testMachine(String)
Define o nome da máquina de teste padrão registrado nos relatórios. Um valor AxeReportingOptions.testMachine(String) o substitui para um relatório.
public AxeConfiguration testMachine(String testMachine);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
testMachine |
String |
O nome da máquina de teste. |
Retornos
Este AxeConfiguration, para encadeamento de métodos.
Exemplo
AxeConfiguration.configure().testMachine(System.getenv("HOSTNAME"));com.deque.html.axedevtools.selenium.reporter.AxeReportingOptions
Descreve um relatório: onde escrevê-lo, e a suíte de testes, estado da UI, agente de usuário, máquina de teste e número de linha a serem registrados nele. Passe-o para logResults. Ele implementa ReportingOptions.
Qualquer valor que você não definir recai para a configuração AxeConfiguration correspondente. Os arquivos de relatório são nomeados <test suite name>-<UI state>.log e .json, então, dê a cada verificação em uma suíte de testes seu próprio estado de UI, ou o relatório posterior sobrescreve o anterior.
AxeReportingOptions()
Cria um AxeReportingOptions sem valores definidos, então, cada valor vem de AxeConfiguration até que você o defina. O estado de UI não tem um padrão e deve ser definido antes que um relatório seja gravado.
public AxeReportingOptions();Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.uiState("home-page");defaultAuditReportingOptions()
Retorna novas opções com o diretório de saída target/axe-report, nome da suíte de testes accessibility e estado da UI check, assim o relatório é gravado em target/axe-report/accessibility-check.log e .json. Estas são as opções que o matcher Hamcrest isAuditedForAccessibility() usa quando você não chama logResults.
public static AxeReportingOptions defaultAuditReportingOptions();Retornos
Um novo AxeReportingOptions.
Exemplo
Results results = new AxeSelenium()
.logResults(AxeReportingOptions.defaultAuditReportingOptions())
.run(driver);getSuiteTestName()
Retorna o nome da suíte de testes para este relatório, ou o padrão AxeConfiguration se nenhum estiver definido.
public String getSuiteTestName();AxeReportingOptions.testSuiteName(String)
Define o nome da suíte de testes para este relatório. É a primeira parte dos nomes dos arquivos de relatório.
public AxeReportingOptions testSuiteName(String testSuiteName);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
testSuiteName |
String |
O nome da suíte de testes. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("payment-step");getUiState()
Retorna o estado da UI para este relatório.
public String getUiState();Exceções
MissingUIStateException se nenhum estado da UI tiver sido definido.
uiState(String)
Define o estado da UI para este relatório: um nome curto para como a página estava quando foi verificada, como menu-open ou form-errors. É a segunda parte dos nomes dos arquivos de relatório, e é obrigatório: escrever um relatório sem ele lança MissingUIStateException.
public AxeReportingOptions uiState(String uiState);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
uiState |
String |
O nome do estado da UI. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
webDriver.findElement(By.id("menu-button")).click();
Results results = new AxeSelenium()
.logResults(new AxeReportingOptions().uiState("menu-open"))
.run(driver);AxeReportingOptions.getOutputDirectory()
Retorna o diretório para o qual este relatório é gravado, ou o padrão AxeConfiguration se nenhum estiver definido.
public String getOutputDirectory();AxeReportingOptions.outputDirectory(String)
Define o diretório para o qual este relatório é gravado. Diretórios ausentes são criados quando o relatório é gravado.
public AxeReportingOptions outputDirectory(String outputDirectory);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
outputDirectory |
String |
O caminho do diretório. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.outputDirectory("target/axe-reports/checkout")
.uiState("cart");getFileName()
Retorna o nome do arquivo de relatório sem extensão: o nome da suíte de testes e o estado da UI unidos por um hífen, seguidos por um timestamp se useUniqueFilename estiver ativado.
public String getFileName();getFilePath(String)
Retorna o caminho completo de um arquivo de relatório: o diretório de saída, um /, o nome do arquivo, e extension.
public String getFilePath(String extension);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
extension |
String |
A extensão do arquivo, incluindo o ponto inicial, tal como .json. |
Retornos
O caminho do arquivo.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("checkout")
.uiState("cart")
.outputDirectory("axe-reports");
String jsonPath = options.getFilePath(".json"); // axe-reports/checkout-cart.jsonuseUniqueFilename(boolean)
Adiciona um carimbo de data/hora UTC aos nomes dos arquivos de relatório, para que a execução do mesmo teste novamente escreva novos arquivos em vez de sobrescrever o relatório anterior.
Este método retorna a interface ReportingOptions em vez de AxeReportingOptions, então chame-o como uma declaração separada, como no exemplo, em vez de em uma cadeia que você atribui a um AxeReportingOptions ou passa para logResults. Os nomes de arquivo .log e .json são construídos separadamente, por isso seus carimbos de data/hora podem diferir ligeiramente.
public ReportingOptions useUniqueFilename(boolean uniqueFilename);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
uniqueFilename |
boolean |
true para adicionar um carimbo de data/hora aos nomes dos arquivos. |
Retornos
Este objeto, digitado como ReportingOptions.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.testSuiteName("nightly")
.uiState("home");
options.useUniqueFilename(true);AxeReportingOptions.getUserAgent()
Retorna o agente de usuário registrado neste relatório, ou o padrão AxeConfiguration se nenhum for definido.
public String getUserAgent();AxeReportingOptions.userAgent(String)
Define o agente de usuário registrado neste relatório. É apenas um rótulo e não altera o agente de usuário que o navegador envia.
public AxeReportingOptions userAgent(String userAgent);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
userAgent |
String |
O agente de usuário a ser registrado. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
String userAgent = (String) ((JavascriptExecutor) webDriver).executeScript("return navigator.userAgent");
AxeReportingOptions options = new AxeReportingOptions()
.userAgent(userAgent)
.uiState("home");AxeReportingOptions.getTestMachine()
Retorna o nome da máquina de teste registrado neste relatório, ou o padrão AxeConfiguration se nenhum for definido.
public String getTestMachine();AxeReportingOptions.testMachine(String)
Define o nome da máquina de teste registrado neste relatório.
public AxeReportingOptions testMachine(String testMachine);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
testMachine |
String |
O nome da máquina de teste. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.testMachine("ci-linux-04")
.uiState("home");getLineNum()
Retorna o número da linha de teste registrado neste relatório, ou null se nenhum for definido.
public String getLineNum();lineNum(String)
Define o número da linha de teste registrado neste relatório, substituindo qualquer valor já definido. Você raramente precisa dele: logResults registra automaticamente a linha de chamada quando nenhum número de linha está definido.
public AxeReportingOptions lineNum(String lineNum);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
lineNum |
String |
O número da linha. |
Retornos
Este AxeReportingOptions, para encadeamento de métodos.
Exemplo
AxeReportingOptions options = new AxeReportingOptions()
.lineNum("42")
.uiState("home");lineNumIfEmpty(String)
Define o número da linha de teste apenas se nenhum estiver definido ainda. logResults o usa para registrar a linha de chamada sem sobrescrever um valor que você definiu com lineNum.
Este método retorna a interface ReportingOptions em vez de AxeReportingOptions, então chame-o como uma declaração separada em vez de em uma cadeia que você atribui a um AxeReportingOptions ou passa para logResults.
public ReportingOptions lineNumIfEmpty(String lineNum);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
lineNum |
String |
O número da linha. |
Retornos
Este objeto, digitado como ReportingOptions.
com.deque.html.axedevtools.selenium.reporter.MissingUIStateException
Um RuntimeException lançado quando um relatório é escrito com opções de relatório que não têm estado de UI, com a mensagem "Por favor, forneça o estado de UI da página atual sob teste". Para evitá-lo, chame uiState em cada AxeReportingOptions que você passar para logResults.
com.deque.html.axedevtools.selenium.results.ResultsFilter
Contém os pares de elemento e regra a serem removidos dos resultados. Cada AxeSelenium cria seu próprio ResultsFilter, que você adiciona com AxeSelenium.ignoring(String, String) em vez de criar um você mesmo. Você também pode usar um ResultsFilter diretamente para filtrar um objeto Results que você já possui.
filterIgnoredViolations(Results)
Remove as violações ignoradas de results. A entrada inteira de uma regra é removida das violações quando o ID da regra coincide e qualquer um dos seus nós tem um target igual a um seletor ignorado, mesmo que outros nós não coincidam. O objeto Results que você passa é modificado e retornado.
public Results filterIgnoredViolations(Results results);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
results |
Results |
Os resultados a serem filtrados. |
Retornos
O mesmo objeto Results, com as violações ignoradas removidas.
Exemplo
Results results = new AxeSelenium().run(driver);
new ResultsFilter()
.ignoring("[#legacy-widget]", "aria-allowed-attr")
.filterIgnoredViolations(results);ResultsFilter.ignoring(String, String)
Adiciona um par de elemento e regra a serem ignorados. O seletor deve corresponder exatamente ao target de um nó, na forma "[#sidebar]"; veja AxeSelenium.ignoring(String, String).
public ResultsFilter ignoring(String cssSelector, String ruleId);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
cssSelector |
String |
O target do elemento, conforme aparece nos resultados. |
ruleId |
String |
ID da regra cuja violação ignorar. |
Retornos
Este ResultsFilter, para encadeamento de métodos.
Exemplo
ResultsFilter filter = new ResultsFilter()
.ignoring("[#sidebar]", "color-contrast")
.ignoring("[.third-party-iframe]", "frame-title");com.deque.html.axedevtools.reporter.AxeDevtoolsReporter
Escreve os arquivos de relatório .log e .json para uma verificação. AxeSelenium e os matchers Hamcrest o usam para você quando você chama logResults; use-o diretamente apenas para relatar em Results que você já possui.
AxeDevtoolsReporter()
Cria um AxeDevtoolsReporter.
public AxeDevtoolsReporter();Exemplo
AxeDevtoolsReporter reporter = new AxeDevtoolsReporter();generateReport(Results, String)
Retorna um resumo em texto simples das violações em results: o texto de ajuda e o URL de cada regra, o alvo de cada nó afetado e as verificações para corrigir, seguido do comando que produziu os resultados. Este é o texto escrito no arquivo .log, e o texto que o matcher Hamcrest isAxeClean() mostra quando uma asserção falha.
public String generateReport(Results results, String executedCommand);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
results |
Results |
Os resultados da verificação. |
executedCommand |
String |
O texto do comando a ser incluído no relatório, por exemplo, de runCommand(). |
Retornos
O texto do relatório.
Exemplo
AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);
String report = new AxeDevtoolsReporter().generateReport(results, axe.runCommand());
System.out.println(report);report(ReportingOptions, Results, String)
Escreve o relatório para results em dois arquivos no caminho dado por reportingOptions: um arquivo .log com o texto generateReport e um arquivo .json com os resultados completos. Se reportingOptions for null, nada é escrito.
public void report(ReportingOptions reportingOptions, Results results, String executedCommand);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
reportingOptions |
ReportingOptions |
Onde escrever o relatório, geralmente um AxeReportingOptions. |
results |
Results |
Os resultados da verificação. |
executedCommand |
String |
O comando que produziu os resultados. |
Exceções
MissingUIStateException se reportingOptions não tem estado de UI, ou um RuntimeException se os arquivos não puderem ser escritos.
Exemplo
AxeSelenium axe = new AxeSelenium();
Results results = axe.run(driver);
new AxeDevtoolsReporter().report(
new AxeReportingOptions().uiState("after-login"),
results,
axe.runCommand());com.deque.html.axedevtools.utils.FileUtils
Auxiliares de arquivos que o Axe DevTools usa internamente para ler e escrever arquivos de relatório. Não é destinado ao uso em seus testes.
