Quick Info
Description
HCL DevOps Test API, is an integration testing and virtualization tool that includes capabilities to automate and run tests earlier and more often to find problems sooner in the development cycle.Quick Info
0.0.21 
ucv-ext-onetest-api:0.0.21.tar
Uploaded: 04-Apr-2024 06:59
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-onetest-api:0.0.21Release Notes
ucv-ext-onetest-api:0.0.19.tar
Uploaded: 14-Nov-2022 12:07
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-onetest-api:0.0.19Release Notes
ucv-ext-onetest-api:0.0.15.tar
Uploaded: 28-Jan-2022 13:54
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-onetest-api:0.0.15Release Notes
Summary
Usage
Configuration propertiesSummary
The HCL DevOps Test API plugin provides an integration with HCL DevOps Test API. This plugin imports test result data from a MySQL DB and saves the data as metrics in HCL DevOps Velocity insights.
Compatibility
This plugin requires HCL DevOps Velocity version 2.2.2 or later.
HCL DevOps Test API 10.1.3 or later is supported.
History
The following table describes the changes made in each plugin version.
| Version | Description |
|---|---|
| 0.0.15 | User Access Key Related Changes. |
| 0.0.2 | Initial release |
Usage
To use the HCL DevOps Test API 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 HCL DevOps Test API plugin supports endpoint integration which are listed in the following table.
| Name | Path | Method |
|---|---|---|
| DevOps Test API | onetest-api/callback | Post |
Invoking the plugin
To import data from the HCL DevOps Test API server, send an HTTP POST request to your endpoint such as the following sample.
https://<pluginEndpoint>/onetest-api/callback
The payload for the POST is shown below.
{
"project": "<Project Name>",
"startDate": "<Start Date>" // Optional - Format is "YYYY-MM-DD"
}
Integration
There are two methods to integrate the plugin:
- Using the user interface
- Using a JSON file
Using the user interface
- From the Plugins page, click Settings > Integrations > Plugins.
- Under the Action column for the plugin, click Add Integration.
- On the Add Integration page enter values for the fields used to configure the integration and define communication.
- Click Save.
Using a JSON file
The JSON file contains the information for creating a value stream and integrating with the HCL DevOps Test API server. The following table describes the information for the creating a HCL DevOps Velocity value stream map.
- From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
- Edit the JSON file to include the plugin configuration properties.
- Save and upload the JSON file. This replaces the current JSON file with the new content.
- View the new integration on the Integrations page.
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 HCL DevOps Test API Configuration Properties table describes the configuration properties that define the connection and communications with the HCL DevOps Test API server. When using the JSON method to integrate the plugin these properties are coded within the
propertiesconfiguration property.
Some properties might not be displayed in the user interface, to see all properties enable the Hidden 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 HCL DevOps Test API 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 HCL DevOps Test API plugin is ucv-ext-onetest-api |
Yes | type |
| Name | Type | Description | Required | Property Name |
|---|---|---|---|---|
| User Access Key | Secure | The user access key to authenticate with the HCL DevOps Velocity server. | Yes | ucvAccessKey |
| HCL DevOps Test Database Hostname | String | The hostname of the HCL DevOps Test Database. | Yes | oneTestDBUrl |
| HCL DevOps Test Database | String | The name of HCL DevOps Test Database. | Yes | oneTestDB |
| HCL DevOps Test Database Username | String | The username to authenticate with the HCL DevOps Test Database. | Yes | oneTestDBUsername |
| HCL DevOps Test Database Password | Secure | The password to authenticate with the HCL DevOps Test Database. | Yes | oneTestDBPassword |
Example
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-api/callback" --header "Content-Type: application/json" --data-raw "{ \"project\": \"Onetest\", \"startDate\": \"2020-09-30\" }"
Related Plugins
HCL DevOps Test Performance for Launch
Automated Testing