szeidler/drupal_tests

Drupal测试容器

这是一个Docker容器及模板，用于测试单个Drupal模块，支持单元测试、Kernel测试、Behat测试、代码标准检查和代码覆盖率报告。若需测试整个Drupal站点而非单个模块，请参考https://github.com/juampynr/d8cidemo%E3%80%82

功能特性

• 基于官方Drupal镜像扩展，支持Composer、Robo和代码覆盖率报告。
• 提供CircleCI作业模板，便于集成持续集成流程。
• 核心逻辑通过Shell脚本和Robo命令实现，易于适配其他CI工具。

CircleCI快速开始

1. 进入你的Drupal模块目录（确保已初始化Git仓库）。
2. 执行初始化命令：bash -c "$(curl -fsSL https://github.com/deviantintegral/drupal_tests/raw/master/setup.sh)"。
3. 检查并提交生成的新文件到Git仓库。
4. 将仓库连接到CircleCI平台。
5. 若使用私有Composer仓库，在CircleCI中添加COMPOSER_AUTH环境变量（配置方式参考https://getcomposer.org/doc/03-cli.md#composer-auth%EF%BC%89%E3%80%82
6. 推送代码分支，触发CircleCI作业（此时作业会运行但暂不执行实际测试）。
7. 如需覆盖钩子脚本（如code-sniffer.sh），复制脚本到模块的.circleci目录，并修改CircleCI配置中的run步骤：

   yaml
   - run:
       working_directory: /var/www/html
       command: |
         cp ./modules/$CIRCLE_PROJECT_REPONAME/.circleci/code-sniffer.sh /var/www/html
         ./code-sniffer.sh $CIRCLE_PROJECT_REPONAME
   

测试快速开始

若已执行setup.sh，以下步骤已自动完成：

1. 将templates/module下的所有文件和目录复制到模块根目录。
2. 编辑phpunit.core.xml.dist，设置代码覆盖率报告的白名单路径（替换my_module为你的模块名称）。
3. 在tests/src/Behat目录中，将my_module和MyModule替换为你的模块名称。
4. 在模块目录中安装开发依赖：

   sh
   composer require --dev --no-update \
       behat/mink-selenium2-driver \
       drupal/coder \
       drupal/drupal-extension \
       bex/behat-screenshot \
       phpmd/phpmd \
       phpmetrics/phpmetrics
   

5. 开始编写测试用例！单元、Kernel、Functional测试遵循Drupal贡献模块的目录结构；Behat测试需放在tests/src/Behat目录下。

Behat测试

Behat测试在drupal.org上不运行，但存储结构需规范。本地运行Behat场景时，需从Drupal根目录使用绝对路径指向配置文件：

sh
vendor/bin/behat -v -c $(pwd)/modules/my_module/tests/src/Behat/behat.yml

Behat测试调试

Behat配置集成了Selenium、Chrome和VNC服务器。在CircleCI中，可通过SSH访问容器并转发端口：

sh
# 替换为CircleCI提供的SSH命令，并添加端口转发
<CircleCI SSH命令> -L8080:localhost:80 -L5900:localhost:5900

• 站点访问：通过http://localhost:8080访问容器内的Drupal站点，使用drush user-login获取管理员登录链接。
• VNC调试：连接localhost:5900（密码secret），可观察Chrome浏览器执行测试的过程。

覆盖PHPUnit配置

phpunit.core.xml.dist文件会被复制到Drupal核心目录，请根据模块需求修改该文件的配置项。

应用补丁

如需对Drupal核心或依赖库应用补丁，编辑patches.json文件（格式遵循https://github.com/cweagans/composer-patches%E8%A7%84%E8%8C%83%EF%BC%89%E3%80%82

更新模块中的模板

运行setup.sh可更新到最新版本的模板，需注意保留自定义修改：

sh
git checkout -b update-circleci
bash -c "$(curl -fsSL https://github.com/deviantintegral/drupal_tests/raw/master/setup.sh)"
git add -p # 选择性添加需要的更改
git checkout -p # 撤销不需要的更改
git commit -m "更新CircleCI模板至最新版本"

测试新Drupal版本

容器基于Drupal稳定分支构建（如8.3.x）。如需测试新版本：

1. 修改Dockerfile中的基础镜像（例如FROM drupal:8.4-apache）。
2. 本地构建镜像：docker build -t drupal-8.4-test .。
3. 在模块的.circleci/config.yml中替换镜像为drupal-8.4-test。
4. 本地测试作业：circleci build --job run-unit-kernel-tests。
5. 提交PR到本仓库，更新模板。
6. 在Docker Hub中配置新标签的自动构建。
7. 合并PR后，更新模块的config.yml指向新镜像标签。