Configuring the Freestyle project

You must configure a Freestyle project to add a build step, and then run test assets from Jenkins.

You must have completed the following tasks:

  • Installed the DTUI-FunctionalTest-Jenkins-IBM plugin on the Jenkins primary server. See Installing the plugin on the Jenkins primary server.

  • Created an Agent in Jenkins. For more information about creating Agents, refer to the Jenkins documentation.

  • Copied the name of the labels that you provided in the Labels field when you created the Agent.

  • Created a Jenkins Freestyle project.

When you create a Freestyle project in the Jenkins server, you must select the Restrict where this project can be run checkbox and enter the name of the labels that you provided during the creation of Agent in the Label Expression field.
  1. Open the Jenkins Freestyle project, and then click Configure.
  2. Click the Build tab, and then click Add build step.
  3. Select the Run an IBM DevOps Test UI - Functional Test option from the drop-down list.
  4. 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.
    Fail the job if the test or any of the containing tests fail The flag to indicate whether the job should be marked as failed when the test or any child test within the test fails.
  5. Optional: Click Add build step again, and provide details for the next test to run multiple tests under the same job.
  6. Click Save.
You have configured the Freestyle project by adding the build step.
You can run test assets from the Jenkins server. See Running tests from Jenkins.