Usage

To use the HCL DevOps Test lugin, the plugin must be loaded and an instance created. Load the plugin into the HCL DevOps Velocity container if necessary. From the user interface, click Settings > Integrations > Plugins. On the Plugins page, locate the plugin and click Load Plugin. To create an instance, locate the plugin and click Install. The plugin is now listed below those plugins to be installed and available for invoking.

Integration type

The HCL DevOps Test plugin parses data from the HCL DevOps Test tool.

Invoking the plugin

To invoke the HCL DevOps Test plugin send an HTTP Post request with the data to parse. Whenever a there is a hit to the endpoint, the data is parsed and displayed as metrics in HCL DevOps Velocity. You can use various methods such as Postman, REST calls, CURL, and CI/CD tools like Jenkins to invoke the plugin endpoints.

Invoke using Jenkins

Install the Jenkin’s UrbanCode Velocity plugin into your Jenkins server. In your freestyle job or pipeline use the UCV-Upload Metrics File to UrbanCode Velocity step and provide the required fields. This step allows your build job to upload generated coverage results files to HCL DevOps Velocity.

pipeline {
   agent any
   stages {
      stage('oneTestMetrics') {
         steps {
            step([$class: 'UploadMetricsFile',  appName: 'My Onetest Test', dataFormat: 'onetestFTJSON', filePath: '<location of the onetest report>', name: 'my-onetest-test', pluginType: 'onetest', tenantId: '<tenant Id>', testSetName: 'onetest', metricsRecordUrl: "${env.BUILD_URL}"])
         }
      }
   }
}

Invoke the plugin using a Rest call

When using a REST call to invoke the HCL DevOps Test plugin, it must be a POST method and include the location of the HCL DevOps Velocity quality data endpoint.

The following request sample shows a REST call that you can copy and update as necessary. Key points about the snippet:

• The URL points to the HCL DevOps Velocity quality data endpoint. Update with the server location for your installation of HCL DevOps Velocity.
• The BODY of the call is a multipart/form data. It includes information about the payload.

METHOD: POST 
URL: https://<url_DevOpsVelocity_server>/reporting-consumer/metrics
BODY (multipart/form-data):
 {
  payload: <json_object_string> // See below for schema format
 testArtifact: <HCL_DevOpsTest_JSON_file>
 }

The following shows the schema for the payload. Replace the angle brackets with your values for the parameters.

{
  "tenant_id": "<tenant_id>",    // required Tenant ID
  "metricName": "<metric_name>", // optional: name for recurring test set
  "application": {
    "name": "<application_name>"  //Name of application
  },
  "record": {
    "recordName": "<record_name>", // optional: Name for this record
    "executionDate": 1547983466015, // optional: UNIX Epoch
    "pluginType": "onetest",
    "dataFormat": "<data_type>",  // onetestFTJSON or onetestPTJSON or onetestUIJSON
    "metricsRecordUrl": "<Jenkins_build_url>" // optional: To link the Jenkins build with test results
 },
  "build": {  // Optional: One of the following fields must be included 
    "buildId": "<build_id>",
    "jobExternalId": "<external_job_id>",
    "url": "<build_url>",
  },
  "commitId": "<commit_id>",  // optional
  "pullRequestId": "<pullrequest_id>", // optional
  "environment": "<environment_name>" // optional
}

Data format details

• onetestFTJSON is for Functional test results
• onetestPTJSON is for Performance test results &
• onetestUIJSON is for Web UI test results

Invoke using Curl

curl –request POST \
–url https://<url_DevOpsVelocity_server>/reporting-consumer/metrics \
–form ‘payload={
“tenant_id”: “5ade13625558f2c6688d15ce”,
“application”: {
“name”: “My Application”
},
“record”: {
“pluginType”: “onetest”,
“dataFormat”: “onetestFTJSON”
}
}
‘ \
–form testArtifact=@test-result/oneTest.json