PlaywrightとJavaScriptの手順
PlaywrightとJavaScriptでテストを構成する
-
テストフォルダのルートレベルに、
@axe-core/watcherパッケージとそのすべての依存関係をインストールします。npmまたはお好みのパッケージマネージャを使用します(例:yarnまたはpnpm)。npm install --save-dev @axe-core/watcher -
テストファイルまたはファイル群で、
playwrightConfig()関数、wrapPlaywright()関数、およびPlaywrightControllerクラスをインポートします:@axe-core/watcher/playwright:const { wrapPlaywrightPage, playwrightConfig, PlaywrightController } = require('@axe-core/watcher/playwright') -
テストセットアップコード(通常は
beforeまたはbeforeAllブロック内)に、既存のコードをラップして、browserContextインスタンスをplaywrightConfig()を呼び出しながら作成し、APIキーを提供します:const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY const PROJECT_ID = process.env.PROJECT_ID const browserContext = await playwright.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 }, /** * 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'] }) );必ず環境で
ACCESSIBILITY_API_KEYとPROJECT_IDを設定し、自分のAPIキー(axeアカウントで見つかります、 **API KEYS** タブ)とプロジェクトID(プロジェクトを作成したときのこれらの指示の上部に表示されるか、 **プロジェクトの構成** を選択してプロジェクトページから利用可能です) **設定**の下にあります。 -
一度
pageインスタンスを作成したら、PlaywrightControllerクラスのインスタンスを作成し、次をラップします:browserContext:// 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); -
最後に、axe Watcherからの全てのテスト結果がフラッシュアウトされることを確認してください。そのためには、以下のコードブロックをテストのティアダウンコード(通常は
afterEachブロック内)に追加します:afterEach(async () => { await controller.flush() })
