非同期処理の例

まず、はじめにガイドに記載されているように、JestでBabelのサポートを有効にします。

APIからユーザーデータを取得してユーザー名を返すモジュールを実装してみましょう。

user.js

import request from './request';

export function getUserName(userID) {
  return request(`/users/${userID}`).then(user => user.name);
}

上記の実装では、request.jsモジュールがPromiseを返すことを期待しています。 thenを呼び出してユーザー名を受け取ります。

ネットワークにアクセスしてユーザーデータを取得するrequest.jsの実装を考えてみましょう。

request.js

const http = require('http');

export default function request(url) {
  return new Promise(resolve => {
    // This is an example of an http request, for example to fetch
    // user data from an API.
    // This module is being mocked in __mocks__/request.js
    http.get({path: url}, response => {
      let data = '';
      response.on('data', _data => (data += _data));
      response.on('end', () => resolve(data));
    });
  });
}

テストでネットワークにアクセスしたくないため、__mocks__フォルダ（フォルダは大文字と小文字が区別されるため、__MOCKS__は機能しません）にrequest.jsモジュールの手動モックを作成します。次のようなものになります。

__mocks__/request.js

const users = {
  4: {name: 'Mark'},
  5: {name: 'Paul'},
};

export default function request(url) {
  return new Promise((resolve, reject) => {
    const userID = parseInt(url.slice('/users/'.length), 10);
    process.nextTick(() =>
      users[userID]
        ? resolve(users[userID])
        : reject({
            error: `User with ${userID} not found.`,
          }),
    );
  });
}

それでは、非同期機能のテストを作成しましょう。

__tests__/user-test.js

jest.mock('../request');

import * as user from '../user';

// The assertion for a promise must be returned.
it('works with promises', () => {
  expect.assertions(1);
  return user.getUserName(4).then(data => expect(data).toBe('Mark'));
});

jest.mock('../request')を呼び出して、Jestに手動モックを使用するように指示します。 itは、解決されるPromiseが返されることを期待します。最後にPromiseを返す限り、好きなだけPromiseをチェーンしていつでもexpectを呼び出すことができます。

.resolves

resolvesを使用すると、冗長性を減らし、他のマッチャーと一緒に履行されたPromiseの値をunwrapできます。Promiseが拒否された場合、アサーションは失敗します。

it('works with resolves', () => {
  expect.assertions(1);
  return expect(user.getUserName(5)).resolves.toBe('Paul');
});

async/await

async/await構文を使用してテストを作成することもできます。以前と同じ例を記述する方法は次のとおりです。

// async/await can be used.
it('works with async/await', async () => {
  expect.assertions(1);
  const data = await user.getUserName(4);
  expect(data).toBe('Mark');
});

// async/await can also be used with `.resolves`.
it('works with async/await and resolves', async () => {
  expect.assertions(1);
  await expect(user.getUserName(5)).resolves.toBe('Paul');
});

プロジェクトでasync/awaitを有効にするには、@babel/preset-envをインストールし、babel.config.jsファイルでこの機能を有効にします。

エラー処理

エラーは.catchメソッドを使用して処理できます。必ずexpect.assertionsを追加して、特定の数のアサーションが呼び出されていることを確認してください。そうでないと、履行されたPromiseはテストに失敗しません。

// Testing for async errors using Promise.catch.
it('tests error with promises', () => {
  expect.assertions(1);
  return user.getUserName(2).catch(error =>
    expect(error).toEqual({
      error: 'User with 2 not found.',
    }),
  );
});

// Or using async/await.
it('tests error with async/await', async () => {
  expect.assertions(1);
  try {
    await user.getUserName(1);
  } catch (error) {
    expect(error).toEqual({
      error: 'User with 1 not found.',
    });
  }
});

.rejects

.rejectsヘルパーは、.resolvesヘルパーと同様に機能します。Promiseが履行された場合、テストは自動的に失敗します。 expect.assertions(number)は必須ではありませんが、テスト中に特定の数のアサーションが呼び出されることを確認するために推奨されます。そうでなければ、.resolvesアサーションをreturn/awaitすることを忘れがちです。

// Testing for async errors using `.rejects`.
it('tests error with rejects', () => {
  expect.assertions(1);
  return expect(user.getUserName(3)).rejects.toEqual({
    error: 'User with 3 not found.',
  });
});

// Or using async/await with `.rejects`.
it('tests error with async/await and rejects', async () => {
  expect.assertions(1);
  await expect(user.getUserName(3)).rejects.toEqual({
    error: 'User with 3 not found.',
  });
});

この例のコードは、examples/asyncにあります。

setTimeoutなどのタイマーをテストする場合は、タイマーモックのドキュメントを参照してください。