単体テスト

単体テストは、コードの小さな部分（ユニット）を分離し、論理的に予測可能な動作をテストすることを目的としています。これは一般に、オブジェクトやサーバーの応答をモックして実際の動作をシミュレートすることを含みます。単体テストの利点としては、以下が挙げられます。

コード内のバグを迅速に発見し、分離する。
特定のコードブロックが何をすべきかを示すことで、コードの各モジュールに対するドキュメントを提供する。
リファクタリングがうまくいったかどうかの有用な指標となる。コードがリファクタリングされた後もテストは合格するはずである。

Prisma ORMのコンテキストでは、これは通常、Prisma Clientを使用してデータベース呼び出しを行う関数をテストすることを意味します。

単一のテストは、関数ロジックが異なる入力（null値や空のリストなど）をどのように処理するかを重点的に検証すべきです。

これは、テストとその環境を可能な限り軽量に保つため、外部サービスやデータベースなど、できるだけ多くの依存関係を取り除くことを目指すべきであることを意味します。

注: このブログ記事では、Prisma ORMを使用したExpressプロジェクトで単体テストを実装するための包括的なガイドが提供されています。このトピックを深く掘り下げたい場合は、ぜひ読んでみてください！

前提条件

このガイドは、プロジェクトにJavaScriptテストライブラリJestとts-jestが既にセットアップされていることを前提としています。

Prisma Clientのモック

単体テストが外部要因から分離されていることを保証するために、Prisma Clientをモックすることができます。これにより、テスト実行時にデータベースへの実際の呼び出しを行うことなく、スキーマ（型安全性）を使用できるという利点が得られます。

このガイドでは、Prisma Clientをモックする2つのアプローチ、シングルトンインスタンスと依存性注入について説明します。どちらもユースケースに応じてメリットがあります。Prisma Clientのモックを支援するために、jest-mock-extendedパッケージが使用されます。

npm install jest-mock-extended@2.0.4 --save-dev

danger

この記事執筆時点では、このガイドではjest-mock-extendedのバージョン^2.0.4を使用しています。

シングルトン

以下の手順では、シングルトンパターンを使用してPrisma Clientをモックする方法を説明します。

プロジェクトのルートにclient.tsというファイルを作成し、以下のコードを追加します。これによりPrisma Clientのインスタンスが作成されます。

client.ts
```
import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()
export default prisma
```

次に、プロジェクトのルートにsingleton.tsというファイルを作成し、以下を追加します。

singleton.ts

import { PrismaClient } from '@prisma/client'
import { mockDeep, mockReset, DeepMockProxy } from 'jest-mock-extended'

import prisma from './client'

jest.mock('./client', () => ({
  __esModule: true,
  default: mockDeep<PrismaClient>(),
}))

beforeEach(() => {
  mockReset(prismaMock)
})

export const prismaMock = prisma as unknown as DeepMockProxy<PrismaClient>

このシングルトンファイルは、Jestにデフォルトのエクスポート（./client.tsのPrisma Clientインスタンス）をモックするように指示し、jest-mock-extendedのmockDeepメソッドを使用してPrisma Clientで利用可能なオブジェクトとメソッドにアクセスできるようにします。そして、各テストが実行される前にモックされたインスタンスをリセットします。

次に、jest.config.jsファイルにsetupFilesAfterEnvプロパティを、singleton.tsファイルへのパスと共に記述します。

jest.config.js

module.exports = {
  clearMocks: true,
  preset: 'ts-jest',
  testEnvironment: 'node',
  setupFilesAfterEnv: ['<rootDir>/singleton.ts'],
}

依存性注入

もう一つのよく使われるパターンとして、依存性注入があります。

context.tsファイルを作成し、以下を追加します。

context.ts

import { PrismaClient } from '@prisma/client'
import { mockDeep, DeepMockProxy } from 'jest-mock-extended'

export type Context = {
  prisma: PrismaClient
}

export type MockContext = {
  prisma: DeepMockProxy<PrismaClient>
}

export const createMockContext = (): MockContext => {
  return {
    prisma: mockDeep<PrismaClient>(),
  }
}

tip

Prisma Clientのモックを介して循環依存エラーが表示される場合は、tsconfig.jsonに"strictNullChecks": trueを追加してみてください。

コンテキストを使用するには、テストファイルで以下のようにします。

import { MockContext, Context, createMockContext } from '../context'

let mockCtx: MockContext
let ctx: Context

beforeEach(() => {
  mockCtx = createMockContext()
  ctx = mockCtx as unknown as Context
})

これにより、createMockContext関数を介して、各テスト実行前に新しいコンテキストが作成されます。このコンテキスト（mockCtx）は、Prisma Clientへのモック呼び出しを行い、テストするクエリを実行するために使用されます。ctxコンテキストは、テスト対象のシナリオクエリを実行するために使用されます。