Back to Playwright

class: TestResult

docs/src/test-reporter-api/class-testresult.md

1.59.13.3 KB
Original Source

class: TestResult

  • since: v1.10
  • langs: js

A result of a single [TestCase] run.

property: TestResult.attachments

  • since: v1.10
  • type: <[Array]<[Object]>>
    • name <[string]> Attachment name.
    • contentType <[string]> Content type of this attachment to properly present in the report, for example 'application/json' or 'image/png'.
    • path ?<[string]> Optional path on the filesystem to the attached file.
    • body ?<[Buffer]> Optional attachment body used instead of a file.

The list of files or buffers attached during the test execution through [property: TestInfo.attachments].

property: TestResult.annotations

  • since: v1.52
  • type: <[Array]<[Object]>>
    • type <[string]> Annotation type, for example 'skip' or 'fail'.
    • description ?<[string]> Optional description.
    • location ?<[Location]> Optional location in the source where the annotation is added.

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

  • annotations defined on the test or suite via [method: Test.(call)] and [method: Test.describe];
  • annotations implicitly added by methods [method: Test.skip], [method: Test.fixme] and [method: Test.fail];
  • annotations appended to [property: TestInfo.annotations] during the test execution.

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

Learn more about test annotations.

property: TestResult.duration

  • since: v1.10
  • type: <[float]>

Running time in milliseconds.

property: TestResult.error

  • since: v1.10
  • type: ?<[TestError]>

First error thrown during test execution, if any. This is equal to the first element in [property: TestResult.errors].

property: TestResult.errors

  • since: v1.10
  • type: <[Array]<[TestError]>>

Errors thrown during the test execution.

property: TestResult.retry

  • since: v1.10
  • type: <[int]>

When test is retried multiple times, each retry attempt is given a sequential number.

Learn more about test retries.

property: TestResult.startTime

  • since: v1.10
  • type: <[Date]>

Start time of this particular test run.

property: TestResult.status

  • since: v1.10
  • type: <[TestStatus]<"passed"|"failed"|"timedOut"|"skipped"|"interrupted">>

The status of this test result. See also [property: TestCase.expectedStatus].

property: TestResult.stderr

  • since: v1.10
  • type: <[Array]<[string]|[Buffer]>>

Anything written to the standard error during the test run.

property: TestResult.stdout

  • since: v1.10
  • type: <[Array]<[string]|[Buffer]>>

Anything written to the standard output during the test run.

property: TestResult.steps

  • since: v1.10
  • type: <[Array]<[TestStep]>>

List of steps inside this test run.

property: TestResult.workerIndex

  • since: v1.10
  • type: <[int]>

Index of the worker where the test was run. If the test was not run a single time, for example when the user interrupted testing, the only result will have a workerIndex equal to -1.

Learn more about parallelism and sharding with Playwright Test.

property: TestResult.parallelIndex

  • since: v1.30
  • type: <[int]>

The index of the worker between 0 and workers - 1. It is guaranteed that workers running at the same time have a different parallelIndex.