Next.jsでのJestの設定

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

**知っておくと良い点：**`async`サーバーコンポーネントはReactエコシステムの新しい機能であるため、Jestは現在それらをサポートしていません。同期サーバーコンポーネントとクライアントコンポーネントの**単体テスト**を実行することはできますが、`async`コンポーネントには**E2Eテスト**を使用することをお勧めします。

クイックスタート

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

ターミナル

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
# 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設定ファイルを作成します。

ターミナル

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

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コンパイラを使用して`transform`を設定する
スタイルシート（`.css`、`.module.css`、およびそれらのscssバリアント）、画像インポート、および`next/font`の自動モック
`process.env`への`.env`（およびすべてのバリアント）の読み込み
テストの解決と変換からの`node_modules`の無視
テストの解決からの`.next`の無視
SWC変換を有効にするフラグに対する`next.config.js`の読み込み

**知っておくと良い点：**環境変数を直接テストするには、別の設定スクリプトまたは`jest.config.ts`ファイルで手動で読み込みます。詳細については、テスト環境変数を参照してください。

Jestの設定 (Babelを使用)

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

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

jest.config.js

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/jestの設定を確認して、Next.jsが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または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設定ファイルに次のオプションを追加することで、すべてのテストでカスタムマッチャーをインポートできます。

jest.config.ts

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

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

jest.setup.ts

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__という名前のフォルダを作成します。

たとえば、<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内に含めないでください。

テストの実行

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

ターミナル

npm run test
# or
yarn test
# or
pnpm test

追加のリソース

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

Jestを使用したNext.jsの例
Jestドキュメント
React Testing Libraryドキュメント
Testing Playground - 良いテストプラクティスを使用して要素を照合します。