logoNext.js 日本語
ドキュメントブログ学習
はじめに/アプリケーションの構築/テスト/Jest

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

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

補足: React の新しい機能である async サーバーコンポーネントは、現在 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 をセットアップするには、jest と以下のパッケージを開発依存関係としてインストールします:

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

以下のコマンドを実行して基本的な 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 で動作するために必要なすべての設定オプションが含まれています:

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'],
}

// next/jest が非同期の Next.js 設定を読み込めるようにこの方法でエクスポート
export default createJestConfig(config)
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'],
}

// next/jest が非同期の Next.js 設定を読み込めるようにこの方法でエクスポート
module.exports = createJestConfig(config)

内部的に、next/jest は以下の設定を自動的に行います:

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

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

Jest のセットアップ (Babel 使用時)

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

Next.js 用の Jest 設定の推奨オプションは以下の通りです:

jest.config.js
module.exports = {
  collectCoverage: true,
  // Node 14.x では coverage provider v8 が高速でほぼ良好なレポートを提供
  coverageProvider: 'v8',
  collectCoverageFrom: [
    '**/*.{js,jsx,ts,tsx}',
    '!**/*.d.ts',
    '!**/node_modules/**',
    '!<rootDir>/out/**',
    '!<rootDir>/.next/**',
    '!<rootDir>/*.config.js',
    '!<rootDir>/coverage/**',
  ],
  moduleNameMapper: {
    // CSS モジュールのインポートを処理
    // https://jestjs.io/docs/webpack#mocking-css-modules
    '^.+\\.module\\.(css|sass|scss)$': 'identity-obj-proxy',

    // CSS インポートを処理 (CSS モジュールなし)
    '^.+\\.(css|sass|scss)$': '<rootDir>/__mocks__/styleMock.js',

    // 画像インポートを処理
    // https://jestjs.io/docs/webpack#handling-static-assets
    '^.+\\.(png|jpg|jpeg|gif|webp|avif|ico|bmp|svg)$/i': `<rootDir>/__mocks__/fileMock.js`,

    // モジュールエイリアスを処理
    '^@/components/(.*)$': '<rootDir>/components/$1',

    // @next/font を処理
    '@next/font/(.*)': `<rootDir>/__mocks__/nextFontMock.js`,
    // next/font を処理
    'next/font/(.*)': `<rootDir>/__mocks__/nextFontMock.js`,
    // server-only を無効化
    'server-only': `<rootDir>/__mocks__/empty.js`,
  },
  // 各テストの実行前に追加のセットアップオプションを設定
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
  testPathIgnorePatterns: ['<rootDir>/node_modules/', '<rootDir>/.next/'],
  testEnvironment: 'jsdom',
  transform: {
    // next/babel プリセットでテストをトランスパイルするために babel-jest を使用
    // https://jestjs.io/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__ ディレクトリ内に作成します:

__mocks__/fileMock.js
module.exports = 'test-file-stub'
__mocks__/styleMock.js
module.exports = {}

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

フォントの処理

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

__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 を設定する必要があります。例:

tsconfig.json or jsconfig.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 設定ファイルに以下のオプションを追加します:

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

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

import '@testing-library/jest-dom'
import '@testing-library/jest-dom'

補足:v6.0 で extend-expect が削除されました。バージョン 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__ フォルダを作成します。

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

export default function Home() {
  return <h1>Home</h1>
}
__tests__/index.test.js
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()
  })
})

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

__tests__/snapshot.js
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 内のファイルはすべてルートとして扱われるためです。

テストの実行

以下のコマンドを実行してテストを実行します:

Terminal
npm run test
# or
yarn test
# or
pnpm test

追加リソース

さらに詳しく知りたい場合は、以下のリソースが役立ちます:

Vitest

Next.js で人気のあるユニットテストライブラリである Vitest と React Testing Library をセットアップする方法を学びます。

Playwright

Next.js でエンドツーエンド (E2E) テストと統合テストを行うために Playwright をセットアップする方法を学びます。