Allure Framework: Creating Beautiful Test Reports

pip install allure-pytest

<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-junit5</artifactId>
    <version>2.24.0</version>
    <scope>test</scope>
</dependency>

dependencies {
    testImplementation 'io.qameta.allure:allure-testng:2.24.0'
}

# macOS
brew install allure

# Windows (Scoop)
scoop install allure

# Linux
sudo apt-add-repository ppa:qameta/allure
sudo apt-get update
sudo apt-get install allure

[pytest]
addopts = --alluredir=./allure-results

import allure
import pytest

@allure.epic("E-Commerce Platform")
@allure.feature("Shopping Cart")
@allure.story("Add Items to Cart")
@allure.severity(allure.severity_level.CRITICAL)
def test_add_item_to_cart():
    with allure.step("Open product page"):
        product_page = open_product_page("laptop-123")

    with allure.step("Click 'Add to Cart' button"):
        product_page.click_add_to_cart()

    with allure.step("Verify item appears in cart"):
        cart = open_cart()
        assert cart.item_count() == 1
        assert "laptop-123" in cart.get_items()

@allure.title("Login with valid credentials")
@allure.description("""
This test verifies that users can successfully login
with valid username and password combination.
""")
def test_valid_login():
    allure.attach("admin", name="username", attachment_type=allure.attachment_type.TEXT)
    login_page = LoginPage()
    login_page.login("admin", "password123")
    assert login_page.is_logged_in()

import allure
import json
from selenium import webdriver

def test_screenshot_on_failure():
    driver = webdriver.Chrome()
    try:
        driver.get("https://example.com")
        assert False  # Simulate failure
    except AssertionError:
        allure.attach(
            driver.get_screenshot_as_png(),
            name="failure_screenshot",
            attachment_type=allure.attachment_type.PNG
        )
        raise
    finally:
        driver.quit()

def test_attach_json_response():
    response = {"status": "success", "data": [1, 2, 3]}
    allure.attach(
        json.dumps(response, indent=2),
        name="api_response",
        attachment_type=allure.attachment_type.JSON
    )

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>3.2.2</version>
            <configuration>
                <properties>
                    <property>
                        <name>listener</name>
                        <value>io.qameta.allure.junit5.AllureJunit5</value>
                    </property>
                </properties>
            </configuration>
        </plugin>
    </plugins>
</build>

import io.qameta.allure.*;
import org.junit.jupiter.api.Test;

@Epic("User Management")
@Feature("User Registration")
public class UserRegistrationTest {

    @Test
    @Story("Register new user with valid data")
    @Severity(SeverityLevel.BLOCKER)
    @Description("Verify that new users can register successfully")
    public void testUserRegistration() {
        step("Navigate to registration page", () -> {
            // Navigation logic
        });

        step("Fill registration form", () -> {
            // Form filling logic
        });

        step("Submit form and verify success", () -> {
            // Submission and verification
        });
    }

    @Step("Open application at {url}")
    public void openApp(String url) {
        // Implementation
    }

    @Attachment(value = "Request body", type = "application/json")
    public String attachJson(String json) {
        return json;
    }
}

<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd">
<suite name="Allure TestNG Suite">
    <listeners>
        <listener class-name="io.qameta.allure.testng.AllureTestNg"/>
    </listeners>
    <test name="Regression Tests">
        <classes>
            <class name="com.example.tests.LoginTest"/>
            <class name="com.example.tests.CheckoutTest"/>
        </classes>
    </test>
</suite>

import io.qameta.allure.*;
import org.testng.annotations.Test;

public class CheckoutTest {

    @Test
    @Epic("E-Commerce")
    @Feature("Checkout Process")
    @Story("Complete purchase")
    @Severity(SeverityLevel.CRITICAL)
    public void testCompletePurchase() {
        addItemToCart("product-123");
        proceedToCheckout();
        fillShippingDetails();
        selectPaymentMethod();
        confirmOrder();
        verifyOrderConfirmation();
    }

    @Step("Add item {productId} to cart")
    private void addItemToCart(String productId) {
        // Implementation
    }
}

# Generate report
allure generate allure-results --clean -o allure-report

# Copy history for trends
cp -r allure-report/history allure-results/history

# Regenerate with history
allure generate allure-results --clean -o allure-report

[
  {
    "name": "Product Defects",
    "matchedStatuses": ["failed"],
    "messageRegex": ".*AssertionError.*"
  },
  {
    "name": "Infrastructure Issues",
    "matchedStatuses": ["broken"],
    "messageRegex": ".*ConnectionError.*"
  },
  {
    "name": "Flaky Tests",
    "matchedStatuses": ["passed", "failed"],
    "traceRegex": ".*timeout.*"
  }
]

Browser=Chrome
Browser.Version=120.0
Environment=Staging
OS=Ubuntu 22.04
Python.Version=3.11

pipeline {
    agent any

    stages {
        stage('Test') {
            steps {
                sh 'mvn clean test'
            }
        }

        stage('Generate Allure Report') {
            steps {
                allure([
                    includeProperties: false,
                    jdk: '',
                    properties: [],
                    reportBuildPolicy: 'ALWAYS',
                    results: [[path: 'target/allure-results']]
                ])
            }
        }
    }
}

name: Tests with Allure

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Install dependencies
        run: |
          pip install -r requirements.txt
          pip install allure-pytest

      - name: Run tests
        run: pytest --alluredir=./allure-results

      - name: Get Allure history
        uses: actions/checkout@v4
        if: always()
        continue-on-error: true
        with:
          ref: gh-pages
          path: gh-pages

      - name: Allure Report
        uses: simple-elf/allure-report-action@v1.9
        if: always()
        with:
          allure_results: allure-results
          allure_history: allure-history
          keep_reports: 20

      - name: Deploy to GitHub Pages
        if: always()
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: allure-history