Générer des rapports avec Java

Ce guide détaille l'ajout du reporter axe DevTools à votre projet de test en exploitant déjà axe DevTools for Web.

Prérequis

L'intégration du reporter nécessite une configuration d'axe DevTools pour les tests Web. Si vous n'obtenez pas déjà les résultats d'analyse d'axe DevTools for Web, lisez le guide expliquant comment configurer axe DevTools avec Java.

Vous devez également obtenir l'exécutable du reporter, qui peut être téléchargé à partir de Binary Reporter sur la page Téléchargements. Assurez-vous de consulter la section Préparation des binaires après le téléchargement.

Configuration du Reporter

Pour utiliser le reporter, il doit être importé dans sa propre instruction. Remplacer <binding> avec Selenium, hamcrest ou Cucumber selon le package que vous utilisez dans votre configuration de test.

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

Ensuite, quelques instructions d’initialisation sont nécessaires. Remplacer <reporter-binary> Avec le nom de votre exécutable de reporter. Voir Prérequis ci-dessus pour plus d'informations sur l'obtention de l'exécutable du reporter. Son nom dépendra du système d'exploitation.

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

Ensuite, initialisez votre configuration de reporting

private AxeReportingOptions _reportOptions = new AxeReportingOptions();

Et enfin, spécifiez le nom de votre suite de tests et le répertoire de sortie du fichier journal

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

Tests d'écriture avec le reporter

Lors de l'exécution d'analyses et de tests d'écriture, le logger enregistre les résultats de votre analyse dans un fichier afin que le Reporter puisse y accéder et les compiler. Pour chaque analyse pour laquelle vous souhaitez créer un rapport, ajoutez la méthode de chaîne .logResults(). Ici, vous pouvez nommer votre report pour référence ultérieure.

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

Génération de rapports

Enfin, avec le reporter configuré et les résultats enregistrés, le reporter peut accéder aux résultats et les transformer. En général, cette étape est effectuée une fois que toutes les analyses d’une suite de tests sont terminées. Cet extrait de code exécute le binaire du reporter. Le reporter prend trois arguments : l'emplacement des résultats du logger configurés dans le AxeConfiguration, la destination souhaitée pour les rapports complétés et leur format souhaité. Pour les configurations de test locales, nous vous recommandons de sélectionner html. Pour l'utilisation de l'Intégration Continue, l'option xml produit des rapports XML JUnit compatibles avec de nombreux environnements d'Intégration Continue. Pour exporter vers d’autres outils, utilisez csv.

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

Dépannage

Si les problèmes avec le rapporteur persistent, contactez directement votre représentant Deque, contactez-nous via notre service d'assistance ou envoyez-nous un e-mail. Nous serons heureux de vous aider.

Voir aussi

• Téléchargement des résultats d'accessibilité JSON dans les rapports axe décrit comment télécharger vos résultats dans les rapports axe.
• Obtention d'une clé API Axe Reports explique comment obtenir une clé API pour commencer à utiliser Axe Reports.
• Création et filtrage de rapports montre comment vous pouvez créer des rapports d'accessibilité au format CSV, XML ou HTML à partir de vos résultats d'accessibilité JSON. Vous pouvez également filtrer votre sortie par gravité à l'aide de cet outil.
• Comment les résultats JSON sont stockés sur le disque décrit les conventions de nommage des fichiers pour les résultats d'accessibilité JSON.