Applies to ReadyAPI 3.0, last modified on November 15, 2019

About

You might want to launch ReadyAPI functional tests in TestEngine as a part of your CI/CD flow in Jenkins. The ReadyAPI TestEngine Jenkins Plugin allows you to easy do that.

ReadyAPI TestEngine Jenkins Plugin

Install the plugin

To install the plugin:

  1. Download the Jenkins plugin from our website:

    https://support.smartbear.com/downloads/readyapi/
  2. Open Jenkins and select Manage Jenkins > Manage Plugins:

    Install the TestEngine Jenkins plugin: Manage Jenkins

    Click the image to enlarge it.

  3. In the Advanced tab, go to the Upload Plugin section, click Choose File and select the .hpi file with the plugin.

  4. Click Upload:

    Install the TestEngine Jenkins plugin: Upload the plugin

    Click the image to enlarge it.

Global settings

To configure global settings of the plugin, select Manage Jenkins > Configure System:

Manage Jenkins

Click the image to enlarge it.

You will find the settings in the ReadyApi TestEngine Plugin section:

Plugin's global settings

Click the image to enlarge it.

Option Description
Server URL The URL of the TestEngine server.
Username The username that will be used to log in to the TestEngine instance.
Server password The user's password
JUnit Report directory The directory in your workspace to which JUnit reports will be saved. If it is not specified, no reports will be saved.

Click Test Connection to check whether Jenkins can connect to TestEngine using the specified URL, username and password.

Run tests

To run ReadyAPI test in TestEngine by using Jenkins:

  1. Makes sure the ReadyAPI TestEngine Jenkins Plugin is installed.

  2. In Jenkins, select a job and click Configure.

  3. In the Build section on the General tab, click Add build step > Run ReadyAPI Projects in TestEngine:

    Run the test using Jenkins: Add the build step
  4. Jenkins will add the step to the build. Configure the build step options and click Save:

    Run the test using Jenkins: Build step options

    Click the image to enlarge it.

Build test step options

You can configure the following build step options:

Option Description
Path to project file or directory The fully-qualified path to the ReadyAPI project you want to run.
Project options
Test suite name The test suite to run. To run all the test suites of your project, leave the field blank.
Test case name The test case to run. If you leave the field blank, the runner will execute all the test cases of the specified test suite, or, if you have not specified a test suite, all the test cases of your project.
Active environment The environment configuration for the test run.
Callback URL The URL to which Jenkins will post the results of the test run.
Note: The URL must allow POST requests.

Click Advanced to see more options.

Advanced project options
Project file password The encryption password. It is needed if you have encrypted the entire project or some of its custom properties. See Protecting Sensitive Data.
Endpoint The endpoint in the <host>:<port> format. For tests that are run by using the plugin, all the HTTP requests will use the endpoint specified here.
Tags A comma-separated list of tags to filter test cases by. Only the test cases matching all the tags will be run.
JUnit Report directory The directory in your workspace where JUnit reports will be saved.
Overrides the JUnit Report Directory global setting.
TestEngine Connection Options
Server URL The URL of the TestEngine instance.
Overrides the Server URL global setting.
Username The username that will be used to log in to the TestEngine instance.
Overrides the Username global setting.
Password The user's password.
Overrides the Password global setting.

Click Test Connection to check whether Jenkins can connect to TestEngine using the specified URL, username and password.

See Also

Administrative Tasks

Highlight search results