---
title: Playwright
description: Learn how to integrate Allure with Playwright tests to generate rich, interactive test reports. Follow step-by-step setup, test execution, and report generation guidance.
---

# Getting started with Allure Playwright

[![Allure Playwright npm latest version](https://img.shields.io/npm/v/allure-playwright?style=flat "Allure Playwright npm latest version")](https://www.npmjs.com/package/allure-playwright)

Generate beautiful HTML reports using [Allure Report](https://allurereport.org/docs/) and your [Playwright](https://playwright.dev/) tests.

Info:
Check out the example projects at [github.com/allure-examples](https://github.com/orgs/allure-examples/repositories?q=visibility%3Apublic+archived%3Afalse+topic%3Aexample+topic%3Aplaywright) to see Allure Playwright in action.

## Setting up

### 1. Prepare your project

1. Make sure [Node.js](https://nodejs.org/) is installed.

   Allure Playwright is tested against Node.js 18 and higher. Older versions may work, but we can't guarantee that.

1. Open a terminal and go to the project directory. For example:

   ```bash
   cd /home/user/myproject
   ```

1. Make sure Allure Report is installed. If it's not, follow the [installation instructions](/docs/v2/install/). Note that Allure Report requires Java.

1. Install the Allure Playwright integration and make sure that the Playwright framework itself is also listed in the project's dependencies.

   **npm:**
   ```bash
   npm install --save-dev @playwright/test allure-playwright
   ```

   **yarn:**
   ```bash
   yarn add --dev @playwright/test allure-playwright allure-js-commons
   ```

   **pnpm:**
   ```bash
   pnpm install --dev @playwright/test allure-playwright
   ```

1. In the `playwright.config.ts` file, add Allure Playwright as a reporter.

   **With default options:**
   ```ts
   export default defineConfig({
     // ...
     reporter: [["line"], ["allure-playwright"]],
   });
   ```

   **With custom options:**
   ```ts
   export default defineConfig({
     // ...
     reporter: [
       ["line"],
       [
         "allure-playwright",
         {
           resultsDir: "allure-results",
         },
       ],
     ],
   });
   ```

   Some additional options can also be defined here, see [Configuration](/docs/playwright-configuration/).

### 2. Run tests

Run your Playwright tests the same way as you would run them usually. For example:

**npm:**
```bash
npx playwright test
```

**yarn:**
```bash
yarn run playwright test
```

**pnpm:**
```bash
pnpx playwright test
```

This will save necessary data into `allure-results` or other directory, according to the [configuration](/docs/playwright-configuration/). If the directory already exists, the new files will be added to the existing ones, so that a future report will be based on them all.

### 3. Generate a report

Finally, convert the test results into an HTML report. This can be done by one of two commands:

- `allure generate` processes the test results and saves an HTML report into the `allure-report` directory. To view the report, use the `allure open` command.

- `allure serve` creates the same report as `allure generate`, then automatically opens the main page of the report in a web browser.

## Writing tests

The Allure Playwright integration extends the standard reporting features of Playwright by providing additional capabilities for crafting more informative and structured tests. This section highlights key enhancements that can be utilized:

- **Metadata Annotation**: Enhance test reports with [descriptions, links, and other metadata](#add-metadata).
- **Test Organization**: Structure your tests into clear hierarchies for better readability and organization [organize tests](#organize-tests).
- **Step Division**: Break down tests into smaller [test steps](#divide-a-test-into-steps) for easier understanding and maintenance.
- **Parametrized Tests**: Clearly describe the parameters for [parametrized tests](#describe-parametrized-tests) to specify different scenarios.
- **Set labels globally**: Use [environment variables](#set-labels-globally) to set metadata and other labels.
- **Attachments**: Automatically capture [screenshots and other files](#attach-screenshots-and-other-files) during test execution.
- **Test Selection**: Use a test plan file to [select which tests to run](#select-tests-via-a-test-plan-file), allowing for flexible test execution.
- **Environment Details**: Include comprehensive [environment information](#environment-information) to accompany the test report.

In most cases, Allure Playwright provides two different ways to use a feature: the Runtime API and the Metadata API.

- **Runtime API**: use Allure's functions to add certain data to the test result during its execution. This approach allows for constructing the data dynamically.

  Note that it is recommended to call the Allure's functions as close to the beginning of the test as possible. This way, the data will be added even if the test fails early.

- **Metadata API**: add a metadata tag (beginning with `@`) into the test name. Allure Playwright will extract it and update the test result's data accordingly. When using this approach, the data is guaranteed to be added regardless of how the test itself runs.

### Add Metadata

Allure allows you to enrich your reports with a variety of [metadata](/docs/v2/readability/#description-links-and-other-metadata). This additional information provides context and details for each test, enhancing the report's usefulness. Refer to the [metadata reference section](/docs/playwright-reference/#metadata) for an exhaustive list of what can be added.

**Runtime API:**
```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";

test("Test Authentication", async () => {
  await allure.displayName("Test Authentication");
  await allure.owner("John Doe");
  await allure.tags("Web interface", "Authentication");
  await allure.severity("critical");
  // ...
});
```

**Metadata API:**
```ts
import { test } from "@playwright/test";

test(
  "Test Authentication" +
    " @allure.label.owner:JohnDoe" +
    " @allure.label.tag:WebInterface" +
    " @allure.label.tag:Authentication" +
    " @allure.label.severity:critical",
  async () => {
    // ...
  },
);
```

### Organize tests

As described in [Improving navigation in your test report](/docs/v2/navigation/), Allure supports multiple ways to organize tests into hierarchical structures.

To specify a test's location in the [behavior-based hierarchy](/docs/v2/navigation/#behavior-based-hierarchy):

**Runtime API:**
```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";

test("Test Authentication", async () => {
  await allure.epic("Web interface");
  await allure.feature("Essential features");
  await allure.story("Authentication");
  // ...
});
```

**Metadata API:**
```ts
import { test } from "@playwright/test";

test(
  "Test Authentication" +
    " @allure.label.epic:WebInterface" +
    " @allure.label.feature:EssentialFeatures" +
    " @allure.label.story:Authentication",
  async () => {
    // ...
  },
);
```

To specify a test's location in the [suite-based hierarchy](/docs/v2/navigation/#suite-based-hierarchy):

**Runtime API:**
```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";

test("Test Authentication", async () => {
  await allure.parentSuite("Tests for web interface");
  await allure.suite("Tests for essential features");
  await allure.subSuite("Tests for authentication");
  // ...
});
```

**Metadata API:**
```ts
import { test } from "@playwright/test";

test(
  "Test Authentication" +
    " @allure.label.parentSuite:TestsForWebInterface" +
    " @allure.label.suite:TestsForEssentialFeatures" +
    " @allure.label.subSuite:TestsForAuthentication",
  async () => {
    // ...
  },
);
```

### Divide a test into steps

To [create steps and sub-steps](/docs/steps/), you can use the `step()` function, see the [reference](/docs/playwright-reference/#test-steps).

Playwright's [`test.step()`](https://playwright.dev/docs/api/class-test#test-step) is also supported.

```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";
import { Status } from "allure-js-commons";

test("Test Authentication", async () => {
  await allure.step("Step 1", async () => {
    await allure.step("Sub-step 1", async (ctx) => {
      await ctx.parameter("foo", "1");
      // ...
    });
    await allure.step("Sub-step 2", async (ctx) => {
      await ctx.parameter("foo", "2");
      // ...
    });
  });
  await allure.logStep("Step 2", Status.SKIPPED);
});
```

Note that by default Allure displays automatically generated steps in the list, too, including those defined using Playwright's [`beforeAll()`](https://playwright.dev/docs/api/class-test#test-before-all), [`beforeEach()`](https://playwright.dev/docs/api/class-test#test-before-each), [`afterEach()`](https://playwright.dev/docs/api/class-test#test-after-each), and [`afterAll()`](https://playwright.dev/docs/api/class-test#test-after-all) functions. This can be disabled using the [`detail`](/docs/playwright-configuration/#detail) setting.

Images: /images/js/playwright/hooks-allure3.png, /images/js/playwright/hooks-allure2.png

### Describe parametrized tests

A typical way to implement the [parametrized tests](/docs/v2/readability/#parametrized-tests) pattern in Playwright is to define the test in a loop and use the loop variable in the test's title and body.

To display a parameter value in the test report, pass it to the [`parameter()`](/docs/playwright-reference/#parametrized-tests) function.

```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";

for (const login of ["johndoe", "johndoe@example.com"]) {
  test(`Test Authentication as ${login}`, async () => {
    await allure.parameter("login", login);
    await allure.parameter("time", new Date().toUTCString(), { excluded: true });
    // ...
  });
}

test("Test Authentication With Empty Login", async ({ page }) => {
  await allure.parameter("login", "");
  await allure.parameter("auth_method", "password");
  // ...
});
```

Tip:

For more information, you can consult the guide on [Playwright parameterization](/docs/guides/playwright-parameterization/).

### Set labels globally

Any [labels](/docs/playwright-reference/#label), including custom ones, can be set via the environment variables in your operating system. Here's an example (assuming you use the `npm` package manager):

**MacOS/Linux:**
```bash
export ALLURE_LABEL_epic=WebInterface
npx playwright test
```

**Windows:**
```powershell
$Env:ALLURE_LABEL_epic = "WebInterface"
npx playwright test
```

### Attach screenshots and other files

Reports generated by Allure can include any files attached to the test using `allure.attachment()` method. (Playwright's built-in [`TestInfo.attach()`](https://playwright.dev/docs/api/class-testinfo#test-info-attach) method is supported as well.)

For example, a popular way to make a report easier to understand is to attach a screenshot of the opened
web page. See [Attachments](/docs/attachments/).

```ts
import { test } from "@playwright/test";
import * as allure from "allure-js-commons";
import { ContentType } from "allure-js-commons";

test("Test Authentication", async () => {
  // ...

  await allure.attachment("Text file", "This is the file content.", ContentType.TEXT);

  await allure.attachmentPath("Screenshot", "/path/to/image.png", {
    contentType: ContentType.PNG,
    fileExtension: "png",
  });
});
```

### Select tests via a test plan file

If the `ALLURE_TESTPLAN_PATH` environment variable is defined and points to an existing file, Playwright will only run tests listed in this file.

Here's an example of running tests according to a file named `testplan.json` (assuming you use the `npm` package manager):

**MacOS/Linux:**
```bash
export ALLURE_TESTPLAN_PATH=testplan.json
npx playwright test
```

**Windows:**
```powershell
$Env:ALLURE_TESTPLAN_PATH = "testplan.json"
npx playwright test
```

### Environment information

For the main page of the report, you can collect various information about the environment in which the tests were executed. To do so, specify the information in the `environmentInfo` configuration parameter.

For example, it is a good idea to use this to remember the OS version and Node.js version retrieved from the [`os`](https://nodejs.org/api/os.html) and [`process`](https://nodejs.org/api/process.html) objects. This may help the future reader investigate bugs that are reproducible only in some environments.

Images: /images/js/environment-allure3.png, /images/js/environment-allure2.png

```ts
import type { PlaywrightTestConfig } from "@playwright/test";
import * as os from "node:os";

const config: PlaywrightTestConfig = {
  reporter: [
    ["line"],
    [
      "allure-playwright",
      {
        environmentInfo: {
          os_platform: os.platform(),
          os_release: os.release(),
          os_version: os.version(),
          node_version: process.version,
        },
      },
    ],
  ],
};

export default config;
```

Note that if your launch includes multiple Playwright runs (see [How it works](/docs/how-it-works/)), Allure Playwright will only save the environment information from the latest run.