example.spec.ts

/**
 * In this test we get a handle to the background page
 * of an extension whose source is located in ./my-extension
 * @see https://playwright.dev/docs/chrome-extensions
 * NOTE: there is not currently support to test extension pop-ups
 * Feature request: https://github.com/microsoft/playwright/issues/5593
 */
import {test, chromium, BrowserContext} from '@playwright/test';

test.describe('chrome extension tests', () => {
  let browserContext: BrowserContext;

  test.beforeEach(async ({}, testInfo) => {
    const pathToExtension = require('path').join(__dirname, '../my-extension');
    const userDataDir = testInfo.outputPath('test-user-data-dir');
    browserContext = await chromium.launchPersistentContext(userDataDir, {
      args: [
        `--disable-extensions-except=${pathToExtension}`,
        `--load-extension=${pathToExtension}`,
      ],
    });
  });

  test.afterEach(async () => {
    // Don't forget to close the created context.
    // Closing persistent context will close the browser.
    await browserContext.close();
  });

  test('Should get handle to background page of extension', async () => {
    browserContext.backgroundPages()[0];
    // Test the background page as you would any other page.
  });
});