Аннотации

Введение

Playwright поддерживает теги и аннотации, которые отображаются в отчете о тестировании.

Вы можете добавлять свои собственные теги и аннотации в любой момент, но Playwright поставляется с несколькими встроенными:

test.skip() помечает тест как неактуальный. Playwright не запускает такой тест. Используйте эту аннотацию, когда тест не применим в какой-либо конфигурации.
test.fail() помечает тест как неудачный. Playwright запустит этот тест и убедится, что он действительно неудачен. Если тест не провалится, Playwright сообщит об этом.
test.fixme() помечает тест как неудачный. Playwright не будет запускать этот тест, в отличие от аннотации fail. Используйте fixme, когда выполнение теста медленное или приводит к сбоям.
test.slow() помечает тест как медленный и утрояет тайм-аут теста.

Аннотации могут быть добавлены к одному тесту или группе тестов.

Встроенные аннотации могут быть условными, в этом случае они применяются, когда условие истинно, и могут зависеть от тестовых фикстур. На одном тесте может быть несколько аннотаций, возможно, в разных конфигурациях.

Сфокусировать тест

Вы можете сфокусировать некоторые тесты. Когда есть сфокусированные тесты, запускаются только они.

test.only('focus this test', async ({ page }) => {
  // Run only focused tests in the entire project.
});

Пропустить тест

Пометьте тест как пропущенный.

test.skip('skip this test', async ({ page }) => {
  // This test is not run
});

Условно пропустить тест

Вы можете пропустить определенные тесты в зависимости от условия.

test('skip this test', async ({ page, browserName }) => {
  test.skip(browserName === 'firefox', 'Still working on it');
});

Группировка тестов

Вы можете группировать тесты, чтобы дать им логическое имя или ограничить хуки before/after для группы.

import { test, expect } from '@playwright/test';

test.describe('two tests', () => {
  test('one', async ({ page }) => {
    // ...
  });

  test('two', async ({ page }) => {
    // ...
  });
});

Тегирование тестов

Иногда вы хотите пометить свои тесты как @fast или @slow, а затем фильтровать по тегу в отчете о тестировании. Или вы можете захотеть запускать только тесты, которые имеют определенный тег.

Чтобы пометить тест, либо предоставьте дополнительный объект с деталями при объявлении теста, либо добавьте токен @ к заголовку теста. Обратите внимание, что теги должны начинаться с символа @.

import { test, expect } from '@playwright/test';

test('test login page', {
  tag: '@fast',
}, async ({ page }) => {
  // ...
});

test('test full report @slow', async ({ page }) => {
  // ...
});

Вы также можете пометить все тесты в группе или предоставить несколько тегов:

import { test, expect } from '@playwright/test';

test.describe('group', {
  tag: '@report',
}, () => {
  test('test report header', async ({ page }) => {
    // ...
  });

  test('test full report', {
    tag: ['@slow', '@vrt'],
  }, async ({ page }) => {
    // ...
  });
});

Теперь вы можете запускать тесты, которые имеют определенный тег, с помощью опции командной строки --grep.

Bash
PowerShell
Batch

npx playwright test --grep @fast

npx playwright test --grep "@fast"

npx playwright test --grep @fast

Или, если вы хотите противоположное, вы можете пропустить тесты с определенным тегом:

Bash
PowerShell
Batch

npx playwright test --grep-invert @fast

npx playwright test --grep-invert "@fast"

npx playwright test --grep-invert @fast

Чтобы запустить тесты, содержащие любой из тегов (логический оператор OR):

Bash
PowerShell
Batch

npx playwright test --grep "@fast|@slow"

npx playwright test --grep --% "@fast^|@slow"

npx playwright test --grep "@fast^|@slow"

Или запустить тесты, содержащие оба тега (логический оператор AND), используя lookaheads в регулярных выражениях:

npx playwright test --grep "(?=.*@fast)(?=.*@slow)"

Вы также можете фильтровать тесты в файле конфигурации через testConfig.grep и testProject.grep.

Аннотирование тестов

Если вы хотите аннотировать свои тесты чем-то более значительным, чем тег, вы можете сделать это при объявлении теста. Аннотации имеют type и description для большего контекста и доступны в API репортера. Встроенный HTML-репортер Playwright показывает все аннотации, кроме тех, где type начинается с символа _.

Например, чтобы аннотировать тест с URL-адресом проблемы:

import { test, expect } from '@playwright/test';

test('test login page', {
  annotation: {
    type: 'issue',
    description: 'https://github.com/microsoft/playwright/issues/23180',
  },
}, async ({ page }) => {
  // ...
});

Вы также можете аннотировать все тесты в группе или предоставить несколько аннотаций:

import { test, expect } from '@playwright/test';

test.describe('report tests', {
  annotation: { type: 'category', description: 'report' },
}, () => {
  test('test report header', async ({ page }) => {
    // ...
  });

  test('test full report', {
    annotation: [
      { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/23180' },
      { type: 'performance', description: 'very slow test!' },
    ],
  }, async ({ page }) => {
    // ...
  });
});

Условно пропустить группу тестов

Например, вы можете запустить группу тестов только в Chromium, передав callback.

example.spec.ts

test.describe('chromium only', () => {
  test.skip(({ browserName }) => browserName !== 'chromium', 'Chromium only!');

  test.beforeAll(async () => {
    // This hook is only run in Chromium.
  });

  test('test 1', async ({ page }) => {
    // This test is only run in Chromium.
  });

  test('test 2', async ({ page }) => {
    // This test is only run in Chromium.
  });
});

Использование fixme в хуке `beforeEach`

Чтобы избежать выполнения хуков beforeEach, вы можете поместить аннотации в сам хук.

example.spec.ts

test.beforeEach(async ({ page, isMobile }) => {
  test.fixme(isMobile, 'Settings page does not work in mobile yet');

  await page.goto('http://localhost:3000/settings');
});

test('user profile', async ({ page }) => {
  await page.getByText('My Profile').click();
  // ...
});