start portlet menu bar end portlet menu bar
  • Overview
  • Documentation
  • Version history

Description

HCL OneTest 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

Product icon

Product

DevOps Velocity (HCL Accelerate)
Plugin type icon

Type

plugin
Compatibility icon

Compatibility

HCL Accelerate version 2.2.2 or later
created by icon

Created by

HCL Software
Website icon

Website

HCL OneTest API

Published Date

Last Updated

Summary

 

The HCL OneTest API plugin provides an integration with HCL OneTest API. This plugin imports test result data from a MySQL DB and saves the data as metrics in HCL Accelerate insights.

Compatibility

This plugin requires HCL Accelerate version 2.2.2 or later.

HCL OneTest API 10.1.3 or later is supported.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
0.0.15 User Access Key Related Changes.
0.0.2 Initial release

Usage

 

To use the HCL OneTest 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 OneTest API plugin supports endpoint integration which are listed in the following table.

Endpoints
Name Path Method
OneTest API onetest-api/callback Post

Invoking the plugin

To import data from the HCL OneTest 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

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream and integrating with the HCL OneTest API server. The following table describes the information for the creating a HCL Accelerate value stream map.

  1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. 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 OneTest API Configuration Properties table describes the configuration properties that define the connection and communications with the HCL OneTest API 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 Hidden 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 HCL OneTest 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 OneTest API plugin is ucv-ext-onetest-api Yes type
HCL OneTest API Configuration Properties
Name Type Description Required Property Name
User Access Key Secure The user access key to authenticate with the HCL Accelerate server. Yes ucvAccessKey
HCL OneTest Database Hostname String The hostname of the HCL OneTest Database. Yes oneTestDBUrl
HCL OneTest Database String The name of HCL OneTest Database. Yes oneTestDB
HCL OneTest Database Username String The user name to authenticate with the HCL OneTest Database. Yes oneTestDBUsername
HCL OneTest Database Password Secure The password to authenticate with the HCL OneTest 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\" }"

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.21
 

Release Notes

  • Rebranding: Name of the plugin has been changed from HCL OneTest API to HCL DevOps Test API.
Download Icon DOWNLOAD

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.19
 

Release Notes

  • 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 HCL OneTest API 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 HCL OneTest API vulnerability data is associated.
  • Preventing Installation on Older Versions: This version of HCL OneTest API Plugin can only be installed on HCL Accelerate version 3.0.0 and later
  • Added Category:Quality is the plugin category of HCL OneTest API.
Download Icon DOWNLOAD

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.15
 

Release Notes

  • User Access Key Related Changes
Download Icon DOWNLOAD

ucv-ext-onetest-api:0.0.2.tar

Uploaded: 10-Feb-2021 14:03

Download Icon DOWNLOAD

Related Plugins