Instructies voor WebdriverIO 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 testbestanden de wdioConfig() functie, de wrapWdio() functie en de WdioController klasse van @axe-core/watcher/wdio:

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

In uw testconfiguratiecode (meestal in een before of beforeAll blok), omwikkel alle bestaande code voor het maken van een browser instantie met een oproep naar wdioConfig(), terwijl u uw API-sleutel verstrekt:

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

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

Zodra u een browser instantie heeft, creëer een instantie van de WdioController klasse:

const controller = new WdioController(browser);

Omwikkel uw browser instantie met de wrapWdio() functie, waarbij u de browser instantie en de controller instantie verstrekt:

wrapWdio(browser, controller)

Zorg er ten slotte voor dat alle testresultaten van axe Watcher zijn verwerkt. Voeg hiervoor het volgende codeblok toe aan uw testafsluitingscode (meestal in een afterEach blok):

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