Instructies voor Puppeteer en JavaScript

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 je testbestand of bestanden de puppeteerConfig()-functie, de wrapPuppeteer()-functie en de PuppeteerController-klasse van @axe-core/watcher/puppeteer:

const {
  puppeteerConfig,
  wrapPuppeteerPage,
  PuppeteerController
} = require('@axe-core/watcher/puppeteer')

Werk je testconfiguratiecode bij (typisch in een before- of beforeAll-blok), en wikkel alle bestaande code voor het aanmaken van een browser-instantie met een oproep naar puppeteerConfig(), terwijl je je API-sleutel verstrekt:

const browser = await puppeteer.launch({
  // Your existing launch options...
})

// 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 puppeteer.launch(
  puppeteerConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    },
    // Your existing launch options...
  })
)

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 een instantie van PuppeteerController en wikkel je Puppeteer browserContext:

// Create a page instance, using your browser instance.
let page = await browser.newPage()

// Initialize the PuppeteerController by passing in the Puppeteer page.
const controller = new PuppeteerController(page)

// Use the new wrapped Puppeteer page instance.
page = wrapPuppeteerPage(page, controller)

Zorg er tenslotte voor dat alle testresultaten van Axe Watcher volledig worden verwerkt. Voeg hiervoor het volgende codeblok toe aan je test-teardowncode (meestal in een afterEach-blok):

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