HCL DevOps Test Hub is a web-based continuous testing platform built on modern, cloud native technologies that enables test teams to run a breadth of tests that includes API, functional, and performance tests and to benefit from a holistic view of test progress
The HCL DevOps Test Hub plugin provides an integration with HCL DevOps Test Hub. This plugin imports the test result data from HCL DevOps Test Hub and saves the data as metrics in HCL DevOps Velocity insights.
HCL DevOps Test Hub 10.0.2 and later is supported.
To use the HCL DevOps Test Hub plugin, the plugin must be loaded and an instance created before you can configure the plug-in 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 HCL DevOps Test Hub plugin supports endpoint integration which are listed in the following table.
| Name | Path | Method |
|---|---|---|
| OneTestEndpoint | onetest/callback | Post |
To import data from the HCL DevOps Test Hub, send an HTTP POST request to your endpoint such as the following sample.
Summary
Usage
Configuration properties
Examples
https://<pluginEndpoint>/onetest/callback
The payload for the POST is shown below.
{
"project": {
"name": "<Project Name>"
},
"test": {
"name": "<Test Name>"
}
}
| Name | Description |
|---|---|
| Project Name | |
| Test Name |
To install the plug-in, perform the following steps:
The tables in the Configuration Properties section describe the properties used to define the integration.
Integrating the plug-in by using user interface
The tables in the Configuration properties topic describe the properties used to define the integration.
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 is a section for integrations. It is in this section that plugin properties can be defined. Refer to the JSON sample code in the Configuration Properties section.
To integrate the plug-in using a JSON, perform the following steps:
icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.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.
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 plug-in 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 plug-in configuration properties used to connect and communicate with the HCL DevOps Test Hub. Enclose the properties within braces. | Yes | properties |
| The name of the tenant. | Yes | tenant_id | |
| NA | Unique identifier assigned to the plug-in. The value for the HCL DevOps Test Hub plug-in is ucv-ext-onetest-server. |
Yes | type |
| Name | Type | Description | Required | Property Name |
|---|---|---|---|---|
| User Access Key | Secure | The user access key to authenticate with the HCL Accelerate server. | Yes | ucvAccessKey |
| HCL DevOps Test Hub URL | String | The base URL of the HCL DevOps Test Hub. For example: https://tp-cicd2.nonprod.hclpnp.com. | Yes | oneTestUrl |
| HCL OneTest Offline User Token | String | The offline user token created in the HCL OneTest user interface by clicking the Create Token button. | Yes | oneTestRefreshToken |
| Build Label Pattern | String | A regular expression pattern that will match a build ID on a test execution label. For example: ([A-Z]+-[0-9]+). | No | buildRegExp |
The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.
"integrations": [
{
"type": "ucv-ext-onetest-server",
"tenant_id": "tenant_id",
"name": "TestHub creation",
"disabled": false,
"properties": {
"oneTestUrl": "URL",
"oneTestRefreshToken": "token",
"buildRegExp": "",
"workflowId": ""
}
}
]
The following cURL command can be used as an example to send a HTTP POST request to the endpoint.
curl --insecure --request POST --url "https://localhost/reporting-consumer/pluginEndpoint/5fbe581479d90350dd187e67/onetest/callback" --header "Content-Type: application/json" --data-raw "{ \"project\": { \"name\": \"Onetest Sample\" }, \"test\": { \"name\": \"cmptest-1\" } }"
Uploaded: 09-Apr-2024 09:33
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.27
Uploaded: 21-Jul-2023 07:13
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.26
Uploaded: 08-Nov-2022 09:18
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.17
Uploaded: 09-Feb-2022 06:10
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.15
Uploaded: 29-Sep-2021 05:55
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.11
Uploaded: 08-Feb-2021 07:39
docker pull hclcr.io/accelerate/ucv-ext-onetest-server:1.0.2
