You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

This report mimics the Test Plans List built-in report available in Xray enabling it to be extracted in an excel format. With this ability to extract the report you can use it for analysis of trends, current testing status, or process this information to generate some metrics, for example, or even share it with someone else that hasn't access to Jira.

Possible usage scenarios:

  • see all the Test Run Status for a given Test Plan
  • see the status of Test Runs in a Test Plan and understand what happened
    track the Test Plans that are taking most time

Output Example(s)

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


In more depth...

KeySummaryFix VersionsBegin DateEnd DateTest Run Status
CAR-12Test Plan for infrastructure


PASSED: 0
FAILED: 0
EXECUTING: 0
TO DO: 0
ABORTED: 0
...




BOOK-522Sprint 2.0 Validations2.028-11-2022 15:37:0005-12-2022 15:37:00PASSED: 2
FAILED: 1
EXECUTING: 1
TO DO: 0
ABORTED: 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 bulk operation)


Learn more

General information about all the existing places available to export from, and how to perform it, is available in 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 may be able to generate a .CSV file.

Report assumptions

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

  1. Issue types having the name: "Test Plan".

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

Usage examples

Export Test Plans of your project

  1. from the Issue Navigator/Search, search by the issueType (i.e., "Test Plan") from your project (e.g., "EWB") and then use bulk export

example of JQL expression to use
project = "EWB" and issuetype="Test Plan" order BY created DESC

Export Test Plans 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
example of JQL expression to use
project = "EWB" and issuetype= "Test Plan" and fixVersion=1.2 order BY created DESC

Export Test Plans obtained on a given Test Environment

  1. from the Issue Navigator/Search, search by Test Plans assigned to that Test Environment  (e.g., "chrome") and then use bulk export


example of JQL expression to use
project = "EWB" and issuetype= "Test Plan" and testEnvironments = chrome order BY created DESC

Export Test Plans from its detailed view

  1. 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.


ColumnNotes

Key

issue key of the Test Plan
SummarySummary 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"

Test Run Status

The status of the latest test run executed for this Test Plan. You have the results divided by PASSED, FAILED, EXECUTING and ABORTED


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 simply delete them. Make sure that no temporary variables are created in the cells of this column that are used in other subsequent columns.

To add additional information, usually we're 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 it on the report.

We can copy the column "Summary" and adapt it.

  1. Copy the "Test Summary" column 
  2. Insert the copied content in a column next to the “TestRunStatus”
    1. The header of the column to be “Description”
    2. ${Summary} to ${Description}
    1. change

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 information, please use it wisely.


Some tips

  • limit the number of input issues; in Xporter there's a global setting for this purpose

Known limitations

  • Test Run Status are not formatted



  • No labels