PlaywrightのE2Eテストにはnpm run devの実行も含めるべき

PlaywrightのE2Eテストでnpm run dev

PlaywrightでE2Eテストを実行する際、テスト対象となるWebサーバーを事前に手動で起動していないでしょうか?

E2Eテストはブラウザ上で画面や操作を検証するだけでなく、Webアプリケーションの起動からテストの実行までを一連の処理として管理することをオススメします。

テストを実行する前に npm run dev を手動で実行する運用だと、起動忘れや環境による実行結果の違いが発生する可能性があります。

PlaywrightにはWebサーバーを自動的に起動・終了する仕組みが用意されているため、これを活用してE2Eテストを自己完結できるようにしましょう。

PlaywrightのwebServerを設定する

playwright.config.tsにwebServerを追加します。

playwright.config.ts
import { defineConfig } from '@playwright/test'

export default defineConfig({
  use: {
    baseURL: 'http://localhost:3000'
  },
  webServer: {
    command: 'npm run dev',
    url: 'http://localhost:3000',
    reuseExistingServer: !process.env.CI,
    stdout: 'ignore',
    stderr: 'pipe'
  }
})

これだけで、PlaywrightがE2Eテストを実行する前に npm run dev を自動実行してくれます。

また、指定したURLにアクセスできる状態になるまで待機してからテストを開始します。

テストが終了すると、Playwrightが起動したWebサーバーも自動的に終了します。

設定 説明
command Webサーバーの起動コマンド
url Webサーバーの起動確認に使用するURL
reuseExistingServer 既存のWebサーバーを再利用するか
stdout 標準出力の扱い
stderr 標準エラー出力の扱い

baseURLを設定してテストコードを簡潔にする

webServerと合わせてbaseURLを設定しておくと、テストコード内で毎回URLを指定する必要がなくなります。

index.spec.ts
import { test, expect } from '@playwright/test'

test('トップページが表示される', async ({ page }) => {
  await page.goto('/')
  await expect(page).toHaveTitle(/トップページ/)
})

child_processのspawnで起動する方法もある

Node.jsのchild_processにある spawn() を使用して、Webサーバーを起動する方法もあります。

TypeScript
const server = spawn('npm', ['run', 'dev'], { stdio: 'ignore' })

ただし、この方法だけではWebサーバーの起動完了を待機できず、テスト終了後のプロセス終了処理も必要になります。

そのため、PlaywrightのE2EテストでWebサーバーを起動する場合は、独自に spawn() でプロセス管理するよりも、標準機能のwebServerを使用するほうが簡潔で安全です。