The list of annotations applicable to the current test. Includes annotations from the test, annotations from all test.describe([title, details, callback]) groups the test belongs to and file-level annotations for the test file.
Learn more about test annotations.
Optional description?: stringOptional description.
Annotation type, for example 'skip' or 'fail'.
The list of files or buffers attached to the current test. Some reporters show test attachments.
To add an attachment, use testInfo.attach(name[, options]) instead of directly pushing onto this array.
Optional body?: BufferOptional attachment body used instead of a file.
Content type of this attachment to properly present in the report, for example 'application/json' or
'image/png'.
Attachment name.
Optional path?: stringOptional path on the filesystem to the attached file.
Column number where the currently running test is declared.
Processed configuration from the configuration file.
The number of milliseconds the test took to finish. Always zero before the test finishes, either successfully or not. Can be used in test.afterEach([title, hookFunction]) hook.
Optional errorFirst error thrown during test execution, if any. This is equal to the first element in testInfo.errors.
Errors thrown during test execution, if any.
Expected status for the currently running test. This is usually 'passed', except for a few cases:
'skipped' for skipped tests, e.g. with
test.skip([title, details, body, condition, callback, description]);'failed' for tests marked as failed with
test.fail([title, details, body, condition, callback, description]).Expected status is usually compared with the actual testInfo.status:
import { test, expect } from '@playwright/test';
test.afterEach(async ({}, testInfo) => {
if (testInfo.status !== testInfo.expectedStatus)
console.log(`${testInfo.title} did not run as expected!`);
});
Absolute path to a file where the currently running test is declared.
Test function as passed to test(title, testFunction).
Line number where the currently running test is declared.
Absolute path to the output directory for this specific test run. Each test run gets its own directory so they cannot conflict.
The index of the worker between 0 and workers - 1. It is guaranteed that workers running at the same time have
a different parallelIndex. When a worker is restarted, for example after a failure, the new worker process has
the same parallelIndex.
Also available as process.env.TEST_PARALLEL_INDEX. Learn more about
parallelism and sharding with Playwright Test.
Processed project configuration from the configuration file.
Specifies a unique repeat index when running in "repeat each" mode. This mode is enabled by passing --repeat-each
to the command line.
Specifies the retry number when the test is retried after a failure. The first test run has testInfo.retry equal to zero, the first retry has it equal to one, and so on. Learn more about retries.
import { test, expect } from '@playwright/test';
test.beforeEach(async ({}, testInfo) => {
// You can access testInfo.retry in any hook or fixture.
if (testInfo.retry > 0)
console.log(`Retrying!`);
});
test('my test', async ({ page }, testInfo) => {
// Here we clear some server-side state when retrying.
if (testInfo.retry)
await cleanSomeCachesOnTheServer();
// ...
});
Absolute path to the snapshot output directory for this specific test. Each test suite gets its own directory so they cannot conflict.
This property does not account for the testProject.snapshotPathTemplate configuration.
NOTE Use of testInfo.snapshotSuffix is discouraged. Please use testConfig.snapshotPathTemplate to configure snapshot paths.
Suffix used to differentiate snapshots between multiple test configurations. For example, if snapshots depend on
the platform, you can set testInfo.snapshotSuffix equal to process.platform. In this case
expect(value).toMatchSnapshot(snapshotName) will use different snapshots depending on the platform. Learn more
about snapshots.
Optional statusActual status for the currently running test. Available after the test has finished in test.afterEach([title, hookFunction]) hook and fixtures.
Status is usually compared with the testInfo.expectedStatus:
import { test, expect } from '@playwright/test';
test.afterEach(async ({}, testInfo) => {
if (testInfo.status !== testInfo.expectedStatus)
console.log(`${testInfo.title} did not run as expected!`);
});
Test id matching the test case id in the reporter API.
Timeout in milliseconds for the currently running test. Zero means no timeout. Learn more about various timeouts.
Timeout is usually specified in the configuration file
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);
});
The title of the currently running test as passed to test(title, testFunction).
The full title path starting with the project.
The unique index of the worker process that is running the test. When a worker is restarted, for example after a
failure, the new worker process gets a new unique workerIndex.
Also available as process.env.TEST_WORKER_INDEX. Learn more about parallelism and sharding
with Playwright Test.
Attach a value or a file from disk to the current test. Some reporters show test attachments. Either path or
body must be specified, but not both.
For example, you can attach a screenshot to the test:
import { test, expect } from '@playwright/test';
test('basic test', async ({ page }, testInfo) => {
await page.goto('https://playwright.dev');
const screenshot = await page.screenshot();
await testInfo.attach('screenshot', { body: screenshot, contentType: 'image/png' });
});
Or you can attach files returned by your APIs:
import { test, expect } from '@playwright/test';
import { download } from './my-custom-helpers';
test('basic test', async ({}, testInfo) => {
const tmpPath = await download('a');
await testInfo.attach('downloaded', { path: tmpPath });
});
NOTE testInfo.attach(name[, options]) automatically takes care of copying attached files to a location that is accessible to reporters. You can safely remove the attachment after awaiting the attach call.
Attachment name. The name will also be sanitized and used as the prefix of file name when saving to disk.
Optional options: { Optional
Optional body?: string | BufferAttachment body. Mutually exclusive with path.
Optional contentContent type of this attachment to properly present in the report, for example 'application/json' or
'image/png'. If omitted, content type is inferred based on the path, or defaults to text/plain for [string]
attachments and application/octet-stream for [Buffer] attachments.
Optional path?: stringPath on the filesystem to the attached file. Mutually exclusive with body.
Marks the currently running test as "should fail". Playwright Test runs this test and ensures that it is actually failing. This is useful for documentation purposes to acknowledge that some functionality is broken until it is fixed. This is similar to test.fail([title, details, body, condition, callback, description]).
Conditionally mark the currently running test as "should fail" with an optional description. This is similar to test.fail([title, details, body, condition, callback, description]).
Test is marked as "should fail" when the condition is true.
Optional description: stringOptional description that will be reflected in a test report.
Optional Mark a test as "fixme", with the intention to fix it. Test is immediately aborted. This is similar to test.fixme([title, details, body, condition, callback, description]).
Conditionally mark the currently running test as "fixme" with an optional description. This is similar to test.fixme([title, details, body, condition, callback, description]).
Test is marked as "fixme" when the condition is true.
Optional description: stringOptional description that will be reflected in a test report.
Optional Returns a path inside the testInfo.outputDir where the test can safely put a temporary file. Guarantees that tests running in parallel will not interfere with each other.
import { test, expect } from '@playwright/test';
import fs from 'fs';
test('example test', async ({}, testInfo) => {
const file = testInfo.outputPath('dir', 'temporary-file.txt');
await fs.promises.writeFile(file, 'Put some data to the dir/temporary-file.txt', 'utf8');
});
Note that
pathSegmentsaccepts path segments to the test output directory such astestInfo.outputPath('relative', 'path', 'to', 'output'). However, this path must stay within the testInfo.outputDir directory for each test (i.e.test-results/a-test-title), otherwise it will throw.
Rest ...pathSegments: readonly string[]Path segments to append at the end of the resulting path.
Rest Changes the timeout for the currently running test. Zero means no timeout. Learn more about various timeouts.
Timeout is usually specified in the configuration file, but it could be useful to change the timeout in certain scenarios:
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);
});
Timeout in milliseconds.
Unconditionally skip the currently running test. Test is immediately aborted. This is similar to test.skip([title, details, body, condition, callback, description]).
Conditionally skips the currently running test with an optional description. This is similar to test.skip([title, details, body, condition, callback, description]).
A skip condition. Test is skipped when the condition is true.
Optional description: stringOptional description that will be reflected in a test report.
Optional Marks the currently running test as "slow", giving it triple the default timeout. This is similar to test.slow([condition, callback, description]).
Conditionally mark the currently running test as "slow" with an optional description, giving it triple the default timeout. This is similar to test.slow([condition, callback, description]).
Test is marked as "slow" when the condition is true.
Optional description: stringOptional description that will be reflected in a test report.
Optional Returns a path to a snapshot file with the given pathSegments. Learn more about
snapshots.
Note that
pathSegmentsaccepts path segments to the snapshot file such astestInfo.snapshotPath('relative', 'path', 'to', 'snapshot.png'). However, this path must stay within the snapshots directory for each test file (i.e.a.spec.js-snapshots), otherwise it will throw.
Rest ...pathSegments: readonly string[]The name of the snapshot or the path segments to define the snapshot file path. Snapshots with the same name in the same test file are expected to be the same.
Rest Generated using TypeDoc
TestInfocontains information about currently running test. It is available to test functions, test.beforeEach([title, hookFunction]), test.afterEach([title, hookFunction]), test.beforeAll([title, hookFunction]) and test.afterAll([title, hookFunction]) hooks, and test-scoped fixtures.TestInfoprovides utilities to control test execution: attach files, update test timeout, determine which test is currently running and whether it was retried, etc.