[Jest] clearAllMocks()とresetAllMocks()の違いについて確認してみた

若槻龍太

2022.02.11

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは、CX事業本部 IoT事業部の若槻です。

JavaScriptのテスティングフレームワークJestでテストをする際に、テスト間のモックをクリアするためにclearAllMocks()をよく使用しています。しかし最近似たようなオブジェクトとしてresetAllMocks()なるものがあることを知りました。

今回は、clearAllMocks()とresetAllMocks()の違いを確認してみました。

clearAllMocks()の動作

まずclearAllMocks()についてです。

clearAllMocks() | The Jest Object · Jest

Clears the mock.calls, mock.instances and mock.results properties of all mocks. Equivalent to calling .mockClear() on every mocked function.

実行すると、すべてのモックの mock.calls、mock.instancesおよびmock.resultsをクリアしてくれるとのこと。

動作確認として、次のようなmodule_bを呼び出すmodule_aのテストを考えてみます。

src/module_a.ts

import * as ModuleB from "./module_b";

export type UserType = "manager" | "general";

/**
 * ユーザーがデータを取得する
 * @param userType ユーザータイプ
 */
export const getDataByUser = async (userType: UserType): Promise<string> => {
  if (userType === "manager") {
    return await ModuleB.getDataByManager();
  }
  userType === "general";
  {
    return await ModuleB.getDataByGeneralUser();
  }
};

src/module_b.ts

/**
 * 管理者ユーザーがデータを取得する
 */
 export const getDataByManager = async (): Promise<string> => {
  return "data for manager";
};

/**
 * 一般ユーザーがデータを取得する
 */
export const getDataByGeneralUser = async (): Promise<string> => {
  return "data for general";
};

module_aのテストです。afterEach()により各テスト（it()）終了後にclearAllMocks()を実行するようにしています。

test/module_a.test.ts

import * as ModuleA from '../src/module_a';
import * as ModuleB from '../src/module_b';

describe('module_a', () => {
  afterEach(() => {
    jest.clearAllMocks();
  });

  (ModuleB.getDataByManager as jest.Mock) = jest.fn().mockReturnValue('dummy');
  (ModuleB.getDataByGeneralUser as jest.Mock) = jest
    .fn()
    .mockReturnValue('dummy');

  it('By Manager', async (): Promise<void> => {
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });

  it('By Manager', async (): Promise<void> => {
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });
});

jestを実行するとテストがPASSしました。

$  npx jest
 PASS  test/module_a.test.ts (8.73 s)
  module_a
    ✓ By Manager (2 ms)
    ✓ By GeneralUser (1 ms)

Test Suites: 1 passed, 1 total
Tests:       2 passed, 2 total
Snapshots:   0 total
Time:        9.009 s
Ran all test suites.

テスト間でmock.callsがクリアされてtoHaveBeenCalledTimes()やtoHaveBeenCalledTimes()によるassertionが適切に行えています。これがclearAllMocks()を使うことによる嬉しみです。

resetAllMocks()

次にresetAllMocks()についてです。

clearAllMocks() | The Jest Object · Jest

Resets the state of all mocks. Equivalent to calling .mockReset() on every mocked function.

実行すると、すべてのモックのstateをクリア（初期化）してくれるとのこと。stateってなんなんでしょうね。

先程のテストのclearAllMocks()をresetAllMocks()に置き換えて動作を見てみます。

test/module_a.test.ts

import * as ModuleA from '../src/module_a';
import * as ModuleB from '../src/module_b';

describe('module_a', () => {
  afterEach(() => {
    jest.resetAllMocks();
  });

  (ModuleB.getDataByManager as jest.Mock) = jest.fn().mockReturnValue('dummy');
  (ModuleB.getDataByGeneralUser as jest.Mock) = jest
    .fn()
    .mockReturnValue('dummy');

  it('By Manager', async (): Promise<void> => {
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });

  it('By Manager', async (): Promise<void> => {
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });
});

するとテストがFAILしました。it()の外で記述しているmockReturnValue()によるモックが、1つ目のテストの後にリセットされてしまっているような動作ですね。

$  npx jest
 FAIL  test/module_a.test.ts (5.097 s)
  module_a
    ✓ By Manager (2 ms)
    ✕ By Manager (2 ms)

  ● module_a › By Manager

    expect(received).toBe(expected) // Object.is equality

    Expected: "dummy"
    Received: undefined

      22 |   it('By Manager', async (): Promise<void> => {
      23 |     const res = await ModuleA.getDataByUser('manager');
    > 24 |     expect(res).toBe('dummy');
         |                 ^
      25 |     //getDataByManagerが1回実行されることを期待
      26 |     expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
      27 |     expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);

      at Object.<anonymous> (test/module_a.test.ts:24:17)

Test Suites: 1 failed, 1 total
Tests:       1 failed, 1 passed, 2 total
Snapshots:   0 total
Time:        5.139 s, estimated 6 s
Ran all test suites.

そこで、それぞれのit()内でmockReturnValue()によるモックをするようにすればテストはPASSしました。

test/module_a.test.ts

import * as ModuleA from '../src/module_a';
import * as ModuleB from '../src/module_b';

describe('module_a', () => {
  afterEach(() => {
    jest.resetAllMocks();
  });

  it('By Manager', async (): Promise<void> => {
    (ModuleB.getDataByManager as jest.Mock) = jest
      .fn()
      .mockReturnValue('dummy');
    (ModuleB.getDataByGeneralUser as jest.Mock) = jest
      .fn()
      .mockReturnValue('dummy');
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });

  it('By Manager', async (): Promise<void> => {
    (ModuleB.getDataByManager as jest.Mock) = jest
      .fn()
      .mockReturnValue('dummy');
    (ModuleB.getDataByGeneralUser as jest.Mock) = jest
      .fn()
      .mockReturnValue('dummy');
    const res = await ModuleA.getDataByUser('manager');
    expect(res).toBe('dummy');
    //getDataByManagerが1回実行されることを期待
    expect(ModuleB.getDataByManager).toHaveBeenCalledTimes(1);
    expect(ModuleB.getDataByGeneralUser).toHaveBeenCalledTimes(0);
  });
});

$  npx jest
 PASS  test/module_a.test.ts
  module_a
    ✓ By Manager (2 ms)
    ✓ By Manager

Test Suites: 1 passed, 1 total
Tests:       2 passed, 2 total
Snapshots:   0 total
Time:        0.73 s, estimated 6 s
Ran all test suites.

結局両者の違いは何なのか

結局両者の違いは何なのか、clearAllMocks()とresetAllMocks()を個別のモックに対して実施するmockClear()とmockReset()のドキュメントの記述を見てみると、ちゃんと具体的に書いてありました。

mockClear() | The Jest Object · Jest

Clears all information stored in the mockFn.mock.calls, mockFn.mock.instances and mockFn.mock.results arrays. Often this is useful when you want to clean up a mocks usage data between two assertions.

mockReset() | The Jest Object · Jest

Does everything that mockFn.mockClear() does, and also removes any mocked return values or implementations.

This is useful when you want to completely reset a mock back to its initial state. (Note that resetting a spy will result in a function with no return value).

記述の要点をまとめてみると、次のようになります。

mockClear()は、2つのassertion間でモックをクリーンアップしたい際に便利。
mockReset()は、mockClear()の実行内容に加えて、return values or implementationsを削除可能。
mockReset()は、モックのstateを完全にリセットしたい際に便利。

なるほど。大きな違いとしてはreturn values or implementationsが削除されるかどうか、のようですね。前節までの検証での動作にも合致します。

参考

以上

[Jest] clearAllMocks()とresetAllMocks()の違いについて確認してみた

clearAllMocks()の動作

resetAllMocks()

結局両者の違いは何なのか

参考

イベント

EVENT【4/23リモート】クラスメソッドのフリーランスエンジニア会社説明会〜AWS / システムアーキテクト案件特集〜を開催します

EVENT【5/28（火）】AWSを最大活用するための1dayカンファレンス

EVENT【5/17（金）】認証機能の開発工数削減をデモで体験！次世代認証基盤サービス『Auth0 by Okta』導入実践ウェビナー

EVENT【5/14（火）】アノテーションの中途向けオンライン会社説明会を開催します

EVENT【5/23（木）】ユースケースに学ぶAWS運用のノウハウ～可視化から統制まで～

EVENT【5/16（木）】Snowflakeを触ってみよう！初めての方向けハンズオンセミナー

EVENT【5/10（金）名古屋】クラスメソッドグループの会社説明会を開催します！

EVENT【4/25（木）リモート】Google Cloudに携わるエンジニアのキャリア～クラスメソッド会社説明会～

EVENT【4/30（火）リモート】クラスメソッドの会社説明会を開催します

EVENT【5/9（木）】組織的なクラウド統制はじめの一歩

[Jest] clearAllMocks()とresetAllMocks()の違いについて確認してみた

clearAllMocks()の動作

resetAllMocks()

結局両者の違いは何なのか

参考

イベント

EVENT【4/23リモート】クラスメソッドのフリーランスエンジニア会社説明会 〜AWS / システムアーキテクト案件特集〜 を開催します

EVENT【5/28（火）】AWSを最大活用するための1dayカンファレンス

EVENT【5/17（金）】認証機能の開発工数削減をデモで体験！次世代認証基盤サービス『Auth0 by Okta』導入実践ウェビナー

EVENT【5/14（火）】アノテーションの中途向けオンライン会社説明会を開催します

EVENT【5/23（木）】ユースケースに学ぶAWS運用のノウハウ～可視化から統制まで～

EVENT【5/16（木）】Snowflakeを触ってみよう！初めての方向けハンズオンセミナー

EVENT【5/10（金） 名古屋】クラスメソッドグループの会社説明会を開催します！

EVENT【4/25（木）リモート】Google Cloudに携わるエンジニアのキャリア～クラスメソッド会社説明会～

EVENT【4/30（火）リモート】クラスメソッドの会社説明会を開催します

EVENT【5/9（木）】組織的なクラウド統制 はじめの一歩

関連記事

環境毎にパラメーターの異なるスタックの AWS CDK スナップショットテスト（Jest）を構成する

JestのmaxWorkersをコマンドラインから確認する

【Prismaとテストシリーズ】jest-prismaでテストケースごとに隔離されたトランザクションで快適にテストできるか試してみた

Jest と Vitest で「関数内で呼び出される関数の戻り値をモックする」方法を比べてみた

EVENT【4/23リモート】クラスメソッドのフリーランスエンジニア会社説明会〜AWS / システムアーキテクト案件特集〜を開催します

EVENT【5/10（金）名古屋】クラスメソッドグループの会社説明会を開催します！

EVENT【5/9（木）】組織的なクラウド統制はじめの一歩