7.8 KiB
id | title |
---|---|
test-timeouts | Timeouts |
Playwright Test has multiple configurable timeouts for various tasks.
Timeout | Default | Description |
---|---|---|
Test timeout | 30000 ms | Timeout for each test, includes test, hooks and fixtures: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set default { <span style={{textTransform: 'uppercase',fontSize: 'smaller', fontWeight: 'bold', opacity: '0.6'}}>Override test.setTimeout(120000) |
Expect timeout | 5000 ms | Timeout for each assertion: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set default { <span style={{textTransform: 'uppercase',fontSize: 'smaller', fontWeight: 'bold', opacity: '0.6'}}>Override expect(locator).toBeVisible({ timeout: 10000 }) |
Test timeout
Playwright Test enforces a timeout for each test, 30 seconds by default. Time spent by the test function, fixtures, beforeEach
and afterEach
hooks is included in the test timeout.
Timed out test produces the following error:
example.spec.ts:3:1 › basic test ===========================
Timeout of 30000ms exceeded.
The same timeout value also applies to beforeAll
and afterAll
hooks, but they do not share time with any test.
Set test timeout in the config
import { defineConfig } from '@playwright/test';
export default defineConfig({
timeout: 5 * 60 * 1000,
});
API reference: [property: TestConfig.timeout
].
Set timeout for a single test
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(120000);
// ...
});
API reference: [method: Test.setTimeout
] and [method: Test.slow#1
].
Change timeout from a beforeEach
hook
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 + 30000);
});
API reference: [method: TestInfo.setTimeout
].
Change timeout for beforeAll
/afterAll
hook
beforeAll
and afterAll
hooks have a separate timeout, by default equal to test timeout. You can change it separately for each hook by calling [method: TestInfo.setTimeout
] inside the hook.
import { test, expect } from '@playwright/test';
test.beforeAll(async () => {
// Set timeout for this hook.
test.setTimeout(60000);
});
API reference: [method: TestInfo.setTimeout
].
Expect timeout
Web-first assertions like expect(locator).toHaveText()
have a separate timeout, 5 seconds by default. Assertion timeout is unrelated to the test timeout. It produces the following error:
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')"
Set expect timeout in the config
import { defineConfig } from '@playwright/test';
export default defineConfig({
expect: {
timeout: 10 * 1000,
},
});
Global timeout
Playwright Test supports a timeout for the whole test run. This prevents excess resource usage when everything went wrong. There is no default global timeout, but you can set a reasonable one in the config, for example one hour. Global timeout produces the following error:
Running 1000 tests using 10 workers
514 skipped
486 passed
Timed out waiting 3600s for the entire test run
You can set global timeout in the config.
// playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
globalTimeout: 60 * 60 * 1000,
});
API reference: [property: TestConfig.globalTimeout
].
Advanced: low level timeouts
These are the low-level timeouts that are pre-configured by the test runner, you should not need to change these. If you happen to be in this section because your test are flaky, it is very likely that you should be looking for the solution elsewhere.
Timeout | Default | Description |
---|---|---|
Action timeout | no timeout | Timeout for each action: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set default { <span style={{textTransform: 'uppercase',fontSize: 'smaller', fontWeight: 'bold', opacity: '0.6'}}>Override locator.click({ timeout: 10000 }) |
Navigation timeout | no timeout | Timeout for each navigation action: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set default { <span style={{textTransform: 'uppercase',fontSize: 'smaller', fontWeight: 'bold', opacity: '0.6'}}>Override page.goto('/', { timeout: 30000 }) |
Global timeout | no timeout | Global timeout for the whole test run: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set in config config = { globalTimeout: 60*60*1000 } |
beforeAll /afterAll timeout |
30000 ms | Timeout for the hook: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set in hook test.setTimeout(60000) |
Fixture timeout | no timeout | Timeout for an individual fixture: <span style={{textTransform:'uppercase',fontSize:'smaller',fontWeight:'bold',opacity:'0.6'}}>Set in fixture { scope: 'test', timeout: 30000 } |
Set timeout for a single assertion
import { test, expect } from '@playwright/test';
test('basic test', async ({ page }) => {
await expect(page.getByRole('button')).toHaveText('Sign in', { timeout: 10000 });
});
Set action and navigation timeouts in the config
import { defineConfig } from '@playwright/test';
export default defineConfig({
use: {
actionTimeout: 10 * 1000,
navigationTimeout: 30 * 1000,
},
});
API reference: [property: TestOptions.actionTimeout
] and [property: TestOptions.navigationTimeout
].
Set timeout for a single action
import { test, expect } from '@playwright/test';
test('basic test', async ({ page }) => {
await page.goto('https://playwright.dev', { timeout: 30000 });
await page.getByText('Get Started').click({ timeout: 10000 });
});
Fixture timeout
By default, fixture shares timeout with the test. However, for slow fixtures, especially worker-scoped ones, it is convenient to have a separate timeout. This way you can keep the overall test timeout small, and give the slow fixture more time.
const { test: base, expect } = require('@playwright/test');
const test = base.extend({
slowFixture: [async ({}, use) => {
// ... perform a slow operation ...
await use('hello');
}, { timeout: 60000 }]
});
test('example test', async ({ slowFixture }) => {
// ...
});
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: 60000 }]
});
test('example test', async ({ slowFixture }) => {
// ...
});
API reference: [method: Test.extend
].