上一篇教程:Developing Discourse Plugins - Part 5 - Add an admin interface
你知道吗?Discourse 为其代码库拥有两个大型测试套件。在服务端,我们的 Ruby 代码使用 rspec 进行测试。对于浏览器端应用,我们有一套包含 ember-testing 的 qunit 测试套件。
假设你已经配置好了开发环境,访问 http://localhost:3000/tests 网址即可在浏览器中开始运行 JavaScript 测试套件。其中一个有趣的特点是,你可以在右下角的一个迷你窗口中看到它正在测试应用程序:
Discourse 应用程序构建时编写了大量测试,访问 /tests 网址时这些测试将开始运行。因此,按你正在开发的插件来筛选测试可能会很有帮助。你可以通过点击界面中的 Plugin(插件)下拉菜单并选择你的插件来实现这一点:
在插件中添加验收测试
首先,确保你检出的是最新版本的 Discourse。能够从插件中运行验收测试是一项相对较新的功能,如果你没有检出最新版本,你的测试将不会显示出来。
在本文中,我将为我们在本系列 第 5 部分 中编写的 purple-tentacle 插件编写一个验收测试。
添加验收测试就像向插件添加一个文件一样简单。创建以下内容:
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. 紫色触手插件的先前版本在 Handlebars 模板中没有 #show-tentacle 元素 ID。请查看最新版本以跟随操作!
一旦这些测试通过,就可以测试交互了。
下一个命令是 await click('#show-tentacle');,它告诉我们的测试框架我们要点击按钮并显示触手。
模拟点击按钮后,我们可以通过以下断言检查触手是否出现:
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
还不错吧?你可以在开发机器上访问 http://localhost:3000/tests?qunit_single_plugin=purple-tentacle&qunit_skip_core=1 亲自尝试该测试。你应该很快看到紫色触手出现,并且所有测试都会通过。
如果你想使用 PhantomJS 在命令行上运行插件的 qunit 测试,可以运行
rake plugin:qunit['purple-tentacle']
(其中 purple-tentacle 是你插件的文件夹名称)
调试你的测试
在编写插件时,测试可以帮助你识别插件中的问题。在开发测试或对插件代码进行更改时,测试可能会失败。为了帮助理解原因,Ember 提供了一些不错的辅助函数:pauseTest() 和 resumeTest()。
要使用它们,请在你希望测试暂停的位置的测试代码中添加 await pauseTest()。现在,当你在浏览器中运行测试时,测试将在你添加 pauseTest() 的位置自动暂停。这将使你有机会检查页面或查看任何错误,以帮助调试问题。
接下来去哪里
我不希望听起来像坏掉的唱片一样重复,但 Ember 文档 中关于测试的内容非常出色。你可能还想通过浏览我们 JavaScript 测试目录 中的测试,看看 Discourse 如何测试各种功能。那里有很多示例可供你学习。
祝测试愉快!
系列更多内容
第 1 部分:插件基础
第 2 部分:插件出口
第 3 部分:站点设置
第 4 部分:Git 设置
第 5 部分:管理界面
第 6 部分:本主题
第 7 部分:发布你的插件
本文档受版本控制 - 建议在 GitHub 上提出更改。


