Generar informes con Java

Esta guía detalla cómo agregar el generador de informes de axe DevTools a su proyecto de prueba que ya aprovecha axe DevTools for Web.

Prerrequisitos

Para integrar el generador de informes es necesario tener en ejecución axe DevTools for Web para la configuración de pruebas. Si aún no obtiene los resultados del escaneo de axe DevTools for Web, lea la guía sobre cómo configurar axe DevTools con Java.

También es necesario obtener el ejecutable del generador de informes, que se puede descargar desde Binary Reporter en la página de Descargas. Asegúrese de consultar la sección Preparación de binarios después de la descarga.

Configuración del Generador de informes

Para utilizar el reportero, éste debe importarse en su propia declaración. Reemplazar <binding> con Selenium, hamcrest o cucumber , dependiendo del paquete que utilice en su configuración de prueba.

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

Luego se requieren algunas declaraciones de inicialización. Reemplazar <reporter-binary> Con el nombre de su ejecutable del informe. Consulte Requisitos previos arriba para obtener más información sobre cómo obtener el ejecutable del generador de informes. Su nombre dependerá del sistema operativo.

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

A continuación, inicialice su configuración de informes.

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

Y, por último, especifique el nombre de su suite de pruebas y el directorio de salida del archivo de registro.

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

Escribir pruebas con el generador de informes

Mientras realiza escaneos y escribe pruebas, el registrador guarda los resultados del escaneo en un archivo para que el reportero pueda acceder a ellos y compilarlos. Para cada escaneo del que desee crear un informe, agregue el método de cadena .logResults(). Aquí puedes nombrar tu informe para referencia futura.

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

Generación de informes

Finalmente, con el generador de informes configurado y los resultados registrados, el generador de informes puede acceder y transformar los resultados. Generalmente, este paso se realiza después de que se hayan completado todos los escaneos en un conjunto de pruebas. Este fragmento de código ejecuta el binario del generador de informes. El reporter toma tres argumentos: la ubicación de los resultados del logger configurados en AxeConfiguration, el destino deseado para los informes completos y su formato deseado. Para configuraciones de pruebas locales, recomendamos seleccionar html. Para el uso de Continuous Integration, la opción xml produce informes xml de JUnit que son compatibles con muchos entornos de CI. Para exportar a otras herramientas, utilice csv.

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

Solución de problemas

Si los problemas con el reportero persisten, comuníquese directamente con su representante de Deque, contáctenos a través de nuestra mesa de soporte o envíenos un correo electrónico. Estaremos encantados de ayudarle.

Consulte también

• Cómo cargar resultados de accesibilidad JSON en axe Reports describe cómo cargar sus resultados en axe Reports.
• Cómo obtener una clave API de axe Reports indica cómo obtener una clave API para comenzar a utilizar axe Reports.
• Creación y filtrado de informes muestra cómo puede crear informes de accesibilidad en formato CSV, XML o HTML a partir de sus resultados de accesibilidad JSON. También puede filtrar su salida por severidad utilizando esta herramienta.
• Cómo se almacenan los resultados JSON en el disco describe las convenciones de nombres de archivos para los resultados de accesibilidad JSON.