測試使用選項

簡介

除了配置測試執行器之外，你還可以配置模擬、網路和錄製給 Browser 或 BrowserContext。這些選項會傳遞給 Playwright 配置中的 use: {} 物件。

基本選項

設定所有測試的基本 URL 和儲存狀態:

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    // Base URL to use in actions like `await page.goto('/')`.
    baseURL: 'http://127.0.0.1:3000',

    // Populates context with given storage state.
    storageState: 'state.json',
  },
});

Option	Description
testOptions.baseURL	用於上下文中所有頁面的基本 URL。允許僅使用路徑進行導航，例如 page.goto('/settings')。
testOptions.storageState	使用給定的存儲狀態填充上下文。對於簡單的身份驗證非常有用，了解更多。

模擬選項

使用 Playwright，你可以模擬真實設備，例如手機或平板電腦。查看我們的專案指南以獲取有關模擬設備的更多資訊。你還可以為所有測試或特定測試模擬 "geolocation"、"locale" 和 "timezone"，以及設置 "permissions" 來顯示通知或更改 "colorScheme"。查看我們的模擬指南以了解更多。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    // Emulates `'prefers-colors-scheme'` media feature.
    colorScheme: 'dark',

    // Context geolocation.
    geolocation: { longitude: 12.492507, latitude: 41.889938 },

    // Emulates the user locale.
    locale: 'en-GB',

    // Grants specified permissions to the browser context.
    permissions: ['geolocation'],

    // Emulates the user timezone.
    timezoneId: 'Europe/Paris',

    // Viewport used for all pages in the context.
    viewport: { width: 1280, height: 720 },
  },
});

Option	Description
testOptions.colorScheme	模擬 'prefers-colors-scheme' 媒體功能，支持的值有 'light'、'dark'、'no-preference'
testOptions.geolocation	上下文 geolocation
testOptions.locale	模擬 使用者的區域設置，例如 en-GB、de-DE 等
testOptions.permissions	要授予上下文中所有頁面的 permissions 列表
testOptions.timezoneId	更改上下文的 timezone
testOptions.viewport	用於上下文中所有頁面的 Viewport

網路選項

配置網絡的可用選項:

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    // Whether to automatically download all the attachments.
    acceptDownloads: false,

    // An object containing additional HTTP headers to be sent with every request.
    extraHTTPHeaders: {
      'X-My-Header': 'value',
    },

    // Credentials for HTTP authentication.
    httpCredentials: {
      username: 'user',
      password: 'pass',
    },

    // Whether to ignore HTTPS errors during navigation.
    ignoreHTTPSErrors: true,

    // Whether to emulate network being offline.
    offline: true,

    // Proxy settings used for all pages in the test.
    proxy: {
      server: 'http://myproxy.com:3128',
      bypass: 'localhost',
    },
  },
});

Option	Description
testOptions.acceptDownloads	是否自動下載所有附件，預設為 true。了解更多 關於下載的工作。
testOptions.extraHTTPHeaders	包含要隨每個請求一起發送的額外 HTTP 標頭的物件。所有標頭值必須是字串。
testOptions.httpCredentials	HTTP 認證 的憑證。
testOptions.ignoreHTTPSErrors	是否在導航期間忽略 HTTPS 錯誤。
testOptions.offline	是否模擬網路離線。
testOptions.proxy	測試中所有頁面使用的 代理設定。

note

你不需要配置任何東西來模擬網路請求。只需定義一個自訂的 Route 來模擬瀏覽器上下文的網路。請參閱我們的網路模擬指南以了解更多資訊。

錄製選項

使用 Playwright，你可以截取螢幕截圖、錄製影片以及記錄測試的追蹤。這些功能預設是關閉的，但你可以透過在 playwright.config.js 檔案中設定 screenshot、video 和 trace 選項來啟用它們。

測試輸出目錄中通常會出現追蹤檔案、截圖和影片，通常是 test-results。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    // Capture screenshot after each test failure.
    screenshot: 'only-on-failure',

    // Record trace only when retrying a test for the first time.
    trace: 'on-first-retry',

    // Record video only when retrying a test for the first time.
    video: 'on-first-retry'
  },
});

Option	Description
testOptions.screenshot	捕捉測試的截圖。選項包括 'off'、'on' 和 'only-on-failure'
testOptions.trace	Playwright 可以在執行測試時產生測試追蹤。之後，你可以打開 Trace Viewer 查看追蹤並獲取有關 Playwright 執行的詳細資訊。選項包括：'off'、'on'、'retain-on-failure' 和 'on-first-retry'
testOptions.video	Playwright 可以為你的測試錄製影片。選項包括：'off'、'on'、'retain-on-failure' 和 'on-first-retry'

其他選項

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    // Maximum time each action such as `click()` can take. Defaults to 0 (no limit).
    actionTimeout: 0,

    // Name of the browser that runs tests. For example `chromium`, `firefox`, `webkit`.
    browserName: 'chromium',

    // Toggles bypassing Content-Security-Policy.
    bypassCSP: true,

    // Channel to use, for example "chrome", "chrome-beta", "msedge", "msedge-beta".
    channel: 'chrome',

    // Run browser in headless mode.
    headless: false,

    // Change the default data-testid attribute.
    testIdAttribute: 'pw-test-id',
  },
});

Option	Description
testOptions.actionTimeout	每個 Playwright 動作的超時時間（以毫秒為單位）。預設為 0（無超時）。了解更多關於超時及如何為單個測試設定。
testOptions.browserName	執行測試的瀏覽器名稱。預設為 'chromium'。選項包括 chromium、firefox 或 webkit。
testOptions.bypassCSP	切換繞過內容安全政策（CSP）。當 CSP 包含生產來源時很有用。預設為 false。
testOptions.channel	要使用的瀏覽器頻道。了解更多關於不同瀏覽器和頻道的資訊。
testOptions.headless	是否在無頭模式下執行瀏覽器，這意味著在執行測試時不顯示瀏覽器。預設為 true。
testOptions.testIdAttribute	更改 Playwright 定位器使用的預設data-testid屬性。

更多瀏覽器和上下文選項

任何由 browserType.launch() 或 browser.newContext() 接受的選項可以分別放入 launchOptions 或 contextOptions 中的 use 部分。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    launchOptions: {
      slowMo: 50,
    },
  },
});

然而，大多數常見的選項如 headless 或 viewport 可以直接在 use 部分使用 - 請參見基本選項、模擬或網絡。

明確的上下文建立和選項繼承

如果使用內建的 browser fixture，呼叫 browser.newContext() 會建立一個繼承自配置的 context:

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    userAgent: 'some custom ua',
    viewport: { width: 100, height: 100 },
  },
});

一個範例測試說明了初始上下文選項的設定:

test('should inherit use options on context when using built-in browser fixture', async ({
  browser,
}) => {
  const context = await browser.newContext();
  const page = await context.newPage();
  expect(await page.evaluate(() => navigator.userAgent)).toBe('some custom ua');
  expect(await page.evaluate(() => window.innerWidth)).toBe(100);
  await context.close();
});

設定範圍

你可以全域、每個專案或每個測試來配置 Playwright。例如，你可以通過在 Playwright 配置的 use 選項中添加 locale 來設置全域使用的語言環境，然後使用配置中的 project 選項為特定專案覆蓋它。你也可以通過在測試文件中添加 test.use({}) 並傳入選項來為特定測試覆蓋它。

playwright.config.ts

import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    locale: 'en-GB'
  },
});

你可以使用 Playwright 設定中的 project 選項來覆蓋特定專案的選項。

import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  projects: [
    {
      name: 'chromium',
      use: {
        ...devices['Desktop Chrome'],
        locale: 'de-DE',
      },
    },
  ],
});

您可以使用 test.use() 方法並傳入選項來覆蓋特定測試文件的選項。例如，對於特定測試使用法語區域來執行測試:

import { test, expect } from '@playwright/test';

test.use({ locale: 'fr-FR' });

test('example', async ({ page }) => {
  // ...
});

在 describe 區塊內也是一樣。例如，要在 describe 區塊中以法語區域執行測試:

import { test, expect } from '@playwright/test';

test.describe('french language block', () => {

  test.use({ locale: 'fr-FR' });

  test('example', async ({ page }) => {
    // ...
  });
});