前回のチュートリアル: Developing Discourse Plugins - Part 5 - Add an admin interface
Discourseには、コードベース用の2つの大規模なテストスイートが存在することをご存知ですか? サーバー側では、Rubyコードが rspec を使用したテストスイートを備えています。ブラウザアプリケーションでは、ember-testing を含む qunit スイートがあります。
開発環境がセットアップされていると仮定すると、http://localhost:3000/tests URLにアクセスすると、ブラウザでJavaScriptテストスイートの実行が始まります。楽しい機能の1つとして、右下隅のミニチュアウィンドウでアプリケーションがテストされている様子を見ることができます。
Discourseアプリケーションは、/tests URLにアクセスすると実行が始まる大量のテストを含んで構築されています。したがって、作業中のプラグインでテストを絞り込むと便利です。インターフェースで Plugin ドロップダウンをクリックし、自分のプラグインを選択することでそれを行うことができます。
プラグインへの受け入れテストの追加
まず、Discourseの最新バージョンをチェックアウトしていることを確認してください。プラグインから受け入れテストを実行できるのは比較的新しい機能であり、最新バージョンをチェックアウトしていない場合、テストが表示されません。
この記事では、このシリーズのパート5で作成した purple-tentacle プラグインの受け入れテストを記載します。
受け入れテストの追加は、プラグインにファイルを1つ追加するだけで簡単に行えます。以下を作成してください。
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(検証)する必要があります。今回のテストでは、 tentacle(触手)が最初は非表示であり、ボタンをクリックした後でのみ表示されるかどうかを確認するために、いくつかの検証を行います。
検証が行われる前に実行される一連のアクションを定義する必要があります。それには await キーワードを使用します。このキーワードを使用することで、各非同期ヘルパーの実行が最初に完了するまで待機します。
重要な最初のアクションは await visit("/admin/plugins/purple-tentacle"); です。これは、テストに対してアプリケーション内のそのURLにナビゲートするように指示します。このURLはtentacleを表示するものでした。
purple tentacleボタンが表示されるページにアクセスした後、ページ上にボタンが存在し、tentacle画像がまだ存在しないことを確認したいと考えます。
それは以下の検証によって行われます。
assert.ok(exists("#show-tentacle"), "it shows the purple tentacle button");
assert.ok(!exists(".tentacle"), "the tentacle is not shown yet");
追伸: purple-tentacleプラグインの以前のバージョンでは、handlebarsテンプレートに #show-tentacle 要素IDがありませんでした。最新バージョンをチェックアウトして追跡してください!
これらのテストが通過したら、インタラクションをテストする時です。
次のコマンドは await click('#show-tentacle'); です。これは、ボタンをクリックしてtentacleを表示したいことをテストフレームワークに伝えます。
ボタン上のクリックをシミュレートした後、以下を検証することにより、tentacleが表示されたかどうかを確認できます。
assert.ok(exists(".tentacle"), "the tentacle wants to rule the world!");
それほど悪くないでしょう? 開発マシンで http://localhost:3000/tests?target=purple-tentacle にアクセスして、自分でテストを試してみることができます。非常にすぐにpurple tentacleが表示され、すべてのテストが通過するはずです。
コマンドラインでプラグインのqunitテストを実行したい場合は、以下を実行できます。
bin/qunit --target purple-tentacle
(開発サーバーが起動していない場合は、--standaloneを追加してください)
(ここで purple-tentacle はプラグインのフォルダ名です)
テストのデバッグ
プラグインを記述するにつれ、テストがプラグイン内の問題を特定するのに役立ちます。テストを開発中、またはプラグインのコードに変更を加えた場合、テストが失敗する可能性があります。理由を理解するのに役立つように、Emberには pauseTest() と resumeTest() という便利なヘルパーがあります。
これらを使用するには、テストを一時停止したい箇所のテストコード内に await pauseTest() を追加します。ここで、ブラウザでテストを実行すると、pauseTest() を追加した箇所でテストが自動的に一時停止します。これにより、ページを検査したり、エラーを表示して問題のデバッグに役立てたりする機会が得られます。
ここから先へ
同じことの繰り返しのように聞こえるかもしれませんが、テストに関するEmberドキュメントは非常に優れています。また、javascriptテストディレクトリのテストを閲覧することで、Discourseが多様な機能をテストする方法を確認することもできるでしょう。そこから学べる例が多数あります。
テストを楽しんでください!
シリーズの続き
パート1: プラグインの基本
パート2: プラグインアウトレット
パート3: サイト設定
パート4: gitセットアップ
パート5: 管理者インターフェース
パート6: このトピック
パート7: プラグインの公開
このドキュメントはバージョン管理されています - github上のsuggestions changesで変更を提案してください。


