Usage

To use the HCL DevOps Test Server 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.

Integration type

The HCL DevOps Test Server plugin supports endpoint integration which are listed in the following table.

Invoking the plugin

To import data from the HCL DevOps Test Server, send an HTTP POST request to your endpoint such as the following sample.

`https://<pluginEndpoint>/onetest/callback`

The payload for the POST is shown below.

{
  "project": {
    "name":"<name of HCL DevOps Test Server project>",
    "id": "<id of HCL DevOps Test Server 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 UCV>",
    "url": "<url of build in UCV>"
  } (optional, this will override buildRegExp if specified)
}

Integration

There are two methods to integrate the plug-in:

• 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 DevOps Test Server server. The following table describes the information for the creating a HCL DevOps Velocity 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 plug-in integrations.
• The HCL DevOps Test Server Configuration Properties table describes the configuration properties that define the connection and communications with the HCL DevOps Test Server. When using the JSON method to integrate the plug-in 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.

Examples

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