- collaboration
- Invite Team Members
- Assign Projects
- Users & Role Management
- Review Management [Test Cases]
- Review Management [Elements]
- Execution Controls
- test cases
- Test Cases
- Test Case List Actions
- Import and Export Test Cases
- Import Test Project Test Cases
- Importing Postman Collections and Environments
- Test cases for Desktop Windows
- Update Test Case result in a Test Plan
- Test cases for Mobile Web Application
- Test Step Types
- Type: Natural Language
- Type: REST API
- Type: Step Group
- Type: For Loop
- Type: While Loop
- Type: Block
- Type: If Condition
- Nested Step Groups
- Create Test Steps
- Image Injection
- Cross-application testing
- Test Data Types
- Raw
- Parameter
- Runtime
- Random
- Data Generator
- Phone Number
- Mail Box
- Environment
- Concat Test Data
- Create Test Data [Parameter]
- Update Test Data Profile
- Updating Value in TDP
- Import TDP
- Bulk Deletion of a Test Data Profile
- Create Test Data [Environment]
- Elements (Objects)
- Web Applications
- Record Multiple Elements
- Record Single Element
- Create Elements
- Supported Locator Types
- Formulating Elements
- Shadow DOM Elements
- Verifying elements in Chrome DevTools
- Handling iframe Elements?
- Dynamic Locators using Parameter
- Dynamic Locators using Runtime
- Using Environment Test Data for Dynamic locators
- Import/Export Elements
- AI Enabled Auto-Healing
- test step recorder
- Install Chrome Extension
- Install Firefox Extension
- Install Edge Extension
- Exclude Attributes/Classes
- test plans
- Add, Edit, Delete Test Machines
- Add, Edit, Delete Test Suites
- Schedule Test Plans
- Run Test Suites In Parallel
- Cross Browser Testing
- Distributed Testing
- Headless Testing
- Test Lab Types
- Disabling Test Cases in Test Plans
- AfterTest Case
- Post Plan Hook
- AfterTest Suite
- Email Configuration in Test Plan
- Execute Partial Test Plans via API
- Ad-hoc Run
- Test Plan Executions
- Dry Runs on Local Devices
- Run Tests on Vendor Platforms
- Run Test Plans on Local Devices
- Test Locally Hosted Applications
- Debug Test Case Failures
- Parallel and Allowed queues
- debugging
- Debug results on local devices (Web applications)
- Debug Results on Local Devices
- Launch Debugger in the Same Window
- Testsigma Agent
- Pre-requisites
- Setup: Windows, Mac, Linux
- Setup: Android Local Devices
- Setting up iOS Local Devices
- Update Agent Manually
- Update Drivers Manually
- Delete Corrupted Agent
- Triggering Tests on Local Devices
- troubleshooting
- Agent - Startup and Registration Errors
- Fetching Agent logs
- Upgrade Testsigma Agent Automatically
- Testsigma Agent - FAQs
- continuous integration
- Test Plan Details
- REST API (Generic)
- Jenkins
- Azure DevOps
- AWS DevOps
- AWS Lambda
- Circle CI
- Bamboo CI
- Travis CI
- CodeShip CI
- Shell Script(Generic)
- Bitrise CI
- GitHub CICD
- Bitbucket CICD
- GitLab CI/CD
- desired capabilities
- Most Common Desired Capabilities
- Browser Console Debug Logs
- Geolocation Emulation
- Bypass Unsafe Download Prompt
- Geolocation for Chrome & Firefox
- Custom User Profile in Chrome
- Emulate Mobile Devices (Chrome)
- Add Chrome Extension
- Network Throttling
- Network Logs
- Biometric Authentication
- Enable App Resigning in iOS
- Enable Capturing Screenshots (Android & iOS)
- Configure Android WebViews
- Incognito/Private mode
- Set Google Play Store Credentials
- addons
- What is an Addon?
- Addons Community Marketplace
- Install Community Addon
- Prerequisites(Create/Update Addon)
- Create an Addon
- Update Addon
- Addon Types
- Create a Post Plan Hook add-on in Testsigma
- Create OCR Text Extraction Addon
- configuration
- API Keys
- Security(SSO)
- Setting Up Google Single Sign-On(SSO) Login in Testsigma
- Setting Up Okta Single Sign-On Integration with SAML Login in Testsigma
- Setting up SAML-based SSO login for Testsigma in Azure
- iOS Settings
- Creating WDA File for iOS App Testing
- uploads
- Upload Files
- Upload Android and iOS Apps
- How to generate mobile builds for Android/iOS applications?
- Testsigma REST APIs
- Environments
- Elements
- Test Plans
- Upload Files
- Get Project wide information
- Upload and update test data profile
- Trigger Multiple Test Plans
- Trigger Test Plan remotely and wait until Completion
- Run the same Test Plan multiple times in Parallel
- Schedule, Update and Delete a test plan using API
- Update Test Case results using API
- Create and update values of Test Data Profile using REST API
- Rerun Test Cases from Run Results using API
- open source dev environment setup
- macOS and IntelliJ Community Edition
- macOS and IntelliJ Ultimate Edition
- Windows and IntelliJ Ultimate Edition
- Setup Dev Environment [Addons]
- NLPs
- Unable to retrieve value stored in text element
- Unable to capture dropdown element
- Unable to Select Radiobutton
- Unable to Click Checkbox
- setup
- Server Docker Deployment Errors
- Secured Business Application Support
- Troubleshooting Restricted Access to Testsigma
- Why mobile device not displayed in Testsigma Mobile Test Recorder?
- Unable to create new test session due to unexpected error
- web apps
- URL not accessible
- Test Queued for a Long Time
- Issues with UI Identifiers
- Missing Elements in Recorder
- Collecting HAR File
- mobile apps
- Failed to Start Mobile Test Recorder
- Troubleshooting “Failed to perform action Mobile Test Recorder” error
- Test Execution State is Queued for a Long Time
- Mobile app keeps stopping after successful launch
- More pre-requisite settings
- Unable to start WDA Process on iPhone
- Most Common causes for Click/Tap NLP failure
- Finding App Package & App Activity (Android)
- on premise setup
- On-Premise Setup Prerequisites
- On-Premise Setup with Docker-compose File
- Post-Installation Checklist for On-Premise Setup
- Install Docker on an Unix OS in Azure Infrastructure
- SMTP Configuration in Testsigma
- Configure Custom Domains
- salesforce testing
- Intro: Testsigma for Salesforce Testing
- Creating a Connected App
- Creating a Salesforce Project
- Creating Metadata Connections
- Adding User Connections
- Build Test Cases: Manual+Live
- Salesforce Element Repositories
- Intro: Testsigma Special NLPs
Integrate Testsigma with your CI/CD using REST API (Generic)
You can integrate Testsigma with your CI/CD tool and trigger test plans and check execution status using REST APIs. This article discusses how to make requests to Testsigma to trigger test plans and check status using CURL & API requests.
Prerequisites
- You should already have the test plan that you want to execute. See test plan management
- You should also know how to generate an API key from settings and get Test Plan ID from an existing Test Plan. See getting test plan details.
Trigger Test Plans Using API
- Go to the specific Test Plan Details page in the Testsigma application (for the Test Plan that you want to include in your CI/CD Pipeline)
- Go to the CI/CD Integrations section on the Test Plan Details page.
- You will see the CURL request under the REST API to integrate with other tools > REST API call to start Test Plan.
Trigger Tests through CURL request:
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\": \"301\", \"environmentId\": \"<ENVIRONMENT_ID>\"}"
You can execute this CURL command in your computer's command-line interface (CLI).
The same can be done using any other REST API client with the following details:
Request Type | POST |
---|---|
Request URL | https://app.testsigma.com/api/v1/execution_results |
Authorization | Bearer <API_KEY> |
Content-type | application/json |
Accept | application/json |
Request Body | { "executionId": "<TEST_PLAN_ID>", "buildNo": "<BUILD_NO>" "environmentId": <ENVIRONMENT_ID> } |
- The <TEST_PLAN_ID> is used to identify the Test Plan which is to be triggered. This can be obtained from the corresponding test plan details page.
- The <API_KEY> is used to authenticate your user in Testsigma API. This can be obtained from the Settings > API Keys by creating a new API key.
- The <BUILD_NO> is the Build number/Version for your corresponding Application Build against which you are running the Tests. This can be obtained from the Dev team or Build Stage in the CI/CD Pipeline.
Check the Status of Test Plan Execution Using API
This API can be used to check the status of the Test Plan using GET method once the Test Plan execution is triggered successfully. Make sure to get RUN_ID for the triggered Test Plan.
PERL
curl -X GET -H \"Content-type: application/json\" \\
-H \"Accept:application/json\" \\
-H \"Authorization: Bearer <API_KEY>\" \\
https://app.testsigma.com/api/v1/execution_results/<RUN_ID>";
You can execute this CURL command in your computer's command-line interface (CLI).
The same can be done using any other REST API client with the following details:
Request Type | GET |
---|---|
Request URL | https://app.testsigma.com/api/v1/execution_results/<RUN_ID> |
Authorization | Bearer <API_KEY> |
Content-type | application/json |
Accept | application/json |
- The <RUN_ID> can be obtained as the value of the key 'id' in the JSON response for the previous API.
- The <API_KEY> can be obtained from the Settings > API_Keys by creating a new API Key.
Executing Tests 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
- Navigating to Test Data > Environments, and click on an Environment.
- On the Environment page, the <ENVIRONMENT_ID> in the URL
https://app.testsigma.com/ui/td/88/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
- 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.
- 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\": \"301\", \"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.
Script Method
If you want to start the Execution and then check the execution status in regular intervals you can make use of a generic Shell Script for integrating with any CI/CD tool.
That's all we need to automate Test Execution when a successful build is triggered using the CI server.