PR测试专用镜像文档

1. 镜像概述和主要用途

本镜像专为手动测试目标仓库的拉取请求（Pull Request，PR）设计，提供隔离、一致的测试环境，帮助开发者验证PR内容的功能正确性、兼容性及稳定性，确保代码合并前的质量管控。

2. 核心功能和特性

2.1 核心功能

• 支持PR测试流程的手动触发，模拟PR合并后的运行环境
• 集成目标仓库代码，可执行预设或自定义测试命令
• 提供隔离的测试空间，避免对本地开发环境的干扰

2.2 主要特性

• 轻量级设计：基于精简基础镜像，资源占用低，启动速度快
• 专注测试场景：功能单一，仅针对PR测试优化，操作流程简化
• 环境一致性：统一测试环境配置，消除“本地可运行但测试环境异常”的问题

3. 使用场景和适用范围

3.1 使用场景

• 仓库维护者处理PR时，需手动验证功能实现、边界条件或兼容性
• 开发者提交PR前，本地模拟合并后环境进行自测
• 对PR涉及的关键模块（如性能、安全）进行专项测试

3.2 适用范围

• 仅限本镜像关联的特定仓库PR测试，不支持跨仓库使用
• 适用于需要手动介入验证的PR场景（如自动化测试无法覆盖的人工检查项）

4. 使用方法和配置说明

4.1 前置条件

• 本地已安装Docker Engine（20.10+版本推荐）
• 已克隆目标仓库代码，并可访问待测试PR分支（通过git fetch origin pull/<PR_ID>/head:<branch_name>拉取）
• 容器网络可访问测试依赖资源（如包管理器、API服务等）

4.2 部署示例

4.2.1 Docker Run命令

bash
docker run -it \
  --name pr-test-container \
  -v /local/path/to/repo:/app/repo \  # 挂载本地仓库目录至容器内
  -e PR_ID=123 \                     # 指定待测试PR编号（必填）
  -e TEST_CMD="make test" \          # 自定义测试命令（如无需默认脚本）
  [镜像名称]:[标签]

4.2.2 Docker Compose配置

创建docker-compose.yml：

yaml
version: '3'
services:
  pr-test:
    image: [镜像名称]:[标签]
    container_name: pr-test-container
    volumes:
      - /local/path/to/repo:/app/repo  # 本地仓库路径映射（必填）
    environment:
      - PR_ID=123                      # PR编号（必填）
      - REPO_BRANCH=pr-test-branch     # 本地PR分支名称（默认自动拉取）
      - TEST_TIMEOUT=300               # 测试超时时间（秒，默认300）
    tty: true  # 保持终端交互

4.3 配置参数说明

4.3.1 环境变量

4.3.2 挂载卷

4.4 操作步骤

1. 拉取PR分支：

   bash
   git clone [***]
   cd target-repo
   git fetch origin pull/<PR_ID>/head:pr-test-branch  # 替换<PR_ID>为实际编号
   git checkout pr-test-branch
   

2. 启动测试容器：
   执行4.2.1中的docker run命令或docker-compose up -d

3. 执行测试：
   容器启动后自动运行TEST_CMD（或默认测试脚本），输出测试结果

4. 验证结果：
   查看终端输出，确认PR功能符合预期；测试完成后可通过docker stop pr-test-container停止容器

5. 注意事项

• 确保本地仓库目录具备读写权限，避免容器内测试命令因权限不足失败
• 若测试涉及外部依赖（如数据库），需通过--link或网络配置使容器可访问
• 测试完成后建议清理容器：docker rm pr-test-container，避免资源占用
• 自定义TEST_CMD时需确保依赖工具已在镜像中预装（或通过Dockerfile扩展基础镜像）