TestStep

Represents a step in the [TestRun].

Methods​

titlePath​

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

Usage

testStep.titlePath();

Returns

• Array<string>

Properties​

annotations​

The list of annotations applicable to the current test step.

Usage

testStep.annotations

Type

• Array<Object>

  • type string

    Annotation type, for example 'skip'.

  • description string (optional)

    Optional description.

  • location Location (optional)

    Optional location in the source where the annotation is added.

attachments​

The list of files or buffers attached in the step execution through testInfo.attach().

Usage

testStep.attachments

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)

    Optional path on the filesystem to the attached file.

  • body Buffer (optional)

    Optional attachment body used instead of a file.

category​

Step category to differentiate steps with different origin and verbosity. Built-in categories are:

• expect for expect calls
• fixture for fixtures setup and teardown
• hook for hooks initialization and teardown
• pw:api for Playwright API calls.
• test.step for test.step API calls.
• test.attach for testInfo.attach API calls.

Usage

testStep.category

Type

• string

duration​

Running time in milliseconds.

Usage

testStep.duration

Type

• number

error​

Error thrown during the step execution, if any.

Usage

testStep.error

Type

• TestError

location​

Optional location in the source where the step is defined.

Usage

testStep.location

Type

• Location

parent​

Parent step, if any.

Usage

testStep.parent

Type

• TestStep

startTime​

Start time of this particular test step.

Usage

testStep.startTime

Type

• Date

steps​

List of steps inside this step.

Usage

testStep.steps

Type

• Array<TestStep>

title​

User-friendly test step title.

Usage

testStep.title

Type

• string