Versions Compared

Old Version 1

changes.mady.by.user Sergio Freire

Saved on

compared with

New Version Current

changes.mady.by.user Isabel Moreira

Saved on

Key

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

Xray v3.3 provides a built-in importer for Zephyr for Jira.

You can import test cases from HP ALM's "Test Plan" (not in any way related with 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 Plan issue) by using HP ALM's REST API.

The current implementation is essentially limited to importing manual test specifications, their steps and their attachments.

Features and Limitations

...

  • import Test case specification from HP ALM's "Test Plan"
    • tests without parameters
    • tests without called steps
    • tests that are not marked as "templates"
    • tests of type "MANUAL"
  • import Test attachments and Test step-level attachments
  • import formatted Test description

...

issues).

Before using the Zephyr 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
  • Defect issue types used in Zephyr must be configured in Xray
  • 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
  • The only mandatory field in Xray's Test, Test Execution and Test Plan should be the issue Summary and issue Reporter
  • Make sure that the Jira workflow states, that are being used by "Zephyr Test" issue type, are editable. Click here for the official Jira documentation on this subject.
  • We strongly recommend you to make a backup of your Jira instance before doing the importation

...


Info
titlePlease note

The current importer is relatively basic. If you need to migrate more information and have further control over the migrated data, we recommend you contact an Atlassian partner with expertise on this kind of migrations. Note that migrating "all" information may be a complex process to implement and some things may not be mappable at all.

Info
titlePlease note
  • The steps information from HP ALM/QC is saved in HTML which is only convertible to Jira's wiki markup from Jira 7.2 and later. In Jira version below 7.2, the steps are shown with HTML markup.
  • In order to import Tests, the Test issues cannot have required fields in Jira; you must set them as optional before starting the import process.

How to use

Suppose you have a project in HP ALM (see above for supported version/s) and you wish to import the tests from HP ALM's "Test Plan", as seen below:

Image Removed  Image Removed

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 FeaturesUnsupported

Inline migration (not cloning) of:

  • Test and Test steps
  • Test and Test step attachments
  • Links between Tests and Defects/Requirements
  • Cycle
    • including Cycle folders*
  • Executions
    • defects (global and step level)
    • attachments (global and step level)
    • result (global and step level)
    • comments (global and step level)
    • assignee
  • All Zephyr executions from the Ad-hoc cycle; only the last Execution is migrated
  • Custom fields in Test steps and on the Execution
  • Activity information
  • Test Statuses and Test Step Statuses configurations
  • Cycle folders as such*
(*) 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 entityXray entityNotes

Test

  • steps
  • attachments

Test

  • steps
  • attachments
  • if empty, the "Step" column will be filled with "<undefined>"
Cycle

Test Plan (optional)

  • Summary: <version> - <cycle's name>
  • fixVersion: version assigned to Cycle

Test Execution, linked to the previous Test Plan

  • Summary: <version> - <cycle's name> Execution
  • fixVersion: version assigned to Cycle

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...

  • if the Cycle contains multiple Executions for the same Test, only the last Execution will be migrated
Cycle's folder

Test Execution, linked to the Test Plan created earlier from the Cycle

  • Summary: <version> - <cycle's name> - <folder name> Execution
  • fixVersion: version assigned to Cycle

Ad-hoc Cycle

Test Plan (optional)

  • Summary: <version> - Ah Hoc
  • fixVersion: version assigned to Cycle

Test Execution, linked to the previous Test Plan

  • Summary: <version> - Ad Hoc Execution
  • fixVersion: version assigned to Cycle

Execution

  • global comment
  • global defects
  • global status
  • step results
  • step comments
  • step defects
  • step status

Test Run

  • global comment
  • global defects
  • global status
  • step results
  • step comments
  • step defects
  • step status

Info
titlePlease 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:

  1. Log in with an administrator account.;
  2. Go to System>Import and Export>External System > Import and Export > External System Import.;
  3. Select Xray's HP ALM/QC Importer.

Image Removed

  1. s Zephyr for Jira Importer.


Image Added


If you see the following error message, then it's because Zephyr is using the same issue link types between Test<=>Defect and Requirement<=>Test.

Image Added

Xray needs have different relations, so that is able to understand the different cases. ThusThen, you need to fill out the details of the HP ALM/QC instance, including its host name/IP, port, domain, project and authentication credentials.

Image Removed

Info
titlePlease note

When you click Next, the connection is validated. If the connection fails, an error message is shown and you won't be able to proceed with the importation process.

Image Removed

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.

Image Removed

Then, you need to choose the project in which you want the Test issues to be created.

change the "Linktype for Test → Relation" to something different from the value "LinkType for Requirement → Test". For example, you can leave "LinkType for Requirement → Test" with "Relates" and change the "Linktype for Test → Relation" to "Defect".

These relations are configurable in Add-ons > Zephyr for Jira > General Configuration > Issue and Remote Links Configuration.


Image Added


After ensuring that the link types are configured with distinct values, you may proceed once again with the migration process. 

The importer will show you some brief information, that we advise you to read carefully.


Image Added


Then, you need to choose the project where to perform the migration; this will be same where the Xray entities will be created in. 

You may fine-tune the process by (un)checking some flags:

  • Links between requirements and tests to respective Xray Issue Link Type used for requirement coverage: creates the link Xray uses for tracking coverage between Tests and requirements; by default Xray used the "tests" issue link type
  • Zephyr Cycles to Xray Test Plans: creates Test Plans based on Zephyr Cycles
  • Zephyr Ad Hoc Cycles to Xray Test Plans: creates Test Plans based on Zephyr Ad Hoc Cycles


If Zephyr Cycles to Xray Test Plans and Zephyr Ad Hoc Cycles to Xray Test Plans are unchecked then no Test Plans will be created; nevertheless, Test Executions will always be created if Zephyr Executions exist. 


Image Added


You need to map Zephyr's Test Statuses to Xray counterparts.


Image Added


Likewise, you also need to map Zephyr's Test Step Statuses.


Image AddedImage Removed


A final confirmation dialog presents information about the total number of Tests Xray entities that will be imported.This number may be lower than the actual number of Test issues that will be created; this occurs because Xray will only be able to import some of the tests, depending on their characteristics which can only be determined during the actual importation.


Image RemovedImage Added


At the end, a brief summary is shown mentioning the total number of Test Xray issues created and any warnings that occurred during the process.


Image Added


Please have a look at the process.

Image Removed

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.

following section for some additional steps before concluding the migration process.

After doing the migration

After migrating data from Zephyr to Xray you will need to perform some additional operations to recalculate the status of Tests and the coverage of the related requirements.

  1. reset the "TestRunStatus" custom field of the migrated Tests
    1. you can use the link provided in the final screen mentioned earlier for quickly obtaining the created Tests; you will be redirected to the Issues search page 
      Image Added
    2. save this search as a filter (you will need it afterwards)
      Image Added
    3. do a bulk change operation on the Test issues
      Image Added

    4. reset the TestRunStatus custom field
      Image Added
  2. reset the "Requirement Status" custom field of the requirements linked to the migrated Tests
    1. use the testRequirements JQL function using use the name of the previously saved filter as argument
      Image Added
    2. do a bulk change operation on the requirement issues
      Image Added
    3. reset the Requirement Status custom field
      Image Added

...