---
title: "Test Coverage Report"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565216/Test%20Coverage%20Report"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# <span style="color: #172b4d">Introduction</span>

<span style="color: #172b4d">The Test Coverage Report (Figure 1) calculates the Test coverage status for a list of coverable Issues for the selected version, </span><span style="color: #172b4d">[Test Plan](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565153)</span><span style="color: #172b4d">, and/or </span><span style="color: #172b4d">[Test Environment](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565129)</span><span style="color: #172b4d">. The statuses are presented in a normalized horizontal stacked bar chart, and the completeness of each Issue is evaluated.</span>

![Figure 1 - Test coverage report](media://831dd286-c2fd-44d5-968d-12c7a8e7f829)

  


To analyze the current status of your release or even past releases, you need to evaluate the status of the Requirements and other covered Issues, considering the respective results.

You might want to analyze just the Requirements implemented in a version, or you may want to analyze Requirements from earlier versions based on your regression Testing.

The Test Coverage report provides the means to analyze your Requirements statuses in real-time.

> ⚠️ To use this report, in the [Project Settings, you must have some Issue Types configured as coverable Issue types](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44566845).

# Operations

## Report Access

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Jira Cloud instance, [enter the Reporting Center](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/338526916).
> 
> > Macro (rw-step)
> 
> Scroll down until you find the Test Coverage Report (Figure 2 - 1) and click it to access it.
> 
> If you hover over it (Figure 2 - 2) you can see the report preview.
> 
> ![Figure 2 - Test Coverage](media://4b985b6b-935e-4a14-8bcd-770cdffa5219)


## Configuring and Using the Report

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> If the Test Coverage Report has not been generated yet, you will see the screen depicted in Figure 3.
> 
> > Macro (rw-step)
> 
> At the top of the report, you have some options that need to be configured:
> 
> - Analysis & Scope (Figure 3 - 1): [how to analyze the Issues](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185).
> - *Group* *By* (Figure 3 - 2): how to visually group the coverable Issues (e.g.: by priority, by component).
> - *View *(Figure 3 - 3)*:* flat or hierarchical.
> - *Filters* (Figure 3 - 4): the source data for the report (e.g., the Requirements or other covered Issues) and how to evaluate the status for each one of the items being shown.
> 
> ![Figure 4 - Configuration](media://13b01e9d-6f28-43f5-86ba-56eb321dabb8)
> 
> 
> > ℹ️ - You don't have to change any of the options shown in Figure 4. You can create the report using the options configured by default.
> > ℹ️ - If you generate a report and then leave the configuration screen, the report will be lost, and you will need to reconfigure it from the beginning.

## Understanding the Report

### Source Data/Filters

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> The source data for the report (e.g.: the Requirements or other covered Issues) can be defined under *Filters *(Figure 5 - 1).
> 
> ![Figure 5 - Filters](media://6c6efb6c-df89-4770-b20c-9d57f9a321a8)
> 
> > Macro (rw-step)
> 
> Source Requirement/coverable Issues can be directly provided using a Basic or Advanced filter:
> 
> - *Basic* (Figure 5 - 2):
>   - *Project *(Figure 5 - 3).
>   - *Assignee* (Figure 5 - 4): the Issue's assignee.
>   - *Component *(Figure 5 - 5)*:* the component assigned to the Issue.
>   - *Fix Versions* (Figure 5 - 6): versions assigned to the Issue.
>   - *Resolution* (Figure 5 - 7): the workflow resolution.
>   - *Status *(Figure 5 - 8): the workflow status.
>   - *Saved Filter *(Figure 5 - 9).
>   - *Contains *(Figure 5 - 10)*:* the full Issue key or part of the summary.
>   - To add more fields to the filter, you can click the *More*** **button (Figure 5 - 11): a modal will open for you to select any fields (Figure 6 - 1). Then, click *Set* (Figure 6 - 2).
> 
> ![Figure 6 - Filters](media://9ee5a6b6-1377-45ce-aab0-7bb5027932c6)
> 
> - *Advanced *(Figure 7 - 1)*:* a JQL query to filter the coverable Issues (Figure 7 - 2). Once you're done, click *Apply* (Figure 7 - 3).
> 
> ![Figure 7 - Advanced](media://a1fa43cc-9a35-47c6-84be-6ee619c2beac)
> 
> > Macro (rw-step)
> 
> You can reset the filters that are displayed back to the default filters, or you can clear all the filter values (Figure 6 - 3).
> 
> Once you're finished, click *Apply* (Figure 7 - 3).
> 
> > Macro (rw-step)
> 
> If you don't wish to make further configuration changes, click *Generate Report* (Figure 8 - 1) to create the report.
> 
> ![Figure 7 - Generate](media://80e1727f-148c-4730-b380-a8c9cf73616a)
> 
> > Macro (rw-step)
> 
> The report will appear (Figure 8).
> 
> You can share the report in Jira by clicking the *Share* button (Figure 8 - 1). This action generates a URL that you can copy (Figure 8 - 2) and share with others. The URL will expire if it is not accessed for six months.
> 
> ![Figure 8 - Report](media://e933e88d-dd01-4d1b-a08a-a98b518bd0c5)


### Analysis & Scope

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

### Group By

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > ℹ️ ### Tips
> > ℹ️ 
> > ℹ️ For more information, please see the [Coverage Analysis](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185) page.

### View

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

# Report Example Analysis

Each bar on the chart (Figure 18 - 1) represents a group of Requirements with a different value* *provided by the grouping field. Stacked within each bar are the Requirements grouped by coverage status: <span style="color: #008000">**OK**</span>, <span style="color: #ff0000">**NOK**</span>, <span style="color: #ffcc00">**NOT RUN**</span>, <span style="color: #333399">**UNKNOWN**</span><span style="color: #333399"> </span>& <span style="color: #003366">**UNCOVERED **</span><span style="color: #003366">(Figure 18 - 2)</span>.  

Since this is a normalized chart, the bars are always 100% wide. The Overall Coverage Requirements chart is interactive, offering the following functionalities:

## Series Information

Hovering over a bar shows a small popup with detailed information about the specific series, including Status, Grouping Field, and Percentage.

![Figure 18 - Report](media://8f66fc6c-7a30-4cd1-9c8c-3421f4dc54fd)

## Series Chart Deactivation

You can deactivate a particular series by clicking it in the chart legend (Figure 19 - 1). The series will no longer appear on the chart (Figure 19 - 2).

To reactivate it, click it again.

![Figure 19 - Report](media://2df495aa-7796-42a2-9563-5cba013127f8)

## Drill-Down

Selecting a section of the chart (Figure 20 - 1) will cause other elements to turn grey (Figure 20 - 2), and a table will appear below the chart showing the corresponding Requirement Issues (Figure 20 - 3).

![Figure 20 - Report](media://3c609e5d-631b-45ce-9bc6-87ec898d62b5)

For each Requirement Issue, the table shows the following indicators:

- **Total Tests**: the total number of linked Tests.
- <span style="color: #339966">**PASSED:**</span> the total number of tests passing (i.e., the ones whose status is mapped to Test Coverage status as *OK*).
- <span style="color: #ff0000">**FAILED:**</span> the total number of tests failing (i.e., the ones whose status is mapped to the Test Coverage status as *NOK*).
- **Other:** the total number of Yests whose current status is mapped on the Test Coverage status as *Not Run* or *Unknown*.

The table also includes a column with a progress bar indicating the completeness of each Issue (Figure 20 - 4).

Some values in the table may include links, allowing you to navigate directly to the corresponding entities based on the displayed numbers.  


> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).