TestConfig

Playwright Test 提供了许多选项来配置如何收集和执行测试，例如 timeout 或 testDir。这些选项在 TestConfig 对象中的配置文件中进行了描述。此类型描述了配置文件的格式，要在运行时访问已解析的配置参数，请使用 FullConfig。

Playwright Test 支持同时运行多个测试项目。项目特定的选项应放在 testConfig.projects 中，但顶级的 TestConfig 也可以定义所有项目之间共享的基础选项。

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  timeout: 30000,
  globalTimeout: 600000,
  reporter: 'list',
  testDir: './tests',
});

属性

build

添加于: v1.35

testConfig.build

Playwright 转译器配置。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  build: {
    external: ['**/*bundle.js'],
  },
});

类型

对象
- external Array<string> (可选)
  
  从转译中排除的路径，表示为 glob 模式列表。通常，你的测试使用的重型 JS 包在此处列出。

captureGitInfo

添加于: v1.51

testConfig.captureGitInfo

这些设置控制是否捕获 git 信息并存储在配置 testConfig.metadata 中。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  captureGitInfo: { commit: true, diff: true }
});

类型

对象
- commit boolean (可选)
  
  是否捕获提交和拉取请求信息，例如哈希值、作者、时间戳。
- diff boolean (可选)
  
  是否捕获提交差异。

详情

当你想在 HTML（或第三方）报告中看到 commit 信息时，捕获它是很有用的。
捕获 diff 信息对于使用实际的源差异来丰富报告很有用。此信息可用于提供有关如何修复测试的智能建议。

注意

这些设置的默认值取决于环境。当测试作为 CI 的一部分运行时，可以安全地获取 git 信息，默认值为 true，否则为 false。

注意

git 提交元数据的结构可能会发生变化。

expect

添加于: v1.10

testConfig.expect

expect 断言库的配置。了解更多关于各种超时的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  expect: {
    timeout: 10000,
    toMatchSnapshot: {
      maxDiffPixels: 10,
    },
  },
});

类型

对象
- timeout number (可选)
  
  异步 expect 匹配器的默认超时时间，以毫秒为单位，默认为 5000 毫秒。
- toHaveScreenshot Object (可选)
  - animations "allow" | "disabled" (可选)
    
    请参阅 animations in page.screenshot()。默认为 "disabled"。
  - caret "hide" | "initial" (可选)
    
    请参阅 caret in page.screenshot()。默认为 "hide"。
  - maxDiffPixels number (可选)
    
    可以接受的不同像素数量，默认未设置。
  - maxDiffPixelRatio number (可选)
    
    不同像素与总像素量的可接受比率，介于 0 和 1 之间，默认未设置。
  - scale "css" | "device" (可选)
    
    请参阅 scale in page.screenshot()。默认为 "css"。
  - stylePath string | Array<string> (可选)
    
    请参阅 style in page.screenshot()。
  - threshold number (可选)
    
    比较图像中相同像素之间可接受的感知颜色差异，范围从 0（严格）到 1（宽松）。"pixelmatch" 比较器计算 YIQ 色彩空间中的颜色差异，并将默认 threshold 值设置为 0.2。
  - pathTemplate string (可选)
    
    控制屏幕截图位置的模板。有关详细信息，请参阅 testConfig.snapshotPathTemplate。
  expect(page).toHaveScreenshot() 方法的配置。
- toMatchAriaSnapshot Object (可选)
  - pathTemplate string (可选)
    
    控制 aria 快照位置的模板。有关详细信息，请参阅 testConfig.snapshotPathTemplate。
  expect(locator).toMatchAriaSnapshot() 方法的配置。
- toMatchSnapshot Object (可选)
  - maxDiffPixels number (可选)
    
    可以接受的不同像素数量，默认未设置。
  - maxDiffPixelRatio number (可选)
    
    不同像素与总像素量的可接受比率，介于 0 和 1 之间，默认未设置。
  - threshold number (可选)
    
    比较图像中相同像素之间可接受的感知颜色差异，范围从 0（严格）到 1（宽松）。"pixelmatch" 比较器计算 YIQ 色彩空间中的颜色差异，并将默认 threshold 值设置为 0.2。
  expect(value).toMatchSnapshot() 方法的配置。
- toPass Object (可选)
  - intervals Array<number> (可选)
    
    toPass 方法的探测间隔，以毫秒为单位。
  - timeout number (可选)
    
    toPass 方法的超时时间，以毫秒为单位。
  expect(value).toPass() 方法的配置。

forbidOnly

添加于: v1.10

testConfig.forbidOnly

如果任何测试或组被标记为 test.only() 或 test.describe.only()，是否退出并报错。在 CI 上很有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  forbidOnly: !!process.env.CI,
});

类型

boolean

fullyParallel

添加于: v1.20

testConfig.fullyParallel

Playwright Test 并行运行测试。为了实现这一点，它运行多个 worker 进程，这些进程同时运行。默认情况下，测试文件是并行运行的。单个文件中的测试按顺序在同一个 worker 进程中运行。

你可以配置整个测试运行，以使用此选项并发执行所有文件中的所有测试。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  fullyParallel: true,
});

类型

boolean

globalSetup

添加于: v1.10

testConfig.globalSetup

全局 setup 文件的路径。此文件将在所有测试之前被 require 并运行。它必须导出一个接受 FullConfig 参数的单个函数。传递路径数组以指定多个全局 setup 文件。

了解更多关于全局 setup 和 teardown的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalSetup: './global-setup',
});

类型

string | Array<string>

globalTeardown

添加于: v1.10

testConfig.globalTeardown

全局 teardown 文件的路径。此文件将在所有测试之后被 require 并运行。它必须导出一个单个函数。另请参阅 testConfig.globalSetup。传递路径数组以指定多个全局 teardown 文件。

了解更多关于全局 setup 和 teardown的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalTeardown: './global-teardown',
});

类型

string | Array<string>

globalTimeout

添加于: v1.10

testConfig.globalTimeout

整个测试套件可以运行的最长时间，以毫秒为单位。零超时（默认值）禁用此行为。在 CI 上很有用，可以防止损坏的 setup 运行时间过长并浪费资源。了解更多关于各种超时的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  globalTimeout: process.env.CI ? 60 * 60 * 1000 : undefined,
});

类型

number

grep

添加于: v1.10

testConfig.grep

筛选器，仅运行标题与其中一个模式匹配的测试。例如，传递 grep: /cart/ 应仅运行标题中带有 "cart" 的测试。也可在命令行中使用 -g 选项。正则表达式将针对由项目名称、测试文件名、test.describe 名称（如果有）、测试名称和测试标签（以空格分隔）组成的字符串进行测试，例如 chromium my-test.spec.ts my-suite my-test。

grep 选项对于标记测试也很有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  grep: /smoke/,
});

类型

RegExp | Array<RegExp>

grepInvert

添加于: v1.10

testConfig.grepInvert

筛选器，仅运行标题不与其中一个模式匹配的测试。这与 testConfig.grep 相反。也可在命令行中使用 --grep-invert 选项。

grepInvert 选项对于标记测试也很有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  grepInvert: /manual/,
});

类型

RegExp | Array<RegExp>

ignoreSnapshots

添加于: v1.26

testConfig.ignoreSnapshots

是否跳过快照期望，例如 expect(value).toMatchSnapshot() 和 await expect(page).toHaveScreenshot()。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  ignoreSnapshots: !process.env.CI,
});

类型

boolean

maxFailures

添加于: v1.10

testConfig.maxFailures

整个测试套件运行的最大测试失败次数。达到此数字后，测试将停止并退出并报错。设置为零（默认值）禁用此行为。

也可在命令行中使用 --max-failures 和 -x 选项。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  maxFailures: process.env.CI ? 1 : 0,
});

类型

number

metadata

添加于: v1.10

testConfig.metadata

元数据包含要包含在报告中的键值对。例如，HTML 报告将以键值对的形式显示它，JSON 报告将包含序列化为 json 的元数据。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  metadata: { title: 'acceptance tests' },
});

类型

元数据

name

添加于: v1.10

testConfig.name

配置名称在报告和测试执行期间可见，除非被 testProject.name 覆盖。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  name: 'acceptance tests',
});

类型

string

outputDir

添加于: v1.10

testConfig.outputDir

测试执行期间创建的文件的输出目录。默认为 <package.json-directory>/test-results。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  outputDir: './test-results',
});

类型

string

详情

此目录在启动时被清除。运行测试时，会在 testConfig.outputDir 内创建一个唯一的子目录，保证并行运行的测试不会冲突。此目录可以通过 testInfo.outputDir 和 testInfo.outputPath() 访问。

这是一个使用 testInfo.outputPath() 创建临时文件的示例。

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

test('example test', async ({}, testInfo) => {
  const file = testInfo.outputPath('temporary-file.txt');
  await fs.promises.writeFile(file, 'Put some data to the file', 'utf8');
});

preserveOutput

添加于: v1.10

testConfig.preserveOutput

是否在 testConfig.outputDir 中保留测试输出。默认为 'always'。

'always' - 为所有测试保留输出；
'never' - 不为任何测试保留输出；
'failures-only' - 仅为失败的测试保留输出。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  preserveOutput: 'always',
});

类型

"always" | "never" | "failures-only"

projects

添加于: v1.10

testConfig.projects

Playwright Test 支持同时运行多个测试项目。有关更多信息，请参阅 TestProject。

用法

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

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

类型

Array<TestProject>

quiet

添加于: v1.10

testConfig.quiet

是否禁止来自测试的 stdio 和 stderr 输出。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  quiet: !!process.env.CI,
});

类型

boolean

repeatEach

添加于: v1.10

testConfig.repeatEach

重复每个测试的次数，对于调试不稳定的测试很有用。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  repeatEach: 3,
});

类型

number

reportSlowTests

添加于: v1.10

testConfig.reportSlowTests

是否报告慢速测试文件。传递 null 以禁用此功能。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reportSlowTests: null,
});

类型

null | Object
- max number
  
  要报告的慢速测试文件的最大数量。默认为 5。
- threshold number
  
  被认为是慢速的测试文件持续时间，以毫秒为单位。默认为 5 分钟。

详情

持续时间超过 threshold 毫秒的测试文件被认为是慢速文件，并且会报告最慢的文件，不超过 max 个。将 max 传递为零会报告所有超过阈值的测试文件。

reporter

添加于: v1.10

testConfig.reporter

要使用的报告器列表。每个报告器可以是

内置报告器名称，例如 'list' 或 'json'。
模块名称，例如 'my-awesome-reporter'。
报告器的相对路径，例如 './reporters/my-awesome-reporter.js'。

你可以将选项传递给元组中的报告器，例如 ['json', { outputFile: './report.json' }]。

在报告器指南中了解更多信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: 'line',
});

类型

string | Array<Object> | "list" | "dot" | "line" | "github" | "json" | "junit" | "null" | "html"
- 0 string
  
  报告器名称或模块或文件路径
- 1 Object
  
  带有报告器选项的对象（如果有）

respectGitIgnore

添加于: v1.45

testConfig.respectGitIgnore

在搜索测试文件时，是否跳过 .gitignore 中的条目。默认情况下，如果未显式指定 testConfig.testDir 和 testProject.testDir，Playwright 将忽略与 .gitignore 条目匹配的任何测试文件。

用法

testConfig.respectGitIgnore

类型

boolean

retries

添加于: v1.10

testConfig.retries

为失败的测试提供的最大重试次数。默认情况下，不会重试失败的测试。了解更多关于测试重试的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  retries: 2,
});

类型

number

shard

添加于: v1.10

testConfig.shard

分片测试并仅执行选定的分片。以从一开始的格式指定，例如 { total: 5, current: 2 }。

了解更多关于使用 Playwright Test 进行并行和分片的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  shard: { total: 10, current: 3 },
});

类型

null | Object
- current number
  
  要执行的分片索引，从一开始。
- total number
  
  分片总数。

snapshotPathTemplate

添加于: v1.28

testConfig.snapshotPathTemplate

此选项配置一个模板，用于控制由 expect(page).toHaveScreenshot()、expect(locator).toMatchAriaSnapshot() 和 expect(value).toMatchSnapshot() 生成的快照的位置。

你可以在 testConfig.expect 中为每个断言单独配置模板。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests',

  // Single template for all assertions
  snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}',

  // Assertion-specific templates
  expect: {
    toHaveScreenshot: {
      pathTemplate: '{testDir}/__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
    },
    toMatchAriaSnapshot: {
      pathTemplate: '{testDir}/__snapshots__/{testFilePath}/{arg}{ext}',
    },
  },
});

类型

string

详情

该值可能包含一些 "tokens"，这些 "tokens" 将在测试执行期间替换为实际值。

考虑以下文件结构

playwright.config.ts
tests/
└── page/
    └── page-click.spec.ts

以及以下使用 toHaveScreenshot() 调用的 page-click.spec.ts

page-click.spec.ts
import { test, expect } from '@playwright/test';

test.describe('suite', () => {
  test('test should work', async ({ page }) => {
    await expect(page).toHaveScreenshot(['foo', 'bar', 'baz.png']);
  });
});

支持的 tokens 列表

{arg} - 相对快照路径不带扩展名。这来自传递给 toHaveScreenshot()、toMatchAriaSnapshot() 或 toMatchSnapshot() 的参数；如果在没有参数的情况下调用，这将是一个自动生成的快照名称。
- 值: foo/bar/baz
{ext} - 快照扩展名（带有前导点）。
- 值: .png
{platform} - process.platform 的值。
{projectName} - 项目的文件系统安全名称（如果有）。
- 值: '' (空字符串)。
{snapshotDir} - 项目的 testProject.snapshotDir。
- 值: /home/playwright/tests (由于未在配置中提供 snapshotDir，因此默认为 testDir)
{testDir} - 项目的 testProject.testDir。
- 值: /home/playwright/tests (绝对路径，因为 testDir 是相对于配置目录解析的)
{testFileDir} - 从 testDir 到测试文件的相对路径中的目录。
- 值: page
{testFileName} - 带有扩展名的测试文件名。
- 值: page-click.spec.ts
{testFilePath} - 从 testDir 到测试文件的相对路径。
- 值: page/page-click.spec.ts
{testName} - 文件系统安全的测试标题，包括父 describe，但不包括文件名。
- 值: suite-test-should-work

每个 token 前面可以有一个字符，该字符仅在此 token 具有非空值时使用。

考虑以下配置

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  snapshotPathTemplate: '__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
  testMatch: 'example.spec.ts',
  projects: [
    { use: { browserName: 'firefox' } },
    { name: 'chromium', use: { browserName: 'chromium' } },
  ],
});

在此配置中

第一个项目没有名称，因此其快照将存储在 <configDir>/__screenshots__/example.spec.ts/... 中。
第二个项目有名称，因此其快照将存储在 <configDir>/__screenshots__/chromium/example.spec.ts/.. 中。
由于 snapshotPathTemplate 解析为相对路径，因此它将相对于 configDir 解析。
正斜杠 "/" 可用作任何平台上的路径分隔符。

testDir

添加于: v1.10

testConfig.testDir

将递归扫描测试文件的目录。默认为配置文件所在的目录。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests/playwright',
});

类型

string

testIgnore

添加于: v1.10

testConfig.testIgnore

与这些模式之一匹配的文件不会作为测试文件执行。匹配是针对绝对文件路径执行的。字符串被视为 glob 模式。

例如，'**/test-assets/**' 将忽略 test-assets 目录中的任何文件。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testIgnore: '**/test-assets/**',
});

类型

string | RegExp | Array<string | RegExp>

testMatch

添加于: v1.10

testConfig.testMatch

只有与这些模式之一匹配的文件才会作为测试文件执行。匹配是针对绝对文件路径执行的。字符串被视为 glob 模式。

默认情况下，Playwright 查找与以下 glob 模式匹配的文件：**/*.@(spec|test).?(c|m)[jt]s?(x)。这表示带有 ".test" 或 ".spec" 后缀的 JavaScript 或 TypeScript 文件，例如 login-screen.wrong-credentials.spec.ts。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testMatch: /.*\.e2e\.js/,
});

类型

string | RegExp | Array<string | RegExp>

timeout

添加于: v1.10

testConfig.timeout

每个测试的超时时间，以毫秒为单位。默认为 30 秒。

这是所有测试的基本超时。此外，每个测试都可以使用 test.setTimeout() 配置自己的超时。了解更多关于各种超时的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  timeout: 5 * 60 * 1000,
});

类型

number

tsconfig

添加于: v1.49

testConfig.tsconfig

适用于所有导入文件的单个 tsconfig 的路径。默认情况下，会单独查找每个导入文件的 tsconfig。请注意，加载配置文件或其任何依赖项时，tsconfig 属性不起作用。当指定 --tsconfig 命令行选项时，将被忽略。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  tsconfig: './tsconfig.test.json',
});

类型

string

updateSnapshots

添加于: v1.10

testConfig.updateSnapshots

是否使用测试运行产生的实际结果更新预期快照。默认为 'missing'。

'all' - 所有执行的测试都将更新快照。
'changed' - 所有执行的测试都将更新不匹配的快照。匹配的快照将不会更新。
'missing' - 创建缺失的快照，例如，当编写新测试并首次运行时。这是默认设置。
'none' - 不更新任何快照。

了解更多关于快照的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  updateSnapshots: 'missing',
});

类型

"all" | "changed" | "missing" | "none"

updateSourceMethod

添加于: v1.50

testConfig.updateSourceMethod

定义如何在源代码中更新快照。

'patch' - 创建一个统一差异文件，可用于稍后更新源代码。这是默认设置。
'3way' - 在源代码中生成合并冲突标记。这允许用户手动选择相关更改，就像他们在 IDE 中解决合并冲突一样。
'overwrite' - 使用新的快照值覆盖源代码。

用法

testConfig.updateSourceMethod

类型

"overwrite" | "3way" | "patch"

use

添加于: v1.10

testConfig.use

所有测试的全局选项，例如 testOptions.browserName。了解更多关于配置的信息，并查看可用选项。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    browserName: 'chromium',
  },
});

类型

TestOptions

webServer

添加于: v1.10

testConfig.webServer

在测试期间启动一个（或多个）开发 Web 服务器。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  webServer: {
    command: 'npm run start',
    url: 'https://127.0.0.1:3000',
    timeout: 120 * 1000,
    reuseExistingServer: !process.env.CI,
  },
  use: {
    baseURL: 'https://127.0.0.1:3000/',
  },
});

现在您可以在导航页面时使用相对路径

test.spec.ts
import { test } from '@playwright/test';

test('test', async ({ page }) => {
  // This will result in https://127.0.0.1:3000/foo
  await page.goto('/foo');
});

可以启动多个 Web 服务器（或后台进程）

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  webServer: [
    {
      command: 'npm run start',
      url: 'https://127.0.0.1:3000',
      timeout: 120 * 1000,
      reuseExistingServer: !process.env.CI,
    },
    {
      command: 'npm run backend',
      url: 'https://127.0.0.1:3333',
      timeout: 120 * 1000,
      reuseExistingServer: !process.env.CI,
    }
  ],
  use: {
    baseURL: 'https://127.0.0.1:3000',
  },
});

类型

Object | Array<Object>
- command string
  
  启动的 Shell 命令。例如 npm run start。
- cwd string (可选)
  
  衍生进程的当前工作目录，默认为配置文件目录。
- env Object<string, string> (可选)
  
  为命令设置的环境变量，默认为 process.env。
- ignoreHTTPSErrors boolean (可选)
  
  在获取 url 时是否忽略 HTTPS 错误。默认为 false。
- port number (可选)
  
  您的 HTTP 服务器预期出现的端口。它会等待直到接受连接。应指定 port 或 url 之一。
- reuseExistingServer boolean (可选)
  
  如果为 true，则在 port 或 url 可用时，它将重用现有服务器。如果在该 port 或 url 上没有服务器运行，它将运行命令来启动新服务器。如果为 false，则如果现有进程正在监听 port 或 url，则会抛出错误。这通常应设置为 !process.env.CI，以便在本地运行测试时允许本地开发服务器。
- stdout "pipe" | "ignore" (可选)
  
  如果为 "pipe"，它会将命令的 stdout 管道传输到进程 stdout。如果为 "ignore"，它将忽略命令的 stdout。默认为 "ignore"。
- stderr "pipe" | "ignore" (可选)
  
  是否将命令的 stderr 管道传输到进程 stderr 或忽略它。默认为 "pipe"。
- timeout number (可选)
  
  等待进程启动并可用的最长时间（以毫秒为单位）。默认为 60000。
- gracefulShutdown Object (可选)
  - signal "SIGINT" | "SIGTERM"
  - timeout number
  如何关闭进程。如果未指定，进程组将被强制 SIGKILL 终止。如果设置为 { signal: 'SIGTERM', timeout: 500 }，则进程组将收到 SIGTERM 信号，如果它在 500 毫秒内未退出，则会收到 SIGKILL 信号。您也可以使用 SIGINT 作为信号。0 超时时间表示不会发送 SIGKILL。Windows 不支持 SIGTERM 和 SIGINT 信号，因此在 Windows 上会忽略此选项。请注意，关闭 Docker 容器需要 SIGTERM。
- url string (可选)
  
  您的 HTTP 服务器上的 URL，当服务器准备好接受连接时，预期返回 2xx、3xx、400、401、402 或 403 状态代码。重定向（3xx 状态代码）将被跟踪，并检查新位置。应指定 port 或 url 之一。

详情

如果指定了端口，Playwright Test 将等待端口在 127.0.0.1 或 ::1 上可用，然后再运行测试。如果指定了 URL，Playwright Test 将等待 URL 返回 2xx、3xx、400、401、402 或 403 状态代码，然后再运行测试。

对于持续集成，您可能希望使用 reuseExistingServer: !process.env.CI 选项，该选项在 CI 上不使用现有服务器。要查看 stdout，您可以设置 DEBUG=pw:webserver 环境变量。

port（但不是 url）作为 testOptions.baseURL 传递给 Playwright。例如，端口 8080 生成等于 https://127.0.0.1:8080 的 baseURL。如果 webServer 被指定为一个数组，您必须显式配置 baseURL（即使它只有一个条目）。

注意

还建议在配置中指定 testOptions.baseURL，以便测试可以使用相对 URL。

workers

添加于: v1.10

testConfig.workers

用于并行化测试的最大并发 worker 进程数。也可以设置为逻辑 CPU 核心数的百分比，例如 '50%'。

Playwright Test 使用 worker 进程来运行测试。始终至少有一个 worker 进程，但可以使用更多进程来加快测试执行速度。

默认为逻辑 CPU 核心数的一半。了解更多关于 Playwright Test 的并行和分片的信息。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  workers: 3,
});

类型

number | string

Deprecated

snapshotDir

添加于: v1.10

testConfig.snapshotDir

不推荐使用

使用 testConfig.snapshotPathTemplate 来配置快照路径。

基本目录，相对于配置文件，用于使用 toMatchSnapshot 创建的快照文件。默认为 testConfig.testDir。

用法

playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  snapshotDir: './snapshots',
});

类型

string

详情

每个测试的目录可以通过 testInfo.snapshotDir 和 testInfo.snapshotPath() 访问。

此路径将作为每个测试文件快照目录的基本目录。将 snapshotDir 设置为 'snapshots'，testInfo.snapshotDir 将解析为 snapshots/a.spec.js-snapshots。

属性​

build​

captureGitInfo​

expect​

forbidOnly​

fullyParallel​

globalSetup​

globalTeardown​

globalTimeout​

grep​

grepInvert​

ignoreSnapshots​

maxFailures​

metadata​

name​

outputDir​

preserveOutput​

projects​

quiet​

repeatEach​

reportSlowTests​

reporter​

respectGitIgnore​

retries​

shard​

snapshotPathTemplate​

testDir​

testIgnore​

testMatch​

timeout​

tsconfig​

updateSnapshots​

updateSourceMethod​

use​

webServer​

workers​

Deprecated​

snapshotDir​

属性

build

captureGitInfo

expect

forbidOnly

fullyParallel

globalSetup

globalTeardown

globalTimeout

grep

grepInvert

ignoreSnapshots

maxFailures

metadata

name

outputDir

preserveOutput

projects

quiet

repeatEach

reportSlowTests

reporter

respectGitIgnore

retries

shard

snapshotPathTemplate

testDir

testIgnore

testMatch

timeout

tsconfig

updateSnapshots

updateSourceMethod

use

webServer

workers

Deprecated

snapshotDir