Allure Framework: Создание Красивых Отчетов о Тестировании

pip install allure-pytest

<dependency>
    <groupId>io.qameta.allure</groupId>
    <artifactId>allure-junit5</artifactId>
 (как обсуждается в [REST Assured: Java-Based API Testing Framework for Modern Applications](/blog/rest-assured-api-testing))    <version>2.24.0</version>
    <scope>test</scope>
</dependency>

dependencies {
    testImplementation 'io.qameta.allure:allure-testng (как обсуждается в [TestNG vs JUnit 5: Complete Comparison for Java Testers](/blog/testng-vs-junit5)):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")
@allure.feature("Корзина Покупок")
@allure.story("Добавление Товаров в Корзину")
@allure.severity(allure.severity_level.CRITICAL)
def test_add_item_to_cart():
    with allure.step("Открыть страницу продукта"):
        product_page = open_product_page("laptop-123")

    with allure.step("Нажать кнопку 'Добавить в корзину'"):
        product_page.click_add_to_cart()

    with allure.step("Проверить, что товар появился в корзине"):
        cart = open_cart()
        assert cart.item_count() == 1
        assert "laptop-123" in cart.get_items()

@allure.title("Вход с валидными учетными данными")
@allure.description("""
Этот тест проверяет, что пользователи могут успешно войти
с валидной комбинацией имени пользователя и пароля.
""")
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
from selenium import webdriver

def test_screenshot_on_failure():
    driver = webdriver.Chrome()
    try:
        driver.get("https://example.com")
        # Логика теста здесь
        assert False  # Симуляция ошибки
    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>2.22.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("Управление Пользователями")
@Feature("Регистрация Пользователя")
public class UserRegistrationTest {

    @Test
    @Story("Регистрация нового пользователя с валидными данными")
    @Severity(SeverityLevel.BLOCKER)
    @Description("Проверить, что новые пользователи могут зарегистрироваться с валидными учетными данными")
    public void testUserRegistration() {
        step("Перейти на страницу регистрации", () -> {
            // Логика навигации
        });

        step("Заполнить форму регистрации", () -> {
            // Логика заполнения формы
        });

        step("Отправить форму и проверить успех", () -> {
            // Отправка и проверка
        });
    }

    @Step("Открыть приложение по адресу {url}")
    public void openApp(String url) {
        // Реализация
    }

    @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("Процесс Оформления Заказа")
    @Story("Завершение покупки")
    @Severity(SeverityLevel.CRITICAL)
    @Description("Проверить полный поток оформления заказа от корзины до подтверждения заказа")
    public void testCompletePurchase() {
        addItemToCart("product-123");
        proceedToCheckout();
        fillShippingDetails();
        selectPaymentMethod();
        confirmOrder();
        verifyOrderConfirmation();
    }

    @Step("Добавить товар {productId} в корзину")
    private void addItemToCart(String productId) {
        // Реализация
    }
}

# Сгенерировать текущий отчет
allure generate allure-results --clean -o allure-report

# Скопировать историю для трендов
cp -r allure-report/history allure-results/history

# Перегенерировать с историей
allure generate allure-results --clean -o allure-report

[
  {
    "name": "Дефекты Продукта",
    "matchedStatuses": ["failed"],
    "messageRegex": ".*AssertionError.*"
  },
  {
    "name": "Проблемы Тестов",
    "matchedStatuses": ["broken"],
    "messageRegex": ".*NullPointerException.*"
  },
  {
    "name": "Нестабильные Тесты",
    "matchedStatuses": ["passed", "failed"],
    "messageRegex": ".*timeout.*"
  }
]

Browser=Chrome
Browser.Version=119.0
Stand=Production
OS=macOS 14.0
Java.Version=17.0.8

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: Тесты с Allure

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Настроить Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'

      - name: Установить зависимости
        run: |
          pip install -r requirements.txt
          pip install allure-pytest

      - name: Запустить тесты
        run: pytest --alluredir=./allure-results

      - name: Получить историю Allure
        uses: actions/checkout@v3
        if: always()
        continue-on-error: true
        with:
          ref: gh-pages
          path: gh-pages

      - name: Отчет Allure
        uses: simple-elf/allure-report-action@master
        if: always()
        with:
          allure_results: allure-results
          allure_history: allure-history
          keep_reports: 20

      - name: Развернуть на GitHub Pages
        if: always()
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: gh-pages
          publish_dir: allure-history

# Плохо
with allure.step("Шаг 1"):
    do_something()

# Хорошо
with allure.step("Вход с именем пользователя 'testuser' и проверка загрузки дашборда"):
    login("testuser", "password")
    assert_dashboard_visible()

import pytest

@pytest.hookimpl(tryfirst=True, hookwrapper=True)
def pytest_runtest_makereport(item, call):
    outcome = yield
    rep = outcome.get_result()
    if rep.when == 'call' and rep.failed:
        driver = item.funcargs.get('driver')
        if driver:
            allure.attach(
                driver.get_screenshot_as_png(),
                name='screenshot',
                attachment_type=allure.attachment_type.PNG
            )

@allure.epic("Портал Клиентов")
@allure.feature("Аутентификация")
@allure.story("Сброс Пароля")
def test_password_reset():
    # Реализация теста

@pytest.mark.parametrize("username,password", [
    ("user1", "pass1"),
    ("user2", "pass2"),
])
def test_login(username, password):
    allure.dynamic.title(f"Тест входа для {username}")
    allure.dynamic.parameter("username", username)
    # Логика теста