ユニットテスト

ユニットテストは、コードの小さな部分 (ユニット) を分離し、論理的に予測可能な動作についてテストすることを目的としています。一般的に、現実世界の動作をシミュレートするために、オブジェクトまたはサーバーの応答をモックすることが含まれます。ユニットテストの利点には、次のようなものがあります。

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

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

危険

このガイドの執筆時点では、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 で使用可能なオブジェクトとメソッドへのアクセスを有効にします。次に、各テストの実行前にモックされたインスタンスをリセットします。

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

jest.config.js

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

依存性注入

使用できるもう 1 つの人気のあるパターンは、依存性注入です。

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>(),
  }
}

ヒント

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 コンテキストは、テスト対象のシナリオクエリを実行するために使用されます。