Xray v3.0 has a basic built-in tests importer for HP ALM/QC v12.5x.
You can import test cases from HP ALM's "Test Plan" (not in any way related with 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
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.
- 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:
To start the importation process:
- Log in with an administrator account.
- Go to System>Import and Export>External System Import.
- Select Xray's HP ALM/QC Importer.
Then, you need to fill out the details of the HP ALM/QC instance, including its host name/IP, port, domain, project and authentication credentials.
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.
Upon a successful connection, you need to choose the project in which you want the Test issues to be created.
When the target project is chosen, you will be prompted to provide some additional configuration fields that allow you to fine tune the process.
- Label: a unique label to add to the Test issues that will be created so these can be quickly found afterwards
Hierarchical Test Organization: migrate hierarchical information from HP ALM/QC's "Test Plan" to Xray's Test Repository. Folders will be created, if needed, in the Test Repository and Tests will be moved to the folders.
To have this option available, you must be able to, at least, access the target project (i.e., browse permission), the Hierarchical Test Organization must be enabled in Xray settings, and:
- have one of the project roles configured on the default Xray global permission for the Hierarchical Test Organization in Xray settings.
- have the Create folders and Move issues user Xray Test Repository Permissions configured on the Project Permission Scheme of the target project
- Test Repository Path: the base Test Repository folder where ALM/QC's "Test Plan" hierarchical structured will be copied into. If "All" is selected, then the structure will be created in root of the Test Repository - this field is only displayed if the Hierarchical Test Organization option is checked.
- HP QC Folder: the base folder where to import Tests from. Only the specified ALM/QC's "Test Plan" folder and its subfolders, along with respective Test cases, will be imported. Folder path must be specified in the format "/Parent Folder/Child Folder"; leave it empty to import all folders. In the case of folders with similar names, make sure to use the full path of the folder. For instance, having 2 folders with the following paths (1: /base_folder, 2: /automated/base_folder), make sure to use full path in this field (/base_folder or /automated/base_folder)
We recommend using a unique label with numbers to assign 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 label fields in Jira.
A final confirmation dialog presents information about the total number of Tests 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.
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.