【Jasmine】JavaScriptテストにおけるtoBeとtoEqualの違いを解説

配列の比較には2つのパターンがある

Jasmineで配列同士を比較する場合、その意味合いとして大きく分けて2つのパターンが存在します。

• 両者がメモリ上の同一の配列オブジェクトを参照している。

• それぞれ異なるオブジェクトを参照しているが、その内容（要素）がすべて等しい。

この2つのパターンに対応するため、JasmineにはtoBeとtoEqualという2つのマッチャーが用意されています。それぞれの違いを具体例とともに見ていきましょう。

例1：toBeによる参照の一致チェック

ケース1のように、変数が同じオブジェクトを参照しているかどうかを確認したい場合は、toBeメソッドを使用します。このメソッドは参照（同一性）の一致を検証します。

describe("Array Equality", () => {
    it("should check for array reference equility", () => {
        let arr = [1, 2, 3];
        let arr2 = arr;
        // 同一の参照なので成功する
        expect(arr).toBe(arr2);
        // 参照が等しくないため失敗する
        expect(arr).toBe([1, 2, 3]);
    });
});

出力結果

上記のコードを実行すると、次のような出力が得られます。

1) Array Equality should check for array equility
Message:
    Expected [ 1, 2, 3 ] to be [ 1, 2, 3 ]. Tip: To check for deep equality, use .toEqual() instead of .toBe().

たとえ中身が完全に同じ [1, 2, 3] であっても、別々に生成された配列はメモリ上で異なるオブジェクトのため、テストは失敗します。エラーメッセージのヒントにもあるように、値そのものの一致を確認したい場合は .toBe() ではなく .toEqual() を使うことが推奨されています。

例2：toEqualによる深い比較

ケース2のように、オブジェクトが異なっていても内容が等しいことを確認したい場合は、toEqualメソッドを使用して配列の深い比較（ディープイコール）を行います。

describe("Array Equality", () => {
    it("should check for array reference equility", () => {
        let arr = [1, 2, 3];
        let arr2 = arr;
        // 同一の参照なので成功する
        expect(arr).toEqual(arr2);
        // 内容が等しいため成功する
        expect(arr).toEqual([1, 2, 3]);
    });
});

出力結果

上記のコードを実行すると、すべてのテストが成功し、次のような出力が得られます。

1 spec, 0 failures

まとめ：使い分けのポイント

toBeは「同一のオブジェクト（参照）であるか」を検証するのに対し、toEqualは「オブジェクトの内容が等しいか」を検証します。プリミティブ値や同一インスタンスの確認にはtoBe、配列やオブジェクトの中身を比較したい場合にはtoEqualを使う、というのが基本的な使い分けのルールです。テストの意図に合わせて適切なマッチャーを選択しましょう。