thereference/docker-drupal-tools

Docker Drupal Tools 镜像文档

镜像概述与主要用途

Docker Drupal Tools 镜像专为CI/CD流程设计，集成多种开发测试工具，为Drupal项目提供一站式的自动化测试、代码质量检查和项目管理支持，简化开发流程并提升代码质量。

核心功能与特性

该镜像包含以下核心工具：

• Behat（含Mink）：PHP自动化测试框架，用于验证业务期望的行为驱动开发工具
• Drush：Drupal命令行工具，支持站点管理、模块操作等Drupal核心功能
• GastonJS：基于PhantomJS的API服务器，提供网页自动化能力
• Drupal Coder：Drupal代码审查库，确保代码符合Drupal编码标准
• PhantomJS：Behat Mink框架的无界面浏览器驱动，支持headless测试
• vfsStream：虚拟文件系统流包装器，用于单元测试中模拟文件系统，兼容PHPUnit等测试框架
• PHPUnit：PHP单元测试框架，遵循xUnit架构，支持代码单元测试
• PHPLint：多进程PHP代码检查工具，加速代码linting过程
• PHP_CodeSniffer：代码规范检查工具，支持PHP、JavaScript和CSS文件的代码标准验证
• coverageChecker：代码覆盖率差异检查工具，针对代码变更（如拉取请求）执行部分检查
• PHPMD：PHP代码缺陷检测工具，分析代码中的潜在问题

使用场景与适用范围

适用于Drupal项目全生命周期的开发与部署流程：

• 持续集成/持续部署(CI/CD)流程中的自动化测试
• 代码提交前的本地代码质量检查
• 项目构建与部署前的规范性验证
• Drupal模块/主题开发过程中的单元测试与功能测试
• 团队协作中的代码审查辅助工具

使用方法与配置说明

基本使用方式

通过Docker命令运行镜像，挂载项目目录以访问代码：

bash
docker run -v /本地/drupal项目路径:/app drupal-tools [命令]

常用工具使用示例

1. Drush命令执行

bash
# 查看Drupal状态
docker run -v /path/to/drupal:/app drupal-tools drush status

# 清除缓存
docker run -v /path/to/drupal:/app drupal-tools drush cr

2. Behat测试

bash
# 运行Behat测试套件
docker run -v /path/to/drupal:/app drupal-tools behat

# 指定测试配置文件
docker run -v /path/to/drupal:/app drupal-tools behat -c behat.yml

3. 代码规范检查

bash
# 使用Drupal标准检查自定义模块
docker run -v /path/to/drupal:/app drupal-tools phpcs --standard=Drupal /app/modules/custom

# 自动修复部分代码规范问题
docker run -v /path/to/drupal:/app drupal-tools phpcbf --standard=Drupal /app/modules/custom

4. 单元测试

bash
# 运行PHPUnit测试
docker run -v /path/to/drupal:/app drupal-tools phpunit /app/tests/Unit

5. 代码质量分析

bash
# 使用PHPMD分析代码问题
docker run -v /path/to/drupal:/app drupal-tools phpmd /app/modules/custom text cleancode,codesize,controversial,design,naming,unusedcode

CI/CD集成示例（GitLab CI）

在.gitlab-ci.yml中集成：

yaml
stages:
  - test

code_quality:
  stage: test
  image: drupal-tools
  script:
    - drush status
    - phpcs --standard=Drupal modules/custom
    - phpmd modules/custom text cleancode,codesize
    - phpunit tests/Unit
    - behat

环境配置

可通过环境变量调整工具行为：

• PHPCS_STANDARD：设置默认PHP_CodeSniffer标准（默认：Drupal）
• BEHAT_CONFIG：指定Behat配置文件路径（默认：behat.yml）
• PHPUNIT_CONFIG：指定PHPUnit配置文件路径（默认：phpunit.xml）