Разработка плагинов для Discourse — Часть 6 — Добавление приёмочных тестов

Предыдущее руководство: 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.

30 лайков

OMG, have I put off writing tests for this long?!

A few things
I noticed you put an “id” into the template file that wasn’t there in the previous tutorial
I added 3 more tests to deal with the “Hide Tentacle” button I added
I needed to be logged in it is an Admin page
I needed to use port 4000 for my VirtualBox Vagrant set-up

Happily, quick success !

5 лайков

I’ve noticed a push to implement testing for plugins lately and I completely agree that this is important. I’ve been terrible at writing these in the past and want to get caught up.

I was considering the setup of Travis CI on a plugin repo as I noticed the ability to use Docker with Travis. But having never touched Travis before, is it possible to do this with a plugin? It would be nice to submit PRs to my own repo and have the tests run automatically.

5 лайков

how can I run single ember tests on the browser?

http://localhost:3000/qunit?module=Acceptance%3A%20Purple%20Tentacle

I mean, if I have another acceptance test called “another test”, how would I run it? Thank you!

If you click “rerun” beside a test, you’ll get a URL that is just for that particular test that you can refresh over and over.

You can also run by module by clicking in the “All Module” box and checking off just the modules you want to run.

2 лайка

This tutorial needs updating to replace ok(...) with assert.ok(...).

Have put the necessary changes in a PR - I’m happy to edit the OP if it’s made into a wiki :slight_smile:

https://github.com/eviltrout/purple-tentacle/pull/2

2 лайка

OK it is wikified! PM me if anything else needs this treatment any time.

1 лайк

A note after writing some basic acceptance tests for the Elections Plugin:

  • If you use the default loggedIn option, you’re logged in as eviltrout with the properties in this session fixture

  • You can login as a custom user (necessary if you’ve added custom user properties) by defining your own session fixture and setting it as the current user using the beforeEach hook. See here for an example.

@eviltrout is there a better way of using a custom user for acceptance tests?

5 лайков

What we should probably do is change the acceptance method in discourse to take an argument for the user to log in as. Then your test could say { loggedIn: true, logInAs: angus }

If you’ve got time for that PR we’d accept it!

4 лайка

q: how to run the ruby tests tests for a plugin?

i am trying to run the tests for discourse-github-linkback, but i have no idea how.

After some stackoverflow i tried this (and i got some errors):

~/discourse$ bundle exec rspec ./plugins/discourse-github-linkback/spec/lib/github_linkback_spec.rb 

An error occurred while loading ./plugins/discourse-github-linkback/spec/lib/github_linkback_spec.rb.
Failure/Error: CoreExt::ActiveSupport.without_bootsnap_cache { super }

NameError:
  uninitialized constant GithubLinkback
# ./plugins/discourse-github-linkback/spec/lib/github_linkback_spec.rb:3:in `<top (required)>'
# ------------------
# --- Caused by: ---
# NameError:
#   uninitialized constant GithubLinkback
#   ./plugins/discourse-github-linkback/spec/lib/github_linkback_spec.rb:3:in `<top (required)>'
No examples found.

Randomized with seed 60987


Finished in 0.02025 seconds (files took 3.36 seconds to load)
0 examples, 0 failures, 1 error occurred outside of examples

Randomized with seed 60987

Note that i see the plugin in the local discourse dev admin page, so i hope it is correctly installed (into ~discourse/plugins/

Simplest way, run bin/rake autospec, and save the file

1 лайк

From what i see, doing cd ~/discourse and then running

runs all the tests for discourse.

On my ubuntu 18.04 VM with i5 6500, this has been running for half an hour already.
It feels wrong to run the whole tests suite when i only want to run the tests in that one plugin.
(this is especially so when i probably will modify my tests again, at least a few times)

Did i do something wrong?

Let me guess, you are symlinking your plugin vs checking out directly to the path under plugins

no,

tbp@tbp-linux-dev:~$ cd ~/discourse/plugins/
git clone -b allow-all-user-repositories-wildcard https://github.com/TheBestPessimist/discourse-github-linkback
tbp@tbp-linux-dev:~/discourse/plugins$ ll
total 40
drwxr-xr-x 10 tbp tbp 4096 May 13 21:48 ./
drwxr-xr-x 20 tbp tbp 4096 May 13 21:18 ../
drwxr-xr-x  6 tbp tbp 4096 May 13 20:29 discourse-details/
drwxr-xr-x  6 tbp tbp 4096 May 13 21:48 discourse-github-linkback/
drwxr-xr-x  6 tbp tbp 4096 May 13 20:29 discourse-local-dates/
drwxr-xr-x  9 tbp tbp 4096 May 13 20:29 discourse-narrative-bot/
drwxr-xr-x  7 tbp tbp 4096 May 13 20:29 discourse-nginx-performance-report/
drwxr-xr-x  5 tbp tbp 4096 May 13 20:29 discourse-presence/
drwxr-xr-x  3 tbp tbp 4096 May 13 20:29 lazyYT/
drwxr-xr-x  9 tbp tbp 4096 May 13 20:29 poll/
tbp@tbp-linux-dev:~/discourse/plugins$ 

Can you confirm you tried saving the spec file once it was running, cause it is meant to interrupt stuff and start running the plugin spec?

since the initial bin/rake autospec is still running, there was/is no “save spec file” message yet.
also, by running bin/rake autospec --help, i saw no --save option.

I didn’t understand what save the file meant, so my full command was bin/rake autospec > spec.rb ← probably this is wrong

I meant in Vim or whatever you use, save the spec file, there is a watcher on it that will invoke the spec runner once it is saved.

Also see: How do I run only discourse/plugins/poll/spec? - #6 by tgxworld

1 лайк

Finally i did it :^).

With the help of that link, i ran the tests by using this command:
bundle exec rake plugin:spec["discourse-github-linkback"]
and, ofc, i was in ~/discourse when doing that.

Thanks for all your help @sam!

(1st PR for discourse-plugin babyyyyy :tada:)

8 лайков

My Qunit-Tests aren’t executed or at least they don’t show me any output.
They finish with the following:

No output has been received in the last 10m0s, this potentially indicates a stalled build or something wrong with the build itself.
Check the details on how to adjust your build configuration on: https://docs.travis-ci.com/user/common-build-problems/#Build-times-out-because-no-output-was-received

Travis.CI Result - Travis CI
Test-File - GitHub - kokoro-ko/discourse-humble-box: humble-bundle onebox · GitHub

I am not that skilled with CI yet and haven’t found my mistake by now.

Do your tests pass if you visit /qunit on your development environment? How about if you run rake plugin:qunit[discouse-humble-box]?

2 лайка