allure-playwright

What is allure-playwright?

The allure-playwright package integrates Allure reporting capabilities with Playwright, a popular end-to-end testing framework. It allows you to generate detailed and visually appealing test reports, capturing various aspects of your test execution such as steps, attachments, and test results.

What are allure-playwright's main functionalities?

Generate Allure Reports

This feature allows you to generate Allure reports by annotating your Playwright tests with labels and steps. The code sample demonstrates how to add labels and steps to a basic test.

const { test } = require('@playwright/test');
const { allure } = require('allure-playwright');

test('basic test', async ({ page }) => {
  allure.label('feature', 'Login');
  allure.label('severity', 'critical');
  await page.goto('https://example.com');
  allure.step('Navigate to example.com');
  await page.click('text=Login');
  allure.step('Click on Login button');
  // Add more steps and assertions
});

Attach Screenshots

This feature allows you to attach screenshots to your Allure reports. The code sample demonstrates how to take a screenshot during a test and attach it to the report.

const { test } = require('@playwright/test');
const { allure } = require('allure-playwright');

test('screenshot test', async ({ page }) => {
  await page.goto('https://example.com');
  const screenshot = await page.screenshot();
  allure.attachment('Screenshot', screenshot, 'image/png');
});

Attach Logs

This feature allows you to attach logs to your Allure reports. The code sample demonstrates how to attach log data to the report.

const { test } = require('@playwright/test');
const { allure } = require('allure-playwright');

test('log test', async ({ page }) => {
  await page.goto('https://example.com');
  const logs = 'Some log data';
  allure.attachment('Logs', logs, 'text/plain');
});

Other packages similar to allure-playwright

jest-allure

The jest-allure package integrates Allure reporting with Jest, another popular testing framework. It provides similar functionalities such as generating detailed test reports, attaching screenshots, and adding steps. However, it is specifically designed for use with Jest rather than Playwright.

wdio-allure-reporter

The wdio-allure-reporter package integrates Allure reporting with WebdriverIO, a testing framework for Node.js. It offers similar functionalities such as generating test reports and attaching screenshots, but it is designed for use with WebdriverIO.

README

allure-playwright

This project implements Allure integration with Playwright Test framework.

Installation

npm i -D @playwright/test allure-playwright

or via yarn:

yarn add @playwright/test allure-playwright --dev

Usage

Either add allure-playwright into playwright.config.ts:

{
  reporter: "allure-playwright";
}

Or pass the same value via command line:

npx playwright test --reporter=line,allure-playwright

Specify location for allure results:

Mac / Linux

ALLURE_RESULTS_DIR=my-allure-results npx playwright test --reporter=line,allure-playwright

Windows

set ALLURE_RESULTS_DIR=my-allure-results
npx playwright test --reporter=line,allure-playwright

or inside the config via:

const config = {
  reporter: [ ['allure-playwright', { outputFolder: 'my-allure-results' }] ],
};

Proving extra information

You can use allure labels to provide extra information about tests such via

• label
• link
• id
• epic
• feature
• story
• suite
• parentSuite
• subSuite
• owner
• severity
• tag
• issue
• tms

Labels Usage

import { test, expect } from "@playwright/test";
import { allure } from "allure-playwright";

test("basic test", async ({ page }, testInfo) => {
  allure.epic("Some Epic");
  allure.story("Some Story");
});

Links Usage

import { test, expect } from "@playwright/test";
import { allure } from "allure-playwright";

test("basic test", async ({ page }, testInfo) => {
  allure.link({ url: "https://playwright.dev", name: "playwright-site" });
  allure.issue({
    url: "https://github.com/allure-framework/allure-js/issues/352",
    name: "Target issue",
  });
});

Attachments Usage

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

test("basic test", async ({ page }, testInfo) => {
  const path = testInfo.outputPath("screenshot.png");
  await page.screenshot({ path });
  testInfo.attachments.push({ name: "screenshot", path, contentType: "image/png" });
});