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

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

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

クイックスタート

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

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 ファイルで手動でロードします。詳細については、テスト環境変数を参照してください。

Jest のセットアップ（Babel を使用）

Next.js Compiler をオプトアウトして Babel を使用する場合、Jest を手動で設定し、上記のパッケージに加えて babel-jest と identity-obj-proxy をインストールする必要があります。

Next.js 用に Jest を設定するための推奨オプションを以下に示します。

module.exports = {
  collectCoverage: true,
  // on node 14.x coverage provider v8 offers good speed and more or less good report
  coverageProvider: 'v8',
  collectCoverageFrom: [
    '**/*.{js,jsx,ts,tsx}',
    '!**/*.d.ts',
    '!**/node_modules/**',
    '!<rootDir>/out/**',
    '!<rootDir>/.next/**',
    '!<rootDir>/*.config.js',
    '!<rootDir>/coverage/**',
  ],
  moduleNameMapper: {
    // Handle CSS imports (with CSS modules)
    // https://jest.dokyumento.jp/docs/webpack#mocking-css-modules
    '^.+\\.module\\.(css|sass|scss)$': 'identity-obj-proxy',
 
    // Handle CSS imports (without CSS modules)
    '^.+\\.(css|sass|scss)$': '<rootDir>/__mocks__/styleMock.js',
 
    // Handle image imports
    // https://jest.dokyumento.jp/docs/webpack#handling-static-assets
    '^.+\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$': `<rootDir>/__mocks__/fileMock.js`,
 
    // Handle module aliases
    '^@/components/(.*)$': '<rootDir>/components/$1',
 
    // Handle @next/font
    '@next/font/(.*)': `<rootDir>/__mocks__/nextFontMock.js`,
    // Handle next/font
    'next/font/(.*)': `<rootDir>/__mocks__/nextFontMock.js`,
    // Disable server-only
    'server-only': `<rootDir>/__mocks__/empty.js`,
  },
  // Add more setup options before each test is run
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
  testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/.next/'],
  testEnvironment: 'jsdom',
  transform: {
    // Use babel-jest to transpile tests with the next/babel preset
    // https://jest.dokyumento.jp/docs/configuration#transform-objectstring-pathtotransformer--pathtotransformer-object
    '^.+\\.(js|jsx|ts|tsx)$': ['babel-jest', { presets: ['next/babel'] }],
  },
  transformIgnorePatterns: [
    '/node_modules/',
    '^.+\\.module\\.(css|sass|scss)$',
  ],
}

各設定オプションの詳細については、Jest ドキュメントを参照してください。また、Next.js が Jest をどのように設定しているかを確認するために、next/jest の設定を確認することもお勧めします。

スタイルシートと画像インポートの処理

スタイルシートと画像はテストでは使用されませんが、インポートするとエラーが発生する可能性があるため、モックする必要があります。

設定で参照されているモックファイル（fileMock.js および styleMock.js）を __mocks__ ディレクトリ内に作成します。

module.exports = 'test-file-stub'

module.exports = {}

静的アセットの処理の詳細については、Jest ドキュメントを参照してください。

フォントの処理

フォントを処理するために、__mocks__ ディレクトリ内に nextFontMock.js ファイルを作成し、以下の設定を追加します。

module.exports = new Proxy(
  {},
  {
    get: function getter() {
      return () => ({
        className: 'className',
        variable: 'variable',
        style: { fontFamily: 'fontFamily' },
      })
    },
  }
)

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

プロジェクトでモジュールパスエイリアスを使用している場合、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() のような便利なカスタムマッチャーが含まれており、テストの作成が容易になります。テスト設定ファイルに以下のオプションを追加することで、すべてのテストでカスタムマッチャーをインポートできます。

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

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

import '@testing-library/jest-dom'

注意： extend-expect は v6.0 で削除されました。したがって、バージョン 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__ という名前のフォルダを作成します。

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

export default function Home() {
  return <h1>Home</h1>
}

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

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

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

注意： テストファイルは Pages Router の内部に含めるべきではありません。Pages Router 内のファイルはすべてルートとして扱われるためです。

テストを実行する

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

npm run test
# or
yarn test
# or
pnpm test

追加リソース

さらに読むために、これらのリソースが役立つ場合があります。

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