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.

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":"<name of Rational Test Automation Server project>",
    "id": "<id of Rational Test Automation 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)
}

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 DevOps 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

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 DevOps Velocity 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.

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]+)"
   }
}
]