TestCase

TestCase corresponds to every test() call in a test file. When a single test() is running in multiple projects or repeated multiple times, it will have multiple TestCase objects in corresponding projects' suites.

Methods​

ok​

Whether the test is considered running fine. Non-ok tests fail the test run with non-zero exit code.

Usage

testCase.ok();

Returns

• boolean

outcome​

Testing outcome for this test. Note that outcome is not the same as testResult.status:

• Test that is expected to fail and actually fails is 'expected'.
• Test that passes on a second retry is 'flaky'.

Usage

testCase.outcome();

Returns

• "skipped" | "expected" | "unexpected" | "flaky"

titlePath​

Returns a list of titles from the root down to this test.

Usage

testCase.titlePath();

Returns

• Array<string>

Properties​

annotations​

The list of annotations applicable to the current test. Includes:

• annotations defined on the test or suite via test() and test.describe();
• annotations implicitly added by methods test.skip(), test.fixme() and test.fail();
• annotations appended to testInfo.annotations during the test execution.

Annotations are available during test execution through testInfo.annotations.

Learn more about test annotations.

Usage

testCase.annotations

Type

• Array<Object>

  • type string

    Annotation type, for example 'skip' or 'fail'.

  • description string (optional)

    Optional description.

expectedStatus​

Expected test status.

• Tests marked as test.skip() or test.fixme() are expected to be 'skipped'.
• Tests marked as test.fail() are expected to be 'failed'.
• Other tests are expected to be 'passed'.

See also testResult.status for the actual status.

Usage

testCase.expectedStatus

Type

• "passed" | "failed" | "timedOut" | "skipped" | "interrupted"

id​

A test ID that is computed based on the test file name, test title and project name. The ID is unique within Playwright session.

Usage

testCase.id

Type

• string

location​

Location in the source where the test is defined.

Usage

testCase.location

Type

• Location

parent​

Suite this test case belongs to.

Usage

testCase.parent

Type

• Suite

repeatEachIndex​

Contains the repeat index when running in "repeat each" mode. This mode is enabled by passing --repeat-each to the command line.

Usage

testCase.repeatEachIndex

Type

• number

results​

Results for each run of this test.

Usage

testCase.results

Type

• Array<TestResult>

retries​

The maximum number of retries given to this test in the configuration.

Learn more about test retries.

Usage

testCase.retries

Type

• number

tags​

The list of tags defined on the test or suite via test() or test.describe(), as well as @-tokens extracted from test and suite titles.

Learn more about test tags.

Usage

testCase.tags

Type

• Array<string>

timeout​

The timeout given to the test. Affected by testConfig.timeout, testProject.timeout, test.setTimeout(), test.slow() and testInfo.setTimeout().

Usage

testCase.timeout

Type

• number

title​

Test title as passed to the test() call.

Usage

testCase.title

Type

• string

type​

Returns "test". Useful for detecting test cases in suite.entries().

Usage

testCase.type

Type

• "test"