【初心者向け】Jestモックでテストをレベルアップ！複数回の呼び出しと引数検証

2024-04-22

Jest モックで複数の呼び出しと複数引数を検証する方法

このチュートリアルでは、Jest モックを使用して、複数の呼び出しと複数の引数を検証する方法について説明します。

例：

function calculateSum(a, b) {
  return a + b;
}

test('calculateSum function should return the sum of two numbers', () => {
  const mockCalculateSum = jest.fn();
  global.calculateSum = mockCalculateSum;

  // 2つの異なる呼び出しでモック関数を検証します
  mockCalculateSum(1, 2); // 1 + 2 = 3
  mockCalculateSum(3, 4); // 3 + 4 = 7

  // 各呼び出しの引数を検証します
  expect(mockCalculateSum).toHaveBeenCalledWith(1, 2);
  expect(mockCalculateSum).toHaveBeenCalledWith(3, 4);
});

解説：

jest.fn() 関数を使用して、モック関数を作成します。
モック関数をグローバルスコープに割り当てます。
テスト対象の関数をモック関数で置き換えます。
モック関数を複数の呼び出しで検証します。
各呼び出しの引数を toHaveBeenCalledWith() メソッドを使用して検証します。

複数の引数を検証する方法：

toHaveBeenCalledWith() メソッドは、モック関数が特定の引数で呼び出されたことを検証するために使用されます。
引数の順序は重要です。
配列を使用して複数の引数を渡すことができます。

その他のヒント：

モック関数の戻り値を制御することができます。
モック関数を例外をスローするように設定することができます。

Jest モックは、テストを記述し、コードの動作を検証する強力なツールです。上記の例とヒントを使用して、Jest モックを使用して複数の呼び出しと複数の引数を検証する方法を理解できます。

サンプルコード：Jest モックを使用して複数の呼び出しと複数引数を検証する

calculateSum.ts

export function calculateSum(a: number, b: number): number {
  return a + b;
}

import { calculateSum } from './calculateSum';

jest.mock('./calculateSum');

test('calculateSum function should return the sum of two numbers', () => {
  const mockCalculateSum = calculateSum as jest.Mock;

  // 2つの異なる呼び出しでモック関数を検証します
  mockCalculateSum.mockImplementationOnce((a, b) => a - b);
  mockCalculateSum(1, 2); // 1 - 2 = -1
  expect(mockCalculateSum).toHaveBeenCalledWith(1, 2);

  mockCalculateSum.mockImplementationOnce((a, b) => a * b);
  mockCalculateSum(3, 4); // 3 * 4 = 12
  expect(mockCalculateSum).toHaveBeenCalledWith(3, 4);
});

calculateSum.ts ファイルから calculateSum 関数をインポートします。
calculateSum.mock.ts ファイルをモックします。
test('calculateSum function should return the sum of two numbers') テストケースを定義します。
calculateSum 関数を jest.Mock 型にキャストします。
mockImplementationOnce メソッドを使用して、モック関数の戻り値を個別に設定します。
expect(mockCalculateSum).toHaveBeenCalledWith(1, 2); を使用して、モック関数が正しい引数で呼び出されたことを検証します。

この例は、Jest モックを使用して複数の呼び出しと複数の引数を検証する方法を示す基本的な例です。実際のテストでは、より複雑なロジックと検証が必要になる場合があります。

補足：

この例では、mockImplementationOnce メソッドを使用して、モック関数の戻り値を個別に設定しています。他の方法として、mockReturnValue メソッドを使用してすべての呼び出しで同じ戻り値を設定することもできます。
テスト対象の関数が非同期の場合、resolves または rejects メソッドを使用して、モック関数の Promise 結果を制御できます。

Jest モックで複数の呼び出しと複数引数を検証する方法：その他の方法

toHaveBeenCalledTimes と toHaveBeenCalledWith の組み合わせ:

この方法は、モック関数が特定の回数呼び出されたことを検証し、各呼び出しの引数を検証するのに役立ちます。

test('calculateSum function should be called twice with the correct arguments', () => {
  const mockCalculateSum = jest.fn();
  global.calculateSum = mockCalculateSum;

  calculateSum(1, 2);
  calculateSum(3, 4);

  expect(mockCalculateSum).toHaveBeenCalledTimes(2);
  expect(mockCalculateSum).toHaveBeenCalledWith(1, 2);
  expect(mockCalculateSum).toHaveBeenCalledWith(3, 4);
});

利点:

シンプルで分かりやすい構文
複数の呼び出しを個別に検証できる

冗長な記述になりやすい
各呼び出しの検証に個別の expect ステートメントが必要

モック関数のプロパティ検証:

この方法は、モック関数のプロパティ、例えば calls プロパティを使用して、呼び出し履歴と引数を検証するのに役立ちます。

test('calculateSum function should be called twice with the correct arguments', () => {
  const mockCalculateSum = jest.fn();
  global.calculateSum = mockCalculateSum;

  calculateSum(1, 2);
  calculateSum(3, 4);

  const calls = mockCalculateSum.mock.calls;
  expect(calls.length).toBe(2);
  expect(calls[0][0]).toBe(1);
  expect(calls[0][1]).toBe(2);
  expect(calls[1][0]).toBe(3);
  expect(calls[1][1]).toBe(4);
});

呼び出し履歴と引数をコンパクトに検証できる

calls プロパティの構造を理解する必要がある
個別の expect ステートメントは使用できない

サードパーティ製のライブラリを使用する:

モックの作成と検証をより簡単にできる
独自のモッキング機能を提供している

Jest との互換性がない場合がある
学習曲線が上がる

どの方法を選択するかは、テストのニーズと個人の好みによって異なります。シンプルなテストであれば、toHaveBeenCalledTimes と toHaveBeenCalledWith の組み合わせで十分です。より複雑なテストや、モック関数の詳細な検証が必要な場合は、モック関数のプロパティ検証やサードパーティ製のライブラリを検討することができます。

javascript typescript unit-testing