wengerk/drupal-for-contrib

Drupal贡献模块/主题容器化Docker镜像

镜像概述

本镜像专为Drupal的贡献模块/主题设计，旨在简化模块/主题的测试流程。与其他集成Docker到完整Drupal项目的镜像不同，本镜像专注于为贡献模块/主题提供容器化环境，帮助开发者避免手动搭建完整Drupal环境的繁琐步骤，支持手动或自动化测试。

快速参考

维护与支持

• 维护者：https://github.com/wengerk/docker-drupal-for-contrib%EF%BC%88%E9%9D%9EDocker%E7%A4%BE%E5%8C%BA%E3%80%81Drupal%E7%A4%BE%E5%8C%BA%E6%88%96Drupal%E5%AE%89%E5%85%A8%E5%9B%A2%E9%98%9F%EF%BC%89
• 获取帮助：Docker社区论坛、Docker社区Slack或Stack Overflow
• 赞助商：本项目由瑞士网络 agency https://github.com/antistatique 赞助。访问[***]

快速参考（续）

• 问题提交：https://github.com/wengerk/docker-drupal-for-contrib/issues
• 基础镜像：https://github.com/docker-library/drupal
• Travis CI构建：[***]

支持的标签及对应的Dockerfile链接

为何需要另一个Drupal镜像

Docker Hub上已有许多Drupal镜像，它们的共同目标是将Docker集成到完整的Drupal项目中。

本镜像则截然不同：我们不解决Docker与Drupal的集成问题，而是提供为贡献模块/主题设置Docker的解决方案。

许多开发者在创建出色模块时，需要手动搭建完整的Drupal 8/9环境并将自定义模块/主题 symlink 到其中，测试过程繁琐。本Docker镜像通过提供容器化的Drupal 8/9/10/11环境，高度简化这一流程，用于模块/主题贡献项目的手动或自动化测试。

使用方法

在Drupal贡献模块/主题中使用

1. 创建Dockerfile

在仓库根目录创建Dockerfile：

dockerfile
ARG BASE_IMAGE_TAG=10.4
FROM wengerk/drupal-for-contrib:${BASE_IMAGE_TAG}

2. 创建docker-compose.yml

在仓库根目录创建docker-compose.yml：

yaml
services:
  drupal:
    build: .
    depends_on:
      - db
    ports:
      - 8888:80
    volumes:
      # 将模块挂载到正确的贡献模块目录
      - .:/var/www/html/modules/contrib/my_module
    restart: always

  db:
    image: mariadb:10.6
    environment:
      MYSQL_USER: drupal
      MYSQL_PASSWORD: drupal
      MYSQL_DATABASE: drupal
      MYSQL_ROOT_PASSWORD: root
    restart: always

注意：更新挂载的volume名称以匹配你的自定义模块名称。

3. 运行Docker

shell
$ docker-compose build --pull --build-arg BASE_IMAGE_TAG=10.4 drupal
$ docker-compose up -d drupal
# 等待Docker就绪，尤其是MariaDB需要几秒启动时间
$ docker-compose exec -u www-data drupal drush site-install standard --db-url="mysql://drupal:drupal@db/drupal" --site-name=Example -y

4. 运行PHPUnit测试

shell
docker-compose exec -u www-data drupal phpunit --no-coverage --group=my_module --configuration=/var/www/html/phpunit.xml

Travis集成示例

1. 创建.travis.yml

在仓库根目录创建.travis.yml：

yaml
language: php

services:
  - docker

env:
  global:
    # 要在Docker中挂载和测试的模块名称
    - MODULE_NAME="my_module"

jobs:
  include:
    - name: D8.9
      env: BASE_IMAGE_TAG="8.9"
    - name: D9.0
      env: BASE_IMAGE_TAG="9.0"
    - name: D10.0
      env: BASE_IMAGE_TAG="10.0"
    - name: D11.0
      env: BASE_IMAGE_TAG="11.0"

before_install:
  - docker-compose build --pull --build-arg BASE_IMAGE_TAG=${BASE_IMAGE_TAG} drupal
  - docker-compose up -d drupal
  # 等待Docker就绪，尤其是MariaDB需要几秒启动
  - docker-compose exec drupal wait-for-it drupal:80 -t 60
  - docker-compose exec drupal wait-for-it db:3306 -t 60

before_script:
  - docker-compose exec -u www-data drupal drush site-install standard --db-url="mysql://drupal:drupal@db/drupal" --site-name=Example -y

script:
  - docker-compose exec -u www-data drupal phpunit --no-coverage --group=${MODULE_NAME} --configuration=/opt/drupal/web/phpunit.xml

GitHub Actions集成示例

yaml
name: Continuous integration
on: [push]

jobs:
  tests:
    name: Tests
    runs-on: ubuntu-latest

    strategy:
      matrix:
        drupal_version: ['8.9', '9.0', '9.1', '10.0', '10.1', '10.2', '11.0']
        module: ['my_module']
        experimental: [ false ]
        include:
          - drupal_version: '10.3'
            module: 'my_module'
            experimental: true
          - drupal_version: '11.1'
            module: 'my_module'
            experimental: true

    steps:
      - uses: actions/checkout@v3
      - run: docker-compose -f docker-compose.yml pull --include-deps drupal
      - name: 构建docker-compose堆栈
        run: docker-compose -f docker-compose.yml build --pull --build-arg BASE_IMAGE_TAG=${{ matrix.drupal_version }} drupal
        continue-on-error: ${{ matrix.experimental }}
      - name: 运行单元测试
        run: docker-compose -f docker-compose.yml run -u www-data drupal phpunit --no-coverage --group=${{ matrix.module }} --configuration=/var/www/html/phpunit.xml
        continue-on-error: ${{ matrix.experimental }}