agoldis/sorry-cypress-director

sorry-cypress Docker镜像文档

镜像概述和主要用途

sorry-cypress是一个开源、本地部署、自托管的Cypress仪表盘替代方案。它允许用户脱离官方Cypress仪表盘，在自有基础设施上运行Cypress测试，支持测试并行执行、结果持久化存储及可视化展示，帮助团队完全掌控测试数据和运行环境，避免官方仪表盘的限制和依赖。

核心功能和特性

• 并行测试执行：无需官方仪表盘即可并行运行Cypress测试
• 资产存储：支持将失败测试的截图和视频上传至S3存储桶
• 结果可视化：提供Web仪表盘浏览测试结果、失败详情、截图及视频
• 灵活存储模式：可运行于无持久化的轻量模式，或搭配MongoDB进行数据持久化
• 本地部署：自托管在自有基础设施，数据完全自主，无使用限制

使用场景和适用范围

• 需要脱离官方Cypress仪表盘进行测试管理的团队
• 希望完全掌控测试数据和基础设施的企业或组织
• 需要并行执行Cypress测试以提高CI/CD效率的项目
• 对数据隐私和合规性有严格要求的场景

详细使用方法和配置说明

快速启动（本地演示）

通过Docker Compose快速启动完整服务栈：

bash
# 克隆仓库（可选，用于获取docker-compose配置）
git clone https://github.com/agoldis/sorry-cypress.git
cd sorry-cypress

# 启动所有服务
docker-compose -f docker-compose.full.yml up

服务启动后：

• 访问 http://localhost:8080 查看Web仪表盘
• Cypress配置指向 http://localhost:1234 即可使用并行测试功能

Docker镜像信息

预构建镜像托管于Docker Hub：https://hub.docker.com/u/agoldis

镜像标签对应Git标签，latest标签对应master分支最新版本。

基础使用流程

1. 配置Cypress指向sorry-cypress服务

   找到Cypress安装路径（可通过DEBUG=cypress:* cypress version命令查看），修改配置文件 <cypress-root>/packages/server/config/app.yml：

   yaml
   production:
     # 替换为sorry-cypress director服务URL
     api_url: "http://localhost:1234/"  # 本地部署示例
     # 或 "https://your-director-service.com/" 生产环境示例
   

2. 运行并行测试

   bash
   cypress run --parallel --record --key YOUR_RECORD_KEY --ci-build-id UNIQUE_BUILD_ID
   

服务配置说明

director服务

负责测试并行协调、结果存储和截图上传，核心配置通过环境变量实现：

持久化配置（MongoDB）：

bash
EXECUTION_DRIVER="../execution/mongo/driver"
MONGODB_URI="mongodb://mongo:27017"  # MongoDB连接地址
MONGODB_DATABASE="sorry-cypress"      # 数据库名称

S3截图存储配置：

bash
SCREENSHOTS_DRIVER="../screenshots/s3.driver"
S3_BUCKET="your-bucket-name"          # S3存储桶名称
S3_REGION="us-east-1"                 # S3区域
# 需确保环境中存在具有S3访问权限的AWS凭证

api服务

GraphQL API服务，用于查询MongoDB中存储的测试数据：

dashboard服务

Web仪表盘（ReactJS），可视化测试结果：

Docker Compose完整配置示例

yaml
# docker-compose.full.yml 示例
version: '3'

services:
  mongo:
    image: docker.xuanyuan.run/mongo:4.4
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db

  director:
    image: docker.xuanyuan.run/agoldis/sorry-cypress-director:latest
    ports:
      - "1234:1234"
    environment:
      - PORT=1234
      - DASHBOARD_URL=http://localhost:8080
      - EXECUTION_DRIVER=../execution/mongo/driver
      - MONGODB_URI=mongodb://mongo:27017
      - MONGODB_DATABASE=sorry-cypress
      - SCREENSHOTS_DRIVER=../screenshots/s3.driver
      - S3_BUCKET=your-s3-bucket
      - S3_REGION=us-east-1
    depends_on:
      - mongo

  api:
    image: docker.xuanyuan.run/agoldis/sorry-cypress-api:latest
    ports:
      - "4000:4000"
    environment:
      - MONGODB_URI=mongodb://mongo:27017
      - MONGODB_DATABASE=sorry-cypress
    depends_on:
      - mongo

  dashboard:
    image: docker.xuanyuan.run/agoldis/sorry-cypress-dashboard:latest
    ports:
      - "8080:80"
    environment:
      - GRAPHQL_SCHEMA_URL=http://api:4000
    depends_on:
      - api

volumes:
  mongo-data:

其他部署方式

• Heroku部署：参考https://github.com/agoldis/sorry-cypress/wiki/Heroku-Tutorial
• AWS部署：使用CloudFormation模板快速部署，包含完整服务栈和网络配置，详见https://github.com/agoldis/sorry-cypress/wiki/AWS-Tutorial

常见问题

Q: 为什么选择sorry-cypress？
A: 解决官方Cypress仪表盘可能出现的崩溃、并行测试限制等问题，实现数据自主和基础设施可控。

Q: 是否合法使用？
A: 合法，Cypress本身是开源软件，sorry-cypress作为替代方案符合开源许可。

Q: 是否生产就绪？
A: 是的，已在多个生产环境中使用。

相关资源

• https://github.com/agoldis/sorry-cypress/wiki
• https://docs.cypress.io/guides/guides/parallelization.html
• https://github.com/agoldis/sorry-cypress/wiki/AWS-Multiple-Cypress-Agents

许可证

MIT