Anleitungen für WebDriverJS und TypeScript

Im Stammverzeichnis Ihres Testordners installieren Sie das Paket @axe-core/watcher und alle seine Abhängigkeiten mit npm oder Ihrem bevorzugten Paketmanager (zum Beispiel yarn oder pnpm).

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

Importieren Sie in Ihrer Testdatei oder Ihren Testdateien die webdriverConfig() Funktion, die wrapWebdriver() Funktion und die WebdriverController Klasse aus @axe-core/watcher/webdriver:

import {
  webdriverConfig,
  wrapWebdriver,
  WebdriverController
} from '@axe-core/watcher/webdriver'

Aktualisieren Sie Ihren Test-Setup-Code (typischerweise in einem before- oder beforeAll-Block), indem Sie Chrome-Optionen angeben, wenn Sie Ihre browser Instanz instanziieren, und geben Sie Ihren API-Schlüssel an:

// Original code:
const browser = await new Builder()
  .forBrowser('chrome')
  .build()

// Becomes:
const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID
const SERVER_URL = process.env.SERVER_URL

const browser = await new Builder()
  .forBrowser('chrome')
  .setChromeOptions(
    webdriverConfig({
      axe: {
        apiKey: ACCESSIBILITY_API_KEY,
        projectId: PROJECT_ID,
        serverURL: SERVER_URL
      }
    }
  )
  .build()

Stellen Sie sicher, dass Sie ACCESSIBILITY_API_KEY und PROJECT_ID in Ihrer Umgebung auf Ihren persönlichen API-Schlüssel (zu finden in Ihrem Axe-Konto, **API-SCHLÜSSEL**-Tab) und Ihre Projekt-ID (angezeigt oben in diesen Anweisungen, als Sie Ihr Projekt erstellt haben, oder verfügbar auf der Seite "Projekte" durch Auswahl von **Projekt konfigurieren** unter **Einstellungen**) setzen. Wenn Ihre Organisation eine regionale, private Cloud oder eine lokale Axe Developer Hub-Instanz verwendet, setzen Sie auch SERVER_URL auf die Basis-URL dieser Instanz (zum Beispiel https://axe-eu.deque.com); andernfalls lassen Sie SERVER_URL weg und der Standard https://axe.deque.com wird verwendet.

Erstellen Sie eine Instanz von WebdriverController:

const controller = new WebdriverController(browser)

Umschließen Sie Ihre browser Instanz mit der wrapWebdriver() Funktion:

browser = wrapWebdriver(browser, controller)

Stellen Sie schließlich sicher, dass alle Testergebnisse von axe Watcher ausgespült werden. Dazu fügen Sie den folgenden Codeblock in Ihren Test-Teardown-Code ein (typischerweise in einem afterEach-Block):

afterEach(async () => {
  await controller.flush()
})