メインコンテンツまでスキップ

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

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

Good to know: asyncな Server Component は、React エコシステムにおいて新しいため、Jest では現在サポートされていません。同期の Server Component や Client Component にはユニットテストを実施できますが、asyncなコンポーネントにはE2E テストを使用することをお勧めします。

クイックスタート​

create-next-app を使用して、Next.js の with-jest の例を使って、素早く開始できます：

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/dom @testing-library/jest-dom ts-node
# or \{#or}
yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom ts-node
# or \{#or}
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
# or \{#or}
yarn create jest@latest
# or \{#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({
  // テスト環境で next.config.js と .env ファイルをロードするために Next.js アプリのパスを指定します
  dir: './',
})

// Jest に渡す任意のカスタム設定を追加します
const config: Config = {
  coverageProvider: 'v8',
  testEnvironment: 'jsdom',
  // 各テストが実行される前に追加の設定オプションを追加します
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
}

// createJestConfig は next/jest が非同期の Next.js 設定をロードできるようにこの方法でエクスポートされます
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 のロード

Good to know: 環境変数を直接テストするには、別のセットアップスクリプトまたは jest.config.ts ファイル内で手動でロードします。詳細については、テスト環境変数をご覧ください。

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

プロジェクトでモジュールパスエイリアスを使用している場合、jsconfig.json ファイルのパスオプションと 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'

Good to know: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 Docsをご覧ください。

最初のテストを作成する：​

プロジェクトはテストを実行する準備が整いました。プロジェクトのルートディレクトリに __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()
})

テストの実行​

その後、次のコマンドを実行してテストを実行します：

Terminal
npm run test
# or \{#or}
yarn test
# or \{#or}
pnpm test

その他のリソース​

さらに学びたい場合は、以下のリソースが役立つかもしれません：