• Overview
  • Documentation
  • Version history

Description

IBM DevOps Test Hub is a fully-containerized (Docker) server component used by test teams to consolidate testing from each of the Test Workbench products into a single view.

Quick Info

Product icon

Product

HCL DevOps Velocity (HCL Accelerate)
Plugin type icon

Type

plugin
Compatibility icon

Compatibility

HCL DevOps Velocity 5.0.0 or later, HCL Accelerate 2.0x to 4.0x
created by icon

Created by

HCL Software

Published Date

Last Updated

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.

Endpoints
Name Path Method
RTASEndpoint rtas/callback Post

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>"
      }
  }
]

  1. In the above example, provide all of your own values for the values inside of < > brackets.
  2. 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.
  3. 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.
  4. 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.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The IBM DevOps Test Hub Configuration Properties table describes the configuration properties that define the connection and communications with the IBM DevOps Test Hub server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plugin configuration properties used to connect and communicate with the IBM DevOps Test Hub server. Enclose the properties within braces. Yes properties
  The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plugin. The value for the IBM DevOps Test Hub plugin is ucv-ext-rtas Yes type
IBM DevOps Test Hub Configuration Properties
Name Type Description Required Property Name
Build Label Pattern String A regular expression pattern to match a build ID on a test execution label. For example: ([A-Z]+-[0-9]+). No buildRegExp
IBM DevOps Test Hub Offline User Token String The offline user token created in the IBM DevOps Test Hub user interface by clicking the Create Token button. Yes rtasOfflineToken
IBM DevOps Test Hub URL String The base URL of the IBM DevOps Test Hub. For example: https://tp-cicd2.nonprod.hclpnp.com. Yes rtasUrl
Workflow Id String The value stream that this metric is associated. No workflowId

Summary

The IBM DevOps Test Hub plugin provides for integration with an IBM DevOps Test Hub server. This plugin imports test result data from an IBM DevOps Test Hub server and saves the data as HCL DevOps Velocity issues. The data is used to generate metrics. Data between the IBM DevOps Test Hub and the HCL DevOps Velocity server is synchronized every five minutes.

Compatibility

Must be running HCL DevOps Velocity version 2.0 or later to use the plugin.

IBM DevOps Test Hub 10.1.0 or later is supported.

ucv-ext-rtas:1.0.38.tar

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.38
 

Release Notes

  • Bug fix: Fixed an issue where the callback step failed when a trailing slash (/) was present at the end of the URL. The plugin now automatically detects and removes trailing slashes to ensure proper URL formatting and successful callback execution.
  • Rebranding: The plug-in name is changed from Rational Test Automation Server to IBM DevOps Test Hub.

ucv-ext-rtas:1.0.34.tar

Uploaded: 21-Jul-2023 09:19

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.34
 

Release Notes

  • Minor bug fix:Fixed bug related to test results URL generated in plugin.
  • Removed Manual User Access Key: From current version onwards this plugin will only support Auto Generated User Access Key feature of HCL Accelerate.
  • Added WorkflowId: Under the hidden properties section of add integration page for rational-test-automation-server plugin a Workflow ID field is added. This field is optional and can be used to provide HCL Accelerate WorkflowId - the ID of a Value Stream (VSM )to which rational-test-automation-server vulnerability data is associated.

ucv-ext-rtas:1.0.22.tar

Uploaded: 28-Jan-2022 08:51

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.22
 

Release Notes

  • User Access Key Related Changes

ucv-ext-rtas:1.0.6.tar

Uploaded: 08-Feb-2021 07:40

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.6
 

Release Notes

  • Integration id passed along with metrics

Related Plugins