Anleitungen für WebdriverIO Testrunner 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 wdio.config.ts-Datei die wdioTestRunner()-Funktion, die wrapWdio()-Funktion und die WdioController-Klasse aus @axe-core/watcher/wdio:

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

Bevor Sie Ihre WebdriverIO-Konfiguration exportieren, umschließen Sie sie mit einem Aufruf von wdioTestRunner() und geben Sie Ihren API-Schlüssel an:

// Original code:

export const config = {
  // Your config options here...
}

// Becomes:

const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID
const SERVER_URL = process.env.SERVER_URL

export const config = wdioTestRunner({
  axe: {
    apiKey: ACCESSIBILITY_API_KEY,
    projectId: PROJECT_ID,
    serverURL: SERVER_URL
  }, {
    // Your config options here...
  }
})

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 in Ihrem Test-Setup-Code (typischerweise in einem before- oder beforeAll-Block) eine Instanz der WdioController-Klasse und umschließen Sie dann Ihr browser-Objekt:

const controller = new WdioController(browser)
wrapWdio(browser, controller)

Stellen Sie schließlich sicher, dass alle Testergebnisse des axe Watchers ausgegeben werden. Fügen Sie dazu den folgenden Codeblock zu Ihrem Test-Teardown-Code hinzu (typischerweise in einem afterFetch-Block):

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