Instructies voor Playwright en TypeScript
Configureer uw tests met Playwright en TypeScript
-
Installeer in de hoofdmap van je testmap het
@axe-core/watcher-pakket en al zijn afhankelijkheden metnpmof je voorkeurspakketbeheerder (bijvoorbeeldyarnofpnpm).npm install --save-dev @axe-core/watcher -
Implementeer in uw testbestand of bestanden de
playwrightConfig()functie, dewrapPlaywright()functie en dePlaywrightControllerklasse uit@axe-core/watcher/playwright:import { wrapPlaywrightPage, playwrightConfig, PlaywrightController } from '@axe-core/watcher/playwright'; -
In uw testconfiguratiecode (meestal in een
beforeofbeforeAllblok) omgeeft u alle bestaande code voor het maken van eenbrowserContextinstantie met een aanroep naarplaywrightConfig()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 browserContext: BrowserContext = await chromium.launchPersistentContext( /** * We set userDataDir to an empty string which saves * browser data to a temporary directory * @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context */ '', playwrightConfig({ axe: { apiKey: ACCESSIBILITY_API_KEY, projectId: PROJECT_ID, serverURL: SERVER_URL }, /** * We support both headless and headed mode with Chrome. * * For headless mode: * - Use '--headless=chrome' for browsers v94-108. * - Use '--headless=new' for browsers v109+. * * For headed mode: * - Remove the '--headless' flag. * * @see https://playwright.dev/docs/chrome-extensions#headless-mode */ headless: false, args: ['--headless=new'] }) );Zorg ervoor dat u
ACCESSIBILITY_API_KEYenPROJECT_IDin 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 ookSERVER_URLin op de basis-URL van die instance (bijvoorbeeldhttps://axe-eu.deque.com); anders laat uSERVER_URLweg en wordt de standaardhttps://axe.deque.comgebruikt. -
Zodra u een
pageinstantie heeft, maakt u een instantie van dePlaywrightControllerklasse en omgeeft u uwbrowserContext:// Create a page instance, using your browser context. let page = await browserContext.newPage(); // Initialize the PlaywrightController by passing in the Playwright page. const controller = new PlaywrightController(page); // Use the new wrapped Playwright page instance. page = wrapPlaywrightPage(page, controller); -
Zorg er ten slotte voor dat alle testresultaten van axe Watcher worden leeggemaakt. Om dit te doen, voegt u het volgende codeblok toe aan uw testafbraakcode (meestal in een
afterEachblok):afterEach(async () => { await controller.flush() })
