Description

Rational Test Automation Server is a fully-containerized (Docker) server component used by test teams to consolidate testing from each of the Test Workbench products into a single view.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate version 2.0 or later
Created by
HCL Software
Website
Updated Date
June 1, 2021
Version Name Modified date Action

1.0.6

ucv-ext-rtas:1.0.6.tar 08-Feb-2021 07:40

ucv-ext-rtas:1.0.6.tar

1.0.6


Summary

The Rational Test Automation Server plugin provides for integration with an Rational Test Automation Server server. This plugin imports test result data from an Rational Test Automation Server server and saves the data as HCL Accelerate issues. The data is used to generate metrics. Data between the Rational Test Automation server and the HCL Accelerate server is synchronized every five minutes.

Compatibility

Must be running HCL Accelerate version 2.0 or later to use the plugin.

Rational Test Automation Server 10.1.0 or later is supported.

History

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

Plugin history details
Version Description
1.0.6 Bug fixes

Usage

To use the Rational Test Automation Server 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 Rational Test Automation Server plugin supports endpoint integration which are listed in the following table.

Endpoints
Name Path Method
RTASEndpoint rtas/callback Post

Invoking the plugin

To import data from the Rational Test Automation server, send an HTTP POST request to your endpoint such as the following sample.


https:///pluginEndpoint//rtas/callback

The payload for the POST is shown below.


{
  "project": {
    "name":"",
    "id": ""
    (either project name or project id must be specified)
  },
  "test": {
    "name":"",
    "path":"
    (either test name or test path must be specified)
  },
  "commitId": " (optional),
  "build": {
    "id": "",
    "url": ""
  } (optional, this will override buildRegExp if specified)
}

You can map a build to a metric using tags defined on the Rational Test Automation Server by evaluating the tag against a regular express. Use the Build Label Pattern field to define the regular expression. For example, a build expression of “([A-Z]+-[0-9]+)” and a test has a tag of “BUILD-123”, the build is mapped with ID BUILD-123 in the HCL Accelerate server to the newly created metric. For assistance in forming a regular expression, see the Regular expression tester website. You can use the website to help form and test a regular expression based on your build ID.

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 IBM Rational Test Automation Server server. The following table describes the information for the creating a HCL Accelerate value stream map.

  1. 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 Rational Test Automation Server Configuration Properties table describes the configuration properties that define the connection and communications with the Rational Test Automation Server 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 Show Hidden Properties 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 Rational Test Automation Server 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 Rational Test Automation Server plugin is ucv-ext-rtas Yes type
Rational Test Automation Server Configuration Properties
Name Type Description Required Property Name
Build Label Pattern String A regular expression pattern to match a build ID on a test execution label. For example: ([A-Z]+-[0-9]+). No buildRegExp
Rational Test Automation Server Offline User Token String The offline user token created in the Rational Test Automation Server user interface by clicking the Create Token button. Yes rtasOfflineToken
Rational Test Automation Server URL String The base URL of the Rational Test Automation Server. For example: https://tp-cicd2.nonprod.hclpnp.com. Yes rtasUrl
HCL Accelerate User Access Key String The user access key used to authenticate with the HCL Accelerate server. Yes ucvAccessKey

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.


"integrations": [
  {
    "type": "ucv-ext-rtas",
    "tenant_id": "tenant-id",
    "name": "integration-name",
    "logginglevel": "log_level_value",
    "properties":{
      "ucvAccessKey": "ucv-user-access-key",
      "rtasUrl" : "rtas-url",
      "rtasOfflineToken":"rtas-offline-token",
      "buildRegExp": "([A-Z]+-[0-9]+)"
   }
}
]