Plug-in Documentation

IBM Rational Quality Manager (RQM)

Overview

The Rational Quality Manager plug-in includes steps that run tests and test suites in Rational Quality Manager.

To add the Rational Quality Manager plug-in steps to processes, click Quality > RQM in the step palette of the process editor.

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0 or later.

Installation

No special steps are required for installing this plug-in. See Installing plug-ins in UrbanCode Deploy.

The Rational Quality Manager Command Line Execution tool and Rational Quality Manager URL Utility are required to run the RQM plugin. Please view the troubleshooting tab for detailed download and configuration instructions.

History

Version 11

Version 11 includes the following updates:

  • User must now specify the location of a location RQMUrlUtility.jar that matches their version of RQM. This allows support for all RQM versions.
  • Updated method for validated RQM jars.

Version 10

Version 10 includes the following updates:

  • New conciseExecutionResults output properties detailing each tests title and result status.

Version 9

Version 9 includes the following updates:

  • The Result URL output property will be set if found.
  • New output properties will display the ID and result of each Execution and Test Suite Result.
  • If -exitOnComplete=true or -printResultUrl=true is not provided as an additional argument, it will be set automatically.

Version 8

Version 8 includes the following update:

  • Support property file encryption.

Version 7

Version 7 includes the following update:

  • Steps now output Project Name, Test Suite Execution Record ID, and Test Case Execution Record ID.

Version 6

Version 6 includes the requirements of specifying a local RQMExecutionTool.jar that matches the RQM version in use. This allows support for all RQM versions.

Version 5

Version 5 includes an update to the RQMExecutionTool.jar file to provide support new test suite result statuses.

Version 4

Version 4 includes support for specifying adapters by name, and fixes APAR PI54019 Error using Rational Quality Manager version 3 in IBM UrbanCode Deploy 6.2.

Version 3

This release of the plug-in includes a fix for a compatibility defect with IBM UrbanCode Deploy version 6.1.0.4 and later, and a fix for an issue where steps succeed even when the test execution record fails.

Troubleshooting

RQMExecutionTool and RQMUrlUtility Jars

RQMExecutionTool and RQMUrlUtility Jars

The RQM plugin takes advantage of two utilities:

  • Rational Quality Manager Execution Tool (RQMExecutionTool.jar): Stand-alone application to run Test Case Execution Records (TCERs) and Test Suite Execution Records (TSERS).
  • Rational Quality Manager URL Utility (RQMUrlUtility.jar): Java command line application that can access the RQM server via the RQM Reportable API. This enable the plugin to obtain the results of the TCERs and TSERs.
    • Both of these utilities are required to run the plugin and must be downloaded directly from Jazzs website. Its imperative that the versions of these jars match the version of your RQM server. Mismatched versions will result in an UNKNOWN error.

      Installation Directions

      To download the required jars, start by heading to the RQM Download Page. Select your version of RQM and click the All Downloads tab near the top of the page. Scroll down to the Extras section and find Rational Quality Execution Manager Tool and Rational Quality URL Utility. For both files, click the All platform link to download the RQM-Extras-ExecutionTool-X.X.X.zip and RQM-Extras-RQMUrlUtil-X.X.X.zip. The versions of each downloaded zip should match the version of your RQM instance. Extract the zip and place the RQMExecutionTool.jar and RQMURLUtility.jar in a reachable location on the UrbanCode Agents server.

      Configuration Directions

      The Execute Test Case and Execute Test Suite steps have two properties to specify the jars: RQMExecutionTool.jar and RQMURLUtility.jar

      In these two properties, specify the folder or file path containing the RQMExecutionTool.jar and RQMUrlUtility.jar. Follow the below picture for an example. The RQMExecutionTool.jar example property specifies the folder location, while the RQMUrlUtility example property shows the full file path. Note: These jars must be physically located on agent.

      RQM Jars Specification Picture

Result Verdict of UNKNOWN

Result Verdict of UNKNOWN

The plugin takes advantage of two different jars the RQMExecutionTool.jar and RQMUrlUtility.jar. The output from the RQMExecutionTool is fed into the RQMUrlUtility to acquire various result data. However, the RQMExecutionTool.jar may return an UNKNOWN status which is when the RQM server reports an execution state other than define/predictable states. The RQMUrlUtility is unable to find result data from a test with an UNKNOWN result verdict. This status indicates something went wrong with the specific test case or suite within RQM. The RQM server log could be useful to analyze the issue in detail (Log file location).

Usage

Example: Running tests in Rational Quality Manager

The following component process runs a test case in Rational Quality Manager.

To run this process the application binary files must be in the component. Also the environment must contain an installation of Rational Quality Manager. The process runs the following steps in order:

  1. The Download Artifacts step retrieves the binary files.
  2. The Execute Test Case step runs the specified test case in Rational Quality Manager.
A component process that uses the steps in the Rational Quality Manager plug-in to run a test case in Rational Quality Manager

A component process that uses the steps in the Rational Quality Manager plug-in to run a test case in Rational Quality Manager

Steps

Process steps in the Rational Quality Manager plug-in

Execute Test Case

Execute a test case.

Input properties for the Execute Test Case step
Name Type Description Required
Adapter ID String The numeric ID or name of the adapter to use to run the test script in the test case. No
Execution Arguments String List of optional, blank space-separated arguments. The arguments can be as follows:
1. -exitOnComplete=< true or false >. if true, command will not exit until execution
is completed or canceled. If false (default), command will exit immediately after
triggering execution. 2. -printResultUrl=<true or false> : If true the URL
for the associated execution result will be logged. Note: For automated test case
execution, this option also requires -exitOnComplete=true to be specified. 3. -variables=<var1Name:var1Value,var2Name:,va3Name:var3Value>
: Specify Execution variable and optional values to be passed to execution. Note:
Variable name and value are separated by colon :, if value is provided.
No
Password Password The password to use when connecting to Rational Quality Manager. Yes
Project Area Name String The project area to use in Rational Quality Manager. Yes
RQM User String The user name to use when connecting to Rational Quality Manager. Yes
RQMExecutionTool.jar String Specify the folder or full path to the RQMExecutionTool.jar. RQM testing requires the RQMExecutionTool.jar that matches the installed RQM version. Yes
Repository URL String The repository URL of the Rational Quality Manager server. For example, https://hostname:9443/qm. Yes
Test Case Execution Record ID String The numeric ID of the test case execution record to run. Yes
Test Script ID String The numeric ID of the test script to run in the test case. No

Execute Test Suite

Execute a test suite.

Input properties for the Execute Test Suite step
Name Type Description Required
Adapter IDs String The numeric IDs or names of the adapters, separated by commas, to use to run the test
scripts in the test suite.
No
Execution Arguments String List of optional, blank space-separated arguments. The arguments can be as follows:
1. -exitOnComplete=< true or false >. if true, command will not exit until execution
is completed or canceled. If false (default), command will exit immediately after
triggering execution. 2. -printResultUrl=<true or false> : If true the URL
for the associated execution result will be logged. Note: For automated test case
execution, this option also requires -exitOnComplete=true to be specified. 3. -variables=<var1Name:var1Value,var2Name:,va3Name:var3Value>
: Specify Execution variable and optional values to be passed to execution. Note:
Variable name and value are separated by colon :, if value is provided.
No
Password Password The password to use when connecting to Rational Quality Manager. Yes
Project Area Name String The project area to use in Rational Quality Manager. Yes
RQM User String The user name to use when connecting to Rational Quality Manager. Yes
RQMExecutionTool.jar String Specify the folder or full path to the RQMExecutionTool.jar. RQM testing requires the RQMExecutionTool.jar that matches the installed RQM version. Yes
Repository URL String The repository URL of the Rational Quality Manager server. For example, https://hostname:9443/qm. Yes
Test Script IDs String The numeric IDs of the test scripts, separated by commas, that are steps in the test
suite.
No
Test Suite Execution Record ID String The numeric ID of the test suite execution record to run. Yes