Générer des rapports avec Java
Utiliser le reporter Axe DevTools pour le Web avec Java
Ce guide détaille l'ajout du reporter Axe DevTools à votre projet de test utilisant déjà Axe DevTools pour le Web.
Prérequis
L'intégration du reporter nécessite une configuration de test Axe DevTools pour le Web en cours d'exécution. Si vous n'obtenez pas encore de résultats de scan Axe DevTools pour le Web, lisez le guide sur comment configurer Axe DevTools avec Java.
Vous devez également obtenir l'exécutable du reporter, qui peut être téléchargé depuis Reporter binaire sur la page Téléchargements. Assurez-vous de voir la section Préparer les binaires après téléchargement.
Configurer le reporter
Pour utiliser le rapporteur, il doit être importé dans sa propre déclaration. Remplacez <binding> par 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 déclarations d'initialisation sont nécessaires. Remplacez <reporter-binary> par le nom de votre exécutable de rapporteur. Voir Prérequis ci-dessus pour plus d'informations sur l'obtention de l'exécutable du rapporteur. 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 rapport
private AxeReportingOptions _reportOptions = new AxeReportingOptions();Et enfin, spécifiez le nom de votre suite de tests et le répertoire de sortie des fichiers journaux
AxeConfiguration.configure()
.testSuiteName("<suite-name>")
.outputDirectory("<log-directory-location>");Écrire des tests avec le reporter
Lors de l'exécution de scans et de l'écriture de tests, le logger sauvegarde vos résultats de scan dans un fichier afin que le reporter puisse y accéder et les compiler. Pour chaque scan dont vous souhaitez créer un rapport, ajoutez la méthode chaîne .logResults(). Ici, vous pouvez nommer votre rapport pour référence future.
.logResults(_reportOptions.uiState("<scan-name>"))Générer des 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 après que tous les scans d'une suite de tests ont été complétés. Cet extrait de code exécute le binaire du reporter. Le reporter prend trois arguments : l'emplacement des résultats du logger configuré dans le AxeConfiguration, la destination souhaitée pour le ou les rapports complétés, et leur format souhaité. Pour les configurations de test locales, nous recommandons de sélectionner html. Pour une utilisation CI, l'option xml produit des rapports XML JUnit qui sont compatibles avec de nombreux environnements CI. Pour l'export 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 des problèmes persistent avec le reporter, contactez directement votre représentant Deque, accédez à notre service d'assistance, ou envoyez-nous un email. Nous serons ravis de vous aider.
Voir aussi
- Télécharger les résultats d'accessibilité JSON vers Axe Reports décrit comment télécharger vos résultats vers Axe Reports.
- Obtenir une clé API pour Axe Reports explique comment obtenir une clé API pour commencer à utiliser Axe Reports.
- Création et filtrage des rapports montre comment vous pouvez créer des rapports d'accessibilité en 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.
- Utiliser la CLI pour envoyer des résultats d'accessibilité à Axe Developer Hub montre comment vous pouvez télécharger vos fichiers de résultats
.jsonvers Axe Developer Hub.
