testsigmainc/testsigma-agent

Testsigma Agent Docker镜像文档

1. 镜像概述和主要用途

Testsigma Agent Docker镜像是Testsigma自动化测试平台的轻量级执行代理容器化方案，用于在目标环境中部署Testsigma Agent，实现与Testsigma云端平台的通信、测试任务接收及自动化测试用例执行。该镜像封装了Agent运行所需的依赖环境，支持快速部署、跨平台运行，简化测试基础设施的搭建流程。

2. 核心功能和特性

• 平台集成：与Testsigma云端平台实时通信，自动接收测试任务并上报执行结果。
• 跨环境兼容：支持在Linux、Windows（WSL2）、macOS等系统的Docker环境中运行。
• 多浏览器支持：内置Chrome、Firefox等主流浏览器驱动，可配置扩展浏览器版本。
• 资源隔离：通过容器化实现测试执行环境的隔离，避免与宿主环境冲突。
• 轻量化部署：镜像体积优化，启动速度快，支持通过环境变量灵活配置。

3. 使用场景和适用范围

• CI/CD流水线集成：在Jenkins、GitLab CI等流水线中部署Agent，实现代码提交后自动触发测试。
• 分布式测试：在多节点部署多个Agent，并行执行测试用例，缩短测试周期。
• 多环境测试：在开发、测试、预生产环境分别部署Agent，验证不同环境下的功能兼容性。
• 隔离环境测试：需严格控制测试依赖（如特定浏览器版本、网络代理）时，通过容器配置实现环境一致性。

4. 使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+版本）及Docker Compose（可选）。
• 拥有Testsigma平台账号，已在平台创建Agent并获取Agent Key（路径：Testsigma平台 > Agents > 新增Agent > 复制Key）。
• 目标环境需能访问Testsigma云端服务（默认域名：app.testsigma.com，端口443）。

4.2 Docker Run命令示例

通过以下命令快速启动Testsigma Agent容器：

bash
docker run -d \
  --name testsigma-agent \
  --restart always \
  -e TESTSIGMA_AGENT_KEY="your_agent_key_here" \  # 替换为实际Agent Key（必填）
  -e TESTSIGMA_AGENT_NAME="prod-agent-01" \       # 自定义Agent名称（可选，默认自动生成）
  -e LOG_LEVEL="INFO" \                           # 日志级别：DEBUG/INFO/WARN/ERROR（可选，默认INFO）
  -v /var/run/docker.sock:/var/run/docker.sock \  # 如需Agent内部启动容器（如Selenium Grid），需挂载Docker sock
  -v ./tests:/tests \                             # 挂载本地测试数据目录（可选，用于测试文件读取）
  testsigma/agent:latest

4.3 Docker Compose配置示例

创建docker-compose.yml文件，通过Compose管理Agent服务：

yaml
version: '3.8'
services:
  testsigma-agent:
    image: testsigma/agent:latest
    container_name: testsigma-agent
    restart: always
    environment:
      - TESTSIGMA_AGENT_KEY=your_agent_key_here  # 替换为实际Agent Key（必填）
      - TESTSIGMA_AGENT_NAME=staging-agent-01    # 自定义Agent名称（可选）
      - PROXY_HOST=proxy.example.com             # 网络代理地址（可选，需代理时配置）
      - PROXY_PORT=8080                          # 代理端口（可选）
      - PROXY_USER=proxy_user                    # 代理认证用户名（可选）
      - PROXY_PASSWORD=proxy_pass                # 代理认证密码（可选）
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 挂载Docker sock（按需启用）
      - tests_data:/tests                          # 持久化测试数据（可选）
      - agent_logs:/var/log/testsigma-agent        # 持久化Agent日志（可选）
volumes:
  tests_data:
  agent_logs:

启动命令：docker-compose up -d

4.4 配置参数说明

4.4.1 环境变量

4.4.2 卷挂载

4.5 状态验证

容器启动后，可通过以下方式验证Agent状态：

1. 查看容器日志：docker logs -f testsigma-agent，出现Agent connected to Testsigma server即表示连接成功。
2. Testsigma平台验证：登录平台，在「Agents」页面查看Agent状态为「在线」。

5. 注意事项

• Agent Key为敏感信息，请勿暴露在公开配置中。
• 如需自定义浏览器版本，需确保镜像内置驱动支持（可通过BROWSER_*_VERSION环境变量指定）。
• 容器重启策略建议配置为always，确保Agent服务持续可用。