Какие знаешь аннотации Allure?

Аннотации Allure в Java: Основной инструмент для структурирования отчётов

Allure — это мощный фреймворк для создания интерактивных и детализированных отчётов о тестировании. Его аннотации в Java (и аналоги в других языках) являются ключевым механизмом для декорации тестового кода, позволяя обогащать отчёты метаданными, шагами, описаниями и связями с требованиями. Я разделю известные мне аннотации на несколько смысловых групп.

1. Аннотации для описания теста и его метаданных

Эти аннотации отвечают за базовое описание функционала.

• @DisplayName (из JUnit 5, но активно используется с Allure) — задаёт человекочитаемое имя для тестового класса или метода, которое отобразится в отчёте вместо имени метода.

  @Test
  @DisplayName("Проверка успешного логина с валидными данными")
  public void testValidLogin() { ... }
  

• @Description — предоставляет подробное текстовое описание теста. Поддерживает Markdown.

  @Test
  @Description("""
      Этот тест проверяет сценарий успешной авторизации пользователя с ролью 'admin'.
      **Ожидаемый результат:** Перенаправление на dashboard и отображение приветственного сообщения.
      """)
  public void testAdminLogin() { ... }
  

• @Link и @Issue — создают ссылки на внешние ресурсы: документацию, тикет в Jira, баг-репорт и т.д.

  @Test
  @Link(name = "Документация API", url = "https://api.example.com/docs")
  @Issue("PROJECT-123")
  public void testApiEndpoint() { ... }
  

• @TmsLink — аналогична @Issue, но используется для связи с тест-кейсом в системе управления тестированием (например, TestRail).

• @Owner — указывает ответственного за тест (автора или команду).

  @Test
  @Owner("Иванов Иван")
  public void testCriticalFeature() { ... }
  

2. Аннотации для управления шагами (Steps)

Шаги — это основа читаемости отчёта Allure. Они визуализируют последовательность действий.

• @Step — самая важная аннотация. Помечает метод как шаг. Текст шага (можно использовать placeholders {параметр}) и его аргументы будут отображены в отчёте. Применяется как к методам тестовых классов, так и к методам вспомогательных классов (Page Object, API Client).

  @Step("Вводим логин '{username}' в поле 'Email'")
  public void enterUsername(String username) {
      emailField.sendKeys(username);
  }
  
  @Test
  public void loginTest() {
      enterUsername("test@mail.com"); // В отчёте будет шаг с подставленным значением
      enterPassword("12345");
      clickLoginButton();
  }
  

3. Аннотации для группировки тестов (Epic, Feature, Story)

Эти аннотации создают структуру отчёта в стиле Behavior-Driven Development (BDD), группируя тесты по функциональным блокам.

• @Epic — самый высокоуровневый контейнер (например, "Управление пользователями" или "Платёжная система").
• @Feature — функциональность внутри Epic (например, "Регистрация" или "Смена пароля").
• @Story — пользовательская история или конкретный сценарий внутри Feature (например, "Смена пароля по email").

  @Epic("Авторизация и безопасность")
  @Feature("Форма логина")
  @Story("Успешный логин")
  public class LoginTest {
      @Test
      public void testValidLogin() { ... }
  }
  

    В отчёте Allure появится удобная фильтрация по этим уровням.

4. Аннотации для управления Severity (важностью) тестов

• @Severity — определяет критичность тест-кейса. Принимает значения из перечисления SeverityLevel: BLOCKER, CRITICAL, NORMAL, MINOR, TRIVIAL. Позволяет фильтровать отчёты по уровню важности, что критично при анализе результатов прогона.

  @Test
  @Severity(SeverityLevel.BLOCKER)
  public void testLoginPageAvailability() { ... }
  

5. Аннотации для параметризованных тестов и вложений

• @Parameter — не является аннотацией в чистом виде, но Allure автоматически захватывает параметры из JUnit's @ParameterizedTest и отображает их. Для кастомного отображения можно использовать name в @ParameterizedTest.

  @ParameterizedTest
  @ValueSource(strings = {"Chrome", "Firefox"})
  void testCrossBrowser(String browser) {
      // Allure отобразит параметр 'browser' для каждого запуска
  }
  

• Методы для вложений — хотя это не аннотации, это важнейшая часть API Allure. Через статические методы Allure можно добавлять в отчёт различные артефакты:

    *   **`Allure.addAttachment`** — для добавления файлов (скриншоты, логи, HTML-снэпшоты, JSON/XML ответы).

    ```java
    @Test
    public void testWithScreenshot() {
        // ... действия
        byte[] screenshot = ((TakesScreenshot)driver).getScreenshotAs(OutputType.BYTES);
        Allure.addAttachment("Скриншот после логина", "image/png", new ByteArrayInputStream(screenshot), ".png");
    }
    ```

Практическое применение и лучшие практики

• Комбинация аннотаций: Эффективные отчёты строятся на комбинации @Step внутри методов PageObject/API клиента, @DisplayName/@Description на тестовых методах и @Epic/@Feature на классе.
• Именование шагов: Шаги @Step должны быть лаконичными и отражать действие, а не техническую реализацию. Лучше "Нажимаем кнопку 'Сохранить'", чем "executeClickOnSaveButton".
• Вложения — доказательная база: Всегда добавляйте скриншоты в момент падения теста (чесь @AfterEach или лисенеры) и логируйте важные данные (запросы/ответы API) как вложения в формате text/plain или application/json.
• Связь с требованиями: Использование @Link и @Issue превращает отчёт Allure из просто результата прогона в инструмент аналитики, напрямую связывающий падения тестов с дефектами в трекере.

Таким образом, аннотации Allure — это не просто синтаксический сахар, а цельная система семантического описания тестового процесса. Их грамотное использование превращает сырой лог выполнения в наглядную, удобную для анализа и презентации историю проверки качества продукта, понятную как разработчикам, так и менеджерам.