Cadence vManager Build Runner Plugin for TeamCity
This plugin adds an ability to perform REST over HTTP calls to Cadence vManager as a step in your build.
Why this plugin ?
Cadence vManager (starting version 14.1 and above) is now exposing a REST API (vAPI) for performing automation queries and updates for its regression/test and coverage data. This plugin enables you to add a remote execution for extracting runs information, reports data or even launching new sessions as part of your build process.
Features
- Free-style job plugin (can perform all vManager API call).
- Support static/dynamic API calls
- Support dynamic authentication per user id.
- Special build step for performing launch of vsif files dynamically.
Limitations
The plugin support for remote launching of vsif will be supported for Incisive 14.1 S5 and above.
Configuration
After installing the plugin you'll get two new steps in the build step selection.
- Choose "vManager API" if you need a free-style vAPI call to sends dynamic json input and receive a json output.
- Choose "vManager Session Launcher" if you need to add a step for remote launching vsif (one or more).
Usage
vManager API
The step takes care for the following:
- Authentication.
- Defining the API call.
- Defining the json input string for the API (static/dynamic).
- Saving the API result (json format) into the workspace. The below is an example of defining a static vAPI call for getting a list of runs:
The below is an example of defining a dynamic vAPI call:
In case of a need in dynamically change the jSON input for the API per step, the pre-step should create a file with the relevant jSON string to be sent to the vAPI. The input file can be placed anywhere within the agent accessible path . In case this field is empty, The file name need to be: $CHECKOUT_DIR/$BUILD_ID/vapi.input
Please fill this field only in case, you want to hard code the input file name, to be consist across all builds.
vManager Session Launcher
The step takes care for the following:
- Authentication.
- Launching a vsif that is located on the NFS and is available to vManager Server.
The below is an example of defining a static vsif call:
The below is an example of defining a dynamic launch call with multiple vsif files:
In case of a need in dynamically selecting the vsif files to get launched per step, the pre-step should create a file with the relevant data. The input file can be placed anywhere within the agent accessible path. The data insist for various lines with the full paths of the relevant vsif files to be launched, new line for each additional vsif file.
In case this field is empty, The file name need to be: $CHECKING_DIR/$BUILD_ID/vsif.input Please fill this field only in case, you want to hard code the input file name, to be consist across all builds.
Authentication
In case of a need in dynamically selecting the user name per step, the pre-step should place into the workspace directory a file with single line that contains the userid to be used. The file name should be: $CHECKING_DIR/$BUILD_ID/user.input The job will pick the userid which is in the file, and connect to vAPI using this userid and the vAPI secret key.
You can download the plugin from here.