Trigger Test Plans Remotely

You can use Testsigma API to trigger test executions remotely. This is useful when you want to fully automate continuous testing within your CI/CD pipeline, and have already integrated Testsigma with a CI tool you use, such as Jenkins, TravisCI, GitLab, Codeship, and CircleCI.

Prerequisites

Before you begin, ensure that you have referred to:

1. Documentationon generating API keys from Testsigma application.
2. Documentation on managing test plans.

Trigger Test Plans Using API

This endpoint allows users to trigger a Test Plan execution remotely.

Request/Response fields

• executionId: ID of the Test Plan
• result: Result Status of the Test Plan - QUEUED, PASSED, FAILED, ABORTED, or STOPPED
• status: Current Status of the Test Plan creation - STATUS_CREATED
• executedBy: ID of the executor
• buildNo: Build Number specified in the Test Plan Trigger call
• isVisuallyPassed: Whether visual testing passed or not. True or False.
• environment: Environment parameter selected for the Test Plan
• triggeredType: Triggered type for the Test Plan whether by API or via Testsigma App
• totalRunningCount: Total number of running tests
• page_timeout: Global Page load timeout in seconds
• element_timeout: Global Element load timeout in seconds
• recovery_action: Action to be performed on test failure - "Run_Next_Testcase"
• on_aborted_action: Action to be performed on test abort - "Reuse_Session"
• screenshot_option: When to take screenshots - "FAILED_STEPS", “ALL_STEPS”, “NONE”
• group_prerequisite_fail: Action to perform on Test Suite prerequisite failure
• test_case_prerequisite_fail: Action to perform on Test Case prerequisite failure
• test_step_prerequisite_fail: Action to perform on Test Step prerequisite failure
• totalQueuedCount: Total number of queued tests
• Execution Config name and ID are the saved configurations for Partial Test Plan Runs.
• In the POST request, you can either use the name or the ID for the Execution Config.
• Get the Execution Config ID and name via this GET Request: https://testsigma.com/docs/api/test-plans/#get-test-plan-favouritesconfig

For a Test Plan, you can get the Test Plan ID and the complete cURL request to trigger the execution from the Test Plan Details page:

The Run ID is returned as ‘id’ in the response for the request if the execution was started successfully.

The Environment ID is optional. To know how to get an environment id, refer to the documentation on getting an environment ID

Test Plan Status

Each Test Plan Run in Testsigma has a unique Run ID. This Run ID can be used to check the live status of the Test Plan Run or Test Plan Status.

Trigger Test Plans in Different Environments

To execute a test plan with different Environments, you need to have an Environment ID. You can find the Environment ID by following the steps below.

Get Environment ID

1. Navigating to Test Data > Environments, and click on an Environment.
2. On the Environment page, the <ENVIRONMENT_ID> in the URL https://app.testsigma.com/ui/td/103/environments/<ENVIRONMENT_ID>/details is the ID of the environment.

• For Example, if the URL is https://app.testsigma.com/ui/td/88/environments/10/details, the ID is 10.

Executing Tests Plans with Different Environments

1. Navigate to Test Plans > Test Plan > CI/CD Integrations, and copy CURL request under REST API to integrate with other tools > REST API call to start Test Plan.
2. Provide the Environment ID in the request body.

curl -X POST \
-H "Content-type: application/json" \
-H "Accept:application/json" \
-H "Authorization: Bearer <API_KEY>" \
https://app.testsigma.com/api/v1/execution_results \
-d "{\"executionId\": \"431\", \"environmentId\": \"<ENVIRONMENT_ID>\"}"

You can execute this CURL command in your computer's command-line interface (CLI) to trigger test plan with the environment specific to the given ID.

Obtaining the Run ID

If the Test Plan Run was started from within the Testsigma App, the Run ID can be found from the Run Results page as shown below:

The values from 295 to 299 are Run IDs of consecutive Test Plan Runs.

If the Test Plan was started by the Test Plan Trigger API Call, the Run ID can be obtained from the API Response under the JSON key ‘id’.

Test Plan Status API

This endpoint allows users to check the status of an already triggered Test Plan Run.

Request/Response fields

• Id: ID of the Test Plan Result
• Execution: The Test Plan details are located within the nested Execution JSON Object including the Test Plan ID as “id”, Application Version ID as "applicationVersionId”, Test Plan name as "name", Test Plan Description as "description" and so on.
• result: Result Status of the Test Plan - QUEUED, PASSED, FAILED, ABORTED, or STOPPED
• status: Current Status of the Test Plan creation - STATUS_CREATED
• executedBy: ID of the executor
• buildNo: Build Number specified in the Test Plan Trigger call
• isVisuallyPassed: Whether visual testing passed or not. True or False.
• environment: Environment parameter selected for the Test Plan
• triggeredType: Triggered type for the Test Plan whether by API or via Testsigma App
• totalRunningCount: Total number of running tests
• page_timeout: Global Page load timeout in seconds
• element_timeout: Global Element load timeout in seconds
• recovery_action: Action to be performed on test failure - "Run_Next_Testcase"
• on_aborted_action: Action to be performed on test abort - "Reuse_Session"
• screenshot_option: When to take screenshots - "FAILED_STEPS", “ALL_STEPS”, “NONE”
• group_prerequisite_fail: Action to perform on Test Suite prerequisite failure
• test_case_prerequisite_fail: Action to perform on Test Case prerequisite failure
• test_step_prerequisite_fail: Action to perform on Test Step prerequisite failure
• totalQueuedCount: Total number of queued tests

The Response contains a lot of information regarding the Test Plan Run. Here’s a screenshot of the relevant excerpt from the JSON Response:

You can see the result as FAILURE and the current status as STATUS_COMPLETED (along with other information).

GET Test Plan Favourites/Config

This endpoint allows users to get all the Test Plan Favourites/Config that have been set. To know more on how to create these Test Plan Favourites/Configurations refer to the documentation on executing partial test runs.

Test Case Execution details using REST API

This endpoint allows users to get details of all Test case executions using REST API.

{ 
 "executionId": 268,
 "executionResultId": 986,
 "result": "FAILURE",
 "status": "STATUS_COMPLETED",
 "testCases": [
 {
 "testCaseId": 413,
 "testCaseName": "03 data driven small",
 "testCaseResultId": 7975,
 "result": "FAILURE",
 "isDataDrivenCase": true,
 "iterationResults": [
 {
 "iterationResultId": 7963,
 "setName": "examples",
 "result": "SUCCESS"
 },
 {
 "iterationResultId": 7976,
 "setName": "travels",
 "result": "FAILURE"
 },
 {
 "iterationResultId": 7965,
 "setName": "examples 1",
 "result": "FAILURE"
 }
 ],
 "testSuiteId": 197,
 "testSuiteName": "02 DD Small",
 "testSuiteResultId": 2295,
 "machineId": 414,
 "machineTitle": "machine 2",
 "machineResultId": 2370
 }
 ]
 }