Anleitungen für WebdriverIO 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 Ihren Testdateien die Funktion wdioConfig(), die Funktion wrapWdio() und die Klasse WdioController von @axe-core/watcher/wdio:

import {
  wdioConfig,
  wrapWdio,
  WdioController
} from '@axe-core/watcher/wdio'

In Ihrem Test-Setup-Code (typischerweise in einem before- oder beforeAll-Block) umschließen Sie bestehenden Code zur Erstellung einer browser-Instanz mit einem Aufruf von wdioConfig(), während Sie Ihren API-Schlüssel angeben:

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 remote(
  wdioConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    }
  })
)

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.

Sobald Sie eine browser-Instanz haben, erstellen Sie eine Instanz der WdioController-Klasse:

const controller = new WdioController(browser);

Umschließen Sie Ihre browser-Instanz mit der Funktion wrapWdio(), indem Sie die browser-Instanz und die controller-Instanz bereitstellen:

wrapWdio(browser, controller)

Stellen Sie schließlich sicher, dass alle Testergebnisse von axe Watcher ausgegeben werden. Fügen Sie dazu den folgenden Codeblock zu Ihrem Testabschlusscode hinzu (typischerweise in einem afterEach-Block):

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