Versions Compared

Old Version 1

changes.mady.by.user David Duarte

Saved on

compared with

New Version Current

changes.mady.by.user David Duarte

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Jira Datacenter supports archiving of issues and projects since  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 searchessearch results. This enhances Jira performance because Jira it stores less data in the indexes.

This page describes the known impact and limitations of archiving issues in Xray.

As many of the Xray entities are normal Jira issue objects, archiving its issues has the same effect of archiving any other Jira issue type. But additionally, Xray extends this feature by archiving some of its internal data.

The goal of this page is to describe the effects of archiving issues on Xray.

Table of Contents

Archiving Test Executions

Info

Archiving old Test Executions is a good

Info

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 are used. These can quickly create many Test Execution issues while 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.

Table of Contents

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.

Image Removed

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.

Image Removed

When clicking on the link in the Requirement Status bar the Test will not be found in the JQL search.

Image Removed

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.

Image Removed

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.

Image Removed

The Overall Execution Status bar of the Test Plan board behaves the same way.

Image Removed

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.

Image Removed

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.

Image Removed

Automated Steps Library

When archiving a Test it still being included in Tests count but the JQL link will not work.

Image Removed

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.

Image Removed

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.

see Test Repository - REST.

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.

...

requirements

...

requirementsWithStatusByTestPlan

...

testTestSet

...

testTestSet

...

testsWithNoTestSet

...

testPreConditions

...

preConditionTests

...

testRequirements

...

requirementTests

...

testExecutionTests

...

testTestExecutions

...

testSetPartiallyIn

...

testSetFullyIn

...

testPlanTests

...

testPlanTestExecutions

...

testPlanRequirements

...

testTestPlan

...

These issues are good candidates to be archived.

Archiving Test Execution issues will hide them from:

Archiving a Test Execution will also archive its Test Runs.

Archiving Test Runs

Archiving a Test Execution issue automatically archives its related Test Runs. Doing so will not delete the Test Run information from database, instead they will be:

A message will be shown in the Test and Test Execution issue view informing there are archived Test Runs:

Image Added

And also in the execution page:

Image Added

Test Runs archived via Test Execution issue can be restored at any time by restoring the Test Execution issue.

Archiving Tests

Archived Test issues:

Archiving a Test will also archive its Test Runs.

Archiving Test Runs

Archiving a Test issue will also archive its related Test Runs with the same effects described previously when archiving via Test Execution issue.

Test Runs archived via Test issue can be restored at any time by restoring the Test issue.

Archiving Test Plans

Archiving Test Plans will hide them from:

Archived Test Plans will also no longer be used as scope for the Test Run Status and Requirement Status.

Effects in the Test Run and Requirement status scope

Archived Test Plans are no longed used as scope for the Test and Requirements status custom fields, which affects the scope analysis of Requirements and Tests: After archiving a Test Plan TP, a given Requirement R that was NOK in the scope of TP will be UNCOVERED for the same scope TP.

Another effect of not being used as scope is that the Latest Statuses of Tests under a Test Plan issue will not be shown anymore. For this reason, when archiving a Test Plan, a message will be displayed informing of the situation:

Image Added

An archived Test Plan issue can be restored anytime, doing so will retrieve the Test Plan state prior to archiving and all of the Test Plan-scoped statuses for Tests and Requirements.

Archiving Requirements

Archived Requirements will be excluded from:

Archiving Requirements will also archive their Sub-Test Executions.

Archiving Sub-Test Executions

Each issue is archived along with all its subtasks.

In case a Requirement is archived, its Sub-Test Executions will be archived as well. A Sub-Test Execution has the same functionalities of a Test Execution so archiving them have the same effect as archiving a Test Execution issue, namely all its Test Runs will be archived.

Archiving Test Sets and Pre-Conditions

Archived Test Sets and Pre-Conditions will be excluded from:

Archiving Projects

When archiving a Project all its issues are archived as well, including the Xray ones.

The effects of project archiving will be the same as archiving issues.

For example, the archived issues will no longer be present on JQL results and if Test or Test Executions are found, Xray will also archive their internal data, namely its Test Runs.

Impact on Xray Issue Links

Info
This section refers to the Xray custom issue links only (e.g. Tests associated with Pre-Conditions, with Test Sets, etc.) and not to the Jira native issue links.

Whenever issues are archived, those will no longer be present on JQL search results.

Due to the fact that Xray Issue Data Table components, used for presentation of Xray issue associations, are built on top of JQL searches and that archived issues no longer appear in those search results, the links will no longer be shown in some issue views. Because of that, there is no way to know if an issue is still linked to an archived one.

Whenever this happens, a warning message will be displayed at the top of the affected Xray Issue Data Table informing that some associated issues are being hidden. The below image shows an example of the Test Sets section in a Test issue view after archiving one of its related Test Sets.

Image Added

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.