Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
Allure 2 is out
Allure Framework is a flexible lightweight multi-language test report tool with the possibility to add screenshots, logs and so on. It provides modular architecture and neat web reports with the ability to store attachments, steps, parameters and many more.
To use Allure, you only need to complete two steps:
- Gather information about tests
- Generate a report
Gathering information about tests
In this step, all information about running tests is saved to XML files with a predefined format. For this purpose, we provide so-called adapters - small libraries that are attached to particular test frameworks and know how to extract test information to XML. For more information, select one of the supported test frameworks:
- Cucumber JS
- Cucumber JVM
- JUnit 4
Also see various examples on how to use adapters.
Generating a report
Once the XML files have been created by the adapter, you can generate an Allure report using one of the following tools:
- Use Allure Command Line Tool to generate a report by running a console command.
- Use Allure Jenkins Plugin to generate a report as a Jenkins job artifact.
- Use Allure Teamcity Plugin to generate a report as a Teamcity job artifact.
- Use Allure Bamboo Plugin to generate a report as an Atlassian Bamboo plan artifact.
- Use Allure Maven Plugin to generate a report during a Maven build.
- Use Gradle Allure Plugin to generate a report by running Gradle task.
This section describes the main features of Allure. For example, you can group your tests by stories or features, attach files, and distribute assertions over a set of custom steps, among other features. All features are supported by Java test frameworks, so we only provide Java examples here. For details on how a particular adapter works with the test framework of your choice, refer to the adapter guide.