cypress/included

Cypress Included 镜像文档

镜像概述

Cypress Included 是 Cypress 官方提供的 Docker 镜像，旨在简化端到端测试环境的搭建。该镜像包含运行 Cypress 测试所需的全部系统依赖、Cypress 测试框架本身，以及针对非 ARM 架构预先安装的主流浏览器，帮助用户快速部署一致的测试环境。

核心功能与特性

• 完整依赖集成：内置所有运行 Cypress 所需的系统级依赖，无需额外配置基础环境。
• Cypress 预安装：镜像已包含 Cypress 框架，可直接执行测试命令。
• 浏览器支持：在非 ARM 架构（如 x86_64）下，预装主流浏览器（如 Chrome、Firefox 等），满足不同测试场景需求；注意：ARM 架构镜像未预装浏览器，需手动配置。
• 环境一致性：标准化测试环境，避免因本地环境差异导致的测试结果不一致问题。

使用场景

• CI/CD 流程：在持续集成/持续部署 pipeline 中集成，自动运行端到端测试。
• 本地开发：快速搭建与生产环境一致的测试环境，降低环境配置成本。
• 团队协作：统一团队测试环境，减少"在我电脑上能运行"的问题。

使用方法

基本运行命令

通过 docker run 命令启动容器并运行测试：

bash
docker run -it -v $PWD:/e2e -w /e2e docker.xuanyuan.run/cypress/included:latest cypress run

• -v $PWD:/e2e：将当前目录挂载到容器内的 /e2e 工作目录。
• -w /e2e：设置工作目录为 /e2e。
• cypress run：执行 Cypress 测试命令（可根据需求替换为 cypress open 等其他命令）。

Docker Compose 配置示例

创建 docker-compose.yml 文件简化部署：

yaml
version: '3'
services:
  cypress:
    image: docker.xuanyuan.run/cypress/included:latest
    volumes:
      - ./:/e2e
    working_dir: /e2e
    command: cypress run

启动命令：docker-compose up

注意事项

• ARM 架构限制：ARM 架构（如 Apple Silicon）的镜像未预装浏览器，需通过额外步骤手动安装浏览器或使用无浏览器模式运行测试。
• 版本指定：建议在生产环境中指定具体版本标签（如 cypress/included:13.6.0），避免因镜像更新导致环境变化。
• 详细配置：完整使用说明（包括高级配置、浏览器版本等）请参考官方文档：https://github.com/cypress-io/cypress-docker-images/tree/master/included。