Setting up the integration with Jenkins

You can set up the integration with Jenkins by deploying the HCL OneTest API plug-ins for Jenkins into the Jenkins environment.

Before you begin

HCL OneTest™ API or HCL OneTest API Agent must be installed on the same computer as Jenkins (master or slave). If you are using Apache Ant to run your tests, you must install it on the same machine as well. It is not necessary to install HCL Quality Server on the same computer as the other software. See also, Note.
The computer that is running the Jenkins service must have the HCL OneTest™ API license key available to Jenkins. The license key is found at the following location:
  • Windows: C:\Windows\System32\config\systemprofile\HCL\hclproducts\licensing.
  • Linux: /var/lib/jenkins/HCL/hclproducts/licensing.

About this task

You can deploy the HCL OneTest API plug-ins for Jenkins to run tests and integrate viewing of test results from HCL OneTest™ API in the Jenkins Job view.
Note: The test results viewer plug-in the HPI file can have a different name depending on the version of HCL Quality Server that is in use:
  • In all the versions older than 9.1.1: RITPluginForJenkins-1.4.hpi.
  • In version 9.1.1: IntegrationTesterPluginForJenkins-1.4.hpi.
  • Starting in version 9.1.1.1: IntegrationTesterResultsPlugin-version.hpi, where version is the plug-in version number. For example, 1.5.

The test execution plug-in IntegrationTesterTestExecution-version.hpi is available in HCL Quality Server version 9.1.1.1 or later only. It requires HCL OneTest™ API or HCL OneTest API Agent version 9.1.1.1 or later.

Procedure

  1. Download and extract the HCL OneTest API plug-ins for Jenkins package (CIJenkins.zip) that is provided with HCL Quality Server. For more information, see HCL OneTest™ API tool packages.
  2. Copy the IntegrationTesterResultsPlugin-version.hpi file from the downloaded package to a temporary location on the computer where Jenkins is installed. For the exact file name, check Note at the beginning of this topic.
  3. Using a web browser, open the Jenkins dashboard and click Manage Jenkins.

    The Manage Jenkins page is displayed.

  4. Click Manage Plugins.
  5. Click the Advanced tab.
  6. Under Upload Plugin, click Choose File, navigate to the hpi file, and click Open.
  7. Click Upload.

    The plug-in is installed.

  8. Select the Restart Jenkins when installation is complete and no jobs are running check box.

    Alternatively, restart Jenkins manually.

  9. Optional: After Jenkins restarts, you can verify that the plug-in is installed by completing the following tasks:
    1. Click Manage Jenkins on the Jenkins dashboard.
    2. Click Manage Plugins on the Manage Jenkins page.
    3. Click the Installed tab.

      Under Name, an HCL OneTest API Results Plugin entry is displayed and under Enabled, a check box next to the name is selected.

  10. Repeat from Step 2 to Step 9 for the IntegrationTesterTestExecution-version.hpi file, as applicable. See Note at the beginning of this topic for details. When you repeat Step 9, the name of the plug-in to look for is HCL OneTest API Test Execution Plugin.

Results

You can now use Jenkins to run HCL OneTest API tests and view the results.

Feedback