class: Fixtures

• since: v1.10
• langs: js

Playwright Test is based on the concept of the test fixtures. Test fixtures are used to establish environment for each test, giving the test everything it needs and nothing else.

Playwright Test looks at each test declaration, analyses the set of fixtures the test needs and prepares those fixtures specifically for the test. Values prepared by the fixtures are merged into a single object that is available to the test, hooks, annotations and other fixtures as a first parameter.

import { test, expect } from '@playwright/test';

test('basic test', async ({ page }) => {
  // ...
});

Given the test above, Playwright Test will set up the page fixture before running the test, and tear it down after the test has finished. page fixture provides a [Page] object that is available to the test.

Playwright Test comes with builtin fixtures listed below, and you can add your own fixtures as well. Playwright Test also [provides options][TestOptions] to configure [property: Fixtures.browser], [property: Fixtures.context] and [property: Fixtures.page].

property: Fixtures.browser

• since: v1.10

• type: <[Browser]>

[Browser] instance is shared between all tests in the same worker - this makes testing efficient. However, each test runs in an isolated [BrowserContext] and gets a fresh environment.

Learn how to configure browser and see [available options][TestOptions].

Usage

test.beforeAll(async ({ browser }) => {
  const page = await browser.newPage();
  // ...
});

property: Fixtures.browserName

• since: v1.10

• type: <[BrowserName]<"chromium"|"firefox"|"webkit">>

Name of the browser that runs tests. Defaults to 'chromium'. Useful to annotate tests based on the browser.

Usage

test('skip this test in Firefox', async ({ page, browserName }) => {
  test.skip(browserName === 'firefox', 'Still working on it');
  // ...
});

property: Fixtures.context

• since: v1.10

• type: <[BrowserContext]>

Isolated [BrowserContext] instance, created for each test. Since contexts are isolated between each other, every test gets a fresh environment, even when multiple tests run in a single [Browser] for maximum efficiency.

Learn how to configure context and see [available options][TestOptions].

Default [property: Fixtures.page] belongs to this context.

Usage

test('example test', async ({ page, context }) => {
  await context.route('*external.com/*', route => route.abort());
  // ...
});

property: Fixtures.page

• since: v1.10

• type: <[Page]>

Isolated [Page] instance, created for each test. Pages are isolated between tests due to [property: Fixtures.context] isolation.

This is the most common fixture used in a test.

Usage

import { test, expect } from '@playwright/test';

test('basic test', async ({ page }) => {
  await page.goto('/signin');
  await page.getByLabel('User Name').fill('user');
  await page.getByLabel('Password').fill('password');
  await page.getByText('Sign in').click();
  // ...
});

property: Fixtures.request

• since: v1.10

• type: <[APIRequestContext]>

Isolated [APIRequestContext] instance for each test.

Usage

import { test, expect } from '@playwright/test';

test('basic test', async ({ request }) => {
  await request.post('/signin', {
    data: {
      username: 'user',
      password: 'password'
    }
  });
  // ...
});

Source: docs/src/test-api/class-fixtures.md