Generar Informes con Java

Esta guía detalla cómo añadir el reporter de Axe DevTools a tu proyecto de pruebas que ya utiliza Axe DevTools para Web.

Requisitos previos

Integrar el reporter requiere una configuración de pruebas de Axe DevTools para Web en funcionamiento. Si aún no estás obteniendo resultados de escaneo de Axe DevTools para Web, lee la guía sobre cómo configurar Axe DevTools con Java.

También necesitas obtener el ejecutable del reporter, que se puede descargar desde Reporter Binario en la página de Descargas. Asegúrate de ver la sección Preparando Binarios después de la Descarga.

Configuración del Reporter

Para usar el reporter, debe ser importado en su propia declaración. Reemplaza <binding> con selenium, hamcrest o cucumber dependiendo del paquete que uses en tu configuración de pruebas.

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

Luego, se requieren algunas declaraciones de inicialización. Reemplaza <reporter-binary> con el nombre de tu ejecutable del reporter. Consulta Requisitos previos arriba para más información sobre cómo obtener el ejecutable del reporter. Su nombre dependerá del sistema operativo.

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

Luego, inicializa tu configuración de informes

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

Y finalmente, especifica el nombre de tu suite de pruebas y el directorio de salida del archivo de registro

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

Escribiendo Pruebas con el Reporter

Mientras realizas escaneos y escribes pruebas, el registrador guarda los resultados de tus escaneos en un archivo para que el reporter pueda acceder y compilarlos. Para cada escaneo del que quieras crear un informe, añade el método encadenado .logResults(). Aquí, puedes nombrar tu informe para referencia futura.

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

Generando Informes

Finalmente, con el reporter configurado y los resultados registrados, el reporter puede acceder y transformar los resultados. Generalmente, este paso se realiza después de que todos los escaneos en una suite de pruebas hayan terminado. Este fragmento de código ejecuta el binario del reporter. El reporter recibe tres argumentos: la ubicación de los resultados del registrador establecidos en el AxeConfiguration, el destino deseado para el(los) informe(s) completado(s) y su formato deseado. Para configuraciones de pruebas locales, recomendamos seleccionar html. Para el uso en CI, la opción xml produce informes xml de JUnit que son compatibles con muchos entornos CI. Para exportar a otras herramientas, usa 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 reporter persisten, contacta directamente a tu representante de Deque, comunícate con nosotros a través de nuestra mesa de ayuda, o envíanos un correo electrónico. Estaremos encantados de ayudarte.

Ver También

• Subir Resultados de Accesibilidad JSON a axe Reports describe cómo subir tus resultados a axe Reports.
• Obtener una Clave API de axe Reports explica cómo obtener una clave API para comenzar a usar axe Reports.
• Crear y Filtrar Informes muestra cómo puedes crear informes de accesibilidad en CSV, XML o HTML a partir de tus resultados de accesibilidad JSON. También puedes filtrar tu salida por severidad utilizando esta herramienta.
• Cómo se Almacenan los Resultados JSON en el Disco describe las convenciones de nomenclatura de archivos para resultados de accesibilidad JSON.
• Usar la CLI para Enviar Resultados de Accesibilidad a axe Developer Hub muestra cómo puedes subir tus archivos de resultados .json a axe Developer Hub.