The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

CA Service Virtualization Plugin

View this plugin on the Plugins site

svCreateAndDeployVirtualService: CA Service Virtualization - Create And Deploy Virtual Service

Create and deploy Virtual Service from VSI/VSM, RR Pairs, or the following specifications: Swagger, WSDL, or RAML.

  • useCustomRegistry : boolean
    Set to true to override the default global connection setting to CA DevTest registry for the particular project
  • host : String
    The correct hostname or registry name needs to be entered
  • port : String
    Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
  • vseName : String
    Use the name of the VSE to which you want this build step to apply
  • config : String
    Configuration JSON

    Example of using a configuration object that includes port and SSL information

    { "virtualService": { "version": "2", "name": "API_Test_1", "description": "Invoke API V2", "status": "" }, "transportProtocol": { "typeId": "HTTP", "basePath": "/", "useGateway": true, "duptxns": true, "hostHeaderPassThrough": false }, "dataProtocol": { "forRequest": true, "typeId": "RESTDPH" } }

  • deploy : String
    If true will atomically deploy the newly created virtual service on to the VSE
  • undeploy : String
    If selected will undeploy virtual service if it exists on Virtual Service Environment.
  • inputFile1 : String
    Path to input file that will be uploaded to the VSE. The input file can be Request/Response (file or zip), VSM/VSI, Swagger, RAML, or WADL file.
    Possibilities:

    for files in job workspace you can specify:

    • relative path to input file in job workspace (example: dir/test-req.txt)

    for files on the DevTest machine you can specify:

    • absolute path to file (example: file:///C:/something/test-req.txt)
    • http location of input file (example: http://something/test-req.txt)
  • inputFile2 : String
    Path to input file that will be uploaded to the VSE. The input file can be Request/Response or VSM/VSI file.
    Possibilities:

    for files in job workspace you can specify:

    • relative path to input file in job workspace (example: dir/test-rsp.txt)

    for files on the DevTest machine you can specify:

    • absolute path to file (example: file:///C:/something/test-rsp.txt)
    • http location of input file (example: http://something/test-rsp.txt)
  • activeConfig : String
    Path to active project config file that will be uploaded to the VSE.
    Possibilities:

    for files in job workspace you can specify:

    • relative path to input file in job workspace (example: dir/project.config)

    for files on the DevTest machine you can specify:

    • absolute path to file (example: file:///C:/something/project.config)
  • dataFiles : String
    Path to data file that will be uploaded to the VSE. The input should be data file in one of the content type defined in <LISA_HOME>/contenttype.xml,
    Possibilities:

    for files in job workspace you can specify:

    • relative path to input file in job workspace (example: dir/data.csv)

    for files on the DevTest machine you can specify:

    • absolute path to file (example: file:///C:/something/data.csv)
  • swaggerurl : String
    Swagger (OpenAPI) 2.0 or 3.0 document URL
  • ramlurl : String
    RAML 0.8 spec URL
  • wadlurl : String
    WADL URL
  • tokenCredentialId : String

    The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

  • secured : boolean
    Set to true if the CA DevTest API are set to accept only https connections

svDeployTest: CA Service Virtualization - Deploy Test

Deploys and starts CA DevTest test or test suite provided as a .mar file.

Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

  • useCustomRegistry : boolean
    Set to true to override the default global connection setting to CA DevTest registry for the particular project
  • host : String
    The correct hostname or registry name needs to be entered
  • port : String
    Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
  • marFilePath : String
    Path to MAR file that will be uploaded to the VSE. Needs to be relative path to MAR file in job workspace.
  • testType : String
    Choose whether mar file contains test or test suite.
  • tokenCredentialId : String

    The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

  • secured : boolean
    Set to true if the CA DevTest API are set to accept only https connections

svDeployVirtualService: CA Service Virtualization - Deploy Virtual Service

Deploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.

Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

  • useCustomRegistry : boolean
    Set to true to override the default global connection setting to CA DevTest registry for the particular project
  • host : String
    The correct hostname or registry name needs to be entered
  • port : String
    Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
  • vseName : String
    Use the name of the VSE to which you want this build step to apply
  • marFilesPaths : String
    Path to MAR file that will be uploaded to the VSE. The field supports multiple strings delimited by a separate line or comma.
    Possibilities:

    for files in job workspace you can specify:

    • relative path to MAR file in job workspace (example: dir/test.mar)
    • path to MAR files using ant glob syntax (example: **/*.mar)

    for files on the DevTest machine you can specify:

    • absolute path to file (example: file:///C:/something/test.mar)
    • http location of MAR file (example: http://something/test.mar)
  • tokenCredentialId : String

    The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

  • secured : boolean
    Set to true if the CA DevTest API are set to accept only https connections

svStartVirtualService: CA Service Virtualization - Start Virtual Service

Starts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.

Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

  • useCustomRegistry : boolean
    Set to true to override the default global connection setting to CA DevTest registry for the particular project
  • host : String
    The correct hostname or registry name needs to be entered
  • port : String
    Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
  • vseName : String
    Use the name of the VSE to which you want this build step to apply
  • vsNames : String
    Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
  • tokenCredentialId : String

    The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

  • secured : boolean
    Set to true if the CA DevTest API are set to accept only https connections

svStopVirtualService: CA Service Virtualization - Stop Virtual Service

Stops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.

Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.

  • useCustomRegistry : boolean
    Set to true to override the default global connection setting to CA DevTest registry for the particular project
  • host : String
    The correct hostname or registry name needs to be entered
  • port : String
    Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
  • vseName : String
    Use the name of the VSE to which you want this build step to apply
  • vsNames : String
    Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
  • tokenCredentialId : String

    The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

  • secured : boolean
    Set to true if the CA DevTest API are set to accept only https connections

svPublishTestReport: CA Service Virtualization Report Publisher

Generates simple test or test suite report that is available as a part of project run.

    svUndeployVirtualService: CA Service Virtualization - Undeploy Virtual Service

    Undeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.

    Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established

    • useCustomRegistry : boolean
      Set to true to override the default global connection setting to CA DevTest registry for the particular project
    • host : String
      The correct hostname or registry name needs to be entered
    • port : String
      Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
    • vseName : String
      Use the name of the VSE to which you want this build step to apply
    • vsNames : String
      Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
    • tokenCredentialId : String

      The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".

    • secured : boolean
      Set to true if the CA DevTest API are set to accept only https connections

    Was this page helpful?

    Please submit your feedback about this page through this quick form.

    Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

        


    See existing feedback here.