テスト

サンプル

Next.js で一般的に使用されるテストツールのセットアップ方法を学びます: CypressPlaywrightJest と React Testing Library

Cypress

Cypress は エンドツーエンド (E2E) テストコンポーネントテスト に使用されるテストランナーです。

クイックスタート

with-cypress サンプル を使用して create-next-app で素早く開始できます。

ターミナル
npx create-next-app@latest --example with-cypress with-cypress-app

手動セットアップ

Cypress を開始するには、cypress パッケージをインストールします:

ターミナル
npm install --save-dev cypress

Cypress を package.json の scripts フィールドに追加します:

package.json
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "cypress:open": "cypress open"
  }
}

初めて Cypress を実行して、推奨のフォルダ構造を使用したサンプルを生成します:

ターミナル
npm run cypress:open

生成されたサンプルと Cypress ドキュメントの「最初のテストを書く」セクション を見て、Cypress に慣れることができます。

E2E テストとコンポーネントテストの使い分け

Cypress ドキュメントにはガイド があり、これら2種類のテストの違いと、それぞれをいつ使用するのが適切かが説明されています。

最初の Cypress E2E テストを作成

以下の2つの Next.js ページを想定します:

pages/index.js
import Link from 'next/link'

export default function Home() {
  return (
    <nav>
      <h1>ホームページ</h1>
      <Link href="/about">About</Link>
    </nav>
  )
}
pages/about.js
export default function About() {
  return (
    <div>
      <h1>About ページ</h1>
      <Link href="/">ホームページ</Link>
    </div>
  )
}

ナビゲーションが正しく動作することを確認するテストを追加します:

cypress/e2e/app.cy.js
describe('ナビゲーション', () => {
  it('about ページに遷移する', () => {
    // インデックスページから開始
    cy.visit('http://localhost:3000/')

    // "about" を含む href 属性のリンクを見つけてクリック
    cy.get('a[href*="about"]').click()

    // 新しい URL は "/about" を含むべき
    cy.url().should('include', '/about')

    // 新しいページは "About Page" という h1 を含むべき
    cy.get('h1').contains('About Page')
  })
})

cypress.config.js 設定ファイルに baseUrl: 'http://localhost:3000' を追加すれば、cy.visit("http://localhost:3000/") の代わりに cy.visit("/") を使用できます。

最初の Cypress コンポーネントテストを作成

コンポーネントテストは、アプリケーション全体をバンドルしたりサーバーを起動したりせずに、特定のコンポーネントをビルドしてマウントします。これにより、よりパフォーマンスの高いテストが可能になりながらも、視覚的なフィードバックと Cypress E2E テストで使用される同じ API を提供します。

知っておくと良い: コンポーネントテストは Next.js サーバーを起動しないため、<Image />getServerSideProps など、サーバーが利用可能であることに依存する機能はデフォルトでは機能しません。これらの機能をコンポーネントテスト内で動作させる例については、Cypress Next.js ドキュメント を参照してください。

前のセクションと同じコンポーネントを想定して、コンポーネントが期待される出力をレンダリングしていることを検証するテストを追加します:

pages/about.cy.js
import AboutPage from './about.js'

describe('<AboutPage />', () => {
  it('期待されるコンテンツをレンダリングして表示する', () => {
    // About ページの React コンポーネントをマウント
    cy.mount(<AboutPage />)

    // 新しいページは "About Page" という h1 を含むべき
    cy.get('h1').contains('About Page')

    // 期待される URL のリンクが存在することを検証
    // *リンクの追跡* は E2E テストに適している
    cy.get('a[href="/"]').should('be.visible')
  })
})

Cypress テストの実行

E2E テスト

Cypress E2E テストは実際の Next.js アプリケーションをテストするため、Cypress を開始する前に Next.js サーバーが実行されている必要があります。アプリケーションの動作により近い形でテストするために、本番コードに対してテストを実行することを推奨します。

npm run buildnpm run start を実行し、別のターミナルウィンドウで npm run cypress -- --e2e を実行して Cypress を起動し、E2E テストスイートを実行します。

知っておくと良い: 代わりに start-server-and-test パッケージをインストールして package.json の scripts フィールドに追加できます: "test": "start-server-and-test start http://localhost:3000 cypress" とすると、Next.js 本番サーバーを Cypress と同時に起動できます。変更後はアプリケーションを再ビルドすることを忘れないでください。

コンポーネントテスト

npm run cypress -- --component を実行して Cypress を起動し、コンポーネントテストスイートを実行します。

継続的インテグレーション (CI) の準備

これまで Cypress を実行するとインタラクティブなブラウザが開きましたが、これは CI 環境には理想的ではありません。cypress run コマンドを使用してヘッドレスで Cypress を実行することもできます:

package.json
{
  "scripts": {
    //...
    "e2e": "start-server-and-test dev http://localhost:3000 \"cypress open --e2e\"",
    "e2e:headless": "start-server-and-test dev http://localhost:3000 \"cypress run --e2e\"",
    "component": "cypress open --component",
    "component:headless": "cypress run --component"
  }
}

Cypress と継続的インテグレーションについて詳しくは、以下のリソースを参照してください:

Playwright

Playwright は、Chromium、Firefox、WebKit を単一の API で自動化できるテストフレームワークです。すべてのプラットフォームで エンドツーエンド (E2E) テスト統合テスト を記述するために使用できます。

クイックスタート

最も速く始める方法は、with-playwright サンプル を使用して create-next-app を実行することです。これにより、Playwright がすべてセットアップされた Next.js プロジェクトが作成されます。

ターミナル
npx create-next-app@latest --example with-playwright with-playwright-app

手動セットアップ

既存の NPM プロジェクトに Playwright を追加するには、npm init playwright も使用できます。

Playwright を手動で開始するには、@playwright/test パッケージをインストールします:

ターミナル
npm install --save-dev @playwright/test

Playwright を package.json の scripts フィールドに追加します:

package.json
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test:e2e": "playwright test"
  }
}

最初の Playwright エンドツーエンドテストを作成

以下の2つの Next.js ページを想定します:

pages/index.js
import Link from 'next/link'

export default function Home() {
  return (
    <nav>
      <Link href="/about">About</Link>
    </nav>
  )
}
pages/about.js
export default function About() {
  return (
    <div>
      <h1>About ページ</h1>
    </div>
  )
}

ナビゲーションが正しく動作することを確認するテストを追加します:

import { test, expect } from '@playwright/test'

test('about ページに遷移する', async ({ page }) => {
  // インデックスページから開始 (baseURL は playwright.config.ts の webServer で設定)
  await page.goto('http://localhost:3000/')
  // 'About' というテキストの要素を見つけてクリック
  await page.click('text=About')
  // 新しい URL は "/about" になる (baseURL が使用される)
  await expect(page).toHaveURL('http://localhost:3000/about')
  // 新しいページは "About Page" という h1 を含む
  await expect(page.locator('h1')).toContainText('About Page')
})
import { test, expect } from '@playwright/test'

test('about ページに遷移する', async ({ page }) => {
  // インデックスページから開始 (baseURL は playwright.config.ts の webServer で設定)
  await page.goto('http://localhost:3000/')
  // 'About' というテキストの要素を見つけてクリック
  await page.click('text=About')
  // 新しい URL は "/about" になる (baseURL が使用される)
  await expect(page).toHaveURL('http://localhost:3000/about')
  // 新しいページは "About Page" という h1 を含む
  await expect(page.locator('h1')).toContainText('About Page')
})

playwright.config.ts 設定ファイルに "baseURL": "http://localhost:3000" を追加すれば、page.goto("http://localhost:3000/") の代わりに page.goto("/") を使用できます。

Playwright テストの実行

Playwright は実際の Next.js アプリケーションをテストするため、Playwright を開始する前に Next.js サーバーが実行されている必要があります。アプリケーションの動作により近い形でテストするために、本番コードに対してテストを実行することを推奨します。

npm run buildnpm run start を実行し、別のターミナルウィンドウで npm run test:e2e を実行して Playwright テストを実行します。

知っておくと良い: 代わりに webServer 機能を使用して、Playwright に開発サーバーを起動させ、完全に利用可能になるまで待機させることもできます。

継続的インテグレーション (CI) での Playwright の実行

Playwright はデフォルトでテストを ヘッドレスモード で実行します。すべての Playwright 依存関係をインストールするには、npx playwright install-deps を実行します。

Playwright と継続的インテグレーションについて詳しくは、以下のリソースを参照してください:

Jest と React Testing Library

Jest と React Testing Library は、ユニットテスト で頻繁に一緒に使用されます。Next.js アプリケーション内で Jest を使用するには、次の3つの方法があります:

  1. クイックスタートサンプル の1つを使用する
  2. Next.js Rust コンパイラ を使用する
  3. Babel を使用する

以下のセクションでは、これらの各オプションで Jest をセットアップする方法について説明します:

クイックスタート

with-jest サンプルを使用して create-next-app を実行すると、Jest と React Testing Library で素早く開始できます:

ターミナル
npx create-next-app@latest --example with-jest with-jest-app

Jest のセットアップ (Rust コンパイラを使用)

Next.js 12 のリリース以降、Next.js には Jest のための組み込み設定が含まれています。

Jest をセットアップするには、jestjest-environment-jsdom@testing-library/react@testing-library/jest-dom をインストールします:

ターミナル
npm install --save-dev jest jest-environment-jsdom @testing-library/react @testing-library/jest-dom

プロジェクトのルートディレクトリに jest.config.mjs ファイルを作成し、以下を追加します:

jest.config.mjs
import nextJest from 'next/jest.js'

const createJestConfig = nextJest({
  // テスト環境で next.config.js と .env ファイルを読み込むために Next.js アプリのパスを提供
  dir: './',
})

// Jest に渡すカスタム設定を追加
/** @type {import('jest').Config} */
const config = {
  // 各テストの実行前に追加のセットアップオプションを設定
  // setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],

  testEnvironment: 'jest-environment-jsdom',
}

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

内部的に、next/jest は自動的に Jest を設定します。これには以下が含まれます:

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

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

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

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

以下は、Next.js用にJestを設定するための推奨オプションです:

jest.config.js
module.exports = {
  collectCoverage: true,
  // Node 14.xでは、カバレッジプロバイダーv8が高速でほぼ良好なレポートを提供します
  coverageProvider: 'v8',
  collectCoverageFrom: [
    '**/*.{js,jsx,ts,tsx}',
    '!**/*.d.ts',
    '!**/node_modules/**',
    '!<rootDir>/out/**',
    '!<rootDir>/.next/**',
    '!<rootDir>/*.config.js',
    '!<rootDir>/coverage/**',
  ],
  moduleNameMapper: {
    // CSSモジュールを使用した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',
  },
  // 各テスト実行前に追加のセットアップオプションを追加
  // 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のドキュメントを参照してください。

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

スタイルシートと画像はテストでは使用されませんが、インポートするとエラーが発生する可能性があるため、モック化する必要があります。上記の設定で参照されているモックファイルfileMock.jsstyleMock.js__mocks__ディレクトリ内に作成します:

__mocks__/fileMock.js
module.exports = {
  src: '/img.jpg',
  height: 24,
  width: 24,
  blurDataURL: 'data:image/png;base64,imagedata',
}
__mocks__/styleMock.js
module.exports = {}

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

オプション:カスタムマッチャーでJestを拡張

@testing-library/jest-domには、.toBeInTheDocument()などの便利なカスタムマッチャーが含まれており、テストの作成が容易になります。すべてのテストにカスタムマッチャーをインポートするには、Jest設定ファイルに次のオプションを追加します:

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

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

jest.setup.js
import '@testing-library/jest-dom'

v6.0extend-expectが削除されました。バージョン6より前の@testing-library/jest-domを使用している場合は、代わりに@testing-library/jest-dom/extend-expectをインポートする必要があります。

各テスト前に追加のセットアップオプションを追加する必要がある場合は、上記のjest.setup.jsファイルに追加するのが一般的です。

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

プロジェクトでモジュールパスエイリアスを使用している場合、jsconfig.jsonファイルのpathsオプションとjest.config.jsファイルのmoduleNameMapperオプションを一致させるようにJestを設定する必要があります。例えば:

tsconfig.json or jsconfig.json
{
  "compilerOptions": {
    "module": "esnext",
    "moduleResolution": "node",
    "baseUrl": "./",
    "paths": {
      "@/components/*": ["components/*"]
    }
  }
}
jest.config.js
moduleNameMapper: {
  '^@/components/(.*)$': '<rootDir>/components/$1',
}

テストの作成:

package.jsonにテストスクリプトを追加

package.jsonのスクリプトにウォッチモードのJest実行可能ファイルを追加します:

package.json
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "test": "jest --watch"
  }
}

jest --watchは、ファイルが変更されたときにテストを再実行します。Jest CLIのその他のオプションについては、Jestのドキュメントを参照してください。

最初のテストを作成

プロジェクトはテストを実行する準備が整いました。Jestの規約に従って、プロジェクトのルートディレクトリにある__tests__フォルダにテストを追加します。

例えば、<Home />コンポーネントがヘッダーを正常にレンダリングするかどうかをチェックするテストを追加できます:

__tests__/index.test.js
import { render, screen } from '@testing-library/react'
import Home from '../pages/index'
import '@testing-library/jest-dom'

describe('Home', () => {
  it('renders a heading', () => {
    render(<Home />)

    const heading = screen.getByRole('heading', {
      name: /welcome to next\.js!/i,
    })

    expect(heading).toBeInTheDocument()
  })
})

オプションで、スナップショットテストを追加して、<Home />コンポーネントの予期しない変更を追跡できます:

__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を実行してテストスイートを実行します。テストが合格または不合格になった後、追加のテストを追加する際に役立つインタラクティブなJestコマンドのリストが表示されます。

さらなる学習のために、以下のリソースが役立つかもしれません:

コミュニティパッケージと例

Next.jsコミュニティが作成したパッケージや記事が役立つかもしれません:

次に読むべき情報については、以下をお勧めします:

  • pages/basic-features/environment-variables#test-environment-variables