Xray v3.3 provides a built-in importer for Zephyr for Jira.
As of Xray v3.3, the importer only performs inline migration of data (i.e. Zephyr's Test issues are "moved" to Xray's Test issues).
Before using the Zephry Import tool
Before using the tool, please check the necessary requirements and also the existing features and its limitations.
Requirements before proceeding
- Zephyr >= 4.0.0
- Zephyr and Xray should be both installed
- project where migration is being done must have Xray issue types (at least the Tests, Test Executions and Test Plans)
- you may use the "Add Xray Issue Types" action shortcut available in the project settings page
- requirement issue types used in Zephyr must be configured in Xray
- all the different issue types that Zephyr Tests cover should be configured in Xray's Issue Type Mapping settings.
- defect issue types used in Zephyr must be configured in Xray
- all the different issue types are being used as defects in Zephyr should be configured in Xray's Issue Type Mapping settings.
- create similar Test Statuses and Test Step Statuses in Xray; this is not mandatory but may ease the process, which will always ask you to make the mapping between Zephyr statuses and Xray counterparts
- make sure Zephyr is using different issue links between Test<=>Defect and Test<=>Requirement, by going into Zephyr's configuration settings
- Do not change, create or delete any issue in the Project while the importation is running
- We strongly recommend you to make a backup of your Jira instance before doing the importation.
Please note
The current process performs an inline migration, i.e. Tests and data is migrated to Xray and the original entities are "lost".
Thus, we recommend to backup your Jira instance before performing the migration.
Also, as the amount of data to migrate may be considerable large, we advise you to perform this on non-working hours. Please also make sure that users are not changing data on the project while the migration is being done.
Features and Limitations
Below, please find a list of the support features and current limitations.
Most information will be migrated seamlessly but please check the following table in more detail.
| Supported Features | Unsupported |
|---|---|
Inline migration (not cloning) of:
|
|
| (*) Cycle folders will be migrated to Test Executions, since the semantics on Xray are a bit different in terms of entities/organization. | |
How it works
Within this section you're able to find the exact mapping of entities from Zephyr to Xray.
Mapping of information
| Zephyr entity | Xray entity | Notes |
|---|---|---|
Test
| Test
|
|
| Cycle | Test Plan (optional)
Test Execution, linked to the previous Test Plan
| The Test Execution created here will contain the Executions assigned directly to the Cycle, since in Zephyr you can have Executions at that level besides on each folder. Please note that...
|
| Cycle's folder | Test Execution, linked to the Test Plan created earlier from the Cycle
| |
| Ad-hoc Cycle | Test Plan (optional)
Test Execution, linked to the previous Test Plan
| |
Execution
| Test Run
|
Please note
All issues will be created in the project where the migration is being performed.
How to use
Performing the migration is easy; however, it is currently limited to Jira administrators.
The migration follows a wizard like interface; after going through the steps, some additional tasks required to ensure consistency of data.
Performing the migration
Suppose you have a project that you wish to migrate from Zephyr for Jira to Xray and that the requirements mentioned above are met.
To start the importation process:
- Log in with an administrator account;
- Go to System > Import and Export > External System Import;
- Select Xray's Zephyr Importer.
Then, you need to ....
Upon successful connection, you can optionally define a label to assign to the Test issues that will be created. This may be quite useful if you need a quick way to identify the newly created issues. The label syntax is restricted in the same way as the label fields in Jira. We recommend using a unique label with numbers.
Then, you need to choose the project in which you want the Test issues to be created.
A final confirmation dialog presents information about the total number of Tests that will be imported.
At the end, a brief summary is shown mentioning the total number of Test issues created and any warnings that occurred during the process.
From this screen, you can also see the list of created issues based on the label you provided. You can also consult the detailed logs about the process.
After doing the migration
After migrating data from Zephyr to Xray you will need to perform some additional operations:
- reset the "TestRunStatus" custom field of the migrated Tests
- reset the "Requirement Status" custom field of the requirements linked to the migrated Tests
2.
- ???