Setting Up Allure for API and UI Tests

To benefit from Allure, you need to integrate it with your existing test frameworks so that they emit Allure-compatible results. Fortunately, popular tools like pytest, JUnit, Playwright and Cypress already have plugins or reporters that make this straightforward.

Integrating Allure with Common Test Frameworks #

The general pattern is to add an Allure plugin or reporter, configure the output directory and then run your tests as usual. For example, in Python you can use pytest-allure-adaptor-style plugins, while in JavaScript ecosystems you use dedicated reporters for Playwright or Cypress.

# Example: pytest + Allure setup
pip install allure-pytest

# Run tests and generate Allure results
pytest tests/api --alluredir=allure-results

# Example: Playwright + Allure (config extract)
# playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['list'],
    ['allure-playwright', { outputFolder: 'allure-results' }],
  ],
});

Once integration is in place, your pipelines can generate reports after each run and publish them automatically.

Common Mistakes #

Mistake 1 — Configuring Allure only for UI tests #

This leaves gaps.

❌ Wrong: Reporting only part of your suite.

✅ Correct: Integrate Allure across API, UI and other automated tests where it makes sense.

Mistake 2 — Mixing result folders between runs #

This causes confusion.

❌ Wrong: Writing multiple runs into the same directory without cleaning.

✅ Correct: Use --clean or unique folders per run when generating reports.