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.
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.
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.
The IBM DevOps Test Hub plugin supports endpoint integration which are listed in the following table.
Name | Path | Method |
---|---|---|
RTASEndpoint | rtas/callback | Post |
You will need to “install” the plug-in in HCL DevOps Velocity. You can do this in one of two methods.
"integrations": [ { "type": "ucv-ext-rtas", "tenant_id": "
<tenant-id><integration-name>
", "name": " <ucv-user-access-key>
", "logginglevel": "INFO", "properties":{ "_userAccessKey": " <IBM DevOps Test-Hub-url>
", "rtasUrl" : " <IBM DevOps Test-Hub-offline-token>
", "rtasOfflineToken":" <value_stream_id>
", "buildRegExp": "([A-Z]+-[0-9]+)", "workflowId" : "
" } } ]
{ "type": "ucv-ext-rtas", "tenant_id": "
<tenant-id><integration-name>
", "name": " <IBM DevOps Test-Hub-url>
", "logginglevel": "INFO", "properties":{ "rtasUrl" : " <IBM DevOps Test-Hub-offline-token>
", "rtasOfflineToken":" <value_stream_id>
", "buildRegExp": "([A-Z]+-[0-9]+)", "workflowId" : "
" } }
After going through the “Set Up” portion above, you can send an HTTP POST request to your new endpoint: https:///pluginEndpoint//rtas/callback
{ "project": { "name":"
<name of IBM DevOps Test Hub project><id of IBM DevOps Test Hub project>
", "id": " <name of test>
" (either project name or project id must be specified) }, "test": { "name":" <path to test>
", "path":" <sha of a commit>
" (either test name or test path must be specified) }, "commitId": " <id of build in IBM DevOps Velocity>
" (optional), "build": { "id": " <url of build in IBM DevOps Velocity>
", "url": "
" } (optional, this will override buildRegExp if specified) }
There are two methods to integrate the plugin:
The tables in the Configuration Properties section describe the properties used to define the integration.
To install the plug-in, perform the following steps:
To integrate the plug-in using the user interface, perform the following steps:
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:
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.
properties
configuration property.Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.
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 |
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 |
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.
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.
docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.38
Uploaded: 21-Jul-2023 09:19
docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.34
Uploaded: 28-Jan-2022 08:51
docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.22
Uploaded: 08-Feb-2021 07:40
docker pull hclcr.io/accelerate/ucv-ext-rtas:1.0.6