12. Subject7 Jenkins Plugin


Tip

Minimum Jenkins version needed is 2.0


After installing Jenkins plugin, you can watch the video below or read the steps after it to create credentials for Subject7:


After the plugin is installed, you need to create a credential. Here are the steps:

1. Go to Manage Jenkins > Manage Credentials on the left menu in Jenkins.

2- Hover your mouse over Global, click on the arrow that appears next to it and click Add credentials.

3- From Kind, choose Subject7 API Key Credentials or Subject7 Basic Credentials according to your preference. You can get your API key by hovering over your platform username and clicking Manage API Key.


4- Enter the parameters as below:

Proof Host: https://platform.subject-7.com

Username: YOUR-PROOF-USERNAME

Password: YOUR-PROOF-PASSWORD

ID: NOT_USED

Description: Optional 


API Key screenshot:

Basic username and password screenshot:

5- Once finished, click Create. Subject7 should now appear in the post-build action after creating a new project on Jenkins:

6- After you select it from the menu, you will see the form below:

7- Here are the parameters that you need to fill in once the plugin is added and available as a step in the build process: 

Server: This is what you have set up as credentials earlier. Select from the drop-down at this point you should probably have only one item. 

Sync Execution: If checked, the build will not complete until all test cases are passed in the provided Execution Set or we reach the timeout parameter. If not checked, the build will continue without waiting for the result. 

Report Format: Test execution report returned in Jenkins can be in HTML or in JSON format. You can also see the detail report by logging into the platform and search for your build  

Build Number: Optional parameter. If your Jenkins generates build numbers you can use ${BUILD_NUMBER}. This is just a metadata and it will show up in the execution reports and can be used for tracking purposes.  

Timeout (s): Number of seconds before the build waits for automation tests to complete. If it reaches more, the build will fail.

Delay (s): Number of seconds to wait before starting to execute the tests. Sometimes, deployments take little longer because they depend on 3rd party system outside of the build process control and hence waiting is required. 

Callback: In case you want to make a REST call after your build is complete to a third party system. 

CallBack Payload: Payload of the REST callback.  

Execution Set Name: The name of the set you want to kick off.


Tip

REST API allows selection of browser type, data sets, and pool.

Tip

Subject7 Jenkins plugin allows triggering of multiple comma separated execution sets.

Related pages