Предыдущее руководство: Developing Discourse Plugins - Part 5 - Add an admin interface
Знали ли вы, что у Discourse есть два крупных набора тестов для кодовой базы? На стороне сервера наш Ruby-код имеет набор тестов, использующий rspec. Для браузера у нас есть набор qunit, включающий ember-testing.
Предполагая, что у вас настроена среда разработки, если вы откроете URL http://localhost:3000/tests, вы начнете запуск набора тестов JavaScript в браузере. Одна из особенностей — вы можете наблюдать, как тесты проверяют приложение в миниатюрном окне в правом нижнем углу:
Приложение Discourse построено с большим количеством тестов, которые начинаются при открытии URL /tests. Поэтому может быть полезно фильтровать тесты по плагину, над которым вы работаете. Это можно сделать в интерфейсе, нажав на выпадающий список Plugin и выбрав ваш плагин:
Добавление приемочного теста в ваш плагин
Сначала убедитесь, что у вас последняя версия кода Discourse. Возможность запускать приемочные тесты из плагинов — относительно новая функция, и если вы не используете последнюю версию, ваши тесты не появятся.
В этой статье я напишу приемочный тест для плагина purple-tentacle, который мы создали в части 5 этой серии.
Добавить приемочный тест так же просто, как добавить один файл в ваш плагин. Создайте следующий файл:
test/javascripts/acceptance/purple-tentacle-test.js
import { acceptance, exists } from "discourse/tests/helpers/qunit-helpers";
import { click, visit } from "@ember/test-helpers";
import { test } from "qunit";
acceptance("Purple Tentacle", function (needs) {
needs.settings({ purple_tentacle_enabled: true });
needs.user();
test("Purple tentacle button works", async function (assert) {
await visit("/admin/plugins/purple-tentacle");
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
await click("#show-tentacle");
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
});
});
Я постарался написать тест максимально ясно, но он может показаться немного запутанным, если вы никогда раньше не писали приемочные тесты. Я настоятельно рекомендую вам прочитать документацию Ember по приемочному тестированию, так как там есть много полезной информации.
В каждом тесте нам нужно что-то assert (проверить). В нашем тесте мы хотим сделать несколько проверок, чтобы убедиться, что щупальце изначально скрыто и появляется только после нажатия кнопки.
Мы хотим определить набор действий, выполняемых перед проверкой. Для этого мы используем ключевое слово await. Используя это ключевое слово, мы ждем завершения выполнения каждого асинхронного помощника.
Наше первое важное действие: await visit("/admin/plugins/purple-tentacle");. Это говорит тесту перейти по этому URL в нашем приложении. Этот URL отображает щупальце.
После открытия страницы, где появляется кнопка с фиолетовым щупальцем, мы хотим проверить, что кнопка видна на странице, а изображение щупальца еще не существует.
Это делается следующими проверками:
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
P.S. В предыдущей версии плагина purple-tentacle не было элемента с id #show-tentacle в шаблоне handlebars. Установите последнюю версию, чтобы продолжить!
Как только эти тесты проходят, пора проверить взаимодействие.
Следующая команда — await click('#show-tentacle');. Она говорит нашему тестовому фреймворку, что мы хотим нажать на кнопку и показать щупальце.
После имитации нажатия на кнопку мы можем проверить, появляется ли щупальце, с помощью проверки:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
Не так уж сложно, правда? Вы можете попробовать запустить тест самостоятельно, открыв URL http://localhost:3000/tests?target=purple-tentacle на машине разработки. Вы должны очень быстро увидеть появление фиолетового щупальца, и все тесты пройдут.
Если вы хотите запускать тесты qunit для плагина из командной строки, выполните
bin/qunit --target purple-tentacle
(добавьте --standalone, если ваш сервер разработки не запущен)
(где purple-tentacle — это название папки вашего плагина)
Отладка тестов
По мере написания ваших плагинов тесты могут помочь вам выявить проблемы. При разработке тестов или внесении изменений в код плагина тесты могут падать. Чтобы понять почему, в Ember есть удобные помощники: pauseTest() и resumeTest().
Чтобы использовать их, добавьте await pauseTest() в код теста в том месте, где вы хотите остановить выполнение. Теперь, когда вы запускаете тест в браузере, он автоматически останавливается в том месте, где вы добавили pauseTest(). Это даст вам возможность осмотреть страницу или посмотреть ошибки, чтобы отладить проблемы.
Что дальше
Не хочу повторяться, но документация Ember по тестированию превосходна. Также вы можете посмотреть, как Discourse тестирует различные функции, изучив тесты в нашем каталоге javascript-тестов. Там есть много примеров, на которых можно учиться.
Удачного тестирования!
Другие части серии
Часть 1: Основы плагинов
Часть 2: Выходы плагинов (Plugin Outlets)
Часть 3: Настройки сайта
Часть 4: Настройка git
Часть 5: Административные интерфейсы
Часть 6: Эта тема
Часть 7: Публикация плагина
Этот документ находится под контролем версий — предлагайте изменения на github.


