Menu

Next.jsでのCypressのセットアップ

Cypressは、エンドツーエンド（E2E）およびコンポーネントテストに使用されるテストランナーです。このページでは、Next.jsでCypressをセットアップし、最初のテストを作成する方法を説明します。

警告：

  • コンポーネントテストでは、Cypressは現在Next.js version 14とasyncサーバーコンポーネントをサポートしていません。これらの問題は追跡中です。現時点では、コンポーネントテストはNext.js version 13で動作し、asyncサーバーコンポーネントではE2Eテストをお勧めします。
  • Cypressバージョン13.6.3未満は、moduleResolution:"bundler"を使用するTypeScriptバージョン5をサポートしていません。ただし、この問題はCypressバージョン13.6.3以降で解決されています。cypress v13.6.3

クイックスタート

with-cypress exampleを使用して、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スクリプトフィールドに追加します：

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.jsファイルに以下の設定があることを確認します：

cypress.config.ts
import { defineConfig } from 'cypress'
 
export default defineConfig({
  e2e: {
    setupNodeEvents(on, config) {},
  },
})
cypress.config.js
const { defineConfig } = require('cypress')
 
module.exports = 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パッケージをインストールして、Cypressと併せてNext.jsの本番サーバーを実行することもできます。インストール後、package.jsonスクリプトフィールドに"test": "start-server-and-test start http://localhost:3000 cypress"を追加します。新しい変更後はアプリケーションを再ビルドすることを忘れないでください。

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

コンポーネントテストは、サーバーを起動したりアプリケーション全体をバンドルしたりせずに、特定のコンポーネントをビルドおよびマウントします。

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

cypress.config.jsファイルに以下の設定があることを確認します：

cypress.config.ts
import { defineConfig } from 'cypress'
 
export default defineConfig({
  component: {
    devServer: {
      framework: 'next',
      bundler: 'webpack',
    },
  },
})
cypress.config.js
const { defineConfig } = require('cypress')
 
module.exports = 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）

対話型テストに加えて、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と継続的インテグレーションについて、さらに詳しく学ぶためのリソースがあります：