Next.jsでPlaywrightをセットアップする

Playwrightは、単一のAPIでChromium、Firefox、WebKitを自動化できるテストフレームワークです。これを使用して、エンドツーエンド (E2E) テストを作成できます。このガイドでは、Next.jsでPlaywrightをセットアップし、最初のテストを作成する方法を紹介します。

クイックスタート

最も早く始めるには、create-next-appをwith-playwrightの例と一緒に使用することです。これにより、Playwrightが設定されたNext.jsプロジェクトが作成されます。

ターミナル

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

手動セットアップ

Playwrightをインストールするには、以下のコマンドを実行します

ターミナル

npm init playwright
# or
yarn create playwright
# or
pnpm create playwright

これにより、playwright.config.tsファイルの追加を含む、プロジェクトのPlaywrightのセットアップと設定のためのプロンプトが順次表示されます。詳細な手順については、Playwrightのインストールガイドを参照してください。

最初のPlaywright E2Eテストの作成

新しいNext.jsページを2つ作成します

app/page.tsx

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

app/about/page.tsx

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

次に、ナビゲーションが正しく機能していることを確認するためのテストを追加します

tests/example.spec.ts

import { test, expect } from '@playwright/test'
 
test('should navigate to the about page', async ({ page }) => {
  // Start from the index page (the baseURL is set via the webServer in the playwright.config.ts)
  await page.goto('https://:3000/')
  // Find an element with the text 'About' and click on it
  await page.click('text=About')
  // The new URL should be "/about" (baseURL is used there)
  await expect(page).toHaveURL('https://:3000/about')
  // The new page should contain an h1 with "About"
  await expect(page.locator('h1')).toContainText('About')
})

ヒント: playwright.config.ts設定ファイルに"baseURL": "https://:3000"を追加すると、page.goto("https://:3000/")の代わりにpage.goto("/")を使用できます。

Playwrightテストの実行

Playwrightは、Chromium、Firefox、Webkitの3つのブラウザを使用して、ユーザーがアプリケーションを操作する様子をシミュレートします。これにはNext.jsサーバーが実行されている必要があります。アプリケーションの動作をより正確に再現するために、本番コードに対してテストを実行することをお勧めします。

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

ヒント: または、webServer機能を使用して、Playwrightに開発サーバーを起動させ、完全に利用可能になるまで待機させることもできます。

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

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

Playwrightと継続的インテグレーションに関する詳細は、以下のリソースで学ぶことができます