DrupalCI Docker 镜像文档

1. 镜像概述和主要用途

DrupalCI Docker镜像是专为Drupal项目设计的持续集成（CI）工具容器化解决方案，基于drupal.org/project/drupalci项目构建。该镜像封装了Drupal项目自动化测试所需的完整环境，支持多种测试类型（单元测试、功能测试、集成测试等），并兼容不同版本的PHP和Drupal核心，旨在简化Drupal模块、主题及核心代码的测试流程，提升开发效率和代码质量。

2. 核心功能和特性

• 多版本兼容性：支持PHP 7.4+及Drupal 8/9/10核心版本，可按需配置测试环境版本。
• 全面测试支持：集成PHPUnit（单元测试/集成测试）、Behat（功能测试）、Nightwatch.js（前端测试）等主流测试框架。
• 自动化测试流程：内置测试脚本，支持一键执行测试套件，自动生成测试报告（JUnit格式）。
• CI/CD工具集成：无缝对接GitHub Actions、GitLab CI、Jenkins等主流CI/CD平台，支持自定义测试触发条件。
• 可定制环境：通过环境变量和配置文件调整测试参数（如数据库类型、扩展模块、测试超时时间等）。

3. 使用场景和适用范围

• Drupal模块/主题开发者：自动化验证代码提交的功能正确性和兼容性。
• Drupal核心贡献者：快速验证补丁对核心功能的影响，确保符合编码标准。
• 企业级Drupal项目：在团队协作中集成CI流程，确保代码合并前通过自动化测试。
• 第三方扩展维护者：批量测试扩展在不同Drupal版本和PHP环境下的兼容性。

4. 使用方法和配置说明

4.1 获取镜像

从Docker Hub拉取***镜像（默认标签为latest，建议指定具体版本以确保稳定性）：

bash
docker pull drupalci/drupalci:latest
# 或指定版本（如支持Drupal 10的稳定版）
docker pull drupalci/drupalci:10.x

4.2 基本使用（docker run）

通过docker run命令直接运行测试，需挂载本地Drupal项目目录至容器内，并通过环境变量指定测试参数。

基本语法：

bash
docker run --rm \
  -v /本地项目路径:/app \  # 挂载项目代码到容器内/app目录
  -e 环境变量=值 \          # 配置测试环境（如PHP版本、测试类型等）
  drupalci/drupalci \       # 镜像名称
  /app/vendor/bin/phpunit   # 执行测试命令（或使用内置测试脚本）

4.3 使用docker-compose配置

对于复杂测试场景（如依赖数据库、Redis等服务），可通过docker-compose.yml定义完整环境。

示例配置：

yaml
version: '3.8'
services:
  drupalci:
    image: drupalci/drupalci:10.x
    volumes:
      - ./my_drupal_module:/app  # 挂载本地模块代码
    environment:
      - PHP_VERSION=8.2          # 指定PHP版本（支持7.4-8.3）
      - DRUPAL_VERSION=10.1      # 指定Drupal核心版本
      - TEST_TYPE=functional     # 测试类型：unit/functional/integration
      - DB_TYPE=mysql            # 数据库类型：mysql/pgsql/sqlite
      - DB_HOST=db               # 数据库服务地址（对应下方db服务）
      - DB_USER=root
      - DB_PASSWORD=secret
      - DB_NAME=drupal_test
    depends_on:
      - db  # 依赖mysql服务启动后再执行测试

  db:  # 测试依赖的MySQL服务
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=drupal_test
    ports:
      - "3306:3306"

启动服务并执行测试：

bash
docker-compose up --build  # 构建并启动服务，自动执行测试

4.4 环境变量说明

4.5 自定义测试脚本

若需执行自定义测试流程（如前置命令、多步骤测试），可在项目根目录创建drupalci-test.sh脚本，并挂载至容器执行：

bash
# 本地脚本示例（drupalci-test.sh）
#!/bin/bash
# 安装依赖
composer install --working-dir=/app
# 执行单元测试
/app/vendor/bin/phpunit --configuration /app/phpunit.xml
# 执行功能测试
/app/vendor/bin/behat --config /app/behat.yml

通过容器运行自定义脚本：

bash
docker run --rm \
  -v $(pwd):/app \
  -e PHP_VERSION=8.2 \
  drupalci/drupalci \
  bash /app/drupalci-test.sh

5. Docker部署方案示例

5.1 示例1：测试Drupal模块单元测试

场景：验证本地模块在PHP 8.2和Drupal 10.1环境下的单元测试。

命令：

bash
docker run --rm \
  -v $(pwd)/my_module:/app \
  -e PHP_VERSION=8.2 \
  -e DRUPAL_VERSION=10.1 \
  -e TEST_TYPE=unit \
  drupalci/drupalci \
  /app/vendor/bin/phpunit --testsuite Unit

5.2 示例2：通过docker-compose运行功能测试（依赖MySQL）

场景：测试模块在Drupal 10 + MySQL 8.0环境下的功能测试。

docker-compose.yml配置：

yaml
version: '3.8'
services:
  drupalci:
    image: drupalci/drupalci:10.x
    volumes:
      - ./my_module:/app
    environment:
      - PHP_VERSION=8.2
      - DRUPAL_VERSION=10.1
      - TEST_TYPE=functional
      - DB_TYPE=mysql
      - DB_HOST=db
      - DB_USER=root
      - DB_PASSWORD=secret
      - DB_NAME=drupal_test
    depends_on:
      - db
  db:
    image: mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=secret
      - MYSQL_DATABASE=drupal_test
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 5

启动测试：

bash
# 构建并启动服务，自动执行功能测试
docker-compose up

6. 注意事项

• 镜像版本：生产环境建议使用特定版本标签（如10.x），避免latest标签自动更新导致兼容性问题。
• 资源配置：功能测试和集成测试需较高内存（建议容器分配至少2GB内存），可通过--memory=2g参数限制。
• 测试报告：默认报告输出至TEST_REPORT_PATH（如/app/reports），需通过卷挂载本地目录获取报告文件。
• 网络隔离：若测试需访问外部服务（如API），需配置容器网络模式（如--network=host）或添加DNS解析。
• 权限问题：挂载目录时可能因权限冲突导致测试失败，可通过-u $(id -u):$(id -g)参数指定容器用户ID。