モジュールモックのバイパス

Jestでは、どんなモジュールでもテスト内でモックすることが出来ます。これは、そのモジュール内から関数が正しく呼び出されているかをテストするのに役立ちます。 ただし、 テストファイルでモックされたモジュールの一部を使用したい場合があります。 その場合、モック化されたモジュールではなく元の実装にアクセスします。

次の createUser 関数のテストケースを書く場合を考えます。

createUser.js

import fetch from 'node-fetch';

export const createUser = async () => {
  const response = await fetch('https://website.com/users', {method: 'POST'});
  const userId = await response.text();
  return userId;
};

テストでは、実際にネットワークリクエストを行わなくても呼び出されるように、 fetch 関数をモックする必要があります。 ただし、 作成したユーザーのIDを取得するのに使われているので、fetch の戻り値を ( Promiseにラップされた)Response でモックする事も必要です。 ですから、最初は次のようなテストを書くことでしょう。

jest.mock('node-fetch');

import fetch, {Response} from 'node-fetch';
import {createUser} from './createUser';

test('createUser calls fetch with the right args and returns the user id', async () => {
  fetch.mockReturnValue(Promise.resolve(new Response('4')));

  const userId = await createUser();

  expect(fetch).toHaveBeenCalledTimes(1);
  expect(fetch).toHaveBeenCalledWith('https://website.com/users', {
    method: 'POST',
  });
  expect(userId).toBe('4');
});

しかし、上記のテストを実行した場合、createUser関数は次のようなエラーを出力して失敗するでしょう： TypeError: response.text is not a function これは、 jest.mock をテストファイルの最初に呼び出したことで、node-fetchから import した Response クラスがモックされ、本来あるべき振る舞いをしなくなったためです。

このような問題を回避するために、Jest は jest.requireActual ヘルパーを提供しています。 上記のテストを機能させるには、次のようにテストファイル内のimport文を変更します。

// BEFORE
jest.mock('node-fetch');
import fetch, {Response} from 'node-fetch';

// AFTER
jest.mock('node-fetch');
import fetch from 'node-fetch';
const {Response} = jest.requireActual('node-fetch');

これによりテストファイルはモック化されたものではなく、実際の Response オブジェクトを node-fetchから import できます。 つまり、テストが正しくパスするということです。