Plug-in Documentation

Rational Test Automation Server

Overview

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

Compatibility

Must be running UrbanCode Velocity version 1.3.0 and later to use the plug-in.

Rational Test Automation Server 10.1.0 or higher and later is supported.

Versions

There is no install process for this plug-in. The Rational Test Automation Server plug-in is identified to UrbanCode Velocity as a value stream integration. UrbanCode Velocity plug-in images are located in DockerHub and the UrbanCode Velolcity code accesses the version that you select. To view available versions, see the UrbanCode DockerHub.

History

Version 1.0.5

  • Configure logger wrapper

Version 1.0.3

  • Initial release

Usage

To use the Rational Test Automation Server plug-in you must complete the following:

  1. Define the integration
  2. Send an HTTP post to request the new endpoint

Define the integration

The value stream map contains the properties to define the plug-in integration. The plug-in integration is defined as a value stream within the UrbanCode Velocity user interface. Defining the integration includes defining configuration properties that connect the UrbanCode Velocity server to the Rational Test Automation Server.

The basic flow to use the plug-in includes:

  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 plug-in 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 Integration user interface page.

Send the HTTP Post

To gather data, send an HTTP POST request to your endpoint:

https:///pluginEndpoint//rtas/callback

The payload for this POST must be in the following format:

{
  "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 UrbanCode Velocity 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 type

The Rational Test Automation Server plug-in supports endpoint integration which are listed in the following table.

Endpoints
Name Path Method
RTASEndpoint rtas/callback Post

Integration

From the user interface Value Steam page, click Upload to upload the value stream map which is a JSON file.

The JSON file contains the information for creating a value stream and integrating with the Rational Test Automation Server. The following table describes the information for the creating a UrbanCode Velocity value stream map.

Value stream map information
Name Description Required
image The version of the plug-in that you want to use. To view available versions, see the UrbanCode DockerHub. If a value is not specified, the latest version is used. No
name An assigned name to the value stream. Yes
loggingLevel The level of Log4j messages to log. Valid values are: all, debug, info, warn, error, fatal, off, and trace. The default is info. No
properties List of configuration properties used to connect and communicate with the Rational Test Automation Server. Enclose the properties within braces. Yes
tenant_id The name of the tenant. Yes
type Unique identifier assigned to the plug-in. The value for the Rational Test Automation Server plug-in is ucv-ext-rtas. Yes

Configuration Properties

The configuration properties which are included in the properties field are unique to the Rational Test Automation Server plug-in
and define the connection and communication to the Rational Test Automation Server server.

Configuration properties
Name Property Name Type Description Required
Build Label Pattern buildRegExp String A regular expression pattern to match a build ID on a test execution label. For example: ([A-Z]+-[0-9]+). No
Rational Test Automation Server Offline User Token rtasOfflineToken String The offline user token created in the Rational Test Automation Server user interface by clicking the Create Token button. Yes
Rational Test Automation Server URL rtasUrl String The base URL of the Rational Test Automation Server. For example: https://tp-cicd2.nonprod.hclpnp.com. Yes
UrbanCode Velocity User Access Key ucvAccessKey String The user access key used to authenticate with the UrbanCode Velocity server. Yes

Example

The following example can be used as as template to include the AppScan plug-in integration into the JSON file.
Copy and paste the template into the JSON file 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]+)"
   }
}
]