モックブラウザ API

はじめに

Playwright はほとんどのブラウザ機能にネイティブで対応しています。しかし、まだすべてのブラウザで完全にサポートされていない実験的な API や API もあります。Playwright は通常、このような場合に専用の自動化 API を提供しません。このような場合、モックを使用してアプリケーションの動作をテストできます。このガイドでは、いくつかの例を示します。

デバイスのバッテリーステータスを表示するために バッテリー API を使用する Web アプリを考えてみましょう。バッテリー API をモックし、ページがバッテリーステータスを正しく表示することを確認します。

モックの作成

ページは読み込み中に非常に早い段階で API を呼び出す可能性があるため、ページが読み込みを開始する前にすべてのモックを設定することが重要です。これを実現する最も簡単な方法は、page.addInitScript() を呼び出すことです。

await page.addInitScript(() => {
  const mockBattery = {
    level: 0.75,
    charging: true,
    chargingTime: 1800,
    dischargingTime: Infinity,
    addEventListener: () => { }
  };
  // Override the method to always return mock battery info.
  window.navigator.getBattery = async () => mockBattery;
});

これが完了したら、ページに移動して UI ステートを確認できます。

// Configure mock API before each test.
test.beforeEach(async ({ page }) => {
  await page.addInitScript(() => {
    const mockBattery = {
      level: 0.90,
      charging: true,
      chargingTime: 1800, // seconds
      dischargingTime: Infinity,
      addEventListener: () => { }
    };
    // Override the method to always return mock battery info.
    window.navigator.getBattery = async () => mockBattery;
  });
});

test('show battery status', async ({ page }) => {
  await page.goto('/');
  await expect(page.locator('.battery-percentage')).toHaveText('90%');
  await expect(page.locator('.battery-status')).toHaveText('Adapter');
  await expect(page.locator('.battery-fully')).toHaveText('00:30');
});

読み取り専用 API のモック

一部の API は読み取り専用であるため、ナビゲータープロパティに割り当てることはできません。例として、

// Following line will have no effect.
navigator.cookieEnabled = true;

しかし、プロパティが 設定可能な場合、プレーンな JavaScript を使用してオーバーライドできます。

await page.addInitScript(() => {
  Object.defineProperty(Object.getPrototypeOf(navigator), 'cookieEnabled', { value: false });
});

API 呼び出しの検証

ページが期待されるすべての API 呼び出しを行ったかどうかを確認すると便利な場合があります。すべての API メソッドの呼び出しを記録し、それをゴールデン結果と比較できます。page.exposeFunction() は、ページからテストコードにメッセージを渡すのに役立ちます。

test('log battery calls', async ({ page }) => {
  const log = [];
  // Expose function for pushing messages to the Node.js script.
  await page.exposeFunction('logCall', msg => log.push(msg));
  await page.addInitScript(() => {
    const mockBattery = {
      level: 0.75,
      charging: true,
      chargingTime: 1800,
      dischargingTime: Infinity,
      // Log addEventListener calls.
      addEventListener: (name, cb) => logCall(`addEventListener:${name}`)
    };
    // Override the method to always return mock battery info.
    window.navigator.getBattery = async () => {
      logCall('getBattery');
      return mockBattery;
    };
  });

  await page.goto('/');
  await expect(page.locator('.battery-percentage')).toHaveText('75%');

  // Compare actual calls with golden.
  expect(log).toEqual([
    'getBattery',
    'addEventListener:chargingchange',
    'addEventListener:levelchange'
  ]);
});

モックの更新

アプリがバッテリーステータスの更新を正しく反映することを確認するには、モックされたバッテリーオブジェクトがブラウザの実装と同じイベントを発火することを確認することが重要です。以下のテストは、これを実現する方法を示しています。

test('update battery status (no golden)', async ({ page }) => {
  await page.addInitScript(() => {
    // Mock class that will notify corresponding listeners when battery status changes.
    class BatteryMock {
      level = 0.10;
      charging = false;
      chargingTime = 1800;
      dischargingTime = Infinity;
      _chargingListeners = [];
      _levelListeners = [];
      addEventListener(eventName, listener) {
        if (eventName === 'chargingchange')
          this._chargingListeners.push(listener);
        if (eventName === 'levelchange')
          this._levelListeners.push(listener);
      }
      // Will be called by the test.
      _setLevel(value) {
        this.level = value;
        this._levelListeners.forEach(cb => cb());
      }
      _setCharging(value) {
        this.charging = value;
        this._chargingListeners.forEach(cb => cb());
      }
    }
    const mockBattery = new BatteryMock();
    // Override the method to always return mock battery info.
    window.navigator.getBattery = async () => mockBattery;
    // Save the mock object on window for easier access.
    window.mockBattery = mockBattery;
  });

  await page.goto('/');
  await expect(page.locator('.battery-percentage')).toHaveText('10%');

  // Update level to 27.5%
  await page.evaluate(() => window.mockBattery._setLevel(0.275));
  await expect(page.locator('.battery-percentage')).toHaveText('27.5%');
  await expect(page.locator('.battery-status')).toHaveText('Battery');

  // Emulate connected adapter
  await page.evaluate(() => window.mockBattery._setCharging(true));
  await expect(page.locator('.battery-status')).toHaveText('Adapter');
  await expect(page.locator('.battery-fully')).toHaveText('00:30');
});