Behat проверяет Moodle так, как это делает человек: открывает браузер, входит под пользователем, нажимает кнопки и сверяет текст на странице. Для разработчика плагина это единственный способ автоматически убедиться, что форма сохраняется, а нужная ссылка видна только преподавателю. Расскажу, как устроены сценарии, как написать свой шаг и как запускать всё это без многочасовой возни с драйверами.
Как устроен Behat в Moodle
Сценарий — текстовый файл с расширением .feature на языке Gherkin. Каждая строка сценария сопоставляется с PHP-методом («шагом»), который что-то делает в браузере. Большую часть шагов Moodle уже написал: войти пользователем, открыть курс, нажать кнопку, заполнить поле, создать тестовые данные. Свои шаги нужны, когда у плагина есть специфичные элементы интерфейса.
Как и PHPUnit, Behat работает на отдельной тестовой установке: свой префикс таблиц, свой каталог данных, свой адрес сайта. Главная документация: moodledev.io — Behat.
Подготовка окружения
В config.php добавляются настройки, отдельные от основной установки и от PHPUnit:
$CFG->behat_prefix = 'bht_';
$CFG->behat_dataroot = '/var/www/behat_data';
$CFG->behat_wwwroot = 'http://127.0.0.1:8000';
Затем устанавливаются зависимости и инициализируется среда:
composer install
php admin/tool/behat/cli/init.php
Команда создаёт тестовые таблицы и формирует конфигурацию, а в выводе показывает, как запускать тесты и какой веб-сервер для них нужен. Для сценариев с JavaScript понадобятся браузер и драйвер (ChromeDriver или Selenium); для сценариев без JavaScript хватает встроенного режима без браузера. Проще всего получить готовое окружение через moodle-docker: там браузер и Selenium уже подключены.
Запуск выбранных сценариев по тегу:
vendor/bin/behat --config /var/www/behat_data/behatrun/behat/behat.yml --tags=@local_myplugin
Путь к behat.yml зависит от вашего behat_dataroot; точная команда печатается в конце инициализации. Один сценарий можно запустить по имени с ключом --name.
Анатомия сценария
@local_myplugin
Feature: Преподаватель видит отчёт плагина
Чтобы контролировать группу, преподаватель открывает отчёт
Background:
Given the following "users" exist:
| username | firstname | lastname |
| teacher1 | Анна | Иванова |
| student1 | Пётр | Сидоров |
And the following "courses" exist:
| fullname | shortname |
| Курс 1 | C1 |
And the following "course enrolments" exist:
| user | course | role |
| teacher1 | C1 | editingteacher |
| student1 | C1 | student |
Scenario: Преподаватель открывает отчёт
Given I log in as "teacher1"
And I am on "Курс 1" course homepage
When I follow "Отчёт плагина"
Then I should see "Сидоров"
Ключевые слова Given, When, Then, And — это Gherkin; названия функции и сценария, как видите, можно писать по-русски. Блок Background выполняется перед каждым сценарием файла. Тег в первой строке позволяет запускать только сценарии вашего плагина.
Можно ли писать сценарии целиком на русском
Gherkin поддерживает русские ключевые слова: в начале файла добавляется директива языка, и тогда Given превращается в «Допустим», а Then — в «Тогда». Но сами шаги Moodle привязаны к английским формулировкам вроде I log in as "teacher1", и перевести их без переписывания определений нельзя. Поэтому на практике я пишу ключевые слова и шаги по-английски, а названия функций, сценариев и тестовые данные (имена, названия курсов, проверяемые тексты интерфейса) — по-русски. Так сценарий понятен заказчику, а типовые шаги ядра работают без изменений. Если нужны полностью русские шаги, их определяют сами в файле шагов плагина.
Тексты в проверках зависят от языка интерфейса. Тестовый сайт по умолчанию работает с английским интерфейсом, поэтому проверка «I should see "Отчёт плагина"» пройдёт, только если вы дали пункту такое имя в английском языковом файле или переключили язык. Я обычно проверяю английские строки плагина и отдельно, при необходимости, русские.
Свои шаги
Файл с определениями лежит в tests/behat/behat_local_myplugin.php, а класс наследует behat_base. Метод связывается с фразой аннотацией:
require_once(__DIR__ . '/../../../../lib/behat/behat_base.php');
class behat_local_myplugin extends behat_base {
/**
* Открывает страницу настроек плагина.
*
* @Given /^I open the myplugin settings page$/
*/
public function i_open_the_myplugin_settings_page(): void {
$this->execute('behat_general::i_visit', ['/local/myplugin/settings.php']);
}
}
Здесь шаг не делает ничего своего, а составлен из существующего шага ядра — это правильный подход: свои шаги должны быть тонкими и опираться на готовые. Если нужно создавать данные плагина, добавляется генератор в tests/generator/behat_local_myplugin_generator.php, и тогда в сценарии появляется таблица the following "local_myplugin > records" exist:. Точные имена и сигнатуры лучше сверять с примерами других плагинов и документацией, они меняются от версии к версии.
JavaScript-сценарии и ожидание
Сценарий с тегом @javascript выполняется в настоящем браузере. Это медленнее и капризнее, поэтому такие сценарии нужны только там, где логика живёт в браузере: модальные окна, динамические списки, автодополнение. Всё остальное проверяйте без JavaScript.
Типичная проблема — гонка: Behat нажимает кнопку, пока страница ещё не дорисовалась. Moodle ждёт завершения загрузки сам, но для своих динамических блоков нужны явные шаги ожидания либо проверка видимого результата, а не фиксированная пауза.
Частые проблемы
| Симптом | Причина | Решение |
|---|---|---|
| Сценарии не находят шаг | файл шагов не подхватился после добавления | повторить инициализацию Behat |
| Падает только в наборе | сценарии зависят друг от друга | каждый сценарий создаёт свои данные в Background |
| Не удаётся подключиться к браузеру | драйвер не запущен или другой адрес | проверить конфигурацию Selenium/ChromeDriver, взять готовое окружение moodle-docker |
| Элемент «не найден», хотя он виден | он вне видимой области или перекрыт | использовать более точный селектор, прокрутить к элементу |
| Тест вечером проходит, утром нет | в данных зашита дата | вычислять даты относительно текущей |
Что покрывать сценариями, а что оставить PHPUnit
Правило, которое я использую: расчёты и права проверяет PHPUnit, путь пользователя — Behat. Хорошие кандидаты для Behat: главный пользовательский сценарий плагина («преподаватель открыл отчёт и скачал файл»), доступность пункта меню разным ролям, сохранение формы настроек. Одного-трёх сценариев на плагин достаточно, чтобы заметить, что после обновления ядра интерфейс перестал открываться. Подробнее про юнит-тесты — в статье про PHPUnit для плагина.
Как разбирать упавший сценарий
Падение Behat почти всегда читается из сообщения: в нём названа строка сценария и то, что не удалось найти или нажать. Дальше порядок такой:
- Запустить только упавший сценарий, чтобы исключить влияние соседних.
- Для JavaScript-сценариев включить сохранение снимка экрана и HTML страницы при ошибке; обе возможности настраиваются параметрами запуска и описаны в документации. По снимку обычно сразу видно, что вместо ожидаемой страницы открылась ошибка или форма входа.
- Добавить в сценарий шаг, который выводит страницу в нужной точке, и посмотреть, на каком шаге картина расходится с ожиданием.
- Если в шаге используется текст, проверить язык интерфейса и точное написание, включая пробелы и регистр.
Отдельная причина падений, которую я встречала, — устаревшее состояние среды после обновления кода: добавлены новые таблицы или шаги, а Behat об этом не знает. Лечится повторным запуском инициализации.
Сколько сценариев писать
Сценариев должно быть мало, и каждый — про ценность для пользователя. Если вы поймали себя на сценарии «проверить, что кнопка называется так-то», это повод проверить текст языкового файла в юнит-тесте или вообще не проверять. Приёмочные тесты дороги в сопровождении: при смене интерфейса в новой версии Moodle они ломаются первыми. Поэтому я оставляю по одному сценарию на главную возможность плагина, плюс сценарий на ограничения по ролям: один положительный, один «не должно быть доступно».
Данные для сценариев: генераторы вместо ручного ввода
Сценарий не должен сам кликать по форме создания курса: это медленно и хрупко. Для подготовки используются шаги-генераторы, которые создают записи напрямую в базе: пользователей, курсы, категории, записи на курс, группы, когорты, роли, активности. Фраза the following "activities" exist: с таблицей параметров создаёт тест или задание без единого клика. Пишите в таблице только то, что важно для сценария, остальное подставят значения по умолчанию. Так сценарий читается как описание ситуации, а не как инструкция по подготовке стенда, и его легче поддерживать.
Behat в рабочем процессе плагина
Приёмочные тесты окупаются, когда их запускают автоматически, а не по настроению. Для плагина в репозитории на GitHub я подключаю moodle-plugin-ci, и он запускает Behat на каждой версии Moodle из матрицы вместе с проверкой стиля и PHPUnit. Локально достаточно запускать сценарии по тегу плагина перед выпуском версии. Если сценарии выполняются долго, делят их по тегам: быстрые без JavaScript — на каждый коммит, медленные с браузером — перед релизом. Ещё один приём: сохранять в сценарии то, о чём обычно договариваются устно. Например, фраза «куратор видит только свою группу» превращается в два сценария с явными пользователями и группами, и разночтений о том, как плагин должен себя вести, становится меньше. Такие сценарии заодно служат живой документацией и хорошо читаются заказчиком, если описание функции и сценариев написано по-русски. Подробнее о роли тестов при передаче проекта между подрядчиками — в статье про технический долг в Moodle.
Приёмочные тесты особенно полезны в проектах, где плагины живут годами и пережили несколько обновлений: при обновлении Moodle они быстро показывают, что не открывается. Если нужна помощь в обвязке тестами вашего плагина, это входит в доработку Moodle.
Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.