測試設定

簡介

Playwright 有許多選項可以配置你的測試如何執行。你可以在配置文件中指定這些選項。注意，測試執行器選項是頂層的，不要將它們放入 use 部分。

基本配置

以下是一些最常見的配置選項。

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

export default defineConfig({
  // Look for test files in the "tests" directory, relative to this configuration file.
  testDir: 'tests',

  // Run all tests in parallel.
  fullyParallel: true,

  // Fail the build on CI if you accidentally left test.only in the source code.
  forbidOnly: !!process.env.CI,

  // Retry on CI only.
  retries: process.env.CI ? 2 : 0,

  // Opt out of parallel tests on CI.
  workers: process.env.CI ? 1 : undefined,

  // Reporter to use
  reporter: 'html',

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

    // Collect trace when retrying the failed test.
    trace: 'on-first-retry',
  },
  // Configure projects for major browsers.
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },
  ],
  // Run your local dev server before starting the tests.
  webServer: {
    command: 'npm run start',
    url: 'http://127.0.0.1:3000',
    reuseExistingServer: !process.env.CI,
  },
});

Option	Description
testConfig.forbidOnly	如果任何測試標記為 test.only，是否以錯誤退出。對 CI 有用。
testConfig.fullyParallel	讓所有檔案中的所有測試平行執行。查看 Parallelism 和 Sharding 以了解更多詳情。
testConfig.projects	在多個配置或多個瀏覽器上執行測試
testConfig.reporter	使用的報告器。查看 Test Reporters 以了解更多可用的報告器。
testConfig.retries	每個測試的最大重試次數。查看 Test Retries 以了解更多關於重試的資訊。
testConfig.testDir	測試檔案所在的目錄。
testConfig.use	帶有 use{} 的選項
testConfig.webServer	要在測試期間啟動伺服器，請使用 webServer 選項
testConfig.workers	用於平行化測試的最大並行工作程序數。也可以設置為邏輯 CPU 核心的百分比，例如 '50%'。查看 Parallelism 和 Sharding 以了解更多詳情。

過濾測試

篩選測試依據 glob 模式或正則表達式。

playwright.config.ts

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

export default defineConfig({
  // Glob patterns or regular expressions to ignore test files.
  testIgnore: '*test-assets',

  // Glob patterns or regular expressions that match test files.
  testMatch: '*todo-tests/*.spec.ts',
});

Option	Description
testConfig.testIgnore	應該在尋找測試檔案時忽略的 Glob 模式或正則表達式。例如，'*test-assets'
testConfig.testMatch	匹配測試檔案的 Glob 模式或正則表達式。例如，'*todo-tests/*.spec.ts'。預設情況下，Playwright 執行 .*(test|spec).(js|ts|mjs) 檔案。

進階設定

playwright.config.ts

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

export default defineConfig({
  // Folder for test artifacts such as screenshots, videos, traces, etc.
  outputDir: 'test-results',

  // path to the global setup files.
  globalSetup: require.resolve('./global-setup'),

  // path to the global teardown files.
  globalTeardown: require.resolve('./global-teardown'),

  // Each test is given 30 seconds.
  timeout: 30000,

});

Option	Description
testConfig.globalSetup	全域設定檔案的路徑。此檔案將在所有測試之前被要求並執行。它必須匯出一個函式。
testConfig.globalTeardown	全域拆卸檔案的路徑。此檔案將在所有測試之後被要求並執行。它必須匯出一個函式。
testConfig.outputDir	測試工件的資料夾，例如截圖、影片、追蹤等。
testConfig.timeout	Playwright 為每個測試強制執行一個超時，預設為30秒。測試函式、fixtures、beforeEach 和 afterEach hooks 所花費的時間都包含在測試超時內。

預期選項

配置 expect 斷言函式庫。

playwright.config.ts

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

export default defineConfig({
  expect: {
    // Maximum time expect() should wait for the condition to be met.
    timeout: 5000,

    toHaveScreenshot: {
      // An acceptable amount of pixels that could be different, unset by default.
      maxDiffPixels: 10,
    },

    toMatchSnapshot: {
      // An acceptable ratio of pixels that are different to the
      // total amount of pixels, between 0 and 1.
      maxDiffPixelRatio: 0.1,
    },
  },

});

Option	Description
testConfig.expect	Web first assertions like expect(locator).toHaveText() 有一個預設為 5 秒的單獨超時時間。這是 expect() 應等待條件滿足的最長時間。了解更多關於 test and expect timeouts 以及如何為單個測試設置它們。
expect(page).toHaveScreenshot()	expect(locator).toHaveScreenshot() 方法的配置。
expect(value).toMatchSnapshot()	expect(locator).toMatchSnapshot() 方法的配置。