モックとフェイク

アプリケーションをテストする際、実際の実装を実行しないように特定の依存関係をモックまたはフェイクしたい場合があります。たとえば、テストを実行する際に顧客にメールを送信したり、決済ゲートウェイのようなサードパーティのサービスを呼び出したりしたくない場合です。

AdonisJSでは、依存関係をフェイク、モック、またはスタブするためのいくつかの異なるAPIと推奨事項を提供しています。

フェイクAPIの使用

フェイクは、テスト用に明示的に作成された動作する実装を持つオブジェクトです。たとえば、AdonisJSのメーラーモジュールには、テスト中に出力されるメールをメモリに収集し、それらにアサーションを書くために使用できるフェイク実装があります。

以下のコンテナサービスに対してフェイク実装を提供しています。フェイクAPIの詳細は、モジュールのドキュメントと一緒にドキュメント化されています。

依存関係の注入とフェイク

アプリケーションで依存関係の注入を使用するか、コンテナを使用してクラスのインスタンスを作成する場合、container.swapメソッドを使用してクラスのフェイク実装を提供できます。

次の例では、UserServiceをUsersControllerに注入しています。

import UserService from '#services/user_service'
import { inject } from '@adonisjs/core'

export default class UsersController {
  @inject()
  index(service: UserService) {}
}

テスト中には、UserServiceクラスの代替/フェイク実装を次のように提供できます。

import UserService from '#services/user_service'
import app from '@adonisjs/core/services/app'

test('全てのユーザーを取得する', async () => {
  // ハイライト-スタート
  class FakeService extends UserService {
    all() {
      return [{ id: 1, username: 'virk' }]
    }
  }
  
  /**
   * `UserService`を`FakeService`のインスタンスに置き換える
   */  
  app.container.swap(UserService, () => {
    return new FakeService()
  })
  
  /**
   * テストロジックをここに記述
   */
  // ハイライト-エンド
})

テストが完了したら、container.restoreメソッドを使用してフェイクを元に戻す必要があります。

app.container.restore(UserService)

// 全てを元に戻す
app.container.restore()

Sinon.jsを使用したモックとスタブ

Sinonは、Node.jsエコシステムで成熟した、時間をかけてテストされたモッキングライブラリです。モックとスタブを頻繁に使用する場合は、TypeScriptとの互換性が高いSinonをオススメします。

ネットワークリクエストのモック

アプリケーションがサードパーティのサービスに対して出力HTTPリクエストを行う場合、テスト中にnockを使用してネットワークリクエストをモックできます。

nockは、Node.jsのHTTPモジュールからのすべての出力リクエストをインターセプトするため、got、axiosなどのほとんどのサードパーティライブラリと動作します。

時間の凍結

テストの作成時に時間を凍結または移動するために、timekeeperパッケージを使用できます。timekeeperパッケージは、Dateクラスをモックすることで動作します。

次の例では、timekeeperのAPIをJapaテストリソース内にカプセル化しています。

import { getActiveTest } from '@japa/runner'
import timekeeper from 'timekeeper'

export function timeTravel(secondsToTravel: number) {
  const test = getActiveTest()
  if (!test) {
    throw new Error('Japaテストの外部で"timeTravel"を使用することはできません')
  }

  timekeeper.reset()

  const date = new Date()
  date.setSeconds(date.getSeconds() + secondsToTravel)
  timekeeper.travel(date)

  test.cleanup(() => {
    timekeeper.reset()
  })
}

テスト内でtimeTravelメソッドを以下のように使用できます。