Creating a pipeline script from Jenkins

You must create a pipeline script to run test assets from the Jenkins Pipeline project.

Before you begin

You must have completed the following tasks:

Procedure

  1. Open your Jenkins Pipeline project from the list.
  2. Click Configure, and then select the Pipeline tab.
  3. Click Pipeline Syntax to generate a pipeline script.
  4. Select the step: General Build Step option from the drop-down list in the Sample Step field.
  5. Select the Run an HCL DevOps Test UI - Functional Test option from the drop-down list in the Build Step field.
  6. Provide the details about the test run for the fields in the following table:
    Field Description
    Name Required. The name of the test.
    Project Directory Required. The fully qualified path to the Test UI project directory. You must use '\\' or '/' as the file separator.
    Script Name Required. The name of the script to be run.
    Log Format Optional. The format of the script run logs. The available options are as follows:
    • Default
    • none
    • json
    • xml
    • html
    • TPTP
    • Text
    Iteration Count Optional. The number of dataset iterations to be run.
    User Arguments Optional. Additional playback arguments, if any. For multiple arguments, you must enclose each argument within double quotation marks and separate the arguments by providing a space between them. For example, "password" "7891230" "20".
    Project Dependencies Optional. The complete path to the project that your test depends for the run. If there are multiple projects, you must separate each project path with a semicolon.
    Disconnected Mode Optional.
    The option to run the test through an agent in the background. The options are as follows:
    • True: Runs the test through an agent, and the test run continues even when the screen is locked or the agent is disconnected.
    • False: Runs the test, but the test run stops when the screen is locked or the agent is disconnected.
  7. Click Generate Pipeline Script and copy the script that you created for the build step to use it in the sample script.
    Note:

    You need this generated script to enter in step 5.c in the following topic:

    Configuring the Pipeline project by using the sample script

Results

You have created the pipeline script.

What to do next

You can configure the Pipeline project by using the Pipeline script option. See Configuring the Pipeline project by using the sample script.