promise-test-helper

azu/promise-test-helper という名前そのままですが、
Mocha等でPromiseのテストを書くときに見落としを減らすための補助ライブラリを書きました。

MochaのPromiseテストというのは、下記のようにpromiseオブジェクトを返すとそれをPromiseのテストと認識してやってくれる機構の事を言っています。

it("should support by mocha", function () {
    return getSuccessPromise().then(function (value) {
        assert(value);
    });
});

詳しくは下記を見て下さい。

MochaがPromisesのテストをサポートしました | Web scratch

Promiseのテストの難しさ

Promiseのテストについてはazu/promises-bookのChapter.3 – Promisesのテストで詳しく書いているので、こちらを読んで欲しいのですが簡単にハマりどころを紹介します。
(間違いがあったりもっといい方法があったらIssues · azu/promises-bookにissue下さい)

必ず通ってしまうテスト

例えば、次のようなpromiseオブジェクトがRejectedされた時の結果をテストしたい場合、
必要最小限だと以下のように書いてしまうと思います。

function mayBeRejected(){
    return Promise.resolve();
}
it("is bad pattern", function () {
    return mayBeRejected().catch(function (error) {
        assert(error instanceof Error);
    });
});

しかし、このテストはmayBeRejected()がFulfilledされてしまうと、そもそもcatchが呼ばれなくなるので必ずテストがパスしてしまいます。

これを防止するためには、promiseオブジェクトがfulfilledされた時は、
テストが失敗するということを明示する必要があります。

function failTest() { 
    throw new Error("Expected promise to be rejected but it was fulfilled");
}
function mayBeRejected(){
    return Promise.resolve();
}
it("thenで落ちる条件を明示する", function () {
    return mayBeRejected().then(failTest, function (error) {
        assert(error instanceof Error);
    });
});

こうすることでfulfilledされた時はfailTestが呼ばれるのでテストが意図したように落ちます。
(3.2. MochaのPromisesサポートで詳しく解説してます)