Installation

Axe Watcher integriert Barrierefreiheitstests in Ihre vorhandenen End-to-End-Test-Suiten. Dieser Leitfaden behandelt die Installation für beide Versionen des Pakets: JavaScript/TypeScript und Java.

Systemanforderungen

Stellen Sie vor der Installation von Axe Watcher sicher, dass Ihre Umgebung diese Anforderungen erfüllt:

• Sprachunterstützung: Ihre Tests müssen in JavaScript, TypeScript oder Java geschrieben sein.

• Node.js (nur JavaScript/TypeScript): Verwenden Sie eine derzeit gewartete Long Term Support (LTS) Version von Node.js.

• Java (nur Java): Verwenden Sie eine derzeit gewartete LTS-Version von Java.

• Versionen der Browser-Automatisierungsplattformen: Axe Watcher unterstützt die neueste Version oder die vorherige Hauptversion jeder unterstützten Plattform (außer Playwright und Playwright Test, die die vorherige Neben Version und spätere Versionen unterstützen).

• Browser: Watcher verwendet die neueste stabile Version von Chrome for Testing oder Chromium (mit JavaScript/TypeScript oder Java mit Playwright können Sie auch Microsoft Edge verwenden). Beachten Sie, dass der eingebaute Electron-Browser von Cypress nicht mit Watcher kompatibel ist, und Sie müssen Cypress mit cypress run --browser chrome-for-testing --headless, cypress run --browser chromium --headless oder cypress run --browser edge --headless aufrufen.

• Zugriff auf das npm-Registry (nur JavaScript/TypeScript): Ihre Umgebung muss die Berechtigung haben, Pakete von Das npm-Registry herunterzuladen und zu installieren.

• Zugriff auf das Maven Central Repository (nur Java): Ihre Umgebung muss die Berechtigung haben, Pakete von Maven Central herunterzuladen und zu installieren.

• Git-Repository (optional, aber empfohlen): Die Verwendung von Git ermöglicht es Ihnen, Barrierefreiheitsergebnisse mit bestimmten Commits zu verknüpfen und den Fortschritt der Barrierefreiheit Ihres Projekts im Laufe der Zeit zu überwachen.

Installation von JavaScript und TypeScript

Das @axe-core/watcher-Paket ist auf npm verfügbar. Installieren Sie es auf der Stammebene Ihres Testordners mit Ihrem bevorzugten Paketmanager:

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

Oder mit Yarn:

yarn add --dev @axe-core/watcher

Oder mit pnpm:

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

Unterstützte Plattformen

Das JavaScript/TypeScript-Paket unterstützt diese Browser-Automatisierungsplattformen (aktuelle Version und eine Hauptversion zurück):

• Cypress (einschließlich Komponententests)
• Playwright (vorherige Nebenversion und spätere Versionen werden unterstützt)
• Playwright Test (vorherige Nebenversion und spätere Versionen werden unterstützt)
• Puppeteer
• WebdriverIO
• WebdriverIO Testrunner
• WebDriverJS (Selenium)

Nach der Installation folgen Sie den JavaScript- oder TypeScript-Framework-spezifischen Anweisungen in der Axe Watcher-Dokumentation, um Ihre Testsuite zu konfigurieren.

Java-Installation

Das Java Watcher-Paket ist auf Maven Central verfügbar. Fügen Sie die Abhängigkeit zu Ihrem pom.xml hinzu:

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

Aktualisieren Sie die Versionsnummer nach Bedarf, um die neueste Veröffentlichung zu verwenden. Mehr Informationen zu den verfügbaren Versionen des Pakets finden Sie auf Maven Central.

Unterstützte Plattformen

Das Java-Paket unterstützt Selenium WebDriver (die aktuelle Version und die vorherige Hauptversion).

Nächste Schritte

Sobald Sie das Paket installiert haben, müssen Sie Folgendes tun:

1. Erstellen Sie ein Projekt im Axe Developer Hub, um Ihre Projekt-ID zu erhalten.
2. Ändern Sie Ihre Testsuite gemäß den Anweisungen für Ihr spezifisches Testframework.
3. Setzen Sie Ihre ACCESSIBILITY_API_KEY und PROJECT_ID als Umgebungsvariablen.
4. Führen Sie Ihre Tests aus und sehen Sie sich die Ergebnisse im Axe Developer Hub an.

Für detaillierte Einrichtungshinweise spezifisch für Ihr Testframework, siehe die Framework-spezifische Dokumentationsseiten.