Installation

Axe Watcher intègre les tests d'accessibilité dans vos suites de tests end-to-end existantes. Ce guide couvre l'installation pour les versions JavaScript/TypeScript et Java du package.

Configuration requise

Avant d'installer Axe Watcher, assurez-vous que votre environnement répond aux exigences suivantes :

• Prise en charge des langues : Vos tests doivent être écrits en JavaScript, TypeScript ou Java.

• Node.js (JavaScript/TypeScript uniquement) : Utilisez une version de Node.js Long Term Support (LTS) actuellement maintenue.

• Java (Java uniquement) : Utilisez une version LTS de Java actuellement maintenue.

• Versions des plateformes d'automatisation de navigateur : Axe Watcher prend en charge la dernière version ou la version majeure précédente de chaque plateforme prise en charge (sauf pour Playwright et Playwright Test, qui est la version précédente mineure et suivantes).

• Navigateur : Watcher utilise la dernière version stable de Chrome for Testing ou Chromium (avec JavaScript/TypeScript ou Java avec Playwright, vous pouvez également utiliser Microsoft Edge). Notez que le navigateur Electron intégré de Cypress n'est pas compatible avec Watcher, et que vous devrez invoquer Cypress avec cypress run --browser chrome-for-testing --headless, cypress run --browser chromium --headless ou cypress run --browser edge --headless.

• Accès au registre npm (JavaScript/TypeScript uniquement) : Votre environnement doit avoir l'autorisation de télécharger et installer des packages depuis Le registre npm.

• Accès au dépôt central Maven (Java uniquement) : Votre environnement doit avoir l'autorisation de télécharger et installer des packages depuis Maven Central.

• Dépôt Git (optionnel mais recommandé) : Utiliser Git vous permet d'associer les résultats d'accessibilité à des commits spécifiques et de suivre l'évolution de l'accessibilité de votre projet au fil du temps.

Installation de JavaScript et TypeScript

Le package @axe-core/watcher est disponible sur npm. Installez-le à la racine de votre dossier de tests avec le gestionnaire de packages de votre choix :

npm install --save-dev @axe-core/watcher

Ou avec yarn :

yarn add --dev @axe-core/watcher

Ou avec pnpm :

pnpm add --save-dev @axe-core/watcher

Plateformes prises en charge

Le package JavaScript/TypeScript prend en charge ces plateformes d'automatisation de navigateur (version actuelle et une version majeure en arrière) :

• Cypress (y compris les tests de composants)
• Playwright (la version mineure précédente et les suivantes sont prises en charge)
• Playwright Test (la version mineure précédente et les suivantes sont prises en charge)
• Puppeteer
• WebdriverIO
• WebdriverIO Testrunner
• WebDriverJS (Selenium)

Après l'installation, suivez les instructions spécifiques au framework JavaScript ou TypeScript dans la documentation d'Axe Watcher pour configurer votre suite de tests.

Installation de Java

Le package Java Watcher est disponible sur Maven Central. Ajoutez la dépendance à votre pom.xml :

<dependencies>
  <dependency>
    <groupId>com.deque.axe_core</groupId>
    <artifactId>watcher</artifactId>
    <version>4.0.0</version>
  </dependency>
</dependencies>

Mettez à jour le numéro de version si nécessaire pour utiliser la dernière version. Plus d'informations sur les versions disponibles du package se trouvent sur Maven Central.

Plateformes prises en charge

Le package Java prend en charge Selenium WebDriver (la version actuelle et la version majeure précédente).

Étapes suivantes

Une fois le package installé, vous devrez :

1. Créez un projet dans Axe Developer Hub pour obtenir votre ID de projet
2. Modifiez votre suite de tests selon les instructions pour votre framework de test spécifique
3. Définissez vos ACCESSIBILITY_API_KEY et PROJECT_ID comme variables d'environnement
4. Exécutez vos tests et consultez les résultats dans Axe Developer Hub

Pour des instructions de configuration détaillées et spécifiques à votre framework de test, consultez les pages de documentation spécifiques au framework.