Next.jsでJestを設定する

JestとReact Testing Libraryはユニットテストとスナップショットテストでよく一緒に使用されます。このガイドでは、Next.jsでJestを設定し、最初のテストを作成する方法を紹介します。

補足: async Server Componentsは React エコシステムにおいて新しいものであるため、現在Jestはそれらをサポートしていません。同期的なサーバーコンポーネントとクライアントコンポーネントに対してユニットテストを実行することは可能ですが、asyncコンポーネントにはE2Eテストを使用することをお勧めします。

クイックスタート

create-next-appとNext.jsのwith-jestサンプルを使用して、すぐに始めることができます：

Terminal

npx create-next-app@latest --example with-jest with-jest-app

手動設定

Next.js 12のリリース以降、Next.jsにはJestの組み込み設定が含まれています。

Jestを設定するには、jestと以下のパッケージを開発依存関係としてインストールします：

Terminal

npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# or
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# or
pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node

次のコマンドを実行して、基本的なJest設定ファイルを生成します：

Terminal

npm init jest@latest
# or
yarn create jest@latest
# or
pnpm create jest@latest

これによりプロジェクトのJest設定に関する一連のプロンプトが表示され、jest.config.ts|jsファイルが自動的に作成されます。

設定ファイルを更新してnext/jestを使用します。このトランスフォーマーには、JestがNext.jsで動作するために必要なすべての設定オプションが含まれています：

jest.config.ts

TypeScript

import type { Config } from 'jest'
import nextJest from 'next/jest.js'
 
const createJestConfig = nextJest({
  // テスト環境でnext.config.jsと.envファイルを読み込むためにNext.jsアプリのパスを提供します
  dir: './',
})
 
// Jestに渡すカスタム設定を追加
const config: Config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // 各テスト実行前に追加のセットアップオプションを追加
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}
 
// createJestConfigはこの方法でエクスポートされ、next/jestが非同期のNext.js設定を読み込めるようにします
export default createJestConfig(config)

内部的に、next/jestは以下を含む自動的なJest設定を行います：

Next.js Compilerを使用してtransformを設定します。
スタイルシート（.css、.module.cssおよびそのscssバリアント）、画像インポート、next/fontを自動的にモック化します。
.env（およびすべてのバリアント）をprocess.envに読み込みます。
テストの解決とトランスフォームからnode_modulesを除外します。
テストの解決から.nextを除外します。
SWCトランスフォームを有効にするフラグのためにnext.config.jsを読み込みます。

補足: 環境変数を直接テストするには、別のセットアップスクリプトまたはjest.config.tsファイルで手動で読み込む必要があります。詳細については、テスト環境変数を参照してください。

オプション：絶対インポートとモジュールパスエイリアスの処理

プロジェクトがモジュールパスエイリアスを使用している場合は、jsconfig.jsonファイルのpathsオプションとjest.config.jsファイルのmoduleNameMapperオプションを一致させて、Jestがインポートを解決できるように設定する必要があります。例：

tsconfig.json

{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "bundler",
    "baseUrl": "./",
    "paths": {
      "@/components/*": ["components/*"]
    }
  }
}

jest.config.js

moduleNameMapper: {
  // ...
  '^@/components/(.*)$': '<rootDir>/components/$1',
}

オプション：カスタムマッチャーでJestを拡張する

@testing-library/jest-domには、.toBeInTheDocument()のような便利なカスタムマッチャーのセットが含まれており、テストの記述が容易になります。Jest設定ファイルに以下のオプションを追加することで、すべてのテストでカスタムマッチャーをインポートできます：

jest.config.ts

TypeScript

setupFilesAfterEnv: ['<rootDir>/jest.setup.ts']

次に、jest.setup内に以下のインポートを追加します：

jest.setup.ts

TypeScript

import '@testing-library/jest-dom'

補足: extend-expectはv6.0で削除されました。そのため、バージョン6以前の@testing-library/jest-domを使用している場合は、代わりに@testing-library/jest-dom/extend-expectをインポートする必要があります。

各テスト前に他のセットアップオプションを追加する必要がある場合は、上記のjest.setupファイルに追加できます。

`package.json`にテストスクリプトを追加する

最後に、Jestのtestスクリプトをpackage.jsonファイルに追加します：

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "jest",
    "test:watch": "jest --watch"
  }
}

jest --watchはファイルが変更されると自動的にテストを再実行します。その他のJest CLIオプションについては、Jestのドキュメントを参照してください。

最初のテストを作成する

これでプロジェクトでテストを実行する準備が整いました。プロジェクトのルートディレクトリに__tests__というフォルダを作成します。

たとえば、<Page />コンポーネントが見出しを正常にレンダリングするかどうかを確認するテストを追加できます：

app/page.js

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

__tests__/page.test.jsx

import '@testing-library/jest-dom'
import { render, screen } from '@testing-library/react'
import Page from '../app/page'
 
describe('Page', () => {
  it('renders a heading', () => {
    render(<Page />)
 
    const heading = screen.getByRole('heading', { level: 1 })
 
    expect(heading).toBeInTheDocument()
  })
})

オプションで、コンポーネントの予期しない変更を追跡するためのスナップショットテストを追加できます：

__tests__/snapshot.js

import { render } from '@testing-library/react'
import Page from '../app/page'
 
it('renders homepage unchanged', () => {
  const { container } = render(<Page />)
  expect(container).toMatchSnapshot()
})

テストを実行する

次に、以下のコマンドを実行してテストを実行します：

Terminal

npm run test
# or
yarn test
# or
pnpm test

追加リソース

さらに詳しく学ぶために、以下のリソースが役立つでしょう：

Next.js with Jestの例
Jestのドキュメント
React Testing Libraryのドキュメント
Testing Playground - 適切なテスト手法を使用して要素をマッチさせる