Purpose

This report lists some details of the selected requirements (Stories or Epics) in Xray, enabling them to be extracted in an Excel format. With this ability to extract the report you can use it for analysis of trends and current testing status, or process this information to generate some metrics, for example, or even share it with someone else who still needs access to Jira.

Possible usage scenarios:

• get an overview of Requirements by Component and/or Priority
• track the time spent on specifying and executing tests associated with a given Requirement 
• see all the Test Run statuses count for a given Requirement

Store - DC; Cloud

Output Example(s)

The following table shows an example of the columns/rows you should expect.

How to use

This report can be generated from different places/contexts, including:

• Issue view screen
• Issue search page (main search page or as a bulk operation)

Source data

This report is applicable to:

• 1 or more Story or Epic issues

Output format

The standard output format is .XLSX so you can open it in Microsoft Excel, Google Sheets, and other tools compatible with this format. From those tools, you can generate a .CSV file.

Report assumptions

The template has a set of assumptions that you have to make sure your Jira/Xray environment complies with:

1. Issue types having the name: "Story", "Epic".
2. Direct issue links existing between requirements and tests (otherwise you get blank cells for most metrics related to the testing effort).
3. Time calculations require certain statuses or logging (see the "Understanding the report" section below).

If any of these assumptions is not met, you need to update the template or the environment accordingly.

Usage examples

Export Stories of your project

1. from the Issue Navigator/Search, search by the issueType (i.e., "Story") from your project (e.g., "BOOK") and then use bulk export or Export->Xporter
   
   

project = "BOOK" and issuetype="Story" order BY created DESC

Export Epics associated with a given fix version

1. from the Issue Navigator/Search, search by the release (i.e., "fixVersion") of your project (e.g., "EWB") and then use bulk export or Export->Xporter
   
   

project = "BOOK" and issuetype= "Epic" and fixVersion=1.2 order BY created DESC

Export Stories obtained on a given Test Environment

1. from the Issue Navigator/Search, search by Stories assigned to that Test Environment  (e.g., "chrome") and then use bulk export or Export->Xporter

project = "BOOK" and issuetype= "Story" and testEnvironments = chrome order BY created DESC

Export Story from its detailed view

1. open the Story issue and export it using this template

Understanding the report

The report shows information about the Requirements in a list form.

Layout

The report is composed of two sheets - "TestingEffortOverview" and "DetailedExecutionBreakdown" - with the information on the "Requirements" (by default, Stories and Epics). Each sheet will present a line per each Requirement.

The DC version has 2 extra sheets with graphs based on the "DetailedExecutionBreakdown" tab (variables needed for the graphs are not yet available in Cloud).

"TestingEffortOverview" sheet

"DetailedExecutionBreakdown" sheet

Customizing the report

The common customization actions are:

• adding/removing columns
• changing the level of detail in the columns

As this report is column-based, if some columns are not relevant to you, you should be able to delete them. Make sure that no temporary variables are created in the cells of those columns that are used in other subsequent columns.

Exercise 1: add a custom issue type that belongs to Requirements in your configuration

At the top of the template, locate this line

    #{if (%{'${IssueTypeName}'.equals('Epic') || '${IssueTypeName}'.equals('Story')})}

Add, remove, or rename types in brackets after "equals", for example

#{if (%{'${IssueTypeName}'.equals('Story') || '${IssueTypeName}'.equals('Request') || '${IssueTypeName}'.equals('FeatureIdea') })}

Exercise 2: track custom test types

On the "TestingEffortOverview" tab, columns O-R provide the breakdown by 4 common test types. You can add more columns or modify the code in one of the existing ones, depending on which type you are interested.

For example, if you have a custom "Robot" type, you can add it to the first line of the "Non-exploratory Generic" column, then the conditional line below will automatically account for the new entry, no further changes are needed.

${set(genericTestTypes, ‘generic, Robot’)}
...
#{if (%{',${genericTestTypes},'.indexOf(',${Links[j].Test Type},'.toLowerCase()) >= 0})}

Keep in mind that if you add columns, you will also need to update the formula in the "Total Number of Linked Tests" column.

You can further finetune the content and formatting via JavaScript, you can find more useful snippets in this tutorial for Xporter and DocGen.

Performance

Performance can be impacted by the information that is rendered and by how that information is collected/processed.

The number of Test Executions and Test Runs, depending on scenarios, can be considerably high, especially with CI/CD. As this report sums up quite a lot of information, please use it wisely.