跳至主要内容

测试配置

简介​

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,
  },
});
选项描述
testConfig.forbidOnly如果任何测试被标记为 test.only，是否以错误退出。在 CI 上很有用。
testConfig.fullyParallel让所有文件中的所有测试并行运行。有关详细信息，请参阅并行和分片。
testConfig.projects在多个配置或多个浏览器上运行测试
testConfig.reporter要使用的报告器。有关可用报告器的更多信息，请参阅测试报告器。
testConfig.retries每个测试的最大重试次数。有关重试的更多信息，请参阅测试重试。
testConfig.testDir包含测试文件的目录。
testConfig.use具有 use{} 的选项
testConfig.webServer要在测试期间启动服务器，请使用 webServer 选项
testConfig.workers用于并行化测试的最大并发工作进程数。也可以设置为逻辑 CPU 内核的百分比，例如 '50%'.。有关详细信息，请参阅并行和分片。

过滤测试​

通过 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',
});
选项描述
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,

});
选项描述
testConfig.globalSetup全局设置文件的路径。此文件将在所有测试之前被要求并运行。它必须导出单个函数。
testConfig.globalTeardown全局拆卸文件的路径。此文件将在所有测试之后被要求并运行。它必须导出单个函数。
testConfig.outputDir测试工件（如屏幕截图、视频、跟踪等）的文件夹。
testConfig.timeoutPlaywright 对每个测试强制执行超时，默认情况下为 30 秒。测试函数、夹具、beforeEach 和 afterEach 钩子花费的时间包含在测试超时中。

期望选项​

期望断言库的配置。

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,
    },
  },

});
选项描述
testConfig.expectWeb 首要断言（如 expect(locator).toHaveText()）默认情况下有 5 秒的单独超时。这是 expect() 等待条件满足的最大时间。了解有关测试和期望超时以及如何为单个测试设置它们。
expect(page).toHaveScreenshot()expect(locator).toHaveScreenshot() 方法的配置。
expect(value).toMatchSnapshot()expect(locator).toMatchSnapshot() 方法的配置。