What you'll learn
- How to export test cases from Micro Focus ALM/HP QC using a script to extract the test cases and convert them to an Xray compatible CSV file
- Import different test cases (with different fields and options)
- Validate that the test cases were imported to Xray
Overview
Micro Focus ALM (ex HP QC) is a tool from the opentext (ex Micro Focus) toolset. In this tutorial, you will learn how to export the test cases from ALM/QC using the API, and how to use a script (available in GitHub) to convert the XML obtained from the API call into a compatible CSV, so that it can be imported into Xray using the Test Case Importer.
This tutorial will provide an example of exporting test cases (with varied characteristics) from ALM/QC and importing them into Xray.
Features and Limitations
Below is a list of the supported features and current limitations.
Migration from ALM/QC is limited by the information we can export from ALM/QC and how it can be mapped to Xray entities.
Most of the test case information will be migrated seamlessly, but please check the following table for more details.
| Supported Features | Unsupported |
|---|---|
|
|
How it works
Micro Focus ALM/HP QC is an application that allows the users to specify and organize test cases into folders in the TestPlan tab. ALM/QC has test sets, test folders, and plans; these concepts help the organization and execution of test cases. Depending on your testing goals, you can use them or not.
In ALM/QC, we can create test cases and choose the type of the test case between many different types that are there to support the other modules available in this toolset. The script in this tutorial only exports the Manual test types.
In the Manual test type, the user can define multiple steps with step description and expected result; in these steps, you can define a data set and use variables or call other test steps. All of the test types can use steps to define the tests and have special fields available (depending on the test type used to integrate with automation using other opentext modules).
In ALM/QC, to execute tests, you need to associate the executions to a test suite under a folder in the test lab.
ALM/QC uses different entities to describe tests and the flow, so we have summed up into the next table the existing mappings between ALM/QC and Xray.
| ALM/QC | Xray | Comments |
|---|---|---|
| Test Case | Test | Only manual test types are imported into Xray. |
Prerequisites
Example
We will show how we configured and obtained the XML content with all tests from the Domain and Project from ALM/QC. The following examples also show how the scripts convert the XML content extracted from the API into compatible CSV files, and finally, how to import the CSV content into Xray. All of the code is available in GitHub.
We will showcase exporting test cases from ALM/QC using a combination of fields and options that should cover most use cases.
All of the examples in this tutorial have the CSV file with the definition of the test cases to import and a configuration file that will handle all associations and fields for the import to be successful.
Export to XML from ALM/QC and import into Xray
The following script extracts all Manual tests associated to a Domain and Project from ALM/QC.
The first step is to configure the username/password and endpoint of your ALM/QC instance in the 'hpqc_config.ini' under the 'hpqc' section.
The username and password used are the ones with permissions to access your ALM/QC instance.
The endpoint (HPALMQC_ENDPOINT) is the URL you use to access your ALM/QC instance.
The script will then perform the authentication as described in the ALM/QC documentation and create a session.
Once the user and session have been created, the script uses the Domain and Project passed in the script command line to extract all Manual tests from the project on that domain.
In ALM/QC, we can see that we have four tests under the Test Plan tab, three Manual tests and one VAPI-XP-TEST for the Domain TEST and Project DEMO.
The script requests all tests from the TEST Domain and Project DEMO using the endpoint: "rest/domains/{domain}/projects/{project}/tests" that lists all tests available there.
Once that information is returned the script requests the test steps for each test present in the previous request using the endpoint: "rest/domains/{domain}/projects/{project}/design-steps?query={{parent-id[{test.id}]}}".
The XML generated by ALM/QC that holds the steps has the following content:
To execute the script, use the following command:
python3 hpqc2Xray.py -p DEMO -d TEST -o hpalmqc_tests.csv
The script parses the content and converts it into a compatible CSV file.
The output file has all the test steps and the format defined in ALM/QC.
To import it into Xray, we use Test Case Importer with the recently created CSV file; you can use the configuration file provided with the .json extension (importConfiguration.json).
Choose the Project into which you want to import the Tests, as shown below.
When the import operation is complete, you can download the operation details, save the configuration for future use, or check the created issues.
When you click over the link to see the imported issues, we can see that it has created three Tests with all the properties defined in the CSV.
More Details
Let's look into some specificities of this approach and some test particularities.
Manual Tests (With Steps) into Manual Test Case
ALM/QC allows you to create Manual Test Cases with steps (using step description and expected results).
We have created three test cases using the steps separated into fields.
After running the script that converts the XML returned from ALM/QC into a CSV file, we can see that each Test is created and the steps are filled with the information extracted from the returned requests.
The Test Cases extracted use the Test Name from ALM/QC as the summary, and the description is extracted directly into the description field of Xray. Notice that most of the style format is exported into Xray also.
In the first Test we also have several steps that were extracted from the Design Steps of the ALM/QC, the script takes the Description from ALM/QC and creates an Action in Xray. In the same way, it extracts the Expected Result from ALM/QC and creates an Expected Result on the Xray side.
The parameters and Modular tests must be recreated as the information available from ALM/QC does not include them, so they cannot be imported in Xray.
Modular test case from ALM/QC are exported as a reference to the original test case and must be recreated.
Tests with data sets defined in ALM/QC are imported without the data set.
All style formats are maintained with the exception of the underline.
ALM/QC does not define priority, so all Manual Tests imported have the Medium priority associated.
Tips
- Use the CSV file provided to import the examples and the associated JSON configuration to have the setup and mapping correct.
- Ensure you are using the scripts available for the right version of Jira (Cloud or Server).