Playwright .NETでファイルダウンロードをテストする方法|保存先・ファイル名・内容の検証
Playwrightを使用してE2Eテストを実装する場合、画面操作だけでなく、ファイルのダウンロード処理を検証したいことがあります。
例えば、WebアプリケーションからCSVやExcelファイルをダウンロードする機能では、次のような項目をテストする必要があります。
- ダウンロードが正常に開始されること
- ファイルのダウンロードが完了すること
- 指定した場所にファイルが保存されること
- ファイル名が正しいこと
- ダウンロードしたファイルの内容が正しいこと
Playwright .NETでは、WaitForDownloadAsync()やRunAndWaitForDownloadAsync()を利用することで、ダウンロードイベントを待機できます。
この記事では、C#とPlaywrightを使用して、ファイルのダウンロード処理をテストする方法を解説します。
Playwright .NETでファイルダウンロードを待機する方法
Playwrightでは、ファイルのダウンロードが開始されるとDownloadイベントが発生します。
ダウンロードをテストする場合は、ボタンをクリックする前にダウンロードイベントを待機する必要があります。
例えば、次のようなコードです。
var downloadTask = page.WaitForDownloadAsync();
await page.GetByRole(AriaRole.Button, new()
{
Name = "ダウンロード"
}).ClickAsync();
var download = await downloadTask;
ここで重要なのは、WaitForDownloadAsync()を先に呼び出していることです。
ボタンをクリックした後にダウンロードイベントを待機すると、イベントの発生タイミングによっては取得できない可能性があります。
ダウンロードを開始する操作よりも先に待機処理を登録しておきましょう。
RunAndWaitForDownloadAsyncを使用する方法
Playwright .NETには、操作とダウンロードイベントの待機をまとめて実行できるRunAndWaitForDownloadAsync()もあります。
var download = await page.RunAndWaitForDownloadAsync(
async () =>
{
await page.GetByRole(AriaRole.Button, new()
{
Name = "ダウンロード"
}).ClickAsync();
}
);
この方法では、ダウンロードを開始する操作を引数として渡します。
ダウンロードイベントの待機とボタンのクリックを一つの処理にまとめられるため、コードをシンプルにできます。
単純なダウンロードテストであれば、こちらの方法もおすすめです。
ダウンロードしたファイルを指定した場所に保存する方法
Playwrightでは、ダウンロードしたファイルを一時的な保存先に格納します。
ブラウザコンテキストを閉じると、そのコンテキストでダウンロードしたファイルは削除されます。
そのため、ダウンロードしたファイルをテストで利用する場合は、SaveAsAsync()を使用して任意の場所に保存します。
var download = await page.RunAndWaitForDownloadAsync(
async () =>
{
await page.GetByRole(AriaRole.Button, new()
{
Name = "ダウンロード"
}).ClickAsync();
}
);
var filePath = Path.Combine(
Path.GetTempPath(),
download.SuggestedFilename
);
await download.SaveAsAsync(filePath);
Path.GetTempPath()を使用すると、OSの一時ディレクトリを取得できます。
テスト専用の保存先として利用すると便利です。
SuggestedFilenameでファイル名を取得する
ダウンロードしたファイルの名前は、SuggestedFilenameプロパティで取得できます。
var fileName = download.SuggestedFilename;
Console.WriteLine(fileName);
このプロパティは、通常、HTTPレスポンスのContent-DispositionヘッダーやHTMLのdownload属性などを基に、ブラウザが決定したファイル名を返します。
例えば、ダウンロード対象のファイル名がsample.csvの場合、次のように取得できます。
var fileName = download.SuggestedFilename;
Assert.Equal("sample.csv", fileName);
これにより、ダウンロード時のファイル名が正しいことを確認できます。
ダウンロードしたファイルが存在することを確認する方法
ファイルを保存した後は、実際にファイルが存在するか確認します。
.NETのFile.Exists()を使用すると、指定したパスにファイルが存在するか判定できます。
var download = await page.RunAndWaitForDownloadAsync(
async () =>
{
await page.GetByRole(AriaRole.Button, new()
{
Name = "ダウンロード"
}).ClickAsync();
}
);
var filePath = Path.Combine(
Path.GetTempPath(),
download.SuggestedFilename
);
await download.SaveAsAsync(filePath);
Assert.True(File.Exists(filePath));
SaveAsAsync()は、ダウンロードが完了するまで待機して保存するため、別途固定時間のSleepを入れる必要はありません。
また、ファイルが存在するだけでなく、ファイルサイズも確認できます。
var fileInfo = new FileInfo(filePath);
Assert.True(fileInfo.Length > 0);
これにより、空のファイルが保存されていないかも確認できます。
ダウンロードしたCSVファイルの内容を検証する方法
ファイルの存在確認だけでは、ダウンロードされた内容が正しいかまでは分かりません。
例えば、CSVファイルをダウンロードする機能であれば、実際にファイルを読み込んで内容を検証できます。
.NETではFile.ReadAllTextAsync()を使用すると、ファイルの内容を文字列として取得できます。
var content = await File.ReadAllTextAsync(filePath);
Assert.Contains("商品名", content);
Assert.Contains("価格", content);
CSVのヘッダーやデータが正しいことを確認できます。
複数の項目を検証する場合は、次のように記述できます。
var content = await File.ReadAllTextAsync(filePath);
var lines = content.Split(
new[] { "\r\n", "\n" },
StringSplitOptions.RemoveEmptyEntries
);
Assert.Equal("商品名,価格", lines[0]);
Assert.Contains("商品A,1000", lines);
CSVの文字コードや改行コード、カンマを含む値の扱いには注意してください。
複雑なCSVを検証する場合は、CSV解析ライブラリを利用する方法もあります。
ダウンロード処理のテストコード全体
ここまでの内容をまとめると、次のようになります。
CSVファイルをダウンロードして、ファイル名、存在、内容を検証するサンプルです。
using Microsoft.Playwright;
using Xunit;
public class DownloadTests
{
[Fact]
public async Task DownloadCsvTest()
{
using var playwright = await Playwright.CreateAsync();
await using var browser =
await playwright.Chromium.LaunchAsync(
new BrowserTypeLaunchOptions
{
Headless = true
}
);
var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await page.GotoAsync("https://example.com");
var download = await page.RunAndWaitForDownloadAsync(
async () =>
{
await page.GetByRole(
AriaRole.Button,
new() { Name = "ダウンロード" }
).ClickAsync();
}
);
var fileName = download.SuggestedFilename;
Assert.Equal("sample.csv", fileName);
var filePath = Path.Combine(
Path.GetTempPath(),
Guid.NewGuid().ToString() + "_" + fileName
);
try
{
await download.SaveAsAsync(filePath);
Assert.True(File.Exists(filePath));
var content = await File.ReadAllTextAsync(filePath);
Assert.Contains("商品名", content);
Assert.Contains("価格", content);
}
finally
{
if (File.Exists(filePath))
{
File.Delete(filePath);
}
}
await context.CloseAsync();
}
}
※URL、ボタン名、ファイル名、CSVの内容はテスト対象のアプリケーションに合わせて変更してください。
このサンプルでは、一時ディレクトリにファイルを保存し、テスト終了時に削除しています。
また、GUIDをファイル名に付けることで、複数のテストが同時に実行された場合に保存先が重複することを防いでいます。
ダウンロードテストで注意したいポイント
1. ダウンロードイベントを待つ前にクリックしない
ダウンロードイベントを取得する場合は、必ずダウンロードを開始する操作より先に待機処理を登録します。
次のようなコードは避けましょう。
await page.GetByRole(
AriaRole.Button,
new() { Name = "ダウンロード" }
).ClickAsync();
var download = await page.WaitForDownloadAsync();
クリックによってダウンロードイベントが既に発生している可能性があるため、タイミングによってはタイムアウトします。
2. 固定時間のSleepを使用しない
ダウンロードの完了を待つために、次のようなコードを書く必要はありません。
await page.WaitForTimeoutAsync(5000);
固定時間で待機すると、環境やファイルサイズによってテストが不安定になります。
RunAndWaitForDownloadAsync()とSaveAsAsync()を利用すれば、ダウンロードイベントと保存処理の完了を待つことができます。
3. ダウンロードしたファイルはブラウザ終了前に保存する
Playwrightが管理する一時的なダウンロードファイルは、ブラウザコンテキストを閉じると削除されます。
そのため、後からファイルを検証する場合は、コンテキストを閉じる前にSaveAsAsync()で別の場所に保存しておきましょう。
4. 複数のテストで同じ保存先を使用しない
E2Eテストを並列実行する場合、固定のファイル名で保存すると、複数のテストが同じファイルを上書きする可能性があります。
今回のサンプルのようにGUIDを利用するか、テストケースごとに専用のディレクトリを作成する方法がおすすめです。
まとめ
Playwright .NETでは、RunAndWaitForDownloadAsync()を利用することで、ダウンロードを開始する操作とダウンロードイベントの待機をまとめて実行できます。
また、SaveAsAsync()を利用すれば、ダウンロードしたファイルを任意の場所に保存できます。
今回紹介した主なAPIは次のとおりです。
| API | 用途 |
|---|---|
| RunAndWaitForDownloadAsync() | 操作とダウンロード待機をまとめて実行 |
| WaitForDownloadAsync() | ダウンロードイベントを待機 |
| SuggestedFilename | ダウンロード時のファイル名を取得 |
| SaveAsAsync() | 指定した場所にファイルを保存 |
| File.Exists() | ファイルの存在確認 |
| File.ReadAllTextAsync() | ファイル内容の読み込み |
ファイルダウンロード機能のE2Eテストでは、ダウンロードが開始されたことだけでなく、保存先、ファイル名、ファイルの内容まで確認すると、より確実なテストを実装できます。
