Introduction
The Test Evolution Gadget allows you to track the progress of a group of Tests within a specific version of the system by considering a defined testing scope.
This Jira dashboard gadget provides an at-a-glance view of the trend in Test status for a selected group of Tests, based on the results within the configured testing scope.
The calculated status (e.g., TODO, PASS, FAIL) of each Test is shown per day.
Possible usage scenarios:
- Tracking the progress of specific Tests' status based on the latest execution in a particular environment.
- Monitoring the status trend of certain Tests for a specific version in a given environment.
- Observing the status progress of Tests in a specific test plan within a defined environment.
Access
The Test Evolution gadget is a Jira Dashboard gadget. See here how to configure Jira Dashboards.
On your Jira Cloud instance, click Dashboards (Figure 1 - 1) and select Default dashboard (Figure 1 - 2).
Figure 1 - Dashboards
Once the dashboard opens, click Edit (Figure 1 - 3). A new screen will open (Figure 2). Click Add gadget (Figure 2 - 1).
Figure 2 - Gadget
A side dialog will open on the right (Figure 2). Search for the Test Evolution gadget or type it on the bar (Figure 2 - 2). Then, click Add (Figure 2 - 3).
The Test Evolution Gadget will immediately appear on your Dashboard (Figure 3 - 1) and is ready to be used.
Figure 3 - Dashboard
Usage
When you first enter the Test Evolution gadget, you have to fill in the fields below (Figure 4).
Figure 4 - Usage
Tests Scope
Start by selecting (Figure 4 - 1) the Test Issues for the for the scope of the gadget with:
- Project: a project containing Tests.
or
- Saved Filter: a saved filter containing Tests (it might span multiple projects).
Date Range
Configure the date range (Figure 4 - 2) to display on the gadget. You can use a relative Time Frame or fixed dates to define the range.
- If Time frame is selected, then it can be either:
- Past 24 hours.
- Past 72 hours.
- Past Week.
- Current Month.
- Past 3 weeks.
- Past Month.
- Past 6 Months.
- if Fixed is selected, then you need to provide the dates of the time period: From date and To date (only the Test Runs with start date and end date between this range will be considered).
Analysis & Scope
The Analysis & Scope (Figure 4 - 3) allows you to define how the status of Tests is calculated for each day in the date range.
You can first choose the execution scope:
- Latest (Figure 4 - 4): no scope is chosen. All Test Runs will be considered.
- Version (Figure 4 - 4): the version for Test Executions. Only Test Runs with the selected version will be considered for the status.
- Test Plan (Figure 4 - 4): the key of the Test Plan. Only Test Runs in the scope of the selected Test plan will be considered for the status.
Besides the scope, you can also choose the:
- Test Environment (Figure 4 - 5): if a Test environment is chosen, only Test Runs executed in this environment will be considered for the status.
- Final Status Precedence (Figure 4 - 6): whether the final status has precedence over non-final ones. This also affects the status of Tests.
- Auto-generate gadget name (Figure 4 - 7): whether the name of the gadget should be generated based on its parameters or defined by the user.
Final Statuses Have Precedence over Non-final Statuses
If Enabled (Figure 4 - 7)
Scenario | Yesterday | Today 10 am | Today 11 am | Description |
---|---|---|---|---|
1 | TR1 | TR1 | - | Test Run |
PASS | TODO | - | Status change made on that day | |
PASS | TODO | Calculated Test status for that day | ||
2 | TR1 | TR1 | TR1 | Test Run |
PASS | FAIL | TODO | Status change made on that day | |
PASS | TODO | Calculated Test status for that day | ||
3 | TR1 | TR2 | - | Test Run |
PASS | TODO | - | Status change made on that day | |
PASS | PASS | Calculated Test status for that day | ||
4 | TR1 | TR2 | Test Run | |
PASS | FAIL | Status change made on that day | ||
PASS | FAIL | Calculated Test status for that day | ||
5 | - | TR1 | Test Run | |
- | PASS | Status change made on that day | ||
- | PASS | Calculated Test status for that day |
If Disabled (Figure 4 - 7)
In this case, all statuses are considered independent of whether they are final or not. The key differentiator is that the latest Test Run is always taken into account, just by considering the creation date.
Scenario | Yesterday | Today 10 am | Today 11 am | Description |
---|---|---|---|---|
1 | TR1 | TR1 | TR1 | Test Run |
PASS | FAIL | TODO | Status change made on that day | |
PASS | TODO | Calculated Test status for that day | ||
2 | TR1 | TR2 | TR2 | Test Run |
PASS | FAIL | TODO | Status change made on that day | |
PASS | TODO | Calculated Test status for that day | ||
3 | - | TR1 | TR2 | Test Run |
- | FAIL | PASS | Status change made on that day | |
- | PASS | Calculated Test status for that day | ||
4 | TR1 | TR2 | - | Test Run |
TODO | PASS | - | Status change made on that day | |
TODO | PASS | Calculated Test status for that day |
Once you're finished, click the Save button (Figure 4 - 8).
Getting the Data
Once you've filled the Test Evolution gadget fields (Figure 4) and saved the changes, the data will appear.
The Tests Evolution gadget has two views:
- Chart view (Figure 5): the default view, which displays a line chart with a line by status varying by date and amount of Tests in that status. More below.
- Table view (Figure 6): users can switch to the table view to have access to the data source for the gadget. More below.
General Options
You can perform more operations on the Test Evolution gadget screen by clicking the options below, available on the two views:
- Add gadget (Figure 5 - 1): add a new gadget by using the modal represented on the right side of Figure 2.
- Change layout (Figure 5 - 2): switch the layout to one, two, three columns and/or left or right sidebar.
Figure 5 - Chart
- Click the ellipsis button (Figure 5 - 4) to execute more operations regarding the dashboard (Figure 6 - 1).
Figure 6 - Table
Chart View
Here, you can:
- Minimize the chart (Figure 7 - 5).
- See the chart as a single column (Figure 7 - 6).
- Refresh the chart (Figure 7 - 7).
- Switch to the table view (Figure 7 - 9).
Figure 7 - Chart
- Click the ellipsis button (Figure 7 - 8) to perform more actions (Figure 8).
Figure 8 - Chart
More actions (Figure 8):
- Change the highlight color (Figure 8 - 1).
- Configure (Figure 8 - 2): you will be taken to the screen depicted in Figure 4.
- Duplicate (Figure 8 - 3): a clone of the Test Evolution gadget is immediately created.
- Delete (Figure 8 - 4): remove the Test Evolution gadget. A modal will open (Figure 9). Click Delete to confirm (Figure 9 - 1).
Figure 9 - Delete
Table View
Here, you can:
- Minimize the chart (Figure 10 - 1).
- See the chart as a single column (Figure 10 - 2).
- Refresh the table (Figure 10 - 3).
- Switch to the chart view (Figure 10 - 5).
Figure 10 - Table
- Click the ellipsis button (Figure 10 - 4) to perform more actions (Figure 11).
Figure 11 - Table
More actions (Figure 11):
- Change the highlight color (Figure 11 - 1).
- Configure (Figure 11 - 2): you will be taken to the screen depicted in Figure 4.
- Duplicate (Figure 11 - 3): a clone of the Test Evolution gadget is immediately created.
- Delete (Figure 11 - 4): remove the Test Evolution gadget. A modal will open (Figure 12). Click Delete to confirm (Figure 12 - 1).
Figure 12 - Delete
Data and Calculations
Calculations are based on the historical changes for the Test Runs included in the specified analysis scope. For a Test Run, you may or not change the Test Run statuses several times; The Test Evolution gadget will consider it.
Xray stores historical precomputed information on the calculated test status whenever tests are executed. Therefore, there are two important aspects to consider:
- This gadget will not display information before the release date of this feature.
- Changes to past Test Runs do not affect the historical chart data.
General Rules for the Calculation of the Status for a Given Day
- Changes made over time to the status of a Test Run will be reflected in the calculated status for that Test (regardless of whether it's a final or a non-final status).
- A status will persist (i.e., valid) from the moment it has been recorded until the next status change in that Test Run or in another Test Run.
- The Started on or the Finished on dates of the Test Runs are not considered.
See here for more about Xray built-in gadgets for Requirement Coverage reporting.