Gerar Relatórios com Java

Este guia detalha como adicionar o Axe DevTools reporter ao seu projeto de teste que já utiliza o Axe DevTools para Web.

Pré-requisitos

A integração do reporter requer uma configuração de teste em execução do Axe DevTools para Web. Se você ainda não está obtendo resultados de varredura do Axe DevTools para Web, leia o guia sobre como configurar o Axe DevTools com Java.

Você também precisa obter o executável do reporter, que pode ser baixado em Reporter Binário na página de Downloads. Certifique-se de ver a seção Preparando Binários após o Download.

Configurando o Reporter

Para usar o reporter, ele deve ser importado em sua própria instrução. Substitua <binding> por selenium, hamcrest ou cucumber, dependendo de qual pacote você utiliza em sua configuração de teste.

import com.deque.html.axedevtools.<binding>.*;
import com.deque.html.axedevtools.<binding>.reporter.*;

Em seguida, algumas instruções de inicialização são necessárias. Substitua <reporter-binary> pelo nome do seu executável do reporter. Veja Pré-requisitos acima para mais informações sobre como obter o executável do reporter. O nome será dependente do sistema operacional.

static String reporter = new File("src/test/resources/<reporter-binary>").getAbsolutePath();

Então, inicialize sua configuração de relatórios

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

E finalmente, especifique o nome da sua suíte de testes e o diretório de saída do arquivo de log

AxeConfiguration.configure()
    .testSuiteName("<suite-name>")
    .outputDirectory("<log-directory-location>");

Escrevendo Testes com o Reporter

Ao realizar varreduras e escrever testes, o registrador salva seus resultados de varredura em um arquivo para que o reporter possa acessá-los e compilá-los. Para cada varredura que você deseja criar um relatório, adicione o método de encadeamento .logResults(). Aqui, você pode nomear seu relatório para referência futura.

.logResults(_reportOptions.uiState("<scan-name>"))

Gerando Relatórios

Finalmente, com o reporter configurado e os resultados registrados, o reporter pode acessar e transformar os resultados. Geralmente, esta etapa é realizada após todas as varreduras em uma suíte de testes terem sido concluídas. Este trecho de código executa o binário do reporter. O reporter aceita três argumentos: a localização dos resultados do registrador configurados no AxeConfiguration, o destino desejado para o(s) relatório(s) finalizado(s), e o formato desejado. Para configurações de teste locais, recomendamos selecionar html. Para uso em CI, a opção xml produz relatórios JUnit xml que são compatíveis com muitos ambientes de CI. Para exportação para outras ferramentas, use csv.

Runtime rt = Runtime.getRuntime();
String command = reporter + " <log-directory-location> <desired-destination> --format <desired-format>";
rt.exec(command);

Solução de Problemas

Se os problemas com o reporter persistirem, entre em contato diretamente com seu representante Deque, acesse-nos através do nosso suporte técnico, ou envie-nos um e-mail. Ficaremos felizes em ajudar.

Veja Também

• Enviando Resultados de Acessibilidade JSON para o axe Reports descreve como enviar seus resultados para o axe Reports.
• Obtendo uma Chave de API do axe Reports explica como obter uma chave de API para começar a usar o axe Reports.
• Criando e Filtrando Relatórios mostra como você pode criar relatórios de acessibilidade em CSV, XML ou HTML a partir dos seus resultados de acessibilidade em JSON. Você também pode filtrar sua saída por gravidade usando esta ferramenta.
• Como Resultados JSON são Armazenados no Disco descreve as convenções de nomenclatura de arquivos para resultados de acessibilidade em JSON.
• Usando a CLI para Enviar Resultados de Acessibilidade para o axe Developer Hub mostra como você pode enviar seus arquivos de resultados .json para axe Developer Hub.