🔖 Справочник: Allure Framework

⚡ Шпаргалка: Allure за 30 секунд

# Установка
pip install pytest allure-pytest
# + установить Allure CLI отдельно (см. theory.html)

# Запуск тестов
pytest --alluredir=allure-results

# Просмотр отчёта
allure serve allure-results

# Генерация статического отчёта
allure generate allure-results -o allure-report --clean
allure open allure-report

# Шаги в тесте
with allure.step("Описание шага"):
    # действие

# Декоратор на методе
@allure.step("api. Получить список '{id}'")
def get_item(self, id): ...

# Вложение
allure.attach(content, name="Заголовок", attachment_type=allure.attachment_type.TEXT)

Установка

# Python-пакет
pip install pytest allure-pytest

# Windows (Scoop)
scoop install allure

# macOS (Homebrew)
brew install allure

Команды CLI Allure

Команда	Что делает
`pytest --alluredir=allure-results`	Запустить тесты и сохранить сырые данные для Allure
`allure serve allure-results`	Запустить локальный сервер и открыть отчёт в браузере
`allure generate allure-results -o allure-report --clean`	Сгенерировать статический HTML-отчёт в папку allure-report
`allure open allure-report`	Открыть уже сгенерированный статический отчёт
`allure --version`	Проверить версию Allure CLI

Декораторы разметки тестов

Декоратор	Уровень применения	Описание
`@allure.epic("название")`	Класс / функция	Верхний уровень группировки — проект или модуль
`@allure.feature("название")`	Класс / функция	Функциональная область (напр. READ, CREATE)
`@allure.story("название")`	Функция	Пользовательская история
`@allure.title("название")`	Функция	Заголовок теста в отчёте
`@allure.description("текст")`	Функция	Подробное описание теста
`@allure.id("ID")`	Функция	Уникальный идентификатор для навигации в коде
`@allure.severity("уровень")`	Класс / функция	Критичность: blocker, critical, normal, minor, trivial

Шаги allure.step

Синтаксис	Когда использовать
`with allure.step("Описание"):`	Выделить шаг внутри тела теста
`@allure.step("Описание")`	Декорировать метод — каждый вызов становится шагом
`@allure.step("Действие с {param}")`	Динамически подставить значение параметра метода

Вложения (attachments)

Вызов	Описание
`allure.attach(content, name="...", attachment_type=allure.attachment_type.TEXT)`	Прикрепить текстовое содержимое
`allure.attachment_type.TEXT`	Тип: обычный текст
`allure.attachment_type.PNG`	Тип: изображение PNG (скриншот)
`allure.attachment_type.JSON`	Тип: JSON с подсветкой
`allure.attachment_type.HTML`	Тип: HTML-разметка
`allure.attachment_type.CSV`	Тип: CSV-таблица

Запуск pytest с фильтрами Allure

# Запустить все тесты и сохранить данные
pytest --alluredir=allure-results

# С подробным выводом
pytest -v --alluredir=allure-results

# Только тесты с определённой меткой pytest
pytest -m smoke --alluredir=allure-results

# Только тест по имени
pytest -k "test_get_companies" --alluredir=allure-results

Структура проекта с Allure

project/
├── api/
│   └── company_api.py        # Класс CompanyApi с @allure.step на методах
├── db/
│   └── company_table.py      # Класс CompanyTable с @allure.step на методах
├── tests/
│   └── test_x_clients_db.py  # Тесты с разметкой Allure
├── allure-results/           # Сырые данные (генерируется pytest)
├── allure-report/            # HTML-отчёт (генерируется allure generate)
└── conftest.py               # Фикстуры pytest (при необходимости)