Next.jsでCypressを設定する

CypressはEnd-to-End (E2E)テストとコンポーネントテストに使用されるテストランナーです。このページでは、Next.jsでCypressを設定し、最初のテストを作成する方法を紹介します。

注意:

Cypressのバージョン13.6.3未満はTypeScriptバージョン5のmoduleResolution:"bundler"をサポートしていません。ただし、この問題はCypressバージョン13.6.3以降で解決されています。cypress v13.6.3

クイックスタート

with-cypress例を使用したcreate-next-appで素早く始めることができます。

Terminal

npx create-next-app@latest --example with-cypress with-cypress-app

手動セットアップ

Cypressを手動でセットアップするには、cypressを開発依存関係としてインストールします：

Terminal

npm install -D cypress
# または
yarn add -D cypress
# または
pnpm install -D cypress

Cypressのopenコマンドをpackage.jsonのscriptsフィールドに追加します：

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint",
    "cypress:open": "cypress open"
  }
}

Cypressを初めて実行して、Cypressテストスイートを開きます：

Terminal

npm run cypress:open

E2Eテストやコンポーネントテストを設定することができます。いずれかのオプションを選択すると、自動的にcypress.config.jsファイルとcypressフォルダがプロジェクトに作成されます。

最初のCypress E2Eテストを作成する

cypress.configファイルに以下の設定があることを確認してください：

cypress.config.ts

TypeScript

import { defineConfig } from 'cypress'
 
export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {},
  },
})

次に、2つの新しいNext.jsファイルを作成します：

app/page.js

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>Home</h1>
      <Link href="/about">About</Link>
    </div>
  )
}

app/about/page.js

import Link from 'next/link'
 
export default function Page() {
  return (
    <div>
      <h1>About</h1>
      <Link href="/">Home</Link>
    </div>
  )
}

ナビゲーションが正しく機能しているかを確認するテストを追加します：

cypress/e2e/app.cy.js

describe('Navigation', () => {
  it('should navigate to the about page', () => {
    // インデックスページから開始
    cy.visit('http://localhost:3000/')
 
    // "about"を含むhref属性を持つリンクを探してクリック
    cy.get('a[href*="about"]').click()
 
    // 新しいURLには"/about"が含まれるべき
    cy.url().should('include', '/about')
 
    // 新しいページには"About"を含むh1が必要
    cy.get('h1').contains('About')
  })
})

E2Eテストを実行する

Cypressはユーザーがアプリケーションをナビゲートすることをシミュレートします。これにはNext.jsサーバーが実行されている必要があります。アプリケーションの動作をより正確に再現するために、本番コードに対してテストを実行することをお勧めします。

npm run build && npm run startを実行してNext.jsアプリケーションをビルドし、別のターミナルウィンドウでnpm run cypress:openを実行してCypressを起動し、E2Eテストスイートを実行します。

補足:

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

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

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

コンポーネントテストは、アプリケーション全体をバンドルしたりサーバーを起動したりすることなく、特定のコンポーネントをビルドしてマウントします。

Cypressアプリでコンポーネントテストを選択し、フロントエンドフレームワークとしてNext.jsを選択します。プロジェクトにcypress/componentフォルダが作成され、コンポーネントテストを有効にするためにcypress.config.jsファイルが更新されます。

cypress.configファイルに以下の設定があることを確認してください：

cypress.config.ts

TypeScript

import { defineConfig } from 'cypress'
 
export default defineConfig({
  component: {
    devServer: {
      framework: 'next',
      bundler: 'webpack',
    },
  },
})

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

cypress/component/about.cy.tsx

import Page from '../../app/page'
 
describe('<Page />', () => {
  it('should render and display expected content', () => {
    // Homeページ用のReactコンポーネントをマウント
    cy.mount(<Page />)
 
    // 新しいページには"Home"を含むh1が必要
    cy.get('h1').contains('Home')
 
    // 期待されるURLを持つリンクが存在することを検証
    // リンクの追跡はE2Eテストに適している
    cy.get('a[href="/about"]').should('be.visible')
  })
})

補足:

Cypressは現在、asyncサーバーコンポーネントのコンポーネントテストをサポートしていません。E2Eテストを使用することをお勧めします。

コンポーネントテストではNext.jsサーバーが必要ないため、サーバーの存在に依存する<Image />などの機能は標準では機能しない可能性があります。

コンポーネントテストを実行する

ターミナルでnpm run cypress:openを実行して、Cypressを起動し、コンポーネントテストスイートを実行します。

継続的インテグレーション（CI）

インタラクティブテストに加えて、cypress runコマンドを使用してCypressをヘッドレスモードで実行することもできます。これはCI環境に適しています：

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と継続的インテグレーションについて詳しく学ぶことができます：