モジュールモックのバイパス
Jestでは、テストでモジュール全体をモックアウトできます。これは、コードがそのモジュールから関数を正しく呼び出しているかどうかをテストするのに役立ちます。ただし、場合によっては、モックされたモジュールの一部をテストファイルで使用したい場合があります。その場合は、モックされたバージョンではなく、元の実装にアクセスする必要があります。
このcreateUser
関数のテストケースを作成することを検討してください。
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
の戻り値をResponse
(Promise
でラップ)でモックする必要があります。したがって、最初に次のようなテストを作成しようとするかもしれません。
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
がスローされることがわかります。これは、node-fetch
からインポートしたResponse
クラスが(テストファイルの先頭にあるjest.mock
呼び出しにより)モックされており、本来の動作をしなくなったためです。
このような問題を回避するために、Jestはjest.requireActual
ヘルパーを提供しています。上記のテストを機能させるには、テストファイルのインポートを次のように変更します。
// 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
からインポートできます。これは、テストが正しく合格するようになることを意味します。