Configuring the process in IBM® DevOps Deploy

You must configure the process that you created for the component to organize the steps in the process, specify the properties of the steps, and connect them in IBM® DevOps Deploy (Deploy).

Before you begin

About this task

When you open any process to configure, the process is displayed in the process editor. The process editor lists the plugins and steps. The required Start and Finish steps represent the beginning and the end of the process and steps are automatically placed on the design area.

Procedure

  1. Log in to Deploy, if you are not already logged in.
    The Deploy dashboard is displayed.
  2. Click Components.
    A list of components that are available in Deploy is displayed.
  3. Select the component from the list in which you created the process.
  4. Click the Processes tab.
    A list of processes that are available for the component is displayed.
  5. Select the process from the list that you want to configure.
    The Design tab for the process is displayed.
  6. Click HCL DevOps Test Workbench, and then HCL DevOps Test Hub from the left menu.
  7. Drag the Run HCL DevOps Test Hub test step, and then drop it into the design area.
    Note: The selected test must be placed between Start and Finish steps.
  8. Specify the properties for the selected test by performing the following steps:
    1. Click the Edit icon.
      The Edit Properties for Run HCL DevOps Test Hub test dialog is displayed.
    2. Specify the properties for the selected test step by referring to the following tables:

      The following table lists the required fields that you must provide to run the test from Deploy:

      Fields Action
      Name

      Enter the name for the test step.
      HCL DevOps Test Hub URL

      Enter the URL of Test Hub.
      Offline Token

      Enter the offline token that you generated from Test Hub.
      Team Space Name

      Enter the name of the team space that contains the project.

      Note: The license for the team space must be configured and you must be a member of that team space.
      Project Name

      Enter the name of the project that are available in the team space.
      Repository Link

      Enter the URL of the Git repository that you added to your project in Test Hub.
      File Path

      Enter the path of the test assets that you want to run.

      You can find the path of the test assets from the Execution page in Test Hub

      The following table lists the optional fields that you can provide to run the test from Deploy:

      Fields Description
      Branch Name

      Use this field to enter the name of the branch in the Git repository where you stored test assets.
      Custom Trust Store Password

      Use this field to enter the trust store password if you have modified the password while creating the custom trust store.

      Note: If you have not modified the trust store password, you can retain the Custom Trust Store Password field blank.
      Custom Trust Store Path

      Use this field to enter the file path of your trust store followed by the file name if Test Hub uses an internal CA certificate and you have imported the certificate to a custom trust store.
      Datasets

      Use this field to enter the path to the dataset if you want to replace the values of the dataset during a test run.

      You must ensure that both original and new datasets are in the same workspace and have the same column names. When you enter a value for the Datasets field, you must also include the path to the dataset. The path must be in the following format:

      /project_name/ds_path/original_ds.csv:/project_name/ds_path/new_ds.csv

      Note: You can override multiple datasets that are saved in a different project by adding multiple paths to the dataset separated by a semicolon.
      Environment

      Use this field to enter the environment details for the following types of test assets:

      • APISUITE
      • APITEST
      • APISTUB
      Labels

      Use this field to add labels to test results when the test run is complete.

      You can add multiple labels to a test result separated by a comma.

      For example, label1, label2

      After the test run is complete, then the values provided in the Labels field are displayed on the Results page of Test Hub.
      Classification Name

      Use this field to enter the name of the Classification if you created secrets for your project and to use Secrets at test run time.

      This field is mandatory only if you want to run the following types of test assets:

      • APISUITE
      • APITEST
      • APISTUB
      Show Hidden Properties

      Select this checkbox if you want to use an HTTP Proxy to connect to Test Hub.

      After you select the Show Hidden Properties checkbox, you can configure the HTTP Proxy by using the following fields:

      • HTTP Proxy Host: Use this field to enter the hostname of the HTTP proxy that you want to connect to Test Hub.

      • HTTP Proxy Port: Use this field to enter the port number where the HTTP proxy is used to listen to both HTTP and HTTPS traffic.

      • HTTP Proxy User name: Use this field to provide the username for the HTTP proxy.

      • HTTP Proxy Password: Use this field to enter a valid password for the user that you specified in the HTTP Proxy User name field.

      Note: You can use the Show Hidden Properties field only when you want to run the following types of test assets:
      • APISUITE
      • APITEST
      • APISTUB
      Variables

      Use this field to enter the name of the variable and its value if your test requires variables during the test run time.

      You must enter the variables in the following format:

      name_of_the_variable=value_of_the_varibale

      You can add multiple variables to the test run separated by a semicolon.

      For example, varname1=value1;varname2=value2
      Note: In addition to optional fields, you can also use the following fields from Deploy to configure your test run:
      • Working Directory
      • Precondition
      • Post Processing Script
      • Use Impersonation
      • Auth Token Restriction
      You can accept the default values or change the values based on your requirements. For more information about these fields, see the related links.
    3. Click OK to save the properties for the test.
  9. Click Save in the design area.

Results

You have configured the process for the component in Deploy.

What to do next

You must create a resource in Deploy. See Creating a resource in IBM DevOps Deploy.