TestStep

Представляет шаг в TestResult.

Методы​

titlePath​

Возвращает список заголовков шагов от корневого шага до текущего.

Использование

testStep.titlePath();

Возвращает

• Array<string>

Свойства​

annotations​

Список аннотаций, применимых к текущему шагу теста.

Использование

testStep.annotations

Тип

• Array<Object>

  • type string

    Тип аннотации, например 'skip'.

  • description string (необязательно)

    Необязательное описание.

  • location Location (необязательно)

    Необязательное местоположение в исходном коде, где добавлена аннотация.

attachments​

Список файлов или буферов, прикреплённых во время выполнения шага с помощью testInfo.attach().

Использование

testStep.attachments

Тип

• Array<Object>

  • name string

    Имя вложения.

  • contentType string

    Тип содержимого вложения для его корректного отображения в отчёте, например 'application/json' или 'image/png'.

  • path string (необязательно)

    Необязательный путь в файловой системе к прикреплённому файлу.

  • body Buffer (необязательно)

    Необязательное содержимое вложения, используемое вместо файла.

category​

Категория шага, позволяющая различать шаги с разным происхождением и уровнем подробности. Встроенные категории:

• expect для вызовов expect
• fixture для настройки и очистки фикстур
• hook для инициализации и очистки хуков
• pw:api для вызовов API Playwright.
• test.step для вызовов API test.step.
• test.attach для вызовов API testInfo.attach.

Использование

testStep.category

Тип

• string

duration​

Время выполнения в миллисекундах.

Использование

testStep.duration

Тип

• number

error​

Ошибка, возникшая при выполнении шага, если таковая имеется.

Использование

testStep.error

Тип

• TestError

location​

Необязательное местоположение в исходном коде, где определён шаг.

Использование

testStep.location

Тип

• Location

params​

Параметры, зависящие от шага, если они доступны. Например, шаги, созданные вызовами API Playwright, содержат целевой locator и аргументы вызова, такие как url, а шаги test.step() содержат параметры, переданные автором теста.

// { locator: 'getByRole(\'button\')' }
await page.getByRole('button').click();

// { url: 'https://example.com' }
await page.goto('https://example.com');

// { locator: 'getByLabel(\'Password\')', value: 'secret' }
await page.getByLabel('Password').fill('secret');

// { orderId: 42 }
await test.step('checkout', async () => {
  // ...
}, { params: { orderId: 42 } });

Чтобы отчёты были компактными, для вызовов API Playwright приводится только тщательно отобранный набор аргументов, а длинные строковые значения усекаются. Неограниченные аргументы, такие как содержимое страницы, вычисляемые выражения или тела запросов, не приводятся.

Использование

testStep.params

Тип

• Object<string, Object>

parent​

Родительский шаг, если он есть.

Использование

testStep.parent

Тип

• TestStep

startTime​

Время начала этого шага теста.

Использование

testStep.startTime

Тип

• Date

steps​

Список шагов внутри этого шага.

Использование

testStep.steps

Тип

• Array<TestStep>

subtitle​

Понятный пользователю подзаголовок шага теста, дополняющий заголовок, если он доступен. Для вызовов API Playwright это целевой локатор или URL-адрес навигации. Например, у шага Click в качестве подзаголовка указан локатор элемента, по которому щёлкнули. Пользовательские интерфейсы обычно отображают подзаголовок рядом с заголовком или отдельной строкой.

// title `Click`, subtitle `getByRole('button')`
await page.getByRole('button').click();

// title `Navigate`, subtitle `example.com/index.html`
await page.goto('https://example.com/index.html');

Использование

testStep.subtitle

Тип

• string

title​

Понятный пользователю заголовок шага теста, например Click или Navigate.

Использование

testStep.title

Тип

• string