Articles in this section

See more

QuerySurge REST API Integration with ALM/QC (Versions: 14.2+)

* Note: Screenshots were taken of ALM/QC while under HP ownership. Please use this as a reference as screens and names may have changed.

The Scheme

QuerySurge Test Management REST API allows tools such as ALM's Lab Manager to execute tests and retrieve results from QuerySurge. Following diagram illustrates the relationships: 

Pre-requisites

Remote Host Execution with QC/ALM requires installation of the Lab Manager components in your environment. The Lab Manager components do not have to be installed on your QC/ALM server; they can be installed on any boxes you have selected to act as remote hosts. For information regarding remote hosts and Lab Manager configuration, refer to Help and Support. 

Setup

Note: The steps in this section can be done with any login to QC/ALM from any PC on your corporate network. 

  1. Log into Application Lifecycle Management

     
  2. In Application Lifecycle Management, click on Test Plan View

     
  3. Click Tests->New Folder

     
  4. Give the folder a Test Folder Name and press the OK button

     
  5. Right Click on the folder and choose New Test

     
  6. Enter a Test Name, make sure to choose the Type of VAPI-XP-TEST, and press the OK button

     
  7. Click the Finish button

     
  8. Open the sample vbs file (ALM_QC_Script_Rest.vbs), which, if you chose the default options while installing Test Management Sample Script, is found in the C:\Program Files\QuerySurge\rest\samples\testmanagement-samplesfolder

     
  9. In the section between the START OF CONFIGURATION VARIABLES and END OF CONFIGURATION VARIABLES, Edit the variables to the specifics on your machine.

     
  10. Back in Application Lifecycle Management, click the Test Scripts tab.

     
  11. Copy the entire text found in the vbs file into the Test Scripts window.
  12. Click the Save button.
  13. Click Test Lab.

     
  14. Choose Test Sets -> New Folder.

     
  15. Give the folder a Test Set Folder Name and press the OK button

     
  16. Right click on the folder just created and choose New Test

     
  17. Type in a Name ("Demo Test Set" in this example) and press the OK button.

     
  18. Click the Select Tests button.

     
  19. Navigate to your test.

     
  20. Click the "left arrow" button to add the Test to the Test Set.

     
  21. Click the X button to close.

Running QuerySurge from QC/ALM 

  1. Log into Application Lifecycle Management

     
  2. Navigate to your test set and select Run Test Set 

     
  3. On the Automatic Runner Dialog: Click on the Run on Host field. If running tests locally, select Run All Tests Locally and proceed to Step 5.

     
  4. Select your remote host from drop-down and select your host

     
  5. Click the Run button

     
  6. When the test finishes close the Automatic runner to view the high level results
  7. Click Test Runs

     
  8. Click the Refresh button

     
  9. Click on your test result

     
  10. Click on Report

     
  11. You will see a URL provided in the Actual section, so copy and paste this result into a browser

     

  12. Type in your QuerySurge username and password
     

    login.png

     

  13. You will be navigated right to the particular QueryPair you selected from Application Lifecycle Management

    app.png

  14. Click on Steps

     
  15. Notice you will see the same URL in the Actual section as you did when you were in Report

     
  16. Click on the paperclip next to a QueryPair

     
  17. Click on the link to QuerySurge

     

  18. Type in your QuerySurge username and password
     

    login.png
     

  19. You will be navigated right to the particular QueryPair you selected from Application Lifecycle Management
     

    app.png

Troubleshooting

Login Failure

If you encounter a "Login Failed" error while running the script, verify the configuration variables defined at the beginning of the script. Ensure they align with your environment specifications, including correct hostnames, ports, and authentication credentials. Common causes of this error include misconfigured connection details or incorrect credentials.

 

VAPI-XP Test runs in QC/ALM, Pass-Fail results return, but No Steps are Created

This issue is usually related to the user permissions granted to the QC/ALM user by the QC/ALM admin.

  • For QC/ALM to populate the run steps for a QuerySurge test execution the QC/ALM user login executing the test must have the appropriate QC/ALM permissions.
     
  • QC/ALM permissions are set at the group level in the Project Customization section. Make sure that the correct ALM users are in the group whose permissions are modified for use with QuerySurge.
     
  • In the QC/ALM Project Customization section, choose Groups and Permissions. Select Test Lab permissions. Choose a group that your QC/ALM users are in, and assign permissions for Create and Update rights, for the following:
    • Result
    • Run
    • Run Step
    • Test Instance
    • Test Set
    • Test Set Folder
       
  • Make sure to Save your changes.

Note: Newer ALM versions will have more "child" options than previous QC/ALM versions (which may have no child options). Some of these will interact with higher-level choices, so selecting Create or Update will automatically configure the child options.

In the sample image below, a Group has been created by a QC/ALM Admin user for QC/ALM users who will execute QuerySurge VAPI-XP tests. This Group, called "QuerySurge Tester" has Test Lab permissions assigned as described above.
 ALM-Proj-Cust-1.png

 

Related articles