andrewberry/drupal_tests

Drupal测试容器

这是一个基于官方Drupal镜像的Docker容器及模板，用于测试单个Drupal模块，支持以下功能：

• 单元测试与Kernel测试
• Behat测试
• 代码标准检查
• 代码覆盖率分析

若需测试整个Drupal站点而非单个模块，请参考https://github.com/juampynr/d8cidemo%E9%A1%B9%E7%9B%AE%E3%80%82

功能特性

• Dockerfile扩展自https://hub.docker.com/_/drupal/%EF%BC%8C%E6%94%AF%E6%8C%81Composer%E3%80%81Robo%E5%8F%8A%E4%BB%A3%E7%A0%81%E8%A6%86%E7%9B%96%E7%8E%87%E6%8A%A5%E5%91%8A%E7%94%9F%E6%88%90%E3%80%82
• 提供CircleCI作业模板。
• 核心逻辑通过shell脚本和Robo命令实现，便于在其他CI工具中运行。

可参考https://github.com/deviantintegral/drupal_tests_node_example%E4%BA%86%E8%A7%A3%E6%A8%A1%E6%9D%BF%E7%9A%84%E5%AE%9E%E9%99%85%E9%85%8D%E7%BD%AE%EF%BC%8C%E4%BB%A5%E5%8F%8ACircleCI%E4%B8%AD%E5%90%84%E4%BD%9C%E4%B8%9A%E7%9A%84%E6%8A%A5%E5%91%8A%E6%95%88%E6%9E%9C%EF%BC%9Bhttps://github.com/nodespark/elasticsearch_connector%E6%A8%A1%E5%9D%97%E4%B9%9F%E6%98%AF%E4%BD%BF%E7%94%A8%E8%AF%A5%E6%A8%A1%E6%9D%BF%E7%9A%84%E5%85%B8%E5%9E%8B%E6%A1%88%E4%BE%8B%E3%80%82

CircleCI快速开始

1. 进入Drupal模块所在目录（确保已初始化为Git仓库）。
2. 执行脚本：bash -c "$(curl -fsSL https://github.com/deviantintegral/drupal_tests/raw/master/setup.sh)"。
3. 检查并提交新增文件。
4. 将仓库连接到CircleCI。
5. 若使用私有仓库，需在CircleCI中添加COMPOSER_AUTH环境变量（参考https://getcomposer.org/doc/03-cli.md#composer-auth%EF%BC%89%E3%80%82
6. 推送分支，此时所有作业将运行（暂未执行实际测试）。
7. 如需覆盖钩子，将对应脚本复制到.circleci目录，并在运行步骤中复制到项目根目录。例如覆盖hooks/code-sniffer.sh：

   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测试、功能测试遵循Drupal贡献模块的目录结构，若Drupal测试机器人可运行你的测试，该容器也可支持。测试通过run-tests.sh执行，需确保每个测试类有正确的@group注解，基础类无需注解，且测试位于正确命名空间。目前暂不支持FunctionalJavascript测试（建议用Behat替代）。

Behat测试

Behat测试不在drupal.org上运行，需将测试放在tests/src/Behat目录下，结构如下：

• tests/src/Behat
  • behat.yml
  • features/
    • my_module_settings.feature
    • bootstrap/
      • MyModuleFeatureContext.php

本地运行Behat场景时，需从Drupal根目录使用绝对路径指向配置：

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

Behat测试调试

Behat配置使用Selenium、Chrome及VNC服务器。若CI提供容器SSH访问，可转发端口进行调试：

1. 在CircleCI中以SSH模式重建Behat作业。
2. 转发端口（如本地8080到Apache，5900到VNC）：ssh命令 -L8080:localhost:80 -L5900:localhost:5900。
3. 访问http://localhost:8080查看站点，通过drush user-login登录：

   sh
   cd /var/www/html
   vendor/bin/drush -l localhost:8080 user-login
   

4. VNC连接localhost:5900，密码为secret，可观察Chrome执行测试过程。

覆盖PHPUnit配置

phpunit.core.xml.dist会复制到Drupal的core目录，可根据模块需求编辑该文件。

应用补丁

如需对Drupal或依赖项应用补丁，编辑patches.json（格式参考https://github.com/cweagans/composer-patches%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 status # 检查新增文件
git commit

测试新Drupal版本

容器基于Drupal稳定分支（如8.3.x）构建，确保使用最新安全补丁。若需测试新Drupal版本：

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到该仓库，并在Docker Hub配置自动构建新标签，更新模块的config.yml指向新标签。