DiscourseのEmberコードの受け入れテストを書く

自動テストは、将来の機能退行からコードを保護するための優れた方法です。Rails コードベースでこれを行う方法 rspec を通じて知っている人は多いですが、JavaScript の側はいくつかの複雑さを伴うこともあります。

幸いなことに、今日では Ember コードに基本的なテストを追加するのはかなり簡単になりました!

コンポーネントのテストについては、コンポーネントのテスト を参照してください。

受け入れテスト

受け入れテスト は、書くのが比較的容易な場合が多く、ユーザーがブラウザで行うのと同じようにアプリケーションをテストするため、コンポーネントのテストよりも強力な場合があります。私は通常、受け入れテストから開始し、複雑なコンポーネントを作成する場合は、そちらにもテストを追加します。

次に、/admin/snack ルートにアクセスし、スナックがレンダリングされたことを確認する受け入れテストの書き方について説明します:

test/javascripts/acceptance/snack-test.js

import { acceptance } from "helpers/qunit-helpers";
acceptance("Snack");

test("Visit Page", function (assert) {
  visit("/admin/snack");
  andThen(() => {
    assert.ok(exists(".fancy-snack-title"), "the snack title is present");
  });
});

この例では、test() はまるで英語を読んでいるようです! 最初の命令は、URL /admin/snack にアクセスすることを意味します。その後に、andThen() メソッドがあります。このメソッドは、テストが继续する前に、すべてのバックグラウンド処理が完了していることを確認するために必要です。JavaScript および Ember のコードは非同期であるため、アサーションが実行される前に、Ember が必要な処理をすべて完了したことを確認する必要があります。最後に、.fancy-snack-title 要素が存在するかどうかをテストします。

ただし、/qunit?module=Acceptance%3A%20Snack にアクセスしてこのテストを実行すると、AJAX エラーのためにテストが失敗します。

覚えておいていただきたいのですが、私たちのコードには、Rails 側と JavaScript 側の両方が含まれており、データ取得のために AJAX リクエストを実行していました。受け入れテストは JavaScript 側を実行しましたが、Rails からデータを取得するために何をすべきか分かりませんでした。

これを修正するには、優れた pretender ライブラリを使用して、偽のレスポンスを追加する必要があります。test/javascripts/helpers/create-pretender.js ファイルを開き、次のような行を見つけてください:

this.get("/admin/plugins", () => response({ plugins: [] }));

その直後に、次の行を追加して、受け入れテストで動作するように偽のスナックオブジェクトを返します:

this.get("/admin/snack.json", () => {
  return response({ name: "snack name", description: "snack description" });
});

上記のコードは、「/admin/snack.json へのリクエストに対して、以下の response で応答する」と読むことができます。

URL /qunit?module=Acceptance%3A%20Snack を更新すると、受け入れテストは pretender を通じてデータを取得し、テストは成功するはずです。

次に進むには

小さな機能を開発し、それが動作することを確認するためにテストを追加してみてください。フロントエンドのコードを書く前にテストを作成することで、TDD を試してみることもできます。取り組んでいる内容や個人好みによって、この方がより楽しい方法だと感じるかもしれません。幸運と、楽しいコーディングを願っています :slight_smile:


このドキュメントはバージョン管理されています。変更の提案は github でお願いします。

「いいね!」 15

My prior experience in writing qunit tests was based on the other howto

i.e. “acceptance” was simply

acceptance("Purple Tentacle", { loggedIn: true });

I have seen in other plugins where the test code contained “fake” JSON to test against. I wasn’t sure if that would be as good as testing against “real” data, so I wanted to avoid doing it that way.

The six tests passed, but I got a couple of rather angry looking “unhandled request” errors.

After finding an example of some “setup” code, I tried it and it solved the errors.

It works, but I’m not really sure why, nor why it’s needed for some but not for the majority of plugins I’ve seen that have qunit tests.

「いいね!」 3

For a long time we weren’t great with testing plugins, so not many people followed our example and added tests.

You are right to add a response using pretender to handle AJAX calls.

「いいね!」 4

/qunit パスは廃止されたというお知らせです。現在は /tests です。見つけるのに少し時間がかかりました :slight_smile:

「いいね!」 1