コンテンツにスキップ
アプリケーションの構築テストJest

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を自動的にモックする
  • .env（およびすべてのバリアント）をprocess.envにロードする
  • テストの解決と変換からnode_modulesを無視する
  • テストの解決から.nextを無視する
  • SWC変換を有効にするフラグのためにnext.config.jsをロードする

知っておくと良いこと：環境変数を直接テストするには、別のセットアップスクリプトまたはjest.config.tsファイルで手動でロードします。詳細については、テスト環境変数を参照してください。

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

プロジェクトでモジュールパスエイリアスを使用している場合は、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 の中に、以下の import を追加します。

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 にテストスクリプトを追加します：

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

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 /> コンポーネントがヘッディングを正常にレンダリングするかどうかを確認するテストを追加できます。

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

テストの実行：

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

ターミナル
npm run test
# or
yarn test
# or
pnpm test

追加のリソース：

さらに詳しく知りたい場合は、以下のリソースが役立つでしょう。