playwright/docs/src/test-reporter-api/class-testcase.md

# class: TestCase
* since: v1.10
* langs: js

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

## property: TestCase.annotations
* since: v1.10
- type: <[Array]<[Object]>>
  - `type` <[string]> Annotation type, for example `'skip'` or `'fail'`.
  - `description` ?<[string]> Optional description.

The list of annotations applicable to the current test. Includes annotations from the test, annotations from all [`method: Test.describe#1`] groups the test belongs to and file-level annotations for the test file.

Annotations are available during test execution through [`property: TestInfo.annotations`].

Learn more about [test annotations](../test-annotations.md).

## property: TestCase.expectedStatus
* since: v1.10
- type: <[TestStatus]<"passed"|"failed"|"timedOut"|"skipped">>

Expected test status.
* Tests marked as [`method: Test.skip#1`] or [`method: Test.fixme#1`] are expected to be `'skipped'`.
* Tests marked as [`method: Test.fail#1`] are expected to be `'failed'`.
* Other tests are expected to be `'passed'`.

See also [`property: TestResult.status`] for the actual status.

## property: TestCase.location
* since: v1.10
- type: <[Location]>

Location in the source where the test is defined.

## method: TestCase.ok
* since: v1.10
- returns: <[boolean]>

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

## method: TestCase.outcome
* since: v1.10
- returns: <[TestOutcome]<"skipped"|"expected"|"unexpected"|"flaky">>

Testing outcome for this test. Note that outcome is not the same as [`property: TestResult.status`]:
* Test that is expected to fail and actually fails is `'expected'`.
* Test that passes on a second retry is `'flaky'`.

## property: TestCase.parent
* since: v1.10
- type: <[Suite]>

Suite this test case belongs to.

## property: TestCase.repeatEachIndex
* since: v1.10
- type: <[int]>

Contains the repeat index when running in "repeat each" mode. This mode is enabled by passing `--repeat-each` to the [command line](../test-cli.md).

## property: TestCase.results
* since: v1.10
- type: <[Array]<[TestResult]>>

Results for each run of this test.

## property: TestCase.retries
* since: v1.10
- type: <[int]>

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

Learn more about [test retries](../test-retries.md#retries).

## property: TestCase.timeout
* since: v1.10
- type: <[float]>

The timeout given to the test. Affected by [`property: TestConfig.timeout`], [`property: TestProject.timeout`], [`method: Test.setTimeout`], [`method: Test.slow#1`] and [`method: TestInfo.setTimeout`].

## property: TestCase.title
* since: v1.10
- type: <[string]>

Test title as passed to the [`method: Test.(call)`] call.

## method: TestCase.titlePath
* since: v1.10
- returns: <[Array]<[string]>>

Returns a list of titles from the root down to this test.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`# class: TestCase`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`* langs: js`

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

			`## property: TestCase.annotations`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[Array]<[Object]>>`
			- `type` <[string]> Annotation type, for example `'skip'` or `'fail'`.
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-07 04:02:10 +02:00			- `description` ?<[string]> Optional description.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
feat(runner): anonymous describes (#15424) Useful to set some options without coming up with an artificial name. ```js test.describe(() => { test.use({ colorScheme: 'dark' }); test('my test', () => {}); }) ``` 2022-07-06 22:54:11 +02:00			The list of annotations applicable to the current test. Includes annotations from the test, annotations from all [`method: Test.describe#1`] groups the test belongs to and file-level annotations for the test file.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			Annotations are available during test execution through [`property: TestInfo.annotations`].

chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00			`Learn more about [test annotations](../test-annotations.md).`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## property: TestCase.expectedStatus`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[TestStatus]<"passed"\|"failed"\|"timedOut"\|"skipped">>`

			`Expected test status.`
feat(test runner): allow top-level test.fixme similar to test.skip (#10250) ```js test.fixme('my test name', () => {}); ``` 2021-11-19 20:40:40 +01:00			* Tests marked as [`method: Test.skip#1`] or [`method: Test.fixme#1`] are expected to be `'skipped'`.
chore: generate more types (#13358) As a result, fix documentation issues: - Removed `TestStep.data` that is not a thing. - Added `TestConfig.name` documentation. - Refined a lot of optional types in the documentation. - Aligned `test.fail()` and `test.slow()` docs with `test.skip()`. - Strict set of docs vs types inconsistensies in the generator 2022-04-06 22:36:20 +02:00			* Tests marked as [`method: Test.fail#1`] are expected to be `'failed'`.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			* Other tests are expected to be `'passed'`.

			See also [`property: TestResult.status`] for the actual status.

			`## property: TestCase.location`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
chore: generate more types (#13358) As a result, fix documentation issues: - Removed `TestStep.data` that is not a thing. - Added `TestConfig.name` documentation. - Refined a lot of optional types in the documentation. - Aligned `test.fail()` and `test.slow()` docs with `test.skip()`. - Strict set of docs vs types inconsistensies in the generator 2022-04-06 22:36:20 +02:00			`- type: <[Location]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`Location in the source where the test is defined.`

			`## method: TestCase.ok`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- returns: <[boolean]>`

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

			`## method: TestCase.outcome`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- returns: <[TestOutcome]<"skipped"\|"expected"\|"unexpected"\|"flaky">>`

			Testing outcome for this test. Note that outcome is not the same as [`property: TestResult.status`]:
			* Test that is expected to fail and actually fails is `'expected'`.
			* Test that passes on a second retry is `'flaky'`.

docs: replace TestCase.suite with TestCase.parent (#10687) It is there by mistake. 2021-12-02 23:24:43 +01:00			`## property: TestCase.parent`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs: replace TestCase.suite with TestCase.parent (#10687) It is there by mistake. 2021-12-02 23:24:43 +01:00			`- type: <[Suite]>`

			`Suite this test case belongs to.`

test: expose repeatEachIndex (#11158) 2022-01-04 02:29:54 +01:00			`## property: TestCase.repeatEachIndex`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
test: expose repeatEachIndex (#11158) 2022-01-04 02:29:54 +01:00			`- type: <[int]>`

chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00			Contains the repeat index when running in "repeat each" mode. This mode is enabled by passing `--repeat-each` to the [command line](../test-cli.md).
test: expose repeatEachIndex (#11158) 2022-01-04 02:29:54 +01:00
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`## property: TestCase.results`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[Array]<[TestResult]>>`

			`Results for each run of this test.`

			`## property: TestCase.retries`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[int]>`

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

chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00			`Learn more about [test retries](../test-retries.md#retries).`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## property: TestCase.timeout`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[float]>`

chore: generate more types (#13358) As a result, fix documentation issues: - Removed `TestStep.data` that is not a thing. - Added `TestConfig.name` documentation. - Refined a lot of optional types in the documentation. - Aligned `test.fail()` and `test.slow()` docs with `test.skip()`. - Strict set of docs vs types inconsistensies in the generator 2022-04-06 22:36:20 +02:00			The timeout given to the test. Affected by [`property: TestConfig.timeout`], [`property: TestProject.timeout`], [`method: Test.setTimeout`], [`method: Test.slow#1`] and [`method: TestInfo.setTimeout`].
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## property: TestCase.title`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- type: <[string]>`

			Test title as passed to the [`method: Test.(call)`] call.

			`## method: TestCase.titlePath`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`- returns: <[Array]<[string]>>`

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