Skip to content

Cypress - 仪表盘

Cypress Cloud(以前称为 Cypress Dashboard)是一项服务,可为您的 Cypress 测试提供有价值的洞察和功能,尤其是在 CI/CD(持续集成/持续部署)环境中运行时。它允许您记录测试运行、查看详细的分析数据,并更有效地进行协作。

Cypress Cloud 提供多种强大功能:

  • 测试记录:存储测试运行的产物(artifacts),包括命令日志、失败时的屏幕截图以及整个测试会话的视频记录。
  • 分析与洞察:提供关于测试套件健康状况的数据,例如通过/失败率、持续时间以及不稳定测试(flaky test)检测。
  • 并行执行:允许您在多台机器上并行运行测试,显著缩短 CI 运行时间。
  • 负载均衡:智能地在可用的并行机器之间分配 spec 文件,以优化运行持续时间。
  • GitHub 集成:与 GitHub 集成,提供 pull request 的状态检查并方便访问测试结果。
  • 不稳定测试管理:帮助识别和管理那些间歇性通过或失败的测试。
  • 组织管理:在您的团队或组织内管理项目、用户和权限。

要将您的项目连接到 Cypress Cloud,请遵循以下通用步骤:

  1. 打开 Cypress:使用 npx cypress open 启动 Cypress Test Runner(测试运行器)。

  2. 导航到 Runs 选项卡:在 Test Runner 中,通常有一个名为 ‘Runs’ 或 ‘Cloud’ 的选项卡。点击它。

  3. 连接到 Cloud:您会看到诸如 ‘Connect to Cypress Cloud’ 或 ‘Set up project to record’ 的选项。点击此选项开始设置过程。

成功登录后,界面将引导您完成在 Cypress Cloud 中设置项目的过程。

  1. 配置项目:您需要为项目命名,选择一个组织(如果适用),并决定其可见性(公开或私有)。

一旦在 Cypress Cloud 中设置好项目,您将获得:

  • 一个唯一的 projectId:这个 ID 用于在 Cypress Cloud 中标识您的项目。
  • 一个 record key:这个秘密密钥用于在发送数据到 Cypress Cloud 时验证您的测试运行。

projectId 应该会自动添加到您的 cypress.config.js(或 cypress.config.ts)文件中。如果没有,您需要手动添加,例如:e2e: { projectId: 'your-project-id', setupNodeEvents(...) }。

要记录您的第一次运行,请使用 --record 标志和您的 record key 执行 Cypress:

npx cypress run --record --key YOUR_RECORD_KEY

将 YOUR_RECORD_KEY 替换为 Cypress Cloud 提供的实际密钥。最佳实践是在您的 CI 环境中将其设置为环境变量(例如 CYPRESS_RECORD_KEY),而不是硬编码。

命令完成后,终端输出中将包含一个指向 Cypress Cloud 中已记录运行的链接。

在 Cypress Cloud 中,您可以查看关于运行的详细信息,包括总体统计数据(通过、失败、跳过的测试)、单个 spec 结果、失败时的屏幕截图和视频记录。‘Specs’ 选项卡将列出每个测试文件及其结果,允许您深入查看特定的失败,并检查命令日志、错误消息和可视化产物(visual artifacts)。

实际应用:为您的 CI/CD 流水线设置 Cypress Cloud 可为测试失败提供宝贵的可见性,帮助开发人员快速诊断和修复问题。并行执行可以显著减少大型测试套件的反馈周期。

更多详细信息,请参阅官方 Cypress Cloud 文档:[https://on.cypress.io/cloud]