Appearance
Features
This chapter describes the key features of Allure Report.
While all the features are worth learning, you may find it more productive to start with the ones that are the most useful specifically for you. Which ones are they? It depends on your role.
For QA engineers
As a QA engineer, you may want to start with features that will help you the most with the test results analysis:
- Test statuses - learn what statuses Allure supports and their meaning.
- Sorting and filtering - learn how to focus on what's important for you right now when you're reading the report.
- Defect categories - figure out how errors are distributed across the test results and how many tests each error affects.
- Test stability analysis - learn how to identify and tackle unstable tests, i.e., the tests that change their outcome for no apparent reason.
- History and retries - access previous outcomes of the test you're currently focused on.
- Test steps - divide a complex test into well-defined steps to better understand what went wrong and make a more precise conclusion about its outcome.
For developers
As a developer, you may find features that help you debug the most useful. Check these out:
- Test steps - a.k.a. a developer's best friends. Use them to log the execution results of code blocks in your tests. A failure in a test of any complexity becomes much easier to investigate when you can access all the contextual information the steps provide. This feature is the most powerful when combined with attachments.
- Attachments - enrich your test results with files (e.g., logs, HTML response dumps, screenshots), which, when a test fails, will help you get more context about the error.
- History and retries - access the previous results of a retried test to understand better what happened during each attempt.
- Timeline - identify performance and parallelization issues of the tests.
For managers
As a manager, you may be interested in features that help you better understand the state of the whole project or its essential parts:
- Visual analytics - learn how to assess the current state of the project and its dynamic using charts and trend graphs.
- Sorting and filtering - check how errors are distributed across the product features and what features are most affected.
- Export to CSV - learn how to transfer the data from Allure Report to tools like Microsoft Excel or Google Sheets for further analysis.
- Export metrics - learn how to move the data from Allure Report to InfluxDB or Prometheus.
The complete list
Here is the complete list of Allure Report features described in this chapter: