Playwright デバイスとブラウザシミュレーション
この章では、Playwright でモバイルデバイス、地理的位置情報、タイムゾーン、言語、カラースキームなどのブラウザ環境パラメータをシミュレートする方法を紹介します。
モバイル端末デバイスシミュレーション
Playwright には多数のデバイスプリセットが組み込まれており、さまざまなスマートフォンやタブレットのビューポート、User-Agent、タッチ操作をシミュレートできます。
devices プリセットを使用
を通じてdevicesオブジェクトを使用すると、特定のデバイスをすばやくシミュレートできます。
例
import { chromium, devices } from 'playwright';
// iPhone 15 をシミュレート
const browser = await chromium.launch();
const context = await browser.newContext(devices['iPhone 15']);
const page = await context.newPage();
await page.goto('https://www.example.com/');
// ページは iPhone 15 のビューポートと UA でレンダリングされます
// iPhone 15 をシミュレート
const browser = await chromium.launch();
const context = await browser.newContext(devices['iPhone 15']);
const page = await context.newPage();
await page.goto('https://www.example.com/');
// ページは iPhone 15 のビューポートと UA でレンダリングされます
設定ファイルでデバイスプリセットを使用:
例
// ファイルパス:playwright.config.ts
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
projects: [
{
name: 'mobile',
use: { ...devices['Pixel 7'] },
},
],
});
import { defineConfig, devices } from '@playwright/test';
export default defineConfig({
projects: [
{
name: 'mobile',
use: { ...devices['Pixel 7'] },
},
],
});
ビューポートを手動設定
完全なデバイスプリセットが不要な場合は、ビューポートサイズを手動で指定することもできます。
例
const context = await browser.newContext({
viewport: { width: 375, height: 812 }, // ビューポートサイズ
deviceScaleFactor: 3, // デバイスピクセル比(Retina ディスプレイ)
isMobile: true, // モバイルモードを有効化
hasTouch: true, // タッチ操作のシミュレーションを有効化
userAgent: 'Mozilla/5.0 ... Mobile ...', // UA をカスタマイズ
});
viewport: { width: 375, height: 812 }, // ビューポートサイズ
deviceScaleFactor: 3, // デバイスピクセル比(Retina ディスプレイ)
isMobile: true, // モバイルモードを有効化
hasTouch: true, // タッチ操作のシミュレーションを有効化
userAgent: 'Mozilla/5.0 ... Mobile ...', // UA をカスタマイズ
});
地理的位置情報のシミュレーション
Playwright はデバイスの GPS 位置情報をシミュレートできます。
例
test('北京の位置をシミュレート', async ({ context, page }) => {
// 地理的位置情報の権限を付与
await context.grantPermissions(['geolocation']);
// 具体的な緯度経度を設定(北京の座標)
await context.setGeolocation({
latitude: 39.9042,
longitude: 116.4074,
});
await page.goto('https://www.example.com/map');
// ページは北京の位置情報を取得します
});
// 地理的位置情報の権限を付与
await context.grantPermissions(['geolocation']);
// 具体的な緯度経度を設定(北京の座標)
await context.setGeolocation({
latitude: 39.9042,
longitude: 116.4074,
});
await page.goto('https://www.example.com/map');
// ページは北京の位置情報を取得します
});
タイムゾーンと言語のシミュレーション
locale と timezone を設定して、国際化とタイムゾーン関連の機能を検証します。
例
const context = await browser.newContext({
locale: 'zh-CN', // ブラウザの言語を簡体字中国語に設定
timezone: 'Asia/Shanghai', // タイムゾーンを上海(UTC+8)に設定
});
// 設定ファイルでグローバルに設定
export default defineConfig({
use: {
locale: 'en-US',
timezone: 'America/New_York',
},
});
locale: 'zh-CN', // ブラウザの言語を簡体字中国語に設定
timezone: 'Asia/Shanghai', // タイムゾーンを上海(UTC+8)に設定
});
// 設定ファイルでグローバルに設定
export default defineConfig({
use: {
locale: 'en-US',
timezone: 'America/New_York',
},
});
よく使われる locale 値:
| locale | 言語/地域 |
|---|---|
'zh-CN' | 簡体字中国語(中国) |
'zh-TW' | 繁体字中国語(台湾) |
'en-US' | 英語(アメリカ) |
'ja-JP' | 日本語 |
'ko-KR' | 韓国語 |
カラースキームのシミュレーション
ライトモードまたはダークモードをシミュレートしてテストします。prefers-color-schemeメディアクエリの効果を確認します。
例
// ダークモードをテスト
const darkContext = await browser.newContext({
colorScheme: 'dark',
});
// 指定可能な値:'light'、'dark'、'no-preference'
const darkContext = await browser.newContext({
colorScheme: 'dark',
});
// 指定可能な値:'light'、'dark'、'no-preference'
設定ファイルでプロジェクトごとに異なるカラースキームを設定:
例
// ファイルパス:playwright.config.ts
export default defineConfig({
projects: [
{
name: 'chromium-light',
use: { colorScheme: 'light' },
},
{
name: 'chromium-dark',
use: { colorScheme: 'dark' },
},
],
});
export default defineConfig({
projects: [
{
name: 'chromium-light',
use: { colorScheme: 'light' },
},
{
name: 'chromium-dark',
use: { colorScheme: 'dark' },
},
],
});
権限のシミュレーション
を使用context.grantPermissions()してブラウザの権限を付与します。
例
await context.grantPermissions([
'geolocation', // 地理的位置情報
'notifications', // 通知
'camera', // カメラ
'microphone', // マイク
'clipboard-read', // クリップボードの読み取り
'clipboard-write', // クリップボードへの書き込み
]);
// すべての権限をクリア
await context.clearPermissions();
'geolocation', // 地理的位置情報
'notifications', // 通知
'camera', // カメラ
'microphone', // マイク
'clipboard-read', // クリップボードの読み取り
'clipboard-write', // クリップボードへの書き込み
]);
// すべての権限をクリア
await context.clearPermissions();
Cookie 操作
BrowserContext を使用して、Cookie の読み取り、追加、クリアができます。
例
// Cookie を追加
await context.addCookies([
{
name: 'サンプル_session',
value: 'session_token_value',
domain: 'www.example.com',
path: '/',
httpOnly: true,
secure: true,
sameSite: 'Lax',
},
]);
// すべての Cookie を取得
const cookies = await context.cookies();
console.log(cookies);
// 特定の URL の Cookie を取得
const siteCookies = await context.cookies('https://www.example.com');
// すべての Cookie をクリア
await context.clearCookies();
await context.addCookies([
{
name: 'サンプル_session',
value: 'session_token_value',
domain: 'www.example.com',
path: '/',
httpOnly: true,
secure: true,
sameSite: 'Lax',
},
]);
// すべての Cookie を取得
const cookies = await context.cookies();
console.log(cookies);
// 特定の URL の Cookie を取得
const siteCookies = await context.cookies('https://www.example.com');
// すべての Cookie をクリア
await context.clearCookies();
Cookie パラメータの説明
| フィールド | 型 | 説明 |
|---|---|---|
name | string | Cookie 名 |
value | string | Cookie 値 |
domain | string | 適用されるドメイン |
path | string | 適用されるパス、デフォルト'/' |
expires | number | 有効期限(Unixタイムスタンプ) |
httpOnly | boolean | HTTP のみでアクセス可能かどうか |
secure | boolean | HTTPS のみで転送されるかどうか |
sameSite | string | SameSite ポリシー:'Strict' | 'Lax' | 'None' |
localStorage と SessionStorage の操作
を通じてpage.evaluate()ページコンテキストでストレージを操作します。
例
// localStorage を設定
await page.evaluate(() => {
localStorage.setItem('サンプル_key', 'サンプル_value');
});
// localStorage を読み取り
const value = await page.evaluate(() => {
return localStorage.getItem('サンプル_key');
});
console.log(value); // 'サンプル_value'
// localStorage をクリア
await page.evaluate(() => {
localStorage.clear();
});
await page.evaluate(() => {
localStorage.setItem('サンプル_key', 'サンプル_value');
});
// localStorage を読み取り
const value = await page.evaluate(() => {
return localStorage.getItem('サンプル_key');
});
console.log(value); // 'サンプル_value'
// localStorage をクリア
await page.evaluate(() => {
localStorage.clear();
});
その他の拡張Cookie と Storage の操作はすべて
page.goto()の前に完了させ、ページ読み込み時にこれらのデータを使用できるようにします。