Jira Datacenter supports archiving of issues and projects since v8.1. By archiving issues, Jira will remove them from the indexes. The archived issues will still be accessible in read-only mode, however, they will not appear in Jira searches. This enhances Jira performance because Jira stores less data.
This page describes the known impact and limitations of archiving issues in Xray.
We have plans to support the Jira archiving feature and even extend this feature so that Xray issues can be archived without some of the undesirable side effects that are described on this page. A good use case for archiving Xray issues, will be to archive old Test Executions, especially if continuous integration processes keep importing new execution results into Xray on a daily basis.
This feature is on our Roadmap.
For more information on archiving issues please visit JIRA documentation.
Test Run Status
Archiving a Test issue
Even though the Test is read only, it still can be executed from the Test Runs section and the fields from the execution page can be edited (evidences, steps, comments, custom fields, etc).
Archiving a Test Execution
The Test Execution will still contribute for the Test Run Status of the Test. However the Test Execution will not be listed in the Test Run Section of the Test and there will be no indication that an archived Issue is affecting the Test Run Status.
Requirement Status and Coverage
Archiving a Test
The Test Issue still contributes to the Requirement Status, even after reseting this custom field. However the Test is not included in the Test Coverage and there is no indication that an archived Test is affecting the Requirement Status.
When clicking on the link in the Requirement Status bar the Test will not be found in the JQL search.
Archiving a Test Plan
In the Test Coverage Section we will not be able to perform the analysis in the scope of the archived Test Plan because the Issue will not be found in the selector. However, the Test Plan still contributes for the coverage.
Test Execution Overall Execution Status
When archiving a Test it will still contributes to the Overall Execution Status. However, the Test will not be listed in the Tests Section.
Test Plan Overall Execution Status
When archiving a Test issue it will still be included in the Overall Execution Status. However, it will be count with the wrong status (in the example bellow it should be FAIL) and will not be included in the Test list.
The Overall Execution Status bar of the Test Plan board behaves the same way.
Issue Section data tables
Issue sections will not display the associated archived issue. Instead it will display an empty filtered table. See the example bellow for a Test associated with an archived Test Set.
This will affect the following Issue page sections:
- Tests Section of Pre-Condition page
- Tests Section of Test Execution page
- Tests Section of Test Plan page
- Tests Section of Test Set page
- Test Runs Section of Test Page
- Test Plans Section of Test Page
- Test Sets Section of Test Page
- Pre-Conditions Section of Test Page
Test Repository/Test Plan Board
There is an incorrect Test count if the archived Test is associated with a folder. Also the Test will be visible if associated with a folder, otherwise it will not appear in the orphans.
Automated Steps Library
When archiving a Test it still being included in Tests count but the JQL link will not work.
Reports
According to JIRA documentation, archived Issues will no longer appear on the reports. This is not always the case for Xray reports.
All Requirement reports
- Requirement Status is still affected by archived Test
- Test Plan scope analysis is not possible because the archived Test Plan is not found by the selector component
Traceability Report
- Archived Tests are included in the report
- Archived Test Executions are Included in the report
- Archived Defect Issues are included in the report.
Overall Requirement Coverage Report
- Archived Tests are included in Tests counts but JQL link will not work
Test Plans report
- Archived Test is included in Tests counts and included in wrong status (it is wrongly included in TODO). JQL link will not work.
- Archived Test Execution is included in the #Test Executions column but the JQL link will not work.
- Archived Defects are included in the report but JQL link will not work.
Test Executions Report
- Archived Test is included in Tests counts but the JQL links will not work.
- Archived Defects are included in the report but JQL link will not work.
Test Runs Report
- Test Run for archived Test is included in the Report.
- Test Run for archived Test Execution is not included in the Report. This is not coherent with the archived Test behavior.
- Archived Defects are included in the report but JQL link will not work.
Gadgets
According to JIRA documentation, archived Issues will no longer appear on dashboards. This is not always the case for Xray gadgets.
Tests Evolution gadget
The archived Test is being included in the Total value but not on statuses.
Test Runs List gadget
- The archived Test is listed in the gadget.
Requirements List gadget
- Archived Test is still affecting the Requirement Status
- Test is included in Tests counts but JQL link will not work
Test Runs Summary
- Test Run from archived Test is included in the report.
Historical Daily Requirement Coverage Report
- Archived Test is still affecting the Requirement Status.
Overall Requirement Coverage Report
- Archived Test is still affecting the Requirement Status.
REST API V1.0
Test Runs
Even though the Test is read-only, the Test Run can still be edited using the endpoints (PUT|POST|DELETE) /rest/raven/1.0/api/testrun/{id}/status/*.
see Test Runs - REST.
Test Repository
When Using GET /rest/raven/1.0/api/testrepository/<projectKey>/folders the archived Test is included in counts.
PUT and POST can also be executed, even though the Test Issue is read-only.
Import Execution Results
- Execution results can be imported even though the Test issue is archived
- For archived Test Execution it will return an error
REST API V2.0
Test Runs
- PUT on /testrun is possible even when Test is archived
- PUT on /testrun is not possible when Test Execution is archived
Import Execution Results
- Execution results can be imported even though the Test issue is archived
- For archived Test Execution it will return an error
JQL Functions
The cases noted in the table below are not necessary wrong, but due to their peculiarity deserve some reflection.
| JQL function | note |
|---|---|
requirements | The Requirement Status is still affected by the archived. It will return same results as if Test issue wasn't archived. |
requirementsWithStatusByTestPlan | The Requirement Status is still affected by the archived. It will return same results as if Test or Test Plan issue wasn't archived. |
testTestSet | Returns associated issues, even if issue passed as argument is archived. |
testTestSet | Returns associated issues, even if issue passed as argument is archived. |
testsWithNoTestSet | Returns associated issues, even if issue passed as argument is archived. |
testPreConditions | Returns associated issues, even if issue passed as argument is archived. |
preConditionTests | Returns associated issues, even if issue passed as argument is archived. |
testRequirements | Returns associated issues, even if issue passed as argument is archived. |
requirementTests | Returns associated issues, even if issue passed as argument is archived. |
testExecutionTests | Returns associated issues, even if issue passed as argument is archived. |
testTestExecutions | Returns associated issues, even if issue passed as argument is archived. |
testSetPartiallyIn | Returns associated issues, even if issue passed as argument is archived. |
testSetFullyIn | Returns associated issues, even if issue passed as argument is archived. |
testPlanTests | Returns associated issues, even if issue passed as argument is archived. |
testPlanTestExecutions | Returns associated issues, even if issue passed as argument is archived. |
testPlanRequirements | Returns associated issues, even if issue passed as argument is archived. |
testTestPlan | Returns associated issues, even if issue passed as argument is archived. |
Xray Integrity Checker
There is a peculiarity with the following entries of the Xray Integrity Checker
- Clear Test Set Test Count and Test Plan Test Count Custom Field
- Clear Test Execution Defects Custom Field
Let's take the example of an archived Test Set with associated Tests. Running the clear Test Count will clear the value for the issue and, after opening the archived Test Set issue, the value will not be recalculated because the issue is read-only.