Traceability report
- Glib
- Nick
The Traceability report maps Jira Issues with BDD features and scenarios. The report uses JQL (Jira’s Query Language) to identify which issues to display in the Traceability report. The report displays traceability between all Jira Issues and BDD features and scenarios with the exception of AssertThat Test Plans (AssertThat Test Plan reporting).
How to Access
The Traceability report can be found under Features section and Traceability Report
Filter using JQL
To execute the report simply enter the JQL search string to identify the Issues to display in the report and select search. The report maps all features and scenarios to the issues selected in the JQL. More details on how to construct JQL can be found here.
Some commonly used JQL to search for issues are listed below:
# To select Project "Demo" and Issue types Epic or Story
project = "DEMO" AND issuetype in (Epic, Story)
# To select Project "Demo" and Status types.
project = "DEMO" AND status in (Done, "In Progress", "Selected for Development")
# To select Project "Demo" and Issues in the current sprint.
project = "DEMO" AND fixVersion = "Current Sprint"
# To select current sprint for Project "Demo"
project = "DEMO" AND sprint in openSprints()Please note 'CurrentUser' will not work with JQL in the traceability instead use your user details.
Example 1: Traceability matrix for project “DEMO” and issues in status 'To Do':
Constructing JQL - Best Practice
The easiest way to build up your JQL is to use Jira’s Search Issues functionality to build up your JQL.
Choose the Jira icon then > Issues and filters.
Select Search issues.
If basic search is shown instead of advanced search, click Advanced (next to the icon). If advanced is already enabled, you'll see the option of switching to basic.
Enter your JQL query. As you type, Jira will offer a list of "auto-complete" suggestions based on the context of your query. Note, auto-complete suggestions only include the first 15 matches, displayed alphabetically, so you may need to enter more text if you can't find a match.
Press Enter or click Search to run your query. Your search results will be displayed in the issue navigator.
Alternatively in Jira’s Search Issues start building your query in basic then switch to advanced to display the JQL for your search.
Full documentation on how to build up JQL for more advanced queries can be found at:
https://confluence.atlassian.com/jirasoftwarecloud/advanced-searching-764478330.html
Gadget Details
The Coverage and Status gadgets can be dynamically updated to display filtered elements on the gadgets
Overall Coverage - This gadget plots the percentage of Jira tickets covered by (with links to) AssertThat scenarios.
Automated Coverage - Out of the Scenarios linked to Jira tickets in the filter, the gadget displays the number of automated vs manual. Note where a scenario is a scenario outline with multiple examples, this is counted as a single scenario.
Test Status - The status of the scenarios can be Passed, Failed, In progress and Not Run. Note the execution details are also displayed in the Traceability table. For Automated Scenario Examples where there are multiple executions, the counts are displayed in the status column.
Jira Saved Filters
Jira saved filters can be selected from the dropdown as highlighted below. Once selected, the JQL filter will be automatically populated into search field and search triggered.
More information on managing Jira saved filters can be found here: https://support.atlassian.com/jira-core-cloud/docs/save-your-search-as-a-filter/
Download Traceability and set display records size
Up to 500 Jira tickets can be downloaded at a time to a CSV files by changing the display settings. Use pagination to download the traceability details where greater than 500 tickets are required.