Next.jsでJestをセットアップする

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

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

クイックスタート

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

Terminal

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

手動セットアップ

Next.js 12のリリース以降、Next.jsはJestの組み込み設定を提供しています。

Jestをセットアップするには、次の依存パッケージを開発依存として追加します：

Terminal

npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# または
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# または
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
# または
yarn create jest@latest
# または
pnpm create jest@latest

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

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

jest.config.ts

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.jsの設定を読み込めるようにこの方法でエクスポートされています
export default createJestConfig(config)

jest.config.js

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

内部的に、next/jestは自動的にJestを設定します。以下が含まれます：

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

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

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

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

tsconfig.json

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

jest.config.js

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

Optional: Jest をカスタムマッチャーで拡張する

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

jest.config.ts

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

jest.config.js

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

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

jest.setup.ts

import '@testing-library/jest-dom'

jest.setup.js

import '@testing-library/jest-dom'

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

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

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

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

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
# または
yarn test
# または
pnpm test

その他のリソース

詳細については、以下のリソースが役立つでしょう：

Next.js と Jest の例
Jest のドキュメント
React Testing Library のドキュメント
Testing Playground - 要素をマッチングするためのテスト方法を学べます。