Next.js で Jest を設定する方法

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

備考: async Server Components は React エコシステムに新しいため、Jest は現在サポートしていません。同期 Server Components および Client Components の単体テストは実行できますが、async コンポーネントにはE2Eテストを使用することをお勧めします。

クイックスタート

Next.js with-jest の例を使用して、create-next-app で Next.js をすぐに使い始めることができます。

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

手動セットアップ

Next.js 12 のリリース以降、Next.js は Jest の組み込み構成をサポートするようになりました。

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

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

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

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

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

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

import type { Config } from 'jest'
import nextJest from 'next/jest.js'
 
const createJestConfig = nextJest({
  // Provide the path to your Next.js app to load next.config.js and .env files in your test environment
  dir: './',
})
 
// Add any custom config to be passed to Jest
const config: Config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // Add more setup options before each test is run
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}
 
// createJestConfig is exported this way to ensure that next/jest can load the Next.js config which is async
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 がインポートを解決できるように設定する必要があります。例:

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

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

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

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

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

次に、jest.setup 内で次のインポートを追加します。

import '@testing-library/jest-dom'

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

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

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

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

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

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

最初のテストを作成する

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

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

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

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

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

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

テストを実行する

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

npm run test
# or
yarn test
# or
pnpm test

追加リソース

さらに詳しい情報については、これらのリソースが役立つかもしれません。

Next.js with Jest の例
Jest ドキュメント
React Testing Library ドキュメント
Testing Playground - 要素を照合するために優れたテストプラクティスを使用します。