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

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

Cypressはエンドツーエンド（E2E）およびコンポーネントテストのためのテストランナーです。このページでは、Next.jsでCypressをセットアップし、最初のテストを書く方法を紹介します。

警告:

  • TypeScript version 5のmoduleResolution:"bundler"を使用する場合、Cypressのバージョン13.6.3より下のバージョンはサポートしていません。ただし、この問題はCypressのバージョン13.6.3以降で解決されています。詳細はcypress v13.6.3をご覧ください。

クイックスタート​

create-next-appを使用して、with-cypressの例を利用すると迅速に始められます。

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

手動セットアップ​

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

Terminal
npm install -D cypress
# または \{#or}
yarn add -D cypress
# または \{#or}
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 Testingおよび/またはComponent Testingを設定することができます。これらのオプションのいずれかを選択すると、プロジェクトにcypress.config.jsファイルとcypressフォルダーが自動的に作成されます。

最初のCypress E2Eテストの作成​

cypress.configファイルに次の設定がされていることを確認します：

cypress.config.ts
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/')

    // href属性に"about"が含まれているリンクを探してクリック
    cy.get('a[href*="about"]').click()

    // 新しいURLには"/about"が含まれているべき
    cy.url().should('include', '/about')

    // 新しいページには"About"というh1が存在するべき
    cy.get('h1').contains('About')
  })
})

E2Eテストの実行​

Cypressはユーザーがアプリケーションをナビゲートする様子をシミュレートしますので、Next.jsサーバーが実行中である必要があります。アプリケーションがどのように動作するかをより正確に模倣するために、プロダクションコードに対してテストを実行することをお勧めします。

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

Good to know:

  • cypress.config.jsの設定ファイルにbaseUrl: 'http://localhost:3000'を追加することで、cy.visit("http://localhost:3000/")の代わりにcy.visit("/")を使用できます。
  • あるいは、Cypressと一緒にNext.jsプロダクションサーバーを実行するためにstart-server-and-testパッケージをインストールすることもできます。インストール後、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
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')
  })
})

Good to know:

  • Cypressは現在、asyncなServer Componentのコンポーネントテストをサポートしていません。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と継続的インテグレーションについて詳しくは、以下のリソースをご覧ください：