Instructies voor WebdriverIO Testrunner en TypeScript

Installeer in de hoofdmap van je testmap het @axe-core/watcher-pakket en al zijn afhankelijkheden met npm of je voorkeurspakketbeheerder (bijvoorbeeld yarn of pnpm).

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

Importeer in uw wdio.config.ts-bestand de wdioTestRunner()-functie, de wrapWdio()-functie en de WdioController-klasse van @axe-core/watcher/wdio:

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

Voordat u uw WebdriverIO-configuratie exporteert, omhul deze met een aanroep naar wdioTestRunner() terwijl u uw API-sleutel opgeeft:

// 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...
  }
})

Zorg ervoor dat je ACCESSIBILITY_API_KEY en PROJECT_ID in je omgeving instelt op je persoonlijke API-sleutel (te vinden in je Axe-account, tabblad **API-SLEUTELS**) en je project-ID (weergegeven bovenaan deze instructies toen je je project maakte of beschikbaar van de Projecten-pagina door **Project configureren** te kiezen onder **Instellingen**). Als je organisatie een regionale, private cloud of on-premises Axe Developer Hub-instantie gebruikt, stel dan ook SERVER_URL in op de basis-URL van die instantie (bijvoorbeeld, https://axe-eu.deque.com); zo niet, laat dan SERVER_URL weg en zal de standaard https://axe.deque.com gebruikt worden.

Maak in uw testopstellingscode (typisch in een before of beforeAll-blok) een instantie van de WdioController-klasse en omhul vervolgens uw browser-object:

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

Zorg er ten slotte voor dat alle testresultaten van Axe Watcher worden verwijderd. Voeg hiervoor het volgende codeblok toe aan je test-teardowncode (meestal in een afterFetch-blok):

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