Reduxにおける同期的／非同期的なAction Creatorをテストする

基礎からはじめるReact入門 第12回

　前回はJestを用いて、同期的な処理であるReducerのテストを行う方法を学びました。今回はAction Creatorのテストについて解説します。同期的な処理のテストだけではなく、一歩踏み込んだ、非同期処理を伴うAction Creatorをテストする方法についても学ぶことを目的とします。

対象読者

• JavaScriptとWeb開発の基礎に理解がある方
• Reactに興味／関心があり、これから学び始める方

前提環境

　筆者の検証環境は以下の通りです。

• macOS High Sierra 10.13.3
• Node.js v10.4.1／npm 6.1.0
• React 16.4.1
• redux 4.0.0
• react-redux 5.0.7
• jest 20.0.4（react-scripts 1.1.4内）

Action Creatorをテストする

　Action Creatorは、Reduxの重要なパーツとして、Reducerに並び立つ概念です。前回はReducerの自動テストを扱いましたが、Action Creatorもテストしたい存在ですね。今回はAction Creatorのテストについて解説します。

　Action Creatorとは、狭義では「dispatch関数に渡すActionオブジェクトを生成するための関数」です。Actionオブジェクトを生成するだけであれば、同期的な処理を行う関数なので、基本的な方針はReducerと同じになります。つまり、関数を実行した結果の戻り値を検査すればよいのです。これなら簡単そうですね。

　その一方で広義では、Action Creatorにはredux-thunkやasync/awaitを活用した、非同期処理を伴ったスタイルも存在します。これは同期的な処理と同じように解決するわけにはいきません。

　本記事では、同期的なAction Creatorと非同期的なAction Creator、それぞれについて方針を解説していきます。

同期的なAction Creatorをテストする

　それではまず、同期的なAction Creatorのテストの書き方について解説します。リスト1に第8回で取り上げたカウンターアプリをテストする例を示します。

［リスト1］src/actions/counter.test.js

import * as actions from "./counter";

describe("increment()", () => {
  test("+1のActionを作成できる", () => {
    // 条件
    const amount = 1;
    // テスト対象の処理を実行する
    const actual = actions.increment(amount); // (1)
    // 処理結果が期待したものになっているかを検証する
    expect(actual).toEqual({ // (2)
      type: "INCREMENT",
      payload: {
        amount: 1
      }
    });
  });
});

　まず、テスト対象の関数を実行して、戻り値を受け取ります（1）。その後、expect関数を使って、意図した値が返ってきているかどうかを検証します（2）。なお、筆者の好みとして、describeはテスト対象のAction Creator関数ごとに作成しています（リスト2）。

［リスト2］describeはテスト対象の関数ごとに作る

import * as actions from "./counter";

describe("increment()", () => {
  test("+1のActionを作成できる", () => {...});
  test("+5のActionを作成できる", () => {...});
});
describe("decrement()", () => {
  test("-1のActionを作成できる", () => {...});
  test("-5のActionを作成できる", () => {...});
});
describe("reset()", () => {
  test("リセットのActionを作成できる", () => {...});
});

　以上の通り、条件や検証対象の見た目は少し違うものの、考え方としてはReducerのテストとかなり近いといってよいでしょう。