Referência da API para Cucumber
Referência da API para a classe AxeWorld no Axe DevTools para Web Java
Este documento é uma referência para a classe AxeWorld no pacote com.deque.html.axedevtools.cucumber. Ao contrário dos pacotes Selenium e Hamcrest, o pacote Cucumber não possui uma classe builder ou matcher para configuração de escopo e regras. Essas opções são expressas diretamente no texto dos passos Gherkin, conforme descrito em Escrever Testes Cucumber. A classe AxeWorld mantém apenas o estado e a configuração que os passos Gherkin não conseguem expressar, como a página a ser verificada, configurações de análise, opções de relatórios personalizados e o tempo limite do axe-core.
com.deque.html.axedevtools.cucumber.AxeWorld
Mantém a página e a configuração utilizadas pelo passos de acessibilidade do Cucumber ao verificar a acessibilidade. Seu framework de injeção de dependências cria o AxeWorld (PicoContainer, por exemplo, cria um por cenário) e o passa para suas definições de passos e os passos do Axe DevTools, de modo que qualquer coisa que você definir nele em um gancho @Before ou em um passo anterior se aplicará aos passos de acessibilidade no mesmo cenário.
As configurações são lidas toda vez que um passo de acessibilidade é executado. Nada é verificado ou enviado quando você chama os setters.
public StepDefinitions(AxeWorld axeWorld) {
this.axeWorld = axeWorld;
}
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}AxeWorld()
Cria um AxeWorld sem página e sem configuração. Normalmente você não o chama diretamente: declare um parâmetro AxeWorld no construtor da classe de definição do seu passo, e seu framework de injeção de dependências criará e compartilhará a instância.
public AxeWorld();getPage()
Retorna a página que os passos de acessibilidade verificam, ou null se setPage não foi chamado.
public AxeDriver getPage();Retornos
O AxeDriver definido neste mundo.
setPage(AxeDriver)
Define a página que os passos de acessibilidade verificam. Chame isso antes de qualquer passo de acessibilidade ser executado, geralmente em um gancho @Before. Os passos verificam qualquer página que o WebDriver encapsulado esteja mostrando quando o passo é executado, então navegue com seu WebDriver em passos anteriores, como de costume.
public void setPage(AxeDriver page);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
page |
AxeDriver |
A página a ser verificada, encapsulando seu Selenium WebDriver. |
Exemplo
@Before
public void setup() {
webDriver = new ChromeDriver();
axeWorld.setPage(new AxeDriver(webDriver));
}enableAnalytics(boolean)
Ativa ou desativa o serviço de uso para os passos de acessibilidade. Quando você não o chama, o serviço de uso está ativado. Quando a variável de ambiente AXE_TRACK_USAGE é definida, ela tem precedência e este método não tem efeito: true ativa o serviço e qualquer outro valor o desativa.
public void enableAnalytics(boolean state);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
state |
boolean |
true para enviar dados de uso, false para parar de enviá-los. |
Exemplo
@Before
public void setup() {
axeWorld.enableAnalytics(false);
}setAnalyticsUrl(String)
Define a URL para a 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 esta não for definida. Quando AXE_METRICS_URL é definida, este método não tem efeito.
public void setAnalyticsUrl(String url);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
url |
String |
A URL do serviço de uso. |
Exemplo
axeWorld.setAnalyticsUrl("https://usage.example.com");setAnalyticsDistinctId(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, de modo que execuções posteriores na mesma máquina continuam a utilizá-lo. Quando o ID vem da variável de ambiente AXE_DISTINCT_ID, este método não tem efeito.
public void setAnalyticsDistinctId(String did);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
did |
String |
O ID distinto. |
Exemplo
axeWorld.setAnalyticsDistinctId(System.getenv("CI_RUNNER_ID"));setAnalyticsComponentName(String)
Define o nome do projeto enviado com os dados de uso.
Os passos de acessibilidade aplicam o nome do componente após as outras configurações de análise, e defini-lo redefine a URL e o valor enableAnalytics para seus padrões. Portanto, quando você define um nome de componente, qualquer valor setAnalyticsUrl ou enableAnalytics no mesmo AxeWorld não tem efeito. Um valor setAnalyticsDistinctId é mantido, pois o ID distinto é salvo em um arquivo.
public void setAnalyticsComponentName(String name);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
name |
String |
O nome do projeto. |
Exemplo
axeWorld.setAnalyticsComponentName("storefront-features");setReportingOptions(AxeReportingOptions)
Define onde o passo Then the page should be audited for accessibility escreve seu relatório e como descreve o teste. Sem isso, aquele passo escreve em target/axe-report/accessibility-check.log e .json. Veja AxeReportingOptions para as opções. As opções que você passa substituem completamente os padrões: qualquer valor que você não definir recai para AxeConfiguration (os relatórios vão para axe-reports a menos que você defina outputDirectory), e você deve definir uiState.
Isso não tem efeito sobre o passo Then the page should be axe clean, que não escreve um relatório.
public void setReportingOptions(AxeReportingOptions reportingOptions);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
reportingOptions |
AxeReportingOptions |
As opções de relatório a serem utilizadas. |
Exemplo
@Before
public void setup(Scenario scenario) {
axeWorld.setReportingOptions(new AxeReportingOptions()
.outputDirectory("target/axe-report")
.testSuiteName("checkout")
.uiState(scenario.getName().replaceAll("\\W+", "-")));
}setTimeout(int)
Define por quanto tempo, em segundos, o axe-core pode analisar a página antes que o passo falhe por tempo esgotado. O padrão é 30 segundos. Aumente para páginas muito grandes.
public void setTimeout(int timeout);Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
timeout |
int |
O tempo limite, em segundos. |
Exemplo
axeWorld.setTimeout(120);