上一教程:Developing Discourse Plugins - Part 5 - Add an admin interface
你知道吗,Discourse 的代码库拥有两个大型测试套件?在服务器端,我们的 Ruby 代码使用 rspec 进行测试。对于浏览器应用,我们有一个 qunit 套件,其中包含了 ember-testing。
假设你已经配置好了开发环境,如果你访问 http://localhost:3000/tests 这个 URL,就会开始在浏览器中运行 JavaScript 测试套件。一个有趣的地方是,你可以在右下角的一个迷你窗口中看到它正在测试应用程序:
Discourse 应用程序包含大量测试,当你访问 /tests URL 时这些测试就会开始运行。因此,按照你正在开发的插件来过滤测试可能很有帮助。你可以在界面上点击 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");
附注。 紫色触手插件的旧版本在 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 tests 目录中的测试,看看 Discourse 如何测试各种功能。那里有很多你可以学习的示例。
祝测试愉快!
系列更多文章
第 1 部分:插件基础
第 2 部分:插件出口
第 3 部分:站点设置
第 4 部分:git 设置
第 5 部分:管理界面
第 6 部分:本主题
第 7 部分:发布你的插件
本文档受版本控制 - 建议修改 在 github 上。


