Interface TestStepInfo

titlePath

attach

• attach(name, options?): Promise<void>

• Attach a value or a file from disk to the current test step. Some reporters show test step attachments. Either path or body must be specified, but not both. Calling this method will attribute the attachment to the step, as opposed to testInfo.attach(name[, options]) which stores all attachments at the test level.

  For example, you can attach a screenshot to the test step:

  import { test, expect } from '@playwright/test';
  
  test('basic test', async ({ page }) => {
    await page.goto('https://playwright.dev');
    await test.step('check page rendering', async step => {
      const screenshot = await page.screenshot();
      await step.attach('screenshot', { body: screenshot, contentType: 'image/png' });
    });
  });
  Copy

  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 ({}) => {
    await test.step('check download behavior', async step => {
      const tmpPath = await download('a');
      await step.attach('downloaded', { path: tmpPath });
    });
  });
  Copy

  NOTE testStepInfo.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.

  Parameters

  • name: string

    Attachment name. The name will also be sanitized and used as the prefix of file name when saving to disk.

  • Optional options: {
        body?: string | Buffer;
        contentType?: string;
        path?: string;
    }

    Optional

    • Optional body?: string | Buffer

      Attachment body. Mutually exclusive with path.

    • Optional contentType?: string

      Content 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?: string

      Path on the filesystem to the attached file. Mutually exclusive with body.

  Returns Promise<void>

skip

• skip(): void

• Abort the currently running step and mark it as skipped. Useful for steps that are currently failing and planned for a near-term fix.

  Usage

  import { test, expect } from '@playwright/test';
  
  test('my test', async ({ page }) => {
    await test.step('check expectations', async step => {
      step.skip();
      // step body below will not run
      // ...
    });
  });
  Copy

  Returns void
• skip(condition, description?): void

• Conditionally abort the currently running step and mark it as skipped with an optional description. Useful for steps that should not be executed in some cases.

  Usage

  import { test, expect } from '@playwright/test';
  
  test('my test', async ({ page, isMobile }) => {
    await test.step('check desktop expectations', async step => {
      step.skip(isMobile, 'not present in the mobile layout');
      // step body below will not run
      // ...
    });
  });
  Copy

  Parameters

  • condition: boolean

    A skip condition. Test step is skipped when the condition is true.

  • Optional description: string

    Optional description that will be reflected in a test report.

    Optional

  Returns void