Testsigma

https://testsigma.com/docs
Admin
Testsigma is a no-code test automation platform for web, mobile, desktop, and API testing with...
Tokens:227,957
Snippets:3,162
Trust Score:9.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Testsigma Agent on Windows

Source: https://testsigma.com/docs/agent/setup-on-windows-mac-linux

Run the start.bat file from the Testsigma Agent installation folder to start the agent server as a process on Windows. Wait for it to initialize and direct you to the agent registration page.

```batch
@echo off

REM Start the Testsigma Agent server as a process
call start.bat

REM Optional: Add any post-start commands or checks here

```

--------------------------------

### Start Testsigma Agent on Mac/Linux

Source: https://testsigma.com/docs/agent/setup-on-windows-mac-linux

Execute the start script in the terminal to launch the Testsigma Agent on Mac or Linux. Ensure you are in the agent's installation directory.

```bash
sh start.sh
```

--------------------------------

### Install WSL on Windows

Source: https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors

Execute this command to install the Windows Subsystem for Linux (WSL) if Docker Desktop fails to start on Windows due to WSL issues. Refer to the provided link for alternative solutions.

```bash
wsl --install -d ubuntu
```

--------------------------------

### Start Private Grid Hub

Source: https://testsigma.com/docs/runs/executing-tests-in-private-grid

Use this command to start the Selenium Grid hub. Access the hub at http://localhost:4444 after it starts.

```bash
java -jar selenium-server-4.13.0.jar hub
```

--------------------------------

### Enable and Start Testsigma Connect Service

Source: https://testsigma.com/docs/testsigma-tunnel/setup-installation-linux

Enables the Testsigma Connect service to start automatically on boot and then starts the service immediately.

```bash
sudo systemctl enable testsigma-connect.service
```

```bash
sudo systemctl start testsigma-connect.service
```

--------------------------------

### Start Testsigma UI

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce

Command to start the Testsigma UI from the terminal. Navigate to the ui folder before executing.

```bash
npm start
```

--------------------------------

### Check Xcode Version

Source: https://testsigma.com/docs/FAQs/mobile-apps/why-does-the-ios-app-close-right-after-opening-in-testsigma

Confirm that Xcode is installed and functioning properly by checking its version. A version number indicates a successful setup.

```bash
xcodebuild -version
```

--------------------------------

### Enable and Start Testsigma Connect Service

Source: https://testsigma.com/docs/testsigma-tunnel/setup-installation-linux

Enable the Testsigma Connect service to start automatically on system boot and then start the service manually. These commands are for systemd-based systems.

```bash
sudo systemctl enable testsigma-connect
```

```bash
sudo systemctl start testsigma-connect
```

--------------------------------

### Install Apache HTTPD as a Service

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/windows-and-intelliJ-ue

Installs the Apache HTTPd server as a Windows service. Ensure you are in the 'bin' directory of your Apache installation.

```bash
httpd -k install
```

--------------------------------

### Start MySQL 5.7 Service

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue

Start the MySQL 5.7 service using Homebrew. This command requires sudo privileges.

```shell
brew services start mysql@5.7
```

--------------------------------

### Install Apache httpd via Homebrew

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue

Install the Apache httpd web server using Homebrew. Ensure Xcode is installed before proceeding.

```shell
brew install httpd
```

--------------------------------

### Start Apache httpd Service

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue

Start the Apache httpd service using Homebrew. This command requires sudo privileges.

```shell
sudo brew services start httpd
```

--------------------------------

### Install Homebrew and Apache httpd

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce

Installs Homebrew package manager and then installs the Apache httpd web server using Homebrew on macOS.

```shell
/usr/bin/ruby -e “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
```

```shell
brew install httpd
```

--------------------------------

### Start Testsigma Containers with Docker Compose

Source: https://testsigma.com/docs/on-premise-setup/installation-process/setup

Run this command in the terminal after navigating to the directory containing your docker-compose.yml file to start all Testsigma services.

```bash
docker-compose up
```

--------------------------------

### GET Uploads API Example

Source: https://testsigma.com/docs/api/upload-files

This example demonstrates how to retrieve upload details using the GET Uploads API. Ensure you include your Bearer API Token for authorization.

```json
{
"id": 147,
"projectId": 11,
"createdById": 43,
"updatedById": 43,
"createdDate": 1633535450000,
"updatedDate": 1635322081221,
"name": "test-file",
"appPath": "testsigmatech.com/uploads/11/147/Testfile.pdf",
"fileName": "Testfile.pdf",
"uploadType": "Attachment",
"version": null,
"testsigmaAppId": null,
"testsigmaSauceLabsAppId": null,
"browserStackAppId": null,
"sauceLabsAppId": null,
"platformType": "TestsigmaLab",
"isPublic": null,
"uploadStatus": "Completed",
"comments": null,
"message": "Uploaded successfully",
"status": 1,
"nameFromApp": null,
"versionFromApp": null,
"fileSize": 334666,
"preSignedURL": "https://s3.amazonaws.com/attachments-production.testsigma.com/testsigmatech.com/uploads/11/147/Testfile.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPDYqAbdKsCA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211027T080801Z&X-Amz-SignedHeaders=host&X-Amz-Expires=10799&X-Amz-Credential=AS211027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=0e2f85ef6c0069e014",
"signed": false
}
```

--------------------------------

### Application and Namespace Key Matching

Source: https://testsigma.com/docs/testsigma-tunnel/setup-installation-kubernetes

This example demonstrates how the keys defined under 'Deployments' must have matching entries under 'Application' and 'Namespace' for proper configuration.

```yaml
Application:
  myTunnel:
    name: tunnel-client-mycompany

Namespace:
  myTunnel:
    name: my-namespace

```

--------------------------------

### Start Testsigma Agent on Windows

Source: https://testsigma.com/docs/agent/update-agent-manually

Navigate to the agent directory and execute the start script to run the updated agent. Ensure the agent directory has been updated with the latest files.

```bash
./start.bat
```

--------------------------------

### GET Upload Versions API Example

Source: https://testsigma.com/docs/api/upload-files

This example demonstrates how to retrieve all versions of a specific uploaded file using its upload ID. Ensure you include your API token in the Authorization header.

```json
[{
"id": 147,
"createdById": 43,
"updatedById": 43,
"createdDate": 1633535450000,
"updatedDate": 1635322081221,
"name": "test-file",
"appPath": "testsigmatech.com/uploads/11/147/Testfile.pdf",
"fileName": "Testfile.pdf",
"uploadType": "Attachment",
"testsigmaAppId": null,
"testsigmaSauceLabsAppId": null,
"browserStackAppId": null,
"sauceLabsAppId": null,
"fileSize": 334666,
"preSignedURL": "https://s3.amazonaws.com/attachments-production.testsigma.com/testsigmatech.com/uploads/11/147/Testfile.pdf?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPDYqAbdKsCA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20211027T080801Z&X-Amz-SignedHeaders=host&X-Amz-Expires=10799&X-Amz-Credential=AS211027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=0e2f85ef6c0069e014",
"signed": false
}]
```

--------------------------------

### Dynamic Agent API Response

Source: https://testsigma.com/docs/runs/executing-tests-in-private-grid

This is an example response when successfully creating a dynamic agent. The 'jwtApiKey' field is crucial for starting the agent.

```json
{
 "id": 9,
 "uniqueId": "a3cceab7-5bc9-41d1-a905-e54e0a23c677",
 "jwtApiKey": "<Unique JWT Token>",
 "agentVersion": null,
 "createdById": 2,
 "updatedById": 2,
 "createdDate": 1719222650559,
 "updatedDate": 1719222650559,
 "system": {
 "title": "Dynamic Agent",
 "id": 21,
 "protocol": "http",
 "port": null,
 "httpsPort": null,
 "ipAddress": "127.0.0.1",
 "hostName": null,
 "osType": null,
 "osVersion": null,
 "systemType": 4
 },
 "browserList": [],
 "currentAgentVersion": "5.9.0",
 "status": "REGISTERED",
 "isActive": false
}
```

--------------------------------

### Start Private Grid Node

Source: https://testsigma.com/docs/runs/executing-tests-in-private-grid

Start a web node for the private grid. Ensure the node.json configuration file is available. Setting --selenium-manager to true enables Selenium Manager.

```bash
java -jar selenium-server-4.13.0.jar node --config node.json --selenium-manager true
```

--------------------------------

### Testsigma Agent Command Line Options

Source: https://testsigma.com/docs/agent/setup-on-windows-mac-linux

A list of available commands for managing the Testsigma Agent, including starting, stopping, status checks, and installation.

```plaintext
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.
```

--------------------------------

### Configure Chrome Extension in Desired Capabilities

Source: https://testsigma.com/docs/troubleshooting/general/automating-chrome-extension

Use this format in Desired Capabilities to specify a single Chrome extension to be installed automatically when test execution starts.

```json
{"extensions":["extension.crx"]}
```

--------------------------------

### Example Error Message for Used Ports

Source: https://testsigma.com/docs/troubleshooting/agent/agent-failures-due-to-used-ports

This error message indicates that a port required by Apache Tomcat is already in use by another application, preventing the Testsigma Agent from starting.

```text
SEVERE [main] org.apache.coyote.AbstractProtocol.init Failed to initialize end point associated with ProtocolHandler
["http-nio-8080"]
java.net.BindException: Address already in use
```

--------------------------------

### Start Testsigma Agent on Mac/Linux

Source: https://testsigma.com/docs/agent/update-agent-manually

After updating the agent files, navigate to the agent directory in the terminal and execute the start script to launch the agent.

```bash
./start.sh
```

--------------------------------

### Configure values.yaml for Testsigma Tunnel

Source: https://testsigma.com/docs/testsigma-tunnel/setup-installation-kubernetes

Use this example as a starting point for your values.yaml file. Replace placeholder values with your specific configuration details, such as API key, tunnel name, and namespace.

```yaml
Environment:
  name: production              # Environment name (production, staging, etc.)

Application:
  myTunnel:
    name: tunnel-client-mycompany   # Unique application name

Namespace:
  myTunnel:
    name: my-namespace              # Kubernetes namespace for this tunnel

Deployments:
  myTunnel:
    enabled: true
    replicas: 1
    poolType: app                   # Must match a node label: pool-type=<value>
    enabledStatefulSet: true        # Set to true to create the headless Service
    containers:
      image: testsigmainc/testsigma-tunnel
      version: amd64-latest
      imagePullPolicy: Always
    config:
      key: "<YOUR_TUNNEL_API_KEY>"  # API key from the Testsigma dashboard
      tunnelName: "my-tunnel"       # Name that appears in the Testsigma UI
      verbose: true                 # Enable verbose logging
      delegateSslValidation: false  # Set true to skip SSL certificate validation
      proxy: ""                     # HTTP proxy URL (leave empty if not required)

```

--------------------------------

### Set MySQL 5.7 Path and Start Service

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce

Configures the PATH environment variable for MySQL 5.7 and starts the MySQL service using Homebrew.

```shell
export PATH="/opt/homebrew/opt/mysql@5.7/bin:$PATH"
```

```shell
brew services start mysql@5.7
```

--------------------------------

### Add REST API Step in Testsigma

Source: https://testsigma.com/docs/api/overview

Configure a REST API step within a Test Case in Testsigma to interact with Testsigma's API endpoints. This example shows setting up a GET request.

```json
{
    "method": "GET",
    "url": "https://app.testsigma.com/api/v1/applications"
}
```

--------------------------------

### Start Dynamic Agent (Windows)

Source: https://testsigma.com/docs/runs/executing-tests-in-private-grid

Execute this command in the Testsigma Agent directory on Windows to start the dynamic agent. Replace '<JWT_KEY>' with the 'jwtApiKey' obtained from the API response.

```batch
./start.bat --TS_ACTIVATION_KEY=<JWT_KEY>
```

--------------------------------

### Specify Chrome Extension Path in Desired Capabilities

Source: https://testsigma.com/docs/desired-capabilities/add-chrome-extension

Use the 'goog:chromeOptions' desired capability to specify the path to your Chrome extension's CRX file. This enables the extension to be automatically installed when the automation session starts.

```json
{"extensions":["path/to/extension.crx"]}
```

```json
{"extensions":["path/to/extension1.crx"],["path/to/extension2.crx"]}
```

--------------------------------

### Verify Angular CLI Installation

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ce

Checks the installed version of Angular CLI to confirm successful installation.

```shell
ng --version
```

--------------------------------

### Basic Authentication Example in NLP

Source: https://testsigma.com/docs/FAQs/web-apps/basic-authentication

An example of how to input basic authentication credentials in the NLP navigate to test data field. Replace the placeholder with your actual URL.

```text
https://admin:admin123@orangehrm.com
```

--------------------------------

### Install Homebrew Package Manager

Source: https://testsigma.com/docs/contributing/open-source-dev-environment-setup/macos-and-intellij-ue

Install the Homebrew package manager on macOS. This is a prerequisite for installing other development tools.

```shell
/usr/bin/ruby -e “$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
```

--------------------------------

### Start Dynamic Agent (Mac/Linux)

Source: https://testsigma.com/docs/runs/executing-tests-in-private-grid

Execute this command in the Testsigma Agent directory on Mac or Linux to start the dynamic agent. Replace '<JWT_KEY>' with the 'jwtApiKey' obtained from the API response.

```bash
./start.sh --TS_ACTIVATION_KEY=<JWT_KEY>
```

--------------------------------

### Start Testsigma Agent with Chrome Path (Mac/Linux)

Source: https://testsigma.com/docs/agent/troubleshooting/why-is-testsigma-agent-not-detecting-my-installed-browsers

Use this command on Mac or Linux to start the Testsigma Agent and explicitly provide the path to the Chrome executable. This helps the agent detect the browser if it's not found automatically.

```bash
sudo sh start.sh --TS_CHROME_PATH=<chrome_executable_path>
```

--------------------------------

### Install Xcode Command Line Tools

Source: https://testsigma.com/docs/FAQs/mobile-apps/why-does-the-ios-app-close-right-after-opening-in-testsigma

If necessary, install the Xcode command-line tools using this command. This is often required for development tools to function correctly.

```bash
xcode-select --install
```
Tokens:
Raw