Allure Report Integration with Playwright

Allure Report Integration with Playwright

Integrating Allure Reports with Playwright provides detailed, interactive test reports that help visualize test results with rich information like steps, attachments, and screenshots.


Here’s a complete guide to integrate Allure Reports with Playwright using JavaScript/TypeScript.


✅ Prerequisites

Node.js installed


Playwright project set up


npm or yarn as package manager


📦 Step 1: Install Dependencies

Install Allure commandline and Playwright Allure reporter:


bash

Copy

Edit

npm install --save-dev allure-playwright allure-commandline

Optionally, install Allure globally:


bash

Copy

Edit

npm install -g allure-commandline

🛠️ Step 2: Configure Playwright to Use Allure Reporter

Edit your playwright.config.ts or playwright.config.js:


ts

Copy

Edit

import { defineConfig } from '@playwright/test';


export default defineConfig({

  reporter: [

    ['list'],

    ['allure-playwright'],

  ],

  use: {

    screenshot: 'only-on-failure', // optional but useful

    video: 'retain-on-failure',    // optional

  },

});

🧪 Step 3: Write Tests with Allure Metadata (Optional)

You can add metadata using test.info().annotations or allure API:


ts

Copy

Edit

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

import { allure } from 'allure-playwright';


test('My test with Allure metadata', async ({ page }) => {

  allure.label('owner', 'QA Team');

  allure.severity('critical');


  await page.goto('https://example.com');

  await expect(page).toHaveTitle(/Example/);

});

📊 Step 4: Run Tests and Generate Report

Run tests:


bash

Copy

Edit

npx playwright test

Generate the Allure report:


bash

Copy

Edit

npx allure generate ./allure-results --clean -o ./allure-report

Open the report:


bash

Copy

Edit

npx allure open ./allure-report

📁 Folder Structure

After running tests:


allure-results/: Raw result files


allure-report/: Generated report (after running allure generate)


🧼 Optional: Add Scripts to package.json

json

Copy

Edit

"scripts": {

  "test": "playwright test",

  "allure:generate": "allure generate allure-results --clean -o allure-report",

  "allure:open": "allure open allure-report"

}

Now you can run:


bash

Copy

Edit

npm run test

npm run allure:generate

npm run allure:open

🧩 Tips

You can attach screenshots, logs, and videos to Allure using Playwright hooks.


Use test.step() to break down complex steps — Allure will show them clearly.


CI/CD integration is supported (e.g., GitHub Actions, Jenkins).


Let me know if you'd like a working project example or help with setting it up in a CI pipeline!

Learn Playwright Training Course in Hyderabad

Read More

CI/CD Pipeline Setup with GitHub Actions and Playwright

Integrating Playwright with Jenkins

Visit Our IHUB Talent Training Institute in Hyderabad

Get Directions


Comments

Post a Comment

Popular posts from this blog

How to Install and Set Up Selenium in Python (Step-by-Step)

 Here’s your step-by-step guide to installing and setting up Selenium in Python — perfect if you're just getting started with browser automation. 🚀 🐍 Step 1: Install Python If you haven’t already: Download Python: https://www.python.org/downloads/ Make sure to check the box "Add Python to PATH" during installation Verify installation: bash Copy Edit python --version pip --version 📦 Step 2: Install Selenium Library Open your terminal or command prompt and run: bash Copy Edit pip install selenium To verify: bash Copy Edit pip show selenium 🌐 Step 3: Download WebDriver for Your Browser Depending on what browser you want to automate: 🔹 Chrome: Download ChromeDriver: ➡️ https://sites.google.com/chromium.org/driver/ Make sure the driver version matches your installed Chrome version. 🔹 Firefox: Download GeckoDriver: ➡️ https://github.com/mozilla/geckodriver/releases Unzip and place the executable somewhere on your system, like: Windows: C:\WebDrivers\ Mac/Linux: /usr/local...
Read more

Feeling Stuck in Manual Testing? Here’s Why You Should Learn Automation Testing

Feeling Stuck in Manual Testing? Here’s Why You Should Learn Automation Testing Are you feeling like your manual testing career is hitting a ceiling? You’re not alone. Many QA professionals start their careers in manual testing but soon realize the need to level up. If you’re wondering what’s next, automation testing might just be the breakthrough you need. Why Manual Testing Isn’t Enough Anymore Manual testing is essential, especially in exploratory, usability, and ad-hoc testing scenarios. But as applications grow more complex and development cycles become shorter, manual testing can’t keep up. Companies are looking for faster, more efficient testing methods—and that’s where automation comes in. Here are a few signs that you're stuck in manual testing: Repeating the same test cases for every build Working on tight deadlines with limited test coverage Seeing peers move ahead with automation skills Lack of growth in responsibilities or pay scale If any of this sounds familiar, it...
Read more

A Beginner's Guide to ETL Testing: What You Need to Know

A Beginner's Guide to ETL Testing: What You Need to Know Introduction: Understanding the Importance of ETL Testing Have you ever wondered how data gets from one place to another in a way that is both reliable and accurate? What happens when that data is transferred and transformed between systems? The answer lies in the ETL (Extract, Transform, Load) process, a crucial part of data management in many industries. But, how do we ensure that data is being handled correctly in this intricate process? Enter ETL testing. ETL testing is vital for ensuring that your data pipeline is working as expected. But as a beginner, where do you start? What should you focus on? This guide will answer these questions and more, helping you build a solid foundation for mastering ETL testing. Whether you're a data engineer, quality assurance professional, or anyone working with data, this article will provide insights into how ETL testing works, why it's important, and the best practices you need...
Read more