- 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
- Create Test Steps Using Simple English
- Test Step Settings
- Test Step Options
- Reuse Elements
- Test Step Reordering
- Bulk Actions
- Add Steps Before & After
- Web Applications
- Test Step Actions
- Test Step Settings
- Test Data in Steps
- Add Steps Manually
- Reuse Elements
- Update Elements
- Create an Element
- Reorder Test Steps
- Bulk Actions
- Add Steps Before & After
- Record steps anywhere in a Test Case
- 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 the Recorder
- 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
- 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
Setting up Testsigma Agent on your local machine
With Testsigma Agent you can run tests on local machines/devices in addition to Testsigma Cloud. This article discusses how to set up the Testsigma agent on your local machine.
Download Formats Available
The Testsigma Agents are available in the following forms:
- ZIP files
- Executable files
- DMG files
- Docker image
Steps to Download Testsigma Agent as a ZIP File
- Navigate to Agents and click on Download Agent.
- From the dropdown that appears, download the ZIP file as per your machine.
-
After downloading the agent ZIP file, extract the Testsigma Agent ZIP file to a location of your choice. Some suggested locations to place the Testsigma agent folder are mentioned in the table below:
Operating System Preferred Agent location Windows C:\Users<your_username>\ Mac /Users/<your_username>/ Linux /Users/<your_username>/ Replace the <your_username> part with your account username.
The home directory is recommended so as to avoid hassles of setting file permissions and ownership and also to avoid file corruption due to syncing with iCloud or Google Drive.
You can either start the Testsigma agent server as a process via the command line or terminal when needed. Or, you can run the Testsigma agent server as a server. For more information, refer to the below sections to see how to start the Testsigma Agent as a process or as a service.
Steps to Download Testsigma Agent as Executable File
- Navigate to Agents and click on Download Agent.
-
From the dropdown that appears, select the executable file supported by your machine.
- For Windows, select exe,
- For mac, select dmg,
- For Linux, select bin to download the latest version of Testsigma Agent.
- Double click on the downloaded file.
- Choose the path where you would like to install the agent.
- Let the installer run till completion.
Once the installation is complete, you can either run the Testsigma Agent server as a process via the command line/terminal when needed.
Start the Testsigma Agent Server as a Process
For Windows
- Navigate to the Testsigma Agent installation folder and double click the start.bat or run start.bat in the command line file to start the Testsigma Agent.
- Wait for a few minutes for the Testsigma Agent to start up.
- After starting up you will be directed to the agent registration page.
For more information on how to register Testsigma Agent, refer to register the Testsigma Agent.
For Mac/Linux
- Navigate to the Testsigma Agent installation folder and drag start.sh to a new terminal window and click on Return.
- Wait for a few minutes for the Testsigma Agent to start up.
- After starting up you will be directed to the agent registration page.
For more information on how to register Testsigma Agent, refer to register the Testsigma Agent.
Start the Testsigma Agent Server as a Service
- For Windows: Go to the command line. For Mac/Linux: Go to the terminal.
- Navigate to the Testsigma Agent installation folder.
- Inside the Testsigma Agent installation folder, navigate to Wrapper > Bin.
- For Mac/Linux, if you want to install the agent as a service, use the command TestsigmaAgent start.
- For Windows, if you want to install the agent as a service, use the command TestsigmaAgent install.
At present, the option to install Testsigma Agent to start automatically when system boots is only supported for windows.
- To stop the service, run the command - TestsigmaAgent stop from the same location.
Commands that work with TestsigmaAgent:
console Launch in the current console.
start Start in the background as a daemon process.
stop Stop if running as a daemon or in another console.
restart Stop if running and then start.
condrestart Restart only if already running.
status Query the current status.
install Install to start automatically when system boots.
installstart Install and start running as a daemon process.
remove Uninstall.
dump Request a Java thread dump if running.
Register the Testsigma Agent
- Once your Testsigma agent is up and running, you will be directed to the Agent registration page.
- Click on Register to start the Agent registration process.
-
On the Add new Agent overlay,
- Enter a Name for your machine.
- If you want to make this agent private, uncheck the checkbox Visible to Everyone.
- Click on Add Agent.
- After adding, the agent that you registered will be displayed with all the available browsers in that Agent machine:
- There may be instances when you want to add the Testsigma agents to your Testsigma account but want to activate them later. Make sure to check the Activate Later checkbox, On the Add a new Agent popup.
- On successfully adding the agent, you will be taken to the agent configuration page that contains the command that you can use to activate the agent later.
It might take a couple of minutes for the operating system version and the browser names to appear. Refer to the troubleshooting guide if the details does not show up after 10 minutes.
Run Testsigma Agent Using Docker
There are two ways of starting the testsigma local agent using docker:
- Create an Agent in Testsigma application, obtain the Activation Key, and use it to register the agent while the Docker container is booting.
- Create and register a New Agent entirely while booting the Docker container.
- On the dashboard, click on Agents.
- Click on Add new Agent.
-
On the Add a new Agent form,
- Add the Name for the agent.
- Make sure to check the Activate Later checkbox.
- Click on Add Agent.
- On successfully saving the agent, you will be taken to the agent configuration page that will contain the activation key.
- Create a docker-compose.yml file with TS_ACTIVATION_KEY environment variables.
The following docker-compose snippet can be used to start a Testsigma Agent with headless Chrome, Firefox & Edge browsers:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
depends_on:
- chrome
- firefox
- edge
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_ACTIVATION_KEY: "REPLACE_WITH_YOUR_ACTIVATION_KEY"
CHROME: "http://chrome:4444"
FIREFOX: "http://firefox:4444"
EDGE: "http://edge:4444"
chrome:
image: selenium/standalone-chrome:latest
shm_size: 1gb
ports:
- "4444:4444"
firefox:
image: selenium/standalone-firefox:latest
shm_size: 1gb
ports:
- "4445:4444"
edge:
image: selenium/standalone-edge:latest
shm_size: 1gb
ports:
- "4446:4444"
This docker-compose snippet spins up four containers:
- Testsigma Agent
- Standalone Selenium with pre-installed Chrome
- Standalone Selenium with pre-installed Firefox
- Standalone Selenium with pre-installed Edge
Testsigma Agent will detect browser versions through the Environment Variables CHROME, FIREFOX, and EDGE. Note that these Environment Variables are all optional.
If you plan to run your test solely on the Chrome browser, there's no need to specify the FIREFOX and EDGE environment variables. Here's an example docker-compose file:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
depends_on:
- chrome
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_ACTIVATION_KEY: "REPLACE_WITH_YOUR_ACTIVATION_KEY"
CHROME: "http://chrome:4444"
chrome:
image: selenium/standalone-chrome:latest
shm_size: 1gb
ports:
- "4444:4444"
If your system lacks sufficient resources, you can distribute browser containers across multiple systems and specify a remote debugging URL. Here's an example docker-compose file:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_ACTIVATION_KEY: "REPLACE_WITH_YOUR_ACTIVATION_KEY"
CHROME: "<REMOTE_CHROME_URL>"
FIREFOX: "<REMOTE_FIREFOX_URL>"
EDGE: "<REMOTE_EDGE_URL>"
Testsigma Agent container allows controlling minimum and maximum heap memory settings using MIN and MAX environment variables. The default values for MIN and MAX will be 1GB and 8GB, respectively. Here's an example docker-compose file:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_ACTIVATION_KEY: "REPLACE_WITH_YOUR_ACTIVATION_KEY"
MIN: "-Xms1g"
MAX: "-Xmx8g"
CHROME: "<CHROME_URL>"
FIREFOX: "<FIREFOX_URL>"
EDGE: "<EDGE_URL>"
For ARM-based Systems (Mac M1 processors):
Google does not build Chrome for Linux ARM platforms. Instead, docker-seleniarm uses the open-source Chromium browser built for ARM. Here's an example docker-compose file:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
depends_on:
- chrome
- firefox
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_ACTIVATION_KEY: "REPLACE_WITH_YOUR_ACTIVATION_KEY"
CHROME: "http://chrome:4444"
FIREFOX: "http://firefox:4444"
EDGE: "<REMOTE_EDGE_URL>"
chrome:
image: seleniarm/standalone-chrome:latest
shm_size: 1gb
ports:
- "4444:4444"
firefox:
image: seleniarm/standalone-firefox:latest
shm_size: 1gb
ports:
- "4445:4444"
- Save the docker-compose.yml file in an appropriate directory.
- Open a command-line interface and navigate to the directory. Execute the command docker-compose up, which will download the necessary images and start the Testsigma Agent.
Register a New Agent While Booting the Docker Container.
To create and register the Agent Automatically in one step, you must specify the environment variables below instead of TS_ACTIVATION_KEY.
TS_AUTO_REGISTRATION_KEY - Testsigma API key
TS_AUTO_REGISTRATION_TITLE - Title of the Agent
TS_AUTO_REGISTRATION_HTTP_PORT - HTTP Port for internal communication between Agent and Testsigma
TS_AUTO_REGISTRATION_HTTPS_PORT - HTTPS Port for internal communication between Agent and Testsigma
Here's an example docker-compose file:
version: "3.9"
services:
testsigma-agent:
image: testsigmainc/testsigma-agent:latest
container_name: testsigma-agent
depends_on:
- chrome
- firefox
- edge
volumes:
- ./data/agent_data:/var/ts/agent
- ./<foldername>:/root/.testsigma/agent/logs
environment:
TS_AUTO_REGISTRATION_KEY: "REPLACE_WITH_API_KEY"
TS_AUTO_REGISTRATION_TITLE: "REPLACE_WITH_TITLE"
TS_AUTO_REGISTRATION_HTTP_PORT: "REPLACE_WITH_ANY_AVAILABLE_PORT_NUMBER"
TS_AUTO_REGISTRATION_HTTPS_PORT: "REPLACE_WITH_ANY_AVAILABLE_PORT_NUMBER"
CHROME: "http://chrome:4444"
FIREFOX: "http://firefox:4444"
EDGE: "http://edge:4444"
chrome:
image: selenium/standalone-chrome:latest
shm_size: 1gb
ports:
- "4444:4444"
firefox:
image: selenium/standalone-firefox:latest
shm_size: 1gb
ports:
- "4445:4444"
edge:
image: selenium/standalone-edge:latest
shm_size: 1gb
ports:
- "4446:4444"
Please refer to the Activation Key sections for alternative methods of configuring the docker-compose file and starting the Agent using the docker-compose file.