glotzerlab/ci

CI测试镜像文档

镜像概述

CI测试镜像是专为持续集成(CI)流程设计的标准化测试环境解决方案，旨在通过容器化技术提供隔离、一致的测试环境，消除"在我机器上能运行"的环境差异问题。该镜像集成主流测试工具链，支持自动化测试执行、测试结果收集与标准化输出，可无缝对接各类CI/CD平台（如Jenkins、GitLab CI、GitHub Actions等），提升测试效率与可靠性。

核心功能与特性

• 环境隔离：基于容器技术实现测试环境与主机环境的完全隔离，避免依赖冲突
• 多场景支持：内置多种编程语言（Java、Python、Node.js等）及测试框架（JUnit、PyTest、Jest等）的基础依赖
• 测试工具集成：预装常用测试辅助工具（如代码覆盖率工具、测试报告生成器、日志收集工具）
• 灵活配置：通过环境变量自定义测试命令、报告格式、执行参数
• 结果标准化：支持主流测试报告格式（JUnit XML、Cobertura、HTML），便于CI平台解析与展示
• 轻量级设计：基于Alpine或Slim基础镜像构建，减少镜像体积，加速CI流程

使用场景

• 代码提交触发测试：在Git仓库提交代码后，由CI平台自动拉取该镜像执行测试，验证代码质量
• 构建前置验证：在软件构建流程前执行单元测试、集成测试，提前发现问题
• 多版本兼容性测试：通过不同标签的镜像版本（如指定Python 3.8/3.9）验证软件在多环境下的兼容性
• 测试环境复用：在开发、测试、CI流程中使用相同镜像，确保环境一致性

使用方法

基本使用（Docker Run）

bash
docker run -d \
  --name ci-test \
  -v $(pwd)/test-code:/app \  # 挂载测试代码目录
  -e TEST_COMMAND="pytest tests/" \  # 自定义测试命令
  -e REPORT_PATH="/app/reports" \  # 测试报告输出路径
  -e LOG_LEVEL="info" \  # 日志级别（debug/info/warn/error）
  ci-test-image:latest

Docker Compose配置示例

yaml
version: '3'
services:
  test:
    image: ci-test-image:latest
    volumes:
      - ./test-code:/app
      - ./reports:/app/reports  # 持久化测试报告
    environment:
      - TEST_COMMAND="npm run test"
      - REPORT_PATH="/app/reports"
      - LOG_LEVEL="debug"
    depends_on:
      - db  # 若测试依赖数据库，可配置关联服务
  db:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=testpass
      - MYSQL_DATABASE=testdb

环境变量说明

测试报告获取

测试报告默认生成在REPORT_PATH指定目录，可通过挂载宿主机目录持久化获取：

bash
# 宿主机查看测试报告
ls $(pwd)/reports  # 对应容器内 REPORT_PATH 路径

注意事项

• 挂载测试代码目录时，确保宿主机目录权限正确（建议使用chmod 755赋予读取权限）
• 复杂测试场景（如依赖数据库、消息队列）建议通过docker-compose配置关联服务
• 如需自定义测试工具版本，可基于该镜像构建新镜像（通过Dockerfile安装特定版本工具）
• 测试命令应确保非交互执行（避免需要人工输入的场景）