Configuring the Freestyle project by using the Integration Tester Jenkins Plugin

After you install the Integration Tester Jenkins Plugin on the Jenkins server, you can configure the Jenkins Freestyle project environment to run the Integration Tester tests as a Jenkins build.

Before you begin

You must have completed the following tasks:


  1. Open the Jenkins Freestyle project on the Jenkins Dashboard, and then click Configure.
  2. Click the Build tab, and then click Add build step.
  3. Select Run Integration Tester Tests.

    The build step is displayed.

  4. Enter values for the following fields:
    Field Value
    Installation directory Enter the path to the installation directory of HCL OneTest API.
    Project Enter the path to the folder containing the project and the name of the project
    Environment Enter the name of the environment that is configured in the project.
    Tests Enter the name of the test that you want to run.

    If you leave the Installation directory blank, the following environment variables are queried during runtime to find the directory:

    Note: In HCL OneTest API 10.2.2 or later, the environment variables INTEGRATION_TESTER_HOME and INTEGRATION_TESTER_AGENT_HOME are automatically created at the time of installing the product software.

    The job fails if the value is blank. These variables must be visible to the user or the service account that is running the Jenkins primary or secondary server. If you update either of the environment variables, you must restart the Jenkins primary or secondary server for the values to take effect.

  5. Click Advanced to view and update the other fields that are relevant for the test.
  6. Click Save.


You have configured the Freestyle project by adding the build step.

What to do next

You can run test assets from the Jenkins server. See Running tests from Jenkins.