DrupalCI Docker 镜像文档

镜像概述

DrupalCI 镜像提供了 Drupal 项目的标准化持续集成环境，集成了 Drupal 测试框架及必要依赖工具，旨在简化模块、主题和核心代码的自动化测试流程。该镜像支持本地开发测试与 CI/CD 流程无缝对接，帮助开发者高效验证代码质量、功能正确性及跨版本兼容性。

核心功能与特性

• 全面测试支持：覆盖单元测试、集成测试、功能测试等 Drupal 项目常用测试类型，兼容 PHPUnit、Behat 等测试框架。
• 项目类型兼容：支持 Drupal 模块、主题、核心代码等各类项目的测试需求，适配不同贡献场景。
• 环境标准化：内置 Composer、Drush 等开发工具，统一测试环境配置，确保本地与 CI 环境结果一致性。
• 灵活版本控制：支持指定 Drupal 核心版本（如 9.x、10.x）、PHP 版本（7.4+、8.1+）及数据库类型（MySQL、PostgreSQL）。
• CI/CD 集成：可与 GitHub Actions、GitLab CI、Jenkins 等主流 CI/CD 工具无缝集成，自动化触发测试流程。

使用场景

• 本地开发测试：开发者在提交代码前，通过容器快速运行测试，提前发现语法错误、逻辑问题及兼容性问题。
• 团队协作 CI：集成至团队代码仓库，在提交或合并请求时自动触发测试，阻断不合格代码进入主分支。
• Drupal 社区贡献：为贡献 Drupal 核心或社区项目提供标准化测试环境，确保提交代码符合社区质量规范。

使用方法与配置说明

基础运行命令

通过以下命令启动容器，对本地 Drupal 项目执行测试：

bash
docker run -it --rm \
  -v /本地项目路径:/app \  # 挂载本地 Drupal 项目目录
  drupalci/drupalci:latest \
  run-tests  # 默认测试命令，可指定具体测试脚本

核心配置参数

1. 卷挂载

2. 环境变量

通过 -e 参数自定义测试环境，常用变量如下：

典型使用示例

示例 1：本地模块单元测试

对本地 my_module 模块执行 PHPUnit 单元测试，指定 Drupal 10.1.x 和 PHP 8.1：

bash
docker run -it --rm \
  -v $(pwd)/my_module:/app \
  -e DRUPAL_VERSION=10.1.x \
  -e TEST_TYPE=unit \
  -e PHP_VERSION=8.1 \
  drupalci/drupalci:latest \
  phpunit --configuration /app/tests/phpunit.xml

示例 2：集成 GitHub Actions

在 GitHub 仓库中配置 .github/workflows/drupalci.yml，实现提交时自动测试：

yaml
name: DrupalCI 自动化测试
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4

      - name: 运行 DrupalCI 测试
        uses: docker://drupalci/drupalci:latest
        with:
          args: run-tests
        env:
          DRUPAL_VERSION: 10.1.x
          TEST_TYPE: integration
          PHP_VERSION: 8.1
        volumes:
          - ${{ github.workspace }}:/app
          - drupalci_cache:/root/.composer/cache

volumes:
  drupalci_cache:  # 持久化 Composer 缓存，加速测试

注意事项

• 权限配置：本地项目目录需确保容器内用户（通常为 www-data 或 root）有读取权限，避免因权限不足导致测试失败。
• 资源需求：功能测试等复杂场景建议分配至少 2GB 内存，避免容器因资源不足崩溃。
• 测试报告：通过挂载 /app/tests/results 目录，可将测试报告（如 JUnit 格式）导出至本地，便于集成至测试报告工具（如 Jenkins、GitLab Pages）。