Usage

To use the IBM DevOps Test Hub plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. Configuration properties are defined using the product user interface or a JSON file. After the integration is complete, to invoke the plugin send an HTTP Post request to the plugin endpoint.

Integration type

The IBM DevOps Test Hub plugin supports endpoint integration which are listed in the following table.

Invoking the plugin

Set Up

You will need to “install” the plug-in in HCL DevOps Velocity. You can do this in one of two methods.

Method 1: Create a New Value Stream (Easiest Way)

1. Navigate to the Value Stream page and create a new value stream.
2. You can use the following template for creating your integration

"integrations": [
{
  "type": "ucv-ext-rtas",
  "tenant_id": "<tenant-id>",
  "name": "<integration-name>",
  "logginglevel": "INFO",
  "properties":{
    "_userAccessKey": "<ucv-user-access-key>",
    "rtasUrl" : "<IBM DevOps Test-Hub-url>",
    "rtasOfflineToken":"<IBM DevOps Test-Hub-offline-token>",
    "buildRegExp": "([A-Z]+-[0-9]+)",
    "workflowId" : "<value_stream_id>"
      }
  }
]

3. In the above example, provide all of your own values for the values inside of < > brackets.
4. The buildRegExp field can be used to map a build to a metric. The tags on the IBM DevOps Test Hub test will be evaluated against the regolar expression.
5. For instance, if your buildRegExp is defined as “([A-Z]+-[0-9]+)” and you tag your test with “BUILD-123” this will map the build with ID BUILD-123 in the Velocity server to the newly created metric.
6. For help forming a regular expression based on your build ID, you can test out patterns at the following web page: https://regexr.com

Method 2: Use the Integration API Endpoint

1. You can create an integration in HCL DevOps Velocity by making an HTTP POST request to the /integration API endpoint on your HCL DevOps Velocity server, and including your integration definition as your payload.

{
  "type": "ucv-ext-rtas",
  "tenant_id": "<tenant-id>",
  "name": "<integration-name>",
  "logginglevel": "INFO",
  "properties":{
      "rtasUrl" : "<IBM DevOps Test-Hub-url>",
      "rtasOfflineToken":"<IBM DevOps Test-Hub-offline-token>",
      "buildRegExp": "([A-Z]+-[0-9]+)",
      "workflowId" : "<value_stream_id>"
  }
}

Running the Integration

After going through the “Set Up” portion above, you can send an HTTP POST request to your new endpoint: https:///pluginEndpoint//rtas/callback

1. The payload for this POST must be in the following format

{
  "project": {
    "name":"<name of IBM DevOps Test Hub project>",
    "id": "<id of IBM DevOps Test Hub project>"
    (either project name or project id must be specified)
  },
  "test": {
    "name":"<name of test>",
    "path":"<path to test>"
    (either test name or test path must be specified)
  },
  "commitId": "<sha of a commit>" (optional),
  "build": {
    "id": "<id of build in IBM DevOps Velocity>",
    "url": "<url of build in IBM DevOps Velocity>"
  } (optional, this will override buildRegExp if specified)
}

Integration

There are two methods to integrate the plugin:

• Using the user interface
• Using a JSON file

The tables in the Configuration Properties section describe the properties used to define the integration.

Integrating the plug-in by using user interface

To install the plug-in, perform the following steps:

• In DevOps Velocity, click Settings > Integrations > Available.
• In the Action column for the IBM DevOps Test Hub, click Install.

To integrate the plug-in using the user interface, perform the following steps:

• In DevOps Velocity, click Settings > Integrations > Installed.
• In the Action column for the IBM DevOps Test Hub plug-in, and then click Add Integration.
• On the Add Integration dialog, enter the values for the fields to configure the integration and define communication.
• Click Add.

Integrating the plug-in by using JSON file

The JSON file contains the information for creating a value stream. Within the JSON file, there is a section for integrations. It is in this section that plug-in properties can be defined. For JSON sample, refer to the Set up.

To integrate the plug-in using a JSON, perform the following steps:

1. Navigate to value stream page, and then click the necessary value stream.
2. Click wrench icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
3. Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
4. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Set up section for more details.
5. Click Save.