跳到主要内容

注释

介绍​

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 命令行选项运行具有特定标签的测试。

npx playwright test --grep @fast

或者，如果您想要相反的效果，您可以跳过具有特定标签的测试

npx playwright test --grep-invert @fast

要运行包含任一标签的测试（逻辑 OR 运算符）

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

或者，使用正则表达式前瞻运行包含这两个标签的测试（逻辑 AND 运算符）

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

您还可以在配置文件中通过 testConfig.grep 和 testProject.grep 筛选测试。

注释测试​

如果您想用比标签更重要的内容来注释测试，您可以在声明测试时这样做。注释具有 type 和 description，以提供更多上下文并在报告器 API 中可用。Playwright 的内置 HTML 报告器会显示所有注释，但那些 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 中运行一组测试。

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.
  });
});

在 beforeEach 钩子中使用 fixme​

要避免运行 beforeEach 钩子，您可以将注释放在钩子本身中。

example.spec.ts

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

  await page.goto('https://127.0.0.1:3000/settings');
});

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

运行时注释​

在测试正在运行时，您可以将注释添加到 test.info().annotations 中。

example.spec.ts

test('example test', async ({ page, browser }) => {
  test.info().annotations.push({
    type: 'browser version',
    description: browser.version(),
  });

  // ...
});