DrupalCI Docker镜像文档

镜像概述

DrupalCI Docker镜像是针对Drupal项目开发的持续集成解决方案，旨在通过自动化测试、构建和部署流程，简化Drupal开发工作流，提升团队协作效率，并确保代码符合质量标准。该镜像集成了Drupal开发所需的核心工具和依赖，支持多版本Drupal环境，适用于从模块开发到核心贡献的各类Drupal项目。

核心功能和特性

• 多版本兼容：支持Drupal 7/8/9/10等主流版本，适配不同项目的技术栈需求
• 全面测试支持：集成PHPUnit、Behat等测试框架，覆盖单元测试、功能测试、集成测试等场景
• 环境隔离：基于Docker容器化技术，确保测试环境一致性，避免本地环境差异导致的异常
• 灵活集成能力：可与GitHub Actions、GitLab CI、Jenkins等主流CI/CD平台无缝对接
• 自定义配置：通过drupalci.yml配置文件定制测试流程、依赖管理和报告输出
• 轻量级设计：优化镜像体积，减少资源占用，支持快速启动和执行测试任务

使用场景

• Drupal模块开发：自动化验证模块功能完整性、兼容性及代码规范
• 主题开发：测试主题在不同Drupal版本、浏览器环境下的渲染效果和性能
• 核心贡献：为Drupal核心提交补丁时，自动验证补丁对核心功能的影响
• 团队协作：在多人开发流程中，通过自动化测试快速反馈代码问题，减少人工review成本
• 版本升级：验证现有项目代码从低版本Drupal升级到高版本时的兼容性

使用方法和配置说明

快速启动

通过以下命令快速运行基础测试（以Drupal 10模块测试为例）：

bash
docker run --rm -v $(pwd):/app drupalci/drupalci:latest \
  --drupal-version 10 \
  --test-type phpunit \
  --database mysql \
  --php-version 8.2

核心配置参数

环境变量

命令行参数

支持通过命令行参数覆盖环境变量配置：

• --drupal-version: 指定Drupal版本（优先级高于环境变量）
• --test-type: 指定测试类型（phpunit/behat/custom）
• --database: 指定数据库类型
• --php-version: 指定PHP版本
• --config: 自定义配置文件路径（如/app/drupalci.yml）
• --verbose: 启用详细日志输出

Docker Compose配置示例

对于需要数据库依赖的复杂测试，可使用docker-compose.yml管理多服务环境：

yaml
version: '3.8'
services:
  drupalci:
    image: drupalci/drupalci:latest
    volumes:
      - ./my_drupal_module:/app
      - ./reports:/app/reports
    environment:
      - DRUPAL_VERSION=10
      - TEST_TYPE=behat
      - PHP_VERSION=8.2
      - DATABASE=mysql
    depends_on:
      - mysql
    command: --config /app/drupalci.yml

  mysql:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=drupalci_test
      - MYSQL_USER=drupalci
      - MYSQL_PASSWORD=drupalci
    ports:
      - "3306:3306"

启动命令：

bash
docker-compose up

自定义测试配置（drupalci.yml）

通过项目根目录的drupalci.yml文件定制测试流程，示例配置：

yaml
build:
  assessment:
    validate_codebase:
      phplint: ~
      phpcs:
        sniffer: 'Drupal'
        standard: 'Drupal'
        ignore: 'vendor/*'
    testing:
      run_tests.standard:
        types: 'PHPUnit-Unit,PHPUnit-Kernel,PHPUnit-Functional'
        testgroups: '--all'
      run_tests.js:
        types: 'PHPUnit-JS'
  cache:
    directories:
      - vendor
      - core/composer.lock

CI/CD平台集成示例（GitHub Actions）

在GitHub项目中添加自动测试工作流（.github/workflows/drupalci.yml）：

yaml
name: DrupalCI Test
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Run DrupalCI tests
        uses: docker://drupalci/drupalci:latest
        with:
          args: --drupal-version 10 --test-type phpunit --database mysql --config /github/workspace/drupalci.yml
        env:
          MODULE_PATH: /github/workspace
          REPORT_PATH: /github/workspace/reports
      
      - name: Upload test reports
        uses: actions/upload-artifact@v3
        with:
          name: test-reports
          path: reports/

注意事项

• 确保本地Docker环境版本≥20.10，避免兼容性问题
• 首次运行时会拉取依赖和基础镜像，可能需要较长时间
• 大型项目建议增加容器内存限制（如--memory=4g）以避免测试过程中OOM
• 详细配置和高级用法可参考***文档