Перейти к содержимому
M
Все статьи
Разработка 8 мин чтения

Локальная среда Moodle в Docker: поднять за вечер и не мешать продакшену

Пошаговое руководство по moodle-docker: как поднять локальный Moodle для разработки плагинов, запускать PHPUnit и Behat и не трогать рабочий сайт.

Пошаговое руководство по moodle-docker: как поднять локальный Moodle для разработки плагинов, запускать PHPUnit и Behat и не трогать рабочий сайт.

Править рабочий сайт Moodle «на живую» — верный способ получить белый экран в разгар занятий. Если плагин или обновление нужно проверить, их проверяют на отдельной копии, и самый быстрый способ получить такую копию на ноутбуке — Docker. Для Moodle есть готовый набор контейнеров moodle-docker, который поддерживает сама команда разработки и который используется для тестов самого Moodle. Покажу, как поднять его с нуля и как работать с ним ежедневно.

Что получится в итоге

Набор поднимает несколько контейнеров: веб-сервер с PHP, базу данных на выбор, браузер и Selenium для Behat-тестов, почтовую заглушку, в которую попадают все письма. Код Moodle лежит в обычной папке на вашем компьютере и монтируется внутрь контейнера, поэтому его можно править в привычном редакторе, а изменения видны сразу. Данные пользователей и базы живут в контейнерах и не затрагивают рабочую систему.

Что понадобится

  • Docker и Docker Compose (на Mac и Windows — Docker Desktop).
  • Git.
  • Папка с исходниками Moodle, клонированными из репозитория (github.com/moodle/moodle), на нужной ветке.
  • Свободные несколько гигабайт на диске и достаточный объём памяти, выделенный Docker.

Пошагово: запуск за вечер

Шаг 1. Получить код Moodle и сам набор контейнеров.

git clone -b MOODLE_405_STABLE https://github.com/moodle/moodle.git moodle
git clone https://github.com/moodlehq/moodle-docker.git moodle-docker

Шаг 2. Задать переменные окружения. Путь к коду и тип базы данных обязательны.

export MOODLE_DOCKER_WWWROOT=$HOME/dev/moodle
export MOODLE_DOCKER_DB=pgsql

Шаг 3. Скопировать шаблон конфигурации в корень Moodle.

cd moodle-docker
cp config.docker-template.php $MOODLE_DOCKER_WWWROOT/config.php

Шаг 4. Поднять контейнеры и дождаться базы.

bin/moodle-docker-compose up -d
bin/moodle-docker-wait-for-db

Шаг 5. Установить Moodle внутри контейнера.

bin/moodle-docker-compose exec webserver php admin/cli/install_database.php \
  --agree-license --fullname="Dev" --shortname="dev" \
  --summary="Тестовый сайт" --adminpass="выберите-пароль" \
  --adminemail="admin@example.com"

После этого сайт открывается в браузере по адресу http://localhost:8000 (порт по умолчанию 8000, его можно изменить переменной окружения). Письма можно смотреть в веб-интерфейсе почтовой заглушки, адрес которого указан в README набора. Обратите внимание, что версия ветки в команде клонирования — пример: выбирайте ту ветку, под которую пишете плагин.

Основные переменные окружения

ПеременнаяЧто задаёт
MOODLE_DOCKER_WWWROOTпуть к исходникам Moodle на вашем компьютере
MOODLE_DOCKER_DBбаза данных: например, pgsql, mysql, mariadb
MOODLE_DOCKER_PHP_VERSIONверсия PHP в контейнере; полезно, чтобы проверить плагин на нужной версии
MOODLE_DOCKER_BROWSERбраузер для Behat-тестов
MOODLE_DOCKER_WEB_PORTпорт, на котором открывается сайт

Полный и актуальный перечень приведён в README репозитория: он меняется вместе с набором, поэтому сверяйтесь с ним, а не с этой таблицей.

Ежедневная работа

# зайти в консоль веб-контейнера
bin/moodle-docker-compose exec webserver bash

# очистить кэши
bin/moodle-docker-compose exec webserver php admin/cli/purge_caches.php

# остановить и запустить обратно
bin/moodle-docker-compose stop
bin/moodle-docker-compose start

# удалить контейнеры и данные
bin/moodle-docker-compose down

Плагин кладётся в соответствующую папку внутри папки Moodle (например, local/myplugin), после чего в админке запускается обновление или выполняется php admin/cli/upgrade.php в контейнере. Для хранения плагина лучше завести отдельный репозиторий и подключать его в нужное место папки Moodle ссылкой или клонированием; в этом случае история плагина не смешивается с историей ядра.

Тесты в контейнерах

Ради этого набор и создан. Для PHPUnit в config.php набора уже предусмотрены настройки тестовой базы; остаётся только инициализация:

bin/moodle-docker-compose exec webserver php admin/tool/phpunit/cli/init.php
bin/moodle-docker-compose exec webserver vendor/bin/phpunit local/myplugin/tests/manager_test.php

Для Behat набор настраивается через переменные окружения и поднимает отдельный браузер; порядок действий описан в README (подробнее о сценариях). Подробнее о том, что и как проверять юнит-тестами — в статье про PHPUnit для плагина.

Чем локальная среда не заменяет рабочий сервер

ОтличиеК чему приводитЧто делать
Другая версия PHP и расширенияна рабочем сервере падает то, что работало в контейнеревыставить в контейнере ту же версию PHP, что и на сервере
Другая база и настройкизапросы ведут себя иначеиспользовать тот же тип базы
Нет реальных данныхтесты не видят тяжёлых случаевзагрузить обезличенную копию, не используя персональные данные студентов
Нет cron и очередей так, как на серверезадачи не выполняются самизапускать cron вручную командой php admin/cli/cron.php
Нет HTTPS и внешних сервисовне работают интеграции с оплатой, видеосвязьюпроверять такие места отдельно, на тестовом домене

Копия рабочих данных на ноутбуке — это персональные данные слушателей, и утечка с личного компьютера недопустима. Если нужна копия для воспроизведения ошибки, делайте обезличивание (заменяйте имена, адреса, телефоны) или работайте на защищённом тестовом сервере.

Типичные неполадки

  • Не запускается из-за занятого порта. Измените порт переменной окружения или остановите другой сервис.
  • Медленно работает на Mac. Файловая система между хостом и контейнером может быть медленной; помогает настройка способа монтирования в Docker Desktop и меньший объём папки с кодом.
  • Права на файлы. Если контейнер не может писать в каталог данных, проверьте владельца и режим монтирования.
  • После переключения ветки Moodle сайт просит обновление. Это нормально: выполните php admin/cli/upgrade.php или откройте страницу администрирования. Переключение на более старую ветку после обновления базы не поддерживается, поэтому для сравнения версий держите отдельные базы.

Что настроить для комфортной разработки

Контейнер даёт среду, а удобство появляется после нескольких настроек. Полезно подключить отладчик Xdebug: образ допускает его включение, а редактор (PhpStorm или VS Code) слушает порт отладки; тогда можно останавливаться на строке кода плагина и смотреть значения переменных вместо вывода в страницу. Полезно держать в репозитории плагина короткий файл с командами запуска (линтер, тесты, сборка JavaScript), чтобы коллега или вы сами через полгода не вспоминали последовательность. И полезно завести для проекта два стенда: «чистый», где проверяется установка с нуля, и «рабочий», на котором накапливаются тестовые курсы и пользователи.

Несколько версий Moodle одновременно

Если вы поддерживаете плагин на нескольких ветках Moodle, держите отдельный клон ядра на каждую ветку и отдельную базу. Переключение версии кода на одном и том же клоне вместе с общей базой ведёт к ошибкам обновления, потому что база помнит наиболее новую версию. Практичнее всего работать так: каждая ветка в своей папке, при запуске задаётся своя переменная с путём к коду, а база создаётся заново командой установки. Благодаря этому проверка плагина на всех заявленных версиях (совместимость версий) занимает минуты, а не дни, и повторяет то, что делает автоматический конвейер в репозитории.

Обновление самого набора

Репозиторий moodle-docker развивается: появляются новые версии образов, меняются переменные. Периодически обновляйте его командой git pull и перечитывайте README, особенно перед переходом на новую ветку Moodle или новую версию PHP. Если после обновления что-то не стартует, остановите контейнеры, выполните down, удалите устаревшие образы и поднимите набор заново. Данные тестового сайта при этом можно потерять, а они на то и тестовые: установка с нуля занимает несколько минут и является хорошей проверкой того, что инструкция по развёртыванию вашего плагина действительно работает.

Типовой рабочий день с локальной средой

Чтобы среда не оставалась упражнением, встройте её в ежедневную работу. Утром поднимаете контейнеры, переключаетесь на ветку плагина и запускаете набор тестов, чтобы убедиться, что исходное состояние зелёное. Во время работы правите код в редакторе и проверяете страницу в браузере на локальном адресе; после правок в языковых файлах, шаблонах и JavaScript очищаете кэши командой в контейнере (или на время разработки отключаете кэширование шаблонов и языка в настройках разработки). Перед коммитом запускаете проверку стиля и тесты, а перед релизом — установку плагина на чистой базе, чтобы проверить файлы установки и обновления. Вечером контейнеры останавливаете, данные остаются. Такой ритм не требует отдельного выделенного сервера, и плагин, собранный в нём, как правило, без сюрпризов ложится на рабочий сайт, где остаётся проверить только окружение. Эти вопросы разобраны в отдельных материалах про обновление и настройку Moodle.

Локальная среда — основа любой дисциплинированной разработки: на ней проверяются тесты, обновления через git и новые версии PHP. Если вам нужна помощь с настройкой окружения для команды или с переносом доработок с тестового стенда на рабочий сервер, это входит в разработку плагинов Moodle и поддержку.

Нужна помощь с Moodle?

Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.