Как добавить allure плагин java

Для интеграции плагина Allure в проект на Java необходимо выполнить несколько шагов. Это позволит генерировать подробные отчеты о тестах, улучшая их анализ и диагностику. Основной способ добавления – через систему сборки Maven или Gradle, в зависимости от предпочтений команды. В этом руководстве рассмотрим оба варианта с подробными инструкциями и рекомендациями по настройке.

Если вы используете Maven, добавление плагина Allure сводится к добавлению зависимостей в файл pom.xml. В первую очередь нужно указать репозиторий Allure и добавить сам плагин в секцию plugins. Рекомендуется использовать последнюю стабильную версию плагина для обеспечения максимальной совместимости и получения всех актуальных улучшений. Пример конфигурации:

<build>

<plugins>

<plugin>

<groupId>io.qameta.allure</groupId>

<artifactId>allure-maven</artifactId>

<version>2.14.0</version>

</plugin>

</plugins>

</build>

После добавления плагина, можно запускать команду mvn allure:serve для генерации отчета о тестах.

Для проектов с использованием Gradle процесс добавления плагина схож. В build.gradle необходимо добавить зависимость и плагин Allure. Пример конфигурации:

plugins {

id ‘io.qameta.allure’ version ‘2.14.0’

}

После этого можно использовать команду gradle allureServe для просмотра отчетов о тестах. Настройка плагина с помощью Gradle также позволяет интегрировать Allure в существующие пайплайны и CI/CD процессы, что значительно упрощает управление качеством кода в больших проектах.

Установка плагина Allure в Maven проект

Для интеграции Allure в Maven проект необходимо добавить соответствующие зависимости и конфигурацию в файле pom.xml.

Шаг 1: Добавьте зависимость в раздел dependencies.

io.qameta.allure
allure-java-commons
2.18.1

Шаг 2: Добавьте плагин в раздел build вашего pom.xml.

io.qameta.allure
allure-maven
2.9.0



serve

Шаг 3: Настройте версию плагина и опциональные параметры, если это необходимо. Например, можно указать дополнительные параметры для генерации отчётов или настройки сервера для отображения отчётов.

Шаг 4: Сгенерируйте отчет с помощью команды:

mvn allure:serve

После выполнения команды откроется локальный сервер с отчетом Allure, который будет автоматически обновляться при изменении тестов.

Рекомендация: Для более удобной работы с Allure рекомендуется использовать актуальные версии плагинов и зависимостей, так как они содержат исправления и улучшения производительности.

Настройка плагина Allure в файле pom.xml

Для интеграции плагина Allure в проект на базе Maven необходимо настроить несколько параметров в файле pom.xml. Основные шаги включают добавление зависимостей и конфигурации плагина для генерации отчетов.

Ниже приведен пример того, как правильно настроить плагин Allure в pom.xml:

<dependencies>
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-java-commons</artifactId>
<version>2.13.9</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-maven</artifactId>
<version>2.13.9</version>
<executions>
<execution>
<goals>
<goal>serve</goal>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

После добавления зависимостей и плагина, необходимо настроить конфигурацию Allure для правильной генерации отчетов:

<plugin>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-maven</artifactId>
<version>2.13.9</version>
<configuration>
<allureResultsDirectory>${project.build.directory}/allure-results</allureResultsDirectory>
<allureReportsDirectory>${project.build.directory}/allure-report</allureReportsDirectory>
</configuration>
</plugin>

В данном примере конфигурация указывает, где будут сохраняться результаты и отчеты Allure. Параметр allureResultsDirectory задает папку, где Maven будет сохранять результаты тестов, а allureReportsDirectory указывает директорию для отчетов Allure.

После выполнения тестов можно генерировать отчет командой:

mvn allure:generate

Для того чтобы запустить сервер Allure и просматривать отчет в браузере, используйте команду:

mvn allure:serve

Шаг	Команда	Описание
Добавление зависимости	<dependency>…	Включение библиотеки Allure в проект
Настройка плагина	<plugin>…	Конфигурация плагина для Maven для генерации отчетов
Генерация отчетов	mvn allure:generate	Генерация отчетов после выполнения тестов
Запуск сервера отчетов	mvn allure:serve	Просмотр отчетов через браузер

Эта настройка позволит автоматизировать процесс создания отчетов о тестах, что значительно улучшит процесс мониторинга качества приложения.

Интеграция Allure с тестовым фреймворком JUnit

Для интеграции Allure с JUnit необходимо выполнить несколько простых шагов, чтобы эффективно генерировать отчеты о тестах. Это обеспечит вам визуализацию результатов, улучшая восприятие тестов и упрощая анализ их состояния.

• Добавьте зависимости Allure в ваш файл pom.xml (если используете Maven):

<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-junit4</artifactId>
<version>2.13.9</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-java-commons</artifactId>
<version>2.13.9</version>
<scope>test</scope>
</dependency>

• Если используете Gradle, добавьте следующие строки в build.gradle:

testImplementation 'io.qameta.allure:allure-junit4:2.13.9'
testImplementation 'io.qameta.allure:allure-java-commons:2.13.9'

После добавления зависимостей, необходимо активировать Allure для JUnit. Для этого используется аннотация @AllureJUnit4, которая позволяет Allure собирать метаинформацию о тестах.

• Пример теста с интеграцией Allure:

import io.qameta.allure.junit4.AllureJUnit4;
import org.junit.Test;
import org.junit.runner.RunWith;
@RunWith(AllureJUnit4.class)
public class ExampleTest {
@Test
public void testMethod() {
// Ваши тесты
}
}

В данном примере тест запускается через AllureJUnit4, что позволяет Allure собирать информацию о каждом шаге теста.

• Запуск тестов и генерация отчета:

Для запуска тестов и генерации отчета, вам необходимо выполнить команду:

• Для Maven:

mvn clean test

• Для Gradle:

gradle clean test

После выполнения тестов можно сгенерировать отчет командой:

• Для Maven:

mvn allure:serve

• Для Gradle:

gradle allureServe

Команда запустит сервер Allure и откроет отчет в браузере.

При необходимости можно настроить дополнительные параметры, такие как сохранение результатов в отдельную папку или использование других отчетных форматов. Все это конфигурируется в файле pom.xml или build.gradle в зависимости от используемой сборочной системы.

Allure также позволяет интегрировать дополнительные шаги, такие как прикрепление скриншотов, логов или других файлов, что существенно улучшает качество отчетности.

Конфигурация отчётов Allure для генерации HTML

Для генерации отчётов Allure в формате HTML необходимо правильно настроить конфигурацию плагина в проекте. Ниже приведены шаги для настройки Allure в Java-проекте с использованием Maven и Gradle.

1. Настройка для Maven

Для интеграции Allure в Maven проект нужно добавить несколько зависимостей в файл pom.xml.

• Добавьте зависимость Allure в раздел dependencies:

<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-java-commons</artifactId>
<version>2.19.0</version>
</dependency>

• Для генерации отчётов Allure через Maven используйте плагин allure-maven-plugin:

<build>
<plugins>
<plugin>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-maven</artifactId>
<version>2.19.0</version>
<executions>
<execution>
<goals>
<goal>serve</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

• Теперь для генерации отчёта выполните команду:

mvn allure:serve

2. Настройка для Gradle

Для использования Allure с Gradle нужно добавить плагин и настройки в build.gradle.

• Добавьте плагин Allure в раздел plugins:

plugins {
id 'io.qameta.allure' version '2.8.1'
}

• Укажите путь к отчётам в настройках плагина:

allure {
version = '2.19.0'
autoconfigure = true
}

• Для запуска генерации отчёта используйте команду:

gradle allureServe

3. Генерация HTML-отчётов

Для корректной генерации HTML-отчётов Allure, в настройках необходимо указать путь, где будут храниться результаты тестов. Обычно результаты сохраняются в директории target/allure-results (для Maven) или build/allure-results (для Gradle).

• После выполнения тестов в указанных каталогах создаются файлы отчётов, которые можно визуализировать с помощью Allure.
• HTML-отчёт генерируется на основе этих данных с помощью команды allure:serve или allureServe.

4. Дополнительные настройки

• Для получения подробных отчётов с добавлением скриншотов и других артефактов, можно настроить плагин для загрузки этих данных в отчёт через allure.properties.

allure.results.directory=target/allure-results
allure.reports.directory=target/allure-report

• Для интеграции с CI/CD системами, добавьте шаг в сборку, чтобы автоматически генерировать отчёты после выполнения тестов.

Автоматический запуск отчётов Allure после тестов в CI/CD

На примере Jenkins, для настройки отчётов Allure необходимо выполнить следующие шаги:

• Установить плагин Allure в Jenkins. Для этого зайдите в раздел «Управление Jenkins» → «Управление плагинами» → найдите «Allure Jenkins Plugin» и установите его.
• В настройках вашего Jenkins-проекта добавьте шаг сборки для выполнения тестов с использованием фреймворка, например, Maven или Gradle. Убедитесь, что в процессе тестирования генерируются файлы отчётов Allure, например, в формате XML.
• Добавьте шаг «Allure Report» в конфигурацию сборки, указав путь к директории, где генерируются отчёты (например, target/allure-results для Maven).
• После завершения сборки в Jenkins появится вкладка «Allure Report», на которой будет отображён сгенерированный отчёт.

Для GitLab CI настройка происходит через .gitlab-ci.yml. Для этого:

• Для отображения отчётов используйте артефакты, например:

artifacts:
paths:
- allure-results/

Для GitHub Actions настройка автоматического запуска отчётов включает добавление шагов для установки Allure CLI, выполнения тестов и генерации отчёта:

steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Java
uses: actions/setup-java@v2
- name: Run tests
run: mvn clean test
- name: Install Allure CLI
run: npm install -g allure-commandline --save-dev
- name: Generate Allure Report
run: allure generate allure-results --clean -o allure-report
- name: Upload Allure Report
uses: actions/upload-artifact@v2
with:
name: allure-report
path: allure-report

После выполнения этих шагов отчёт будет доступен в виде артефакта или в виде статической страницы на сервере.

Автоматизация запуска отчётов Allure в CI/CD позволяет быстро получать подробные отчёты по результатам тестирования без необходимости вручную запускать и генерировать отчёты. Это значительно ускоряет процесс разработки и повышает качество тестирования в проекте.

Просмотр и анализ отчётов Allure после выполнения тестов

После того как тесты завершены, можно перейти к анализу результатов через отчёт, созданный Allure. Для этого необходимо запустить веб-сервер Allure, чтобы получить доступ к интерактивному интерфейсу отчёта.

Для начала, откройте терминал и перейдите в папку, где был сгенерирован отчёт. Выполните команду:

allure serve <путь_к_папке_с_отчётом>

После выполнения этой команды Allure откроет локальный сервер и предоставит ссылку, по которой можно просматривать отчёт через браузер. Обычно это http://localhost:8080.

В интерфейсе отчёта доступно несколько важных разделов:

• Обзор – здесь отображается общее количество выполненных тестов, успешных, неудачных и пропущенных. Важно отметить, что Allure также отображает статистику по времени выполнения тестов, что помогает выявить потенциальные узкие места.
• История – позволяет отслеживать динамику изменений результатов тестов за несколько запусков. Это особенно полезно для мониторинга стабильности тестируемого приложения.
• Тесты – детализированная информация о каждом тесте, включая его статус, продолжительность, и подробные логи.
• Проблемы – в этом разделе собираются все тесты с ошибками, что упрощает поиск и анализ багов.
• Теги – отображение тестов, помеченных определёнными тегами. Это полезно, если тесты были организованы по категориям, например, для разделения функциональных и регрессионных тестов.

Если вам нужно более глубокое погружение в конкретный тест, можно щелкнуть на его название. Откроется подробная информация с указанием шага, на котором произошла ошибка, и стека вызовов, что значительно ускоряет поиск проблемы.

Кроме того, для эффективного анализа можно использовать фильтры, которые позволяют отсортировать тесты по статусу, времени или тегам. Это особенно полезно при большом объёме тестов, когда нужно быстро сосредоточиться на определённых проблемах.

Для интеграции Allure с CI/CD системами, например Jenkins, можно настроить автоматическую генерацию отчётов и их публикацию в конце каждого билда. Это позволяет постоянно отслеживать качество кода и результаты тестирования без необходимости вручную генерировать отчёты.

Вопрос-ответ: