To open this report your current project must satisfy the following conditon
Requirement Coverage must be enabled.
Shows the requirement traceability, from requirements to defects. Analyze requirements and related Tests, Test Runs and defects, for quickly identifying uncovered or incomplete/faulty requirements.
Aim
This report allows users to analyze the requirements and their traceability to tests, runs and defects.
Some possible usage scenarios:
- make full traceabiliy analysis, from requirements<=>Tests<=>Test Runs<=>Defects
- evaluate the requirement status for a given version and see all linked (open/closed) defects
- see the tests covering each requirement and all their runs and how that contributes to the overall requirement status
- analyze the requirements and related executions and respective defects, in a context of a given Test Environment
- see what defects are impacting the requirements, or a subset of the requirements of a specific version
How to use
This report is either accessible from "Xray Reports" icon on the project left side bar or from the standard "Reports" icon, which includes other kind of reports besides Xray.
Source requirements issues can be directly provided using a saved filter or by specified some requirement fields:
- Saved filter: A saved filter containing requirement issues
- Fix Version: version assigned to requirements
- Assignee: requirement's assignee
- Key or Summary: requirement's key or summary
- Status: workflow status
- Resolution: workflow resoluton
- Include Previous Versions: include previous versions when searching for a version
It's also possible to configure the report with additional parameters:
- Hide Test Runs: hides the Test Runs column; this is quite useful whenever you are using Continuous Integration and you have many runs
Analysis
In the left side it's possible to define the analysis strategy, i.e. the way you want to analyze the selected/filtered requirements. You can either choose to analyze by Version or Test Plan, and complement it with a Test Environment.
When choosing analysis by Version, then only the Test Executions for the specified version are taken into account.
If you choose Test Plan, only Test Executions (and related Tests and results) related with the given Test Plan are considered for the calculation of the coverage status of each requirement.
The (Test) Environment , when specified, considers only executions made for the specified environment.
Note
Whenever you choose analysis by Test Plan, the requirements are not filtered in any way. Therefore, if you want to restrict the list of requirements that are being shown (e.g. just to show the requirements being indirectly covered by the Tests that are part of the Test Plan) you must always use the Filter options and eventualy some saved filter for that purpose (such as the testPlanRequirements JQL function).
Understanding the report
The issues and values that are shown in the report take into account the options selected for analysis, namely for finding out the relevant Test Executions and respective Test Runs (and also the related defects).
The report not only shows the traceability between entities but it also presents some calculated values for the selected options. Examples of these include the requirement status and the Test status that are shown in the Requirements and Tests columns, respectively.
| Column | Notes |
|---|---|
Requirements | "requirements" and the calculated requirement status, taking into account the options selected for analysis |
| Tests | Tests and the calculated status, taking into account the options selected for analysis |
Test Runs | Test Runs and their status from all related Test Executions |
| Defects | defects directly associated with the related Test Runs and also the ones directly linked to the Tests (through "created" issue link), for the given version (through the AffectsVersion). |
Please note
The defects that appear in a separate row (i.e. that are not related with a specific Test Run) contain all defects associated with the Test. In other words, it contains all defects linked to the Test including the ones reported for Test Runs made for a different environment than the one under analysis. This allows you to see all "related defects" which may or not impact your version.
Example
Note: Requirements with Labels or Statuses configured to be ignored in the Requirement Coverage configurations will not appear on this report.