Playwrightで、ファイルのアップロードをテストする方法

​​Playwright​E2Eテスト,TypeScript

Playwright では、<input type="file"> に setInputFiles() でファイルを渡すと、ファイル選択のダイアログを開かずにアップロードのテストが書けます。プロフィール画像の登録や、問い合わせフォームの添付ファイルの送信が、正しく動くかを自動で確かめたいときに使います。

私は検証環境で、アップロードの欄が4種類あるページと、受け取ったファイルの名前・バイト数・SHA-256 の先頭12文字を返すサーバーを作り、テストを実行しました。送ったファイルがそのままサーバーに届いたかまで、テストの中で確かめています。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、@playwright/test 1.63.0 です。ブラウザは Playwright 用の Chromium だけで、ページは Node.js の http モジュールで書いた小さなサーバーから配信しました。Firefox・WebKit、Windows・macOS、ファイル選択のダイアログを人が操作する場合、React などのフレームワークで作った画面では試していません。ドロップの欄は drop イベントだけを送って確かめ、dragover などで欄の見た目を変える動きは試していません。

試したページとサーバー

ページには、次の4つを置きました。

  • accept="image/png" を付けた1ファイルだけの「プロフィール画像」の欄
  • multiple を付けた「添付ファイル」の欄
  • 押すと JavaScript で input を作って開く「画像を選ぶ」ボタン(画面に input がない)
  • ファイルをドロップして受け取る欄

フォームの2つの欄は、どちらも <label> で囲み、name="files" にしています。送信すると fetch で /upload に FormData を送り、サーバーの返事を role="status" の段落に出します。選んだファイルは、名前・バイト数・種類(type)を「選んだファイル」という一覧に出します。

サーバーは、Node.js に組み込みの Request で multipart/form-data を読み、届いたファイルの情報を JSON で返します。

js
const request = new Request('http://localhost' + req.url, {
  method: 'POST', headers: req.headers, body: req, duplex: 'half',
});
const form = await request.formData();
const files = [];
for (const file of form.getAll('files')) {
  if (file.name === '') continue; // 何も選んでいない input の分
  const buf = Buffer.from(await file.arrayBuffer());
  files.push({
    name: file.name, type: file.type, size: buf.length,
    sha256: createHash('sha256').update(buf).digest('hex').slice(0, 12),
  });
}

file.name === '' を飛ばしているのは、何も選んでいない欄もフォームの送信に含まれるからです。Chromium で、何も選んでいない input type="file" から FormData を作って中を見ると、名前が空で 0 バイトのファイルが1つ入っていました。

text
[ { k: 'files', name: '', size: 0, type: 'application/octet-stream' } ]

playwright.config.ts では、webServer でこのサーバー(node server.mjs)を起動し、baseURL を http://localhost:4173 にしています。テストで渡すファイルは、fixtures フォルダに置いた cat.png(78 バイト)、memo.txt(19 バイト)、list.csv(17 バイト)です。

1つのファイルを選んで送信する

基本の形は、公式ドキュメントの、ファイルをアップロードする方法の説明にあるとおりです。input を指すロケーターで setInputFiles() を呼び、ファイルのパスを渡します。

ts
import { test, expect } from '@playwright/test';
import path from 'node:path';

const fixture = (name: string) => path.join(__dirname, '..', 'fixtures', name);

test('1つのファイルを選んで送信する', async ({ page }) => {
  await page.goto('/');
  await page.getByLabel('プロフィール画像').setInputFiles(fixture('cat.png'));
  await expect(page.getByRole('list', { name: '選んだファイル' }))
    .toHaveText('cat.png (78 bytes, image/png)');

  await page.getByRole('button', { name: '送信' }).click();
  await expect(page.getByRole('status'))
    .toHaveText('アップロードしました:cat.png 78 bytes 7bad32f5ba25');
});

setInputFiles() の API リファレンスによると、ロケーターが <label> の中の要素を指しているときは、そのラベルに結びついた input が対象になります。ここでは getByLabel() で input そのものを指しています。

公式リファレンスには、相対パスを渡すと、現在の作業ディレクトリ(テストを実行した場所)から解決すると書かれています。指す先が作業ディレクトリしだいで変わらないように、パスは path.join(__dirname, ...) でテストファイルからの位置で組み立てました。

テストは通りました。サーバーが返した 7bad32f5ba25 は、sha256sum fixtures/cat.png の先頭12文字と同じでした。選んだファイルが、中身まで変わらずにサーバーへ届いています。

複数のファイルを選ぶ

multiple の付いた欄には、パスの配列を渡します。

ts
test('複数のファイルを選ぶ', async ({ page }) => {
  await page.goto('/');
  await page.getByLabel('添付ファイル').setInputFiles([fixture('memo.txt'), fixture('list.csv')]);
  await expect(page.getByRole('listitem')).toHaveText([
    'memo.txt (19 bytes, text/plain)',
    'list.csv (17 bytes, text/csv)',
  ]);
  await page.getByRole('button', { name: '送信' }).click();
  await expect(page.getByRole('status')).toContainText('memo.txt 19 bytes 51aed8ed24bd / list.csv 17 bytes dacdeeaebab0');
});

ページ側の File の type は、memo.txt が text/plain、list.csv が text/csv でした。送信後の画面は次のとおりです。

添付ファイルの欄に「2 files」と出ていて、選んだファイルの一覧に memo.txt と list.csv、その下に「アップロードしました」とサーバーが返した2つのファイルの名前・バイト数・ハッシュが出ている画面
2つのファイルを選んで送信したあとの画面

一方、multiple のない「プロフィール画像」の欄に2つのパスを渡すと、setInputFiles() は次のエラーで落ちました。

text
Error: locator.setInputFiles: Error: Non-multiple file input can only accept single file

ファイルを作らずに中身を渡す

テスト用のファイルを用意しなくても、name・mimeType・buffer を持つオブジェクトを渡せば、メモリ上の中身をファイルとして選べます。日付の入った CSV のように、テストの中で中身を組み立てたいときに便利です。

ts
test('ファイルを作らずに中身を渡す', async ({ page }) => {
  await page.goto('/');
  await page.getByLabel('添付ファイル').setInputFiles({
    name: '売上.csv',
    mimeType: 'text/csv',
    buffer: Buffer.from('date,amount\n2026-11-01,1200\n'),
  });
  await page.getByRole('button', { name: '送信' }).click();
  await expect(page.getByRole('status')).toHaveText(/売上\.csv 28 bytes/);
  console.log(await page.getByRole('status').textContent());
});

日本語のファイル名もそのままサーバーに届き、28 バイトの中身を受け取りました。

text
アップロードしました:売上.csv 28 bytes 87235a7f2c14

空の配列で選択を外す

setInputFiles([]) と空の配列を渡すと、選んだファイルが外れます。2つのファイルを選んでから外し、input.files の数と、ページで数えていた change イベントの回数を出しました。

ts
test('空の配列で選択を外す', async ({ page }) => {
  await page.goto('/');
  const input = page.getByLabel('添付ファイル');
  await input.setInputFiles([fixture('memo.txt'), fixture('list.csv')]);
  await input.setInputFiles([]);
  const count = await input.evaluate((el: HTMLInputElement) => el.files!.length);
  console.log('files.length', count, 'change events', await page.locator('body').getAttribute('data-changes'));
  await expect(page.getByRole('listitem')).toHaveCount(0);
});
text
files.length 0 change events 2

ファイルを選んだときと外したときで、change イベントが2回届きました。

accept は setInputFiles では止まらない

「プロフィール画像」の欄には accept="image/png" を付けています。ここに memo.txt を渡すと、エラーにならずに選べました。

ts
test('accept に合わないファイルを渡す', async ({ page }) => {
  await page.goto('/');
  await page.getByLabel('プロフィール画像').setInputFiles(fixture('memo.txt'));
  await expect(page.getByRole('listitem')).toHaveText('memo.txt (19 bytes, text/plain)');
});

このテストは通りました。accept が合わないファイルを Playwright が止めてくれるわけではありません。画像以外を受け付けない作りにしているなら、その確かめはページの JavaScript かサーバー側で行い、テストでは「画像以外を渡したらエラーの表示が出る」ことを確かめます。

ボタンで開くファイル選択は filechooser で受け取る

「画像を選ぶ」ボタンのように、押したときに JavaScript で input を作るページでは、ボタンを押すまでページに input がないので、setInputFiles() を呼ぶ相手がいません。ボタンに直接 setInputFiles() を呼ぶと、次のエラーで落ちました。

text
Error: locator.setInputFiles: Error: Node is not an HTMLInputElement

この場合は、公式ドキュメントにあるとおり、filechooser イベントを待ちます。ボタンを押す前に waitForEvent('filechooser') で Promise を受け取っておき、押したあとで await します。

ts
test('ボタンで開くファイル選択', async ({ page }) => {
  await page.goto('/');
  const fileChooserPromise = page.waitForEvent('filechooser');
  await page.getByRole('button', { name: '画像を選ぶ' }).click();
  const fileChooser = await fileChooserPromise;

  console.log('isMultiple()', fileChooser.isMultiple());
  console.log('accept', await fileChooser.element().getAttribute('accept'));
  await fileChooser.setFiles(fixture('cat.png'));
  await expect(page.getByRole('listitem')).toHaveText('cat.png (78 bytes, image/png)');
});
text
isMultiple() false
accept image/*

受け取った FileChooser の setFiles() は、setInputFiles() と同じ形でファイルを渡せます。element() で、ボタンが作った input も取り出せました。isMultiple() は false、accept 属性は image/* です。テストは通りました。

ドロップで受け取る欄は drop イベントを送る

ファイルをドロップして受け取る欄は、input ではないので setInputFiles() を使えません。この欄で drop イベントの dataTransfer.files を読んでいるなら、ページの中で DataTransfer を作ってファイルを入れ、dispatchEvent() で drop を送ります。DataTransfer を evaluateHandle() で作って dispatchEvent() に渡す形は、dispatchEvent() の API リファレンスの例と同じです。

ts
import { readFile } from 'node:fs/promises';

test('ドロップで受け取る場所', async ({ page }) => {
  await page.goto('/');
  const buffer = await readFile(fixture('cat.png'));
  const dataTransfer = await page.evaluateHandle(
    ({ bytes, name, type }) => {
      const dt = new DataTransfer();
      dt.items.add(new File([new Uint8Array(bytes)], name, { type }));
      return dt;
    },
    { bytes: [...buffer], name: 'cat.png', type: 'image/png' },
  );
  await page.getByText('ここにファイルをドロップ').dispatchEvent('drop', { dataTransfer });
  await expect(page.getByRole('listitem')).toHaveText('cat.png (78 bytes, image/png)');
});

ファイルの中身は、readFile() で読んだ Buffer を数の配列にしてページに渡し、ページの中で File に戻しています。テストは通り、一覧に cat.png (78 bytes, image/png) が出ました。

パスを間違えたときのエラー

存在しないパスを渡すと、ブラウザに渡る前に、Node.js のエラーで落ちました(パスは /path/to/app に置き換えています)。

text
Error: ENOENT: no such file or directory, stat '/path/to/app/fixtures/nothing.png'

ENOENT と stat が出たら、ページではなく、テストで組み立てたパスを見直します。

​Posted by 86