Quick Info
Description
JUnit provides a testing framework for the Java programming language. The JUnit plugin imports the test results data into HCL Accelerate metrics dashboard.Quick Info
ucv-ext-junit:1.0.72.tar
Uploaded: 27-May-2022 04:37
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-junit:1.0.72
Release Notes
ucv-ext-junit:1.0.66.tar
Uploaded: 29-Sep-2021 05:29
Pull Command
docker pull hclcr.io/accelerate/ucv-ext-junit:1.0.66
Release Notes
Summary
The JUnit plugin provides for integration with a JUnit server. Data is uploaded to the HCL Accelerate server using an HTTP Post request.
History
The following table describes the changes made in each plugin version.
Version | Description |
---|---|
1.0.66 | Updated dataset name |
1.0.38 | Bug fix |
Usage
To use the JUnit plugin, the plugin must be loaded and an instance created. Load the plugin into the HCL Accelerate 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 JUnit plugin is a parser type plugin. It parses JUnit XML data.
Invoking the plugin
To gather data from the JMeter server, 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 Accelerate. 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 plugin
Install the 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 Accelerate.
pipeline {
agent any
stages {
stage('junitMetrics') {
steps {
step([$class: 'UploadMetricsFile', appName: 'My Junit Test', dataFormat: 'junitXML', filePath: '<location of the junit report>', name: 'my-junit-test', pluginType: 'junitXML', tenantId: '<tenant Id>', testSetName: 'junit', metricsRecordUrl: "${env.BUILD_URL}"])
}
}
}
}
Invoke the plugin using a Rest call
When using a REST call to invoke the Code Coverage plugin, it must be a POST method and include the location of the HCL Accelerate 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 Accelerate quality data endpoint. Update with the server location for your installation of HCL Accelerate.
- The BODY of the call is a multipart/form data. It includes information about the payload.
METHOD: POST
URL: https://<url_urbancodevelocity_server>/reporting-consumer/metrics
BODY (multipart/form-data):
{
payload: <payload_json_object_string> // See below for schema format
testArtifact: <junit_xml_file>
}
Invoke using Curl
curl --request POST \
--url https://url_urbancodevelocity_server>/reporting-consumer/metrics \
--form 'payload={
"tenant_id": "",
"application": {
"name": "My Application"
},
"record": {
"pluginType": "junitXML",
"dataFormat": "junitXML"
}
}
' \
--form testArtifact=@test-result/junit.xml
Payload schema
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": "junitXML",
"dataFormat": "junitXML",
"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
}