跳转到主要内容

超时

Playwright Test 为各种任务提供了多个可配置的超时时间。

超时类型默认值描述
测试超时30_000 毫秒每个测试的超时时间
在配置中设置
{ timeout: 60_000 }
在测试中覆盖
test.setTimeout(120_000)
期望超时5_000 毫秒每个断言的超时时间
在配置中设置
{ expect: { timeout: 10_000 } }
在测试中覆盖
expect(locator).toBeVisible({ timeout: 10_000 })

测试超时​

Playwright Test 对每个测试强制执行一个超时时间，默认是 30 秒。测试函数、夹具设置和 beforeEach 钩子花费的时间都包含在测试超时内。

超时测试会产生以下错误

example.spec.ts:3:1 › basic test ===========================

Timeout of 30000ms exceeded.

测试函数完成后，夹具拆卸和 afterEach 钩子之间共享一个额外的独立超时，其值与测试超时相同。

相同的超时值也适用于 beforeAll 和 afterAll 钩子，但它们不与任何测试共享时间。

在配置中设置测试超时​

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

export default defineConfig({
  timeout: 120_000,
});

API 参考: testConfig.timeout。

为单个测试设置超时​

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

test('slow test', async ({ page }) => {
  test.slow(); // Easy way to triple the default timeout
  // ...
});

test('very slow test', async ({ page }) => {
  test.setTimeout(120_000);
  // ...
});

API 参考: test.setTimeout() 和 test.slow()。

从 beforeEach 钩子更改超时​

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

test.beforeEach(async ({ page }, testInfo) => {
  // Extend timeout for all tests running this hook by 30 seconds.
  testInfo.setTimeout(testInfo.timeout + 30_000);
});

API 参考: testInfo.setTimeout()。

更改 beforeAll/afterAll 钩子的超时时间​

beforeAll 和 afterAll 钩子有单独的超时时间，默认等于测试超时。您可以通过在钩子内调用 testInfo.setTimeout() 来单独更改每个钩子的超时时间。

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

test.beforeAll(async () => {
  // Set timeout for this hook.
  test.setTimeout(60000);
});

API 参考: testInfo.setTimeout()。

期望超时​

像 expect(locator).toHaveText() 这样的自动重试断言有单独的超时时间，默认是 5 秒。断言超时与测试超时无关。它会产生以下错误

example.spec.ts:3:1 › basic test ===========================

Error: expect(received).toHaveText(expected)

Expected string: "my text"
Received string: ""
Call log:
  - expect.toHaveText with timeout 5000ms
  - waiting for "locator('button')"

在配置中设置期望超时​

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

export default defineConfig({
  expect: {
    timeout: 10_000,
  },
});

API 参考: testConfig.expect。

为单个断言指定期望超时​

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

test('example', async ({ page }) => {
  await expect(locator).toHaveText('hello', { timeout: 10_000 });
});

全局超时​

Playwright Test 支持整个测试运行的超时时间。这可以防止在一切都出错时过度使用资源。没有默认的全局超时，但您可以在配置中设置一个合理的值，例如一小时。全局超时会产生以下错误

Running 1000 tests using 10 workers

  514 skipped
  486 passed
  Timed out waiting 3600s for the entire test run

您可以在配置中设置全局超时。

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

export default defineConfig({
  globalTimeout: 3_600_000,
});

API 参考: testConfig.globalTimeout。

高级: 低级超时​

这些是测试运行器预先配置的低级超时，您通常不需要更改它们。如果您碰巧因为测试不稳定而来到本节，很可能您应该在其他地方寻找解决方案。

超时类型默认值描述
动作超时无超时每个动作的超时时间
在配置中设置
{ use: { actionTimeout: 10_000 } }
在测试中覆盖
locator.click({ timeout: 10_000 })
导航超时无超时每个导航动作的超时时间
在配置中设置
{ use: { navigationTimeout: 30_000 } }
在测试中覆盖
page.goto('/', { timeout: 30_000 })
全局超时无超时整个测试运行的全局超时
在配置中设置
{ globalTimeout: 3_600_000 }
beforeAll/afterAll 超时30_000 毫秒钩子的超时时间
在钩子中设置
test.setTimeout(60_000)
夹具超时无超时单个夹具的超时时间
在夹具中设置
{ scope: 'test', timeout: 30_000 }

在配置中设置动作和导航超时​

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

export default defineConfig({
  use: {
    actionTimeout: 10 * 1000,
    navigationTimeout: 30 * 1000,
  },
});

API 参考: testOptions.actionTimeout 和 testOptions.navigationTimeout。

为单个动作设置超时​

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

test('basic test', async ({ page }) => {
  await page.goto('https://playwright.net.cn', { timeout: 30000 });
  await page.getByText('Get Started').click({ timeout: 10000 });
});

夹具超时​

默认情况下，夹具与测试共享超时。然而，对于慢速夹具，尤其是工作器范围的夹具，拥有单独的超时会很方便。这样您可以保持整体测试超时较短，并为慢速夹具提供更多时间。

example.spec.ts
import { test as base, expect } from '@playwright/test';

const test = base.extend<{ slowFixture: string }>({
  slowFixture: [async ({}, use) => {
    // ... perform a slow operation ...
    await use('hello');
  }, { timeout: 60_000 }]
});

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

API 参考: test.extend()。