Testsigma Documentation

You can deploy Testsigma locally using Docker Compose. The setup consists of two main services: a mysql database and the testsigma_server.

Service Details

1. MySQL Database (mysql)

• Image: mysql:5.7 (Note: Use mysql:8.0.32 if running on Apple Silicon/M1).
• Platform: linux/x86_64 (Note: Use linux/arm64/v8 if running on Apple Silicon/M1).
• Container Name: testsigma_mysql
• Environment Variables:
  • MYSQL_ROOT_PASSWORD: Set to root by default.
  • MYSQL_DATABASE: Set to testsigma_opensource by default.
  • LANG & LC_ALL: Set to C.UTF-8.
• Persistence: Data is stored in the ./db_data directory on the host.
• Ports: Exposed on port 3306.
• Configuration: Uses --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci.

2. Testsigma Server (testsigma_server)

• Image: testsigmahq/server:v3.0.1 (Note: Use testsigmahq/server:v3.0.1-m1 if running on Apple Silicon/M1).
• Container Name: testsigma_server
• Ports:
  • 9090:9090
  • 443:443
• Persistence: Application data is stored in the ./ts_data directory on the host.
• Dependencies: The server waits for the mysql service to pass its healthcheck before starting.

M1/Apple Silicon Compatibility

If you are using an M1 Mac, you must modify the following fields in the docker-compose.yml:

1. Change mysql image to mysql:8.0.32.
2. Change mysql platform to linux/arm64/v8.
3. Change testsigma_server image to testsigmahq/server:v3.0.1-m1.

version: "3.9"
services:
  mysql:
    image: mysql:5.7 # Replace with mysql:8.0.32 for m1
    platform: linux/x86_64 # Replace with linux/arm64/v8 for m1
    container_name: testsigma_mysql
    restart: always
    volumes:
      - ./db_data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: testsigma_opensource
      LANG: C.UTF-8
      LC_ALL: C.UTF-8
    ports:
      - "3306"
    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    healthcheck:
      test: out=$$(mysqladmin ping -h localhost -P 3306 -u root --password=root 2>&1); echo $$out | grep 'mysqld is alive' || { echo $$out; exit 1; }
      interval: 1s
      retries: 120
  testsigma_server:
    image: testsigmahq/server:v3.0.1 # Replace with testsigmahq/server:v3.0.1-m1 for m1
    container_name: testsigma_server
    ports:
      - "9090:9090"
      - "443:443"
    volumes:
      - ./ts_data:/opt/app/ts_data
    depends_on:
      mysql:
        condition: service_healthy

The ui/src/app/enums/index.ts file serves as the central export point for all enumeration types used within the Testsigma UI. Developers building extensions, add-ons, or custom UI components should import these enums to ensure type safety and consistency with the platform's internal state and logic.

Key categories of enums include:

• Test Execution & Steps: test-case-status.enum, test-step-type.enum, test-step-priority.enum, execution-type.enum.
• Element & Locators: element-locator-type.enum, element-create-type.enum, element-status.enum.
• REST API & HTTP: rest-method.enum, rest-authorization.enum, http-header-names.enum.
• Platform & Environment: platform.enum, workspace-type.enum, active-environment-form-controls.
• Scheduling & Status: schedule-status.enum, schedule-type.enum, invoice-status.enum, user-status.enum.
• Mobile & Browser: mobile-inspection-status.enum, screen-orientation.enum, chrome-recorder-step.enum.