Purpose
This report lists some details of the selected Test Plans 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 that still needs access to Jira.
Possible usage scenarios:
- see the overall status for a given Test Plan, considering the consolidated results for the Tests being tracked
- track the planned Test Plans for a release
Output Example(s)
The following table shows an example of the columns/rows you should expect.
In more depth...
Key | Summary | Fix Versions | Begin Date | End Date | #Test | Passed | Passed (%) | Failed | Failed (%) | Executing | Executing (%) | To do | To do (%) | Aborted | Aborted (%) |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
EWB-705 | CC Test Plan v1.2 | 1.2 | 17-11-2023 02:30:00 | 13-11-2023 03:00:00 | 18 | 1 | 5.6 | 5 | 27.8 | 2 | 11.1 | 8 | 44.4 | 2 | 11.1 |
EWB-607 | Demo Test Plan | 2 | 2 | 100 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | |||
... |
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)
Learn more
General information about all the existing places available to export from and how to perform it is available on the Exporting page.
Source data
This report is applicable to:
- 1 or more Test Plan 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:
- Issue types having the name: "Test Plan".
If any of these assumptions is not met, you need to update the template or the environment accordingly.
Usage examples
Export Test Plans of your project
from the Issue Navigator/Search, search by the issueType (i.e., "Test Plan") from your project (e.g., "EWB") and then use bulk export
project = "EWB" and issuetype = "Test Plan" order BY created DESC
Export Test Plans associated with a given fix version
- from the Issue Navigator/Search, search by the release (i.e., "fixVersion") of your project (e.g., "EWB") and then use bulk export
project = "EWB" and issuetype = "Test Plan" and fixVersion=1.2 order BY created DESC
Export Test Plans obtained on a given Test Environment
from the Issue Navigator/Search, search by Test Plans assigned to that Test Environment (e.g., "chrome") and then use bulk export
project = "EWB" and issuetype = "Test Plan" and testEnvironments = chrome order BY created DESC
Export Test Plans from its detailed view
- open the Test Plan issue and export it using this template
Understanding the report
The report shows information about the Test Plans in a list form.
Layout
The report is composed of one sheet with the information on the "Test Plans".
By default, and to avoid overload/redundancy of information, only the "Test Plans" are rendered; all the other types will not be parsed.
"Test Plans" sheet
This sheet will present a line per each Test Plan.
Column | Notes |
---|---|
Key | Issue key of the Test Plan |
Summary | Summary of the Test Plan |
Fix versions | The fix versions defined in the Test Plan |
Begin Date | Timestamp of when the Test Plan started, in the format "dd-MM-yyyy hh:mm:ss" |
End Date | Timestamp of when the Test Plan ended, in the format "dd-MM-yyyy hh:mm:ss" |
#Tests | Number of tests that are part of the Test Plan. |
Passed | Number of Tests in the passed status. |
Passed (%) | Percentage of Tests in the passed status. |
Failed | Number of Tests in the failed status. |
Failed (%) | Percentage of Tests in the failed status. |
Executing | Number of Tests in the executing status. |
Executing (%) | Percentage of Tests in the executing status. |
To do | Number of Tests in the to do status. |
To do (%) | Percentage of Tests in the to do status. |
Aborted | Number of Tests in the aborted status. |
Aborted (%) | Percentage of Tests in the aborted status. |
Customizing the report
Adding or removing information to/from the report
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.
To add additional information, we're usually thinking of adding:
- fields of the Test Plan itself
Exercise: add a field from the related Test Plan issue
Let's say we have a "Description" field on the Test Plan issue that we want to show on the report.
We can copy the column "Summary" and adapt it.
- Copy the "Summary" column
- Insert the copied content in a column next to the “Summary”
- Change the header of the column to be “Description”
- Change the cell content from ${Summary} to ${Description}
- Save the template and upload it
Performance
Performance can be impacted by the information that is rendered and by how that information is collected/processed.
The number of Test Plans 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.
Some tips
- limit the number of input issues; in Xporter there's a global setting for this purpose