Webエンジニアの茄子です。
今回はフロントエンドテストフレームワークPlaywrightのコンポーネントテスト機能を紹介します。
コンポーネントテストとは、普通にアクセスした時の様々要素が配置されたページではなく、一つのコンポーネントだけを表示した状態をテストするものです。
一つのコンポーネントではありますが、Playwrightの機能でクリックしたりなどの操作ができ、スナップショットをとることでビジュアルリグレッションテスト（VRT）を行うことができます。
環境
node.js : 20.3.1
Next.js: 13.4.19
Playwright: 1.37.1
セットアップ
Next.js
テストするためのアプリのサンプルとして、create-next-app を使います。
npx create-next-app@latestこのような選択肢が出ます。今回はすべてデフォルトの選択肢としましたが必要があれば変えてください。
試しに、サンプルのアプリを起動してみます。
作ったディレクトリに移動して
npm run devhttp://localhost:3000 にアクセスするとこのような画面が表示されます。
Playwright
次にPlaywrightをインストールします。
init とありますが新たなプロジェクトを作るコマンドではありません。先程作ったディレクトリのプロジェクトルートでそのまま実行します。
npm init playwright@latest -- --ctコンポーネント作成
まず、テストするためのコンポーネントを作成します。
最終的には↓のようにコンポーネントごとにディレクトリがあり、中にReactの tsx ファイル、playwrightのテストファイル、snapshotディレクトリという構造にします。
今回は先程のサンプルページと、Selectを用意します。
create-next-appの現在のデフォルト Tailwind CSS を使っている場合はhttps://flowbite.com/docs/getting-started/introduction/ などから持ってくると使いやすいです。
サンプルページは Home として、page.tsxの中身をまるごと持ってきます。
app/components/Home/Home.tsx
import Image from 'next/image'
export default function Home() {
return (
<main className="flex min-h-screen flex-col items-center justify-between p-24">
<div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
<p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
Get started by editing
<code className="font-mono font-bold">app/page.tsx</code>
</p>
<div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
<a
className="pointer-events-none flex place-items-center gap-2 p-8 lg:pointer-events-auto lg:p-0"
href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
target="_blank"
rel="noopener noreferrer"
>
By{' '}
<Image
src="/vercel.svg"
alt="Vercel Logo"
className="dark:invert"
width={100}
height={24}
priority
/>
</a>
</div>
</div>
<br />
<div className="relative flex place-items-center before:absolute before:h-[300px] before:w-[480px] before:-translate-x-1/2 before:rounded-full before:bg-gradient-radial before:from-white before:to-transparent before:blur-2xl before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-[240px] after:translate-x-1/3 after:bg-gradient-conic after:from-sky-200 after:via-blue-200 after:blur-2xl after:content-[''] before:dark:bg-gradient-to-br before:dark:from-transparent before:dark:to-blue-700 before:dark:opacity-10 after:dark:from-sky-900 after:dark:via-[#0141ff] after:dark:opacity-40 before:lg:h-[360px] z-[-1]">
<Image
className="relative dark:drop-shadow-[0_0_0.3rem_#ffffff70] dark:invert"
src="/next.svg"
alt="Next.js Logo"
width={180}
height={37}
priority
/>
</div>
<div className="mb-32 grid text-center lg:max-w-5xl lg:w-full lg:mb-0 lg:grid-cols-4 lg:text-left">
<a
href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
target="_blank"
rel="noopener noreferrer"
>
<h2 className={`mb-3 text-2xl font-semibold`}>
Docs{' '}
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
->
</span>
</h2>
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
Find in-depth information about Next.js features and API.
</p>
</a>
<a
href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
target="_blank"
rel="noopener noreferrer"
>
<h2 className={`mb-3 text-2xl font-semibold`}>
Learn{' '}
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
->
</span>
</h2>
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
Learn about Next.js in an interactive course with quizzes!
</p>
</a>
<a
href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
target="_blank"
rel="noopener noreferrer"
>
<h2 className={`mb-3 text-2xl font-semibold`}>
Templates{' '}
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
->
</span>
</h2>
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
Explore the Next.js 13 playground.
</p>
</a>
<a
href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
target="_blank"
rel="noopener noreferrer"
>
<h2 className={`mb-3 text-2xl font-semibold`}>
Deploy{' '}
<span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
->
</span>
</h2>
<p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
Instantly deploy your Next.js site to a shareable URL with Vercel.
</p>
</a>
</div>
</main>
)
}
一応page.tsxの方も合わせて変更しておきます。
app/page.tsx
import Home from './components/Home/Home';
export default function HomePage() {
return (
<Home />
)
}
Selectは新たに作ります。
app/components/Select/Select.tsx
export default function Select() {
return (
<>
<select id="select-option" className="bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 focus:border-blue-500 block w-full p-2.5 max-w-xs dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400 dark:text-white dark:focus:ring-blue-500 dark:focus:border-blue-500">
<option selected>Please Select</option>
<option value="A">Option A</option>
<option value="B">Option BB</option>
<option value="C">Option C</option>
<option value="D">Option D</option>
</select>
</>
)
}
テスト作成
テストのファイルを作成します。playwrightではテストケースのことをspecといいます。それぞれ、Home.spec.tsx 、Select.spec.tsx とします。
app/components/Home/Home.spec.tsx
import { test, expect } from '@playwright/experimental-ct-react';
import React from 'react';
import Home from './Home';
test.use({ viewport: { width: 1600, height: 900 } });
test('Home Page Content', async ({ mount }) => {
const component = await mount(
<Home />
);
await expect(component).toContainText('app/page.tsx');
await expect(component).toHaveScreenshot();
});
app/components/Select/Select.spec.tsx
import { test, expect } from '@playwright/experimental-ct-react';
import React from 'react';
import Select from './Select';
test.use({ viewport: { width: 480, height: 270 } });
test('Select B option', async ({ mount }) => {
const component = await mount(
<Select />
);
await expect(component).toContainText('Please Select');
await component.selectOption("B");
await expect(component).toContainText('Option B');
await expect(component).toHaveScreenshot();
});
設定の調整
実行の前に２点ほど設定ファイルを調整します。
対象ディレクトリ・出力ファイル
export default defineConfig({
testDir: './app/components',
/* The base directory, relative to the config file, for snapshot files created with toMatchSnapshot and toHaveScreenshot. */
// snapshotDir: './__snapshots__',
snapshotPathTemplate: '{testDir}/{testFileDir}/__snapshots__/{testFileName}-{projectName}{ext}',
...
...
今回は app/components の中でそれぞれのコンポーネントのディレクトリ内にspecを置いていくので、 testDir を ./app/components に変更してください。
また、snapshotの出力先はデフォルトだと専用ディレクトリになっているのですが、これをコンポーネントそれぞれの中に変更するため snapshotDir をコメントアウトし、snapshotPathTemplate を設定します。
CSS読み込み
今回のテンプレートでは globals.css の読み込みが必要です。そういった処理は playwright/index.tsx に書くことでテスト共通で読み込めます。
import '../app/globals.css';
また、tailwind CSSをplaywrightがレンダリングする際に適用するため、tailwindcss.config.ts も変更します。
content: [
'./pages/**/*.{js,ts,jsx,tsx,mdx}',
'./components/**/*.{js,ts,jsx,tsx,mdx}',
'./app/**/*.{js,ts,jsx,tsx,mdx}',
'./playwright/**/*.{js,ts,jsx,tsx,mdx}', // ← これを追加
],
theme: {
...
テスト実行
いよいよ、テストを実行します。
npm run test-ct初回は比較するためのスクリーンショットがないので、このように toHaveScreenshot が必ず失敗します。このときスナップショットが作られ、比較する際のベースになります。
失敗後はレポート画面のサーバー起動状態になりますので、Ctrl+C で抜けてもう一回実行してください。
今度は成功すると思います。成功した場合はそのままプロンプトが戻ってきます。
変更を加えてテスト
次に、何か変更を加えたときにちゃんと失敗するかを確認します。
Homeの方は適当な場所に <br /> を入れ、Selectの方は今回 Option B を選択しているのでここを BB としてみます。
npm run test-ctを再度実行すると、失敗しレポートの画面が表示されます。
失敗したテストの一覧です。例としてwebkit(Safari)のHomeを開きます
下部にこのようにスクリーンショットが表示されます。赤いところが問題のあったところです。
Actual, Expected のタブではこのように重ねて比較できます。
本来のフローでは、この変更が意図したものであれば下記コマンドでベースのスナップショットの更新を行います。
npm run test-ct -- --update-snapshots終わりに
Playwrightのコンポーネントテストを紹介しました。experimentalではありますが、基本的な部分はできていますし、Playwrightの元々のレポートや、クロスブラウザ機能もあって使いやすいと思います。お役に立てれば幸いです。
Playwright 公式ドキュメント ： https://playwright.dev/docs/intro