Playwright 测试

Playwright Test 提供了 test 函数来声明测试，以及 expect 函数来编写断言。

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

test('basic test', async ({ page }) => {
  await page.goto('https://playwright.net.cn/');
  const name = await page.innerText('.navbar__title');
  expect(name).toBe('Playwright');
});

方法

test

添加于版本: v1.10

test.test

声明一个测试。

test(title, body)
test(title, details, body)

用法

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

test('basic test', async ({ page }) => {
  await page.goto('https://playwright.net.cn/');
  // ...
});

标签

您可以通过提供额外的测试详细信息来标记测试。或者，您可以在测试标题中包含标签。请注意，每个标签必须以 @ 符号开头。

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

test('basic test', {
  tag: '@smoke',
}, async ({ page }) => {
  await page.goto('https://playwright.net.cn/');
  // ...
});

test('another test @smoke', async ({ page }) => {
  await page.goto('https://playwright.net.cn/');
  // ...
});

测试标签显示在测试报告中，并且可以通过 TestCase.tags 属性提供给自定义报告器。

您还可以在测试执行期间按标签过滤测试

在命令行中；
在配置中使用 testConfig.grep 和 testProject.grep；

了解更多关于标记的信息。

注解

您可以通过提供额外的测试详细信息来注解测试。

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

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

测试注解显示在测试报告中，并且可以通过 TestCase.annotations 属性提供给自定义报告器。

您还可以在运行时通过操作 testInfo.annotations 来添加注解。

了解更多关于测试注解的信息。

参数

title string #

测试标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
    
    注解类型，例如 'issue'。
  - description string (可选)
    
    可选的注解描述，例如 issue url。
额外的测试详细信息。
body function(Fixtures, TestInfo)#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。

test.afterAll

添加于版本: v1.10

test.test.afterAll

声明一个 afterAll 钩子，该钩子在所有测试之后每个 worker 执行一次。

当在测试文件范围内调用时，在文件中所有测试之后运行。当在 test.describe() 组内调用时，在该组中所有测试之后运行。

用法

test.afterAll(async () => {
  console.log('Done with tests');
  // ...
});

或者，您可以声明一个带有标题的钩子。

test.afterAll('Teardown', async () => {
  console.log('Done with tests');
  // ...
});

参数

title string (可选)添加于版本: v1.38#

钩子标题。
hookFunction function(Fixtures, TestInfo)#

钩子函数，接受一个或两个参数：一个带有 worker 夹具的对象和可选的 TestInfo。

详情

当添加多个 afterAll 钩子时，它们将按照注册顺序运行。

请注意，worker 进程会在测试失败时重启，并且 afterAll 钩子会在新的 worker 中再次运行。了解更多关于 worker 和失败的信息。

即使某些钩子失败，Playwright 仍将继续运行所有适用的钩子。

test.afterAll(hookFunction)
test.afterAll(title, hookFunction)

test.afterEach

添加于版本: v1.10

test.test.afterEach

声明一个 afterEach 钩子，该钩子在每个测试之后执行。

当在测试文件范围内调用时，在文件中每个测试之后运行。当在 test.describe() 组内调用时，在该组中每个测试之后运行。

您可以访问与测试主体本身相同的所有夹具，以及提供许多有用信息的 TestInfo 对象。例如，您可以检查测试是成功还是失败。

test.afterEach(hookFunction)
test.afterEach(title, hookFunction)

用法

example.spec.ts
import { test, expect } from '@playwright/test';

test.afterEach(async ({ page }) => {
  console.log(`Finished ${test.info().title} with status ${test.info().status}`);

  if (test.info().status !== test.info().expectedStatus)
    console.log(`Did not run as expected, ended up at ${page.url()}`);
});

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

或者，您可以声明一个带有标题的钩子。

example.spec.ts
test.afterEach('Status check', async ({ page }) => {
  if (test.info().status !== test.info().expectedStatus)
    console.log(`Did not run as expected, ended up at ${page.url()}`);
});

参数

title string (可选)添加于版本: v1.38#

钩子标题。
hookFunction function(Fixtures, TestInfo)#

钩子函数，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。

详情

当添加多个 afterEach 钩子时，它们将按照注册顺序运行。

即使某些钩子失败，Playwright 仍将继续运行所有适用的钩子。

test.beforeAll

添加于版本: v1.10

test.test.beforeAll

声明一个 beforeAll 钩子，该钩子在所有测试之前每个 worker 进程执行一次。

当在测试文件范围内调用时，在文件中所有测试之前运行。当在 test.describe() 组内调用时，在该组中所有测试之前运行。

您可以使用 test.afterAll() 来拆除在 beforeAll 中设置的任何资源。

test.beforeAll(hookFunction)
test.beforeAll(title, hookFunction)

用法

example.spec.ts
import { test, expect } from '@playwright/test';

test.beforeAll(async () => {
  console.log('Before tests');
});

test.afterAll(async () => {
  console.log('After tests');
});

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

或者，您可以声明一个带有标题的钩子。

example.spec.ts
test.beforeAll('Setup', async () => {
  console.log('Before tests');
});

参数

title string (可选)添加于版本: v1.38#

钩子标题。
hookFunction function(Fixtures, TestInfo)#

钩子函数，接受一个或两个参数：一个带有 worker 夹具的对象和可选的 TestInfo。

详情

当添加多个 beforeAll 钩子时，它们将按照注册顺序运行。

请注意，worker 进程会在测试失败时重启，并且 beforeAll 钩子会在新的 worker 中再次运行。了解更多关于 worker 和失败的信息。

即使某些钩子失败，Playwright 仍将继续运行所有适用的钩子。

test.beforeEach

添加于版本: v1.10

test.test.beforeEach

声明一个 beforeEach 钩子，该钩子在每个测试之前执行。

当在测试文件范围内调用时，在文件中每个测试之前运行。当在 test.describe() 组内调用时，在该组中每个测试之前运行。

您可以访问与测试主体本身相同的所有夹具，以及提供许多有用信息的 TestInfo 对象。例如，您可以在开始测试之前导航页面。

您可以使用 test.afterEach() 来拆除在 beforeEach 中设置的任何资源。

test.beforeEach(hookFunction)
test.beforeEach(title, hookFunction)

用法

example.spec.ts
import { test, expect } from '@playwright/test';

test.beforeEach(async ({ page }) => {
  console.log(`Running ${test.info().title}`);
  await page.goto('https://my.start.url/');
});

test('my test', async ({ page }) => {
  expect(page.url()).toBe('https://my.start.url/');
});

或者，您可以声明一个带有标题的钩子。

example.spec.ts
test.beforeEach('Open start URL', async ({ page }) => {
  console.log(`Running ${test.info().title}`);
  await page.goto('https://my.start.url/');
});

参数

title string (可选)添加于版本: v1.38#

钩子标题。
hookFunction function(Fixtures, TestInfo)#

钩子函数，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。

详情

当添加多个 beforeEach 钩子时，它们将按照注册顺序运行。

即使某些钩子失败，Playwright 仍将继续运行所有适用的钩子。

test.describe

添加于版本: v1.10

test.test.describe

声明一组测试。

test.describe(title, callback)
test.describe(callback)
test.describe(title, details, callback)

用法

您可以声明一组带有标题的测试。标题将在测试报告中作为每个测试标题的一部分可见。

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

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

匿名组

您还可以声明一个没有标题的测试组。这对于使用 test.use() 为一组测试提供通用选项非常方便。

test.describe(() => {
  test.use({ colorScheme: 'dark' });

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

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

标签

您可以通过提供额外的详细信息来标记组中的所有测试。请注意，每个标签必须以 @ 符号开头。

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

test.describe('two tagged tests', {
  tag: '@smoke',
}, () => {
  test('one', async ({ page }) => {
    // ...
  });

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

了解更多关于标记的信息。

注解

您可以通过提供额外的详细信息来注解组中的所有测试。

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

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

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

了解更多关于测试注解的信息。

参数

title string (可选)#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
组中所有测试的额外详细信息。
callback function #

在调用 test.describe() 时立即运行的回调。在此回调中声明的任何测试都将属于该组。

test.describe.configure

添加于版本: v1.10

test.test.describe.configure

配置封闭范围。可以在顶层或 describe 内部执行。配置适用于整个范围，无论它是在测试声明之前还是之后运行。

了解更多关于执行模式的信息，请点击这里。

用法

并行运行测试。

// Run all the tests in the file concurrently using parallel workers.
test.describe.configure({ mode: 'parallel' });
test('runs in parallel 1', async ({ page }) => {});
test('runs in parallel 2', async ({ page }) => {});

串行运行测试，从头开始重试。

注意

不建议串行运行。通常最好使您的测试隔离，以便它们可以独立运行。

// Annotate tests as inter-dependent.
test.describe.configure({ mode: 'serial' });
test('runs first', async ({ page }) => {});
test('runs second', async ({ page }) => {});

为每个测试配置重试和超时。

// Each test in the file will be retried twice and have a timeout of 20 seconds.
test.describe.configure({ retries: 2, timeout: 20_000 });
test('runs first', async ({ page }) => {});
test('runs second', async ({ page }) => {});

并行运行多个 describe，但每个 describe 中的测试按顺序运行。

test.describe.configure({ mode: 'parallel' });

test.describe('A, runs in parallel with B', () => {
  test.describe.configure({ mode: 'default' });
  test('in order A1', async ({ page }) => {});
  test('in order A2', async ({ page }) => {});
});

test.describe('B, runs in parallel with A', () => {
  test.describe.configure({ mode: 'default' });
  test('in order B1', async ({ page }) => {});
  test('in order B2', async ({ page }) => {});
});

参数

options Object (可选)
- mode "default" | "parallel" | "serial" (可选)#
  
  执行模式。了解更多关于执行模式的信息，请点击这里。
- retries number (可选)添加于版本: v1.28#
  
  每个测试的重试次数。
- timeout number (可选)添加于版本: v1.28#
  
  每个测试的超时时间，以毫秒为单位。覆盖 testProject.timeout 和 testConfig.timeout。

test.describe.fixme

添加于版本: v1.25

test.test.describe.fixme

声明一个测试组，类似于 test.describe()。此组中的测试标记为 "fixme"，并且不会执行。

test.describe.fixme(title, callback)
test.describe.fixme(callback)
test.describe.fixme(title, details, callback)

用法

test.describe.fixme('broken tests that should be fixed', () => {
  test('example', async ({ page }) => {
    // This test will not run
  });
});

您也可以省略标题。

test.describe.fixme(() => {
  // ...
});

参数

title string (可选)#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

在调用 test.describe.fixme() 时立即运行的回调。在此回调中添加的任何测试都将属于该组，并且不会运行。

test.describe.only

添加于版本: v1.10

test.test.describe.only

声明一个聚焦的测试组。如果有一些聚焦的测试或套件，它们都将运行，但其他任何内容都不会运行。

test.describe.only(title, callback)
test.describe.only(callback)
test.describe.only(title, details, callback)

用法

test.describe.only('focused group', () => {
  test('in the focused group', async ({ page }) => {
    // This test will run
  });
});
test('not in the focused group', async ({ page }) => {
  // This test will not run
});

您也可以省略标题。

test.describe.only(() => {
  // ...
});

参数

title string (可选)#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

在调用 test.describe.only() 时立即运行的回调。在此回调中添加的任何测试都将属于该组。

test.describe.skip

添加于版本: v1.10

test.test.describe.skip

声明一个跳过的测试组，类似于 test.describe()。跳过组中的测试永远不会运行。

test.describe.skip(title, callback)
test.describe.skip(title)
test.describe.skip(title, details, callback)

用法

test.describe.skip('skipped group', () => {
  test('example', async ({ page }) => {
    // This test will not run
  });
});

您也可以省略标题。

test.describe.skip(() => {
  // ...
});

参数

title string #

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

在调用 test.describe.skip() 时立即运行的回调。在此回调中添加的任何测试都将属于该组，并且不会运行。

test.extend

添加于版本: v1.10

test.test.extend

通过定义可在测试中使用的夹具和/或选项来扩展 test 对象。

用法

首先定义一个夹具和/或一个选项。

TypeScript
JavaScript

import { test as base } from '@playwright/test';
import { TodoPage } from './todo-page';

export type Options = { defaultItem: string };

// Extend basic test by providing a "defaultItem" option and a "todoPage" fixture.
export const test = base.extend<Options & { todoPage: TodoPage }>({
  // Define an option and provide a default value.
  // We can later override it in the config.
  defaultItem: ['Do stuff', { option: true }],

  // Define a fixture. Note that it can use built-in fixture "page"
  // and a new option "defaultItem".
  todoPage: async ({ page, defaultItem }, use) => {
    const todoPage = new TodoPage(page);
    await todoPage.goto();
    await todoPage.addToDo(defaultItem);
    await use(todoPage);
    await todoPage.removeAll();
  },
});

my-test.js
const base = require('@playwright/test');
const { TodoPage } = require('./todo-page');

// Extend basic test by providing a "defaultItem" option and a "todoPage" fixture.
exports.test = base.test.extend({
  // Define an option and provide a default value.
  // We can later override it in the config.
  defaultItem: ['Do stuff', { option: true }],

  // Define a fixture. Note that it can use built-in fixture "page"
  // and a new option "defaultItem".
  todoPage: async ({ page, defaultItem }, use) => {
    const todoPage = new TodoPage(page);
    await todoPage.goto();
    await todoPage.addToDo(defaultItem);
    await use(todoPage);
    await todoPage.removeAll();
  },
});

然后在测试中使用夹具。

example.spec.ts
import { test } from './my-test';

test('test 1', async ({ todoPage }) => {
  await todoPage.addToDo('my todo');
  // ...
});

在配置文件中配置选项。

TypeScript
JavaScript

playwright.config.ts
import { defineConfig } from '@playwright/test';
import type { Options } from './my-test';

export default defineConfig<Options>({
  projects: [
    {
      name: 'shopping',
      use: { defaultItem: 'Buy milk' },
    },
    {
      name: 'wellbeing',
      use: { defaultItem: 'Exercise!' },
    },
  ]
});

playwright.config.ts
// @ts-check

module.exports = defineConfig({
  projects: [
    {
      name: 'shopping',
      use: { defaultItem: 'Buy milk' },
    },
    {
      name: 'wellbeing',
      use: { defaultItem: 'Exercise!' },
    },
  ]
});

了解更多关于夹具和参数化测试的信息。

参数

fixtures Object #

一个包含夹具和/或选项的对象。了解更多关于夹具格式的信息。

返回值

Test #

test.fail

添加于版本: v1.10

test.test.fail

将测试标记为 “应该失败”。Playwright 运行此测试并确保它实际上失败。这对于文档目的非常有用，以确认某些功能已损坏，直到修复为止。

声明一个 “失败” 测试

test.fail(title, body)
test.fail(title, details, body)

在运行时将测试注解为 “失败”

test.fail(condition, description)
test.fail(callback, description)
test.fail()

用法

您可以声明一个测试为失败，以便 Playwright 确保它实际失败。

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

test.fail('not yet ready', async ({ page }) => {
  // ...
});

如果您的测试在某些配置中失败，但在并非所有配置中都失败，则可以根据某些条件在测试主体内部将测试标记为失败。我们建议在这种情况下传递 description 参数。

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

test('fail in WebKit', async ({ page, browserName }) => {
  test.fail(browserName === 'webkit', 'This feature is not implemented for Mac yet');
  // ...
});

您可以使用单个 test.fail(callback, description) 调用，根据某些条件将文件或 test.describe() 组中的所有测试标记为 “应该失败”。

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

test.fail(({ browserName }) => browserName === 'webkit', 'not implemented yet');

test('fail in WebKit 1', async ({ page }) => {
  // ...
});
test('fail in WebKit 2', async ({ page }) => {
  // ...
});

您也可以在测试主体内部调用不带参数的 test.fail()，以始终将测试标记为失败。我们建议使用 test.fail(title, body) 来声明失败的测试。

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

test('less readable', async ({ page }) => {
  test.fail();
  // ...
});

参数

title string (可选)添加于版本: v1.42#

测试标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关测试详细信息描述，请参阅 test()。
body function(Fixtures, TestInfo) (可选)添加于版本: v1.42#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。
condition boolean (可选)#

当条件为 true 时，测试标记为 “应该失败”。
callback function(Fixtures):boolean (可选)#

一个函数，根据测试夹具返回是否标记为 “应该失败”。当返回值是 true 时，测试或多个测试标记为 “应该失败”。
description string (可选)#

可选的描述，将反映在测试报告中。

test.fail.only

添加于版本: v1.49

test.test.fail.only

您可以使用 test.fail.only 来专注于一个预期会失败的特定测试。这在调试失败的测试或处理特定问题时特别有用。

声明一个聚焦的 “失败” 测试

test.fail.only(title, body)
test.fail.only(title, details, body)

用法

您可以声明一个聚焦的失败测试，以便 Playwright 仅运行此测试并确保它实际失败。

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

test.fail.only('focused failing test', async ({ page }) => {
  // This test is expected to fail
});
test('not in the focused group', async ({ page }) => {
  // This test will not run
});

参数

title string (可选)#

测试标题。
details Object (可选)#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关测试详细信息描述，请参阅 test.describe()。
body function(Fixtures, TestInfo) (可选)#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。

test.fixme

添加于版本: v1.10

test.test.fixme

将测试标记为 "fixme"，意图修复它。Playwright 将不会运行超过 test.fixme() 调用的测试。

声明一个 "fixme" 测试

test.fixme(title, body)
test.fixme(title, details, body)

在运行时将测试注解为 "fixme"

test.fixme(condition, description)
test.fixme(callback, description)
test.fixme()

用法

您可以声明一个测试为待修复，Playwright 将不会运行它。

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

test.fixme('to be fixed', async ({ page }) => {
  // ...
});

如果您的测试应该在某些配置中修复，但在并非所有配置中都修复，则可以根据某些条件在测试主体内部将测试标记为 "fixme"。我们建议在这种情况下传递 description 参数。Playwright 将运行测试，但在 test.fixme 调用后立即中止它。

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

test('to be fixed in Safari', async ({ page, browserName }) => {
  test.fixme(browserName === 'webkit', 'This feature breaks in Safari for some reason');
  // ...
});

您可以使用单个 test.fixme(callback, description) 调用，根据某些条件将文件或 test.describe() 组中的所有测试标记为 "fixme"。

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

test.fixme(({ browserName }) => browserName === 'webkit', 'Should figure out the issue');

test('to be fixed in Safari 1', async ({ page }) => {
  // ...
});
test('to be fixed in Safari 2', async ({ page }) => {
  // ...
});

您也可以在测试主体内部调用不带参数的 test.fixme()，以始终将测试标记为失败。我们建议使用 test.fixme(title, body) 代替。

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

test('less readable', async ({ page }) => {
  test.fixme();
  // ...
});

参数

title string (可选)#

测试标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关测试详细信息描述，请参阅 test()。
body function(Fixtures, TestInfo) (可选)#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。
condition boolean (可选)#

当条件为 true 时，测试标记为 “应该失败”。
callback function(Fixtures):boolean (可选)#

一个函数，根据测试夹具返回是否标记为 “应该失败”。当返回值是 true 时，测试或多个测试标记为 “应该失败”。
description string (可选)#

可选的描述，将反映在测试报告中。

test.info

添加于版本: v1.10

test.test.info

返回有关当前正在运行的测试的信息。此方法只能在测试执行期间调用，否则会抛出错误。

用法

test('example test', async ({ page }) => {
  // ...
  await test.info().attach('screenshot', {
    body: await page.screenshot(),
    contentType: 'image/png',
  });
});

返回值

TestInfo #

test.only

添加于版本: v1.10

test.test.only

声明一个聚焦的测试。如果有一些聚焦的测试或套件，它们都将运行，但其他任何内容都不会运行。

test.only(title, body)
test.only(title, details, body)

用法

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

参数

title string #

测试标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关测试详细信息描述，请参阅 test()。
body function(Fixtures, TestInfo)#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。

test.setTimeout

添加于版本: v1.10

test.test.setTimeout

更改测试的超时时间。零表示没有超时。了解更多关于各种超时的信息。

当前正在运行的测试的超时时间可以通过 testInfo.timeout 访问。

用法

更改测试超时时间。

test('very slow test', async ({ page }) => {
  test.setTimeout(120000);
  // ...
});

从缓慢的 beforeEach 钩子更改超时时间。请注意，这会影响与 beforeEach 钩子共享的测试超时时间。

test.beforeEach(async ({ page }, testInfo) => {
  // Extend timeout for all tests running this hook by 30 seconds.
  test.setTimeout(testInfo.timeout + 30000);
});

更改 beforeAll 或 afterAll 钩子的超时时间。请注意，这会影响钩子的超时时间，而不是测试超时时间。
```
test.beforeAll(async () => {
  // Set timeout for this hook.
  test.setTimeout(60000);
});
```

更改 test.describe() 组中所有测试的超时时间。

test.describe('group', () => {
  // Applies to all tests in this group.
  test.describe.configure({ timeout: 60000 });

  test('test one', async () => { /* ... */ });
  test('test two', async () => { /* ... */ });
  test('test three', async () => { /* ... */ });
});

参数

timeout number #

超时时间，以毫秒为单位。

test.skip

添加于版本: v1.10

test.test.skip

跳过一个测试。 Playwright 将不会运行超过 test.skip() 调用的测试部分。

被跳过的测试本不应该被运行。如果你打算修复测试，请使用 test.fixme() 代替。

声明一个被跳过的测试

test.skip(title, body)
test.skip(title, details, body)

在运行时跳过一个测试

test.skip(condition, description)
test.skip(callback, description)
test.skip()

用法

你可以声明一个被跳过的测试，Playwright 将不会运行它。

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

test.skip('never run', async ({ page }) => {
  // ...
});

如果你的测试应该在某些配置中被跳过，但不是所有配置，你可以在测试主体内部基于某些条件跳过测试。我们建议在这种情况下传递一个 description 参数。 Playwright 将会运行测试，但在 test.skip 调用后立即中止它。

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

test('Safari-only test', async ({ page, browserName }) => {
  test.skip(browserName !== 'webkit', 'This feature is Safari-only');
  // ...
});

你可以使用单个 test.skip(callback, description) 调用，基于某些条件跳过文件或 test.describe() 组中的所有测试。

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

test.skip(({ browserName }) => browserName !== 'webkit', 'Safari-only');

test('Safari-only test 1', async ({ page }) => {
  // ...
});
test('Safari-only test 2', async ({ page }) => {
  // ...
});

你也可以在测试主体内部调用不带参数的 test.skip()，以始终将测试标记为失败。我们建议使用 test.skip(title, body) 代替。

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

test('less readable', async ({ page }) => {
  test.skip();
  // ...
});

参数

title string （可选）#

测试标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关测试详细信息描述，请参阅 test()。
body function(Fixtures, TestInfo) （可选）#

测试主体，接受一个或两个参数：一个带有夹具的对象和可选的 TestInfo。
condition boolean （可选）#

当条件为 true 时，测试标记为 “应该失败”。
callback function(Fixtures):boolean （可选）#

一个函数，根据测试夹具返回是否标记为 “应该失败”。当返回值是 true 时，测试或多个测试标记为 “应该失败”。
description string （可选）#

可选的描述，将反映在测试报告中。

test.slow

添加于版本: v1.10

test.test.slow

将测试标记为 “slow”。慢速测试将被赋予三倍的默认超时时间。

请注意，test.slow() 不能在 beforeAll 或 afterAll 钩子中使用。请改用 test.setTimeout()。

test.slow()
test.slow(condition, description)
test.slow(callback, description)

用法

你可以通过在测试主体内部调用 test.slow() 来将测试标记为 slow。

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

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

如果你的测试在某些配置中很慢，但不是所有配置，你可以基于条件将其标记为 slow。我们建议在这种情况下传递一个 description 参数。

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

test('slow in Safari', async ({ page, browserName }) => {
  test.slow(browserName === 'webkit', 'This feature is slow in Safari');
  // ...
});

你可以通过传递回调，基于某些条件将文件或 test.describe() 组中的所有测试标记为 “slow”。

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

test.slow(({ browserName }) => browserName === 'webkit', 'all tests are slow in Safari');

test('slow in Safari 1', async ({ page }) => {
  // ...
});
test('fail in Safari 2', async ({ page }) => {
  // ...
});

参数

condition boolean （可选）#

当条件为 true 时，测试被标记为 “slow”。
callback function(Fixtures):boolean （可选）#

一个函数，用于基于测试 fixtures 返回是否标记为 “slow”。当返回值是 true 时，测试或多个测试被标记为 “slow”。
description string （可选）#

可选的描述，将反映在测试报告中。

test.step

添加于版本: v1.10

test.test.step

声明一个在报告中显示的测试步骤。

用法

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

test('test', async ({ page }) => {
  await test.step('Log in', async () => {
    // ...
  });

  await test.step('Outer step', async () => {
    // ...
    // You can nest steps inside each other.
    await test.step('Inner step', async () => {
      // ...
    });
  });
});

参数

title string #

步骤名称。
body function():Promise<Object>#

步骤主体。
options Object (可选)
- box boolean （可选）添加于: v1.39#
  
  是否在报告中将步骤放入盒子中。默认为 false。当步骤被放入盒子中时，从步骤内部抛出的错误会指向步骤调用位置。详见下文。
- location Location （可选）添加于: v1.48#
  
  指定步骤在测试报告和跟踪查看器中显示的自定义位置。默认情况下，显示 test.step() 调用的位置。
- timeout number (可选)添加于: v1.50#
  
  步骤完成允许的最大时间，以毫秒为单位。如果步骤未在指定的超时时间内完成，test.step() 方法将抛出一个 TimeoutError。默认为 0 (无超时)。

返回值

Promise<Object>#

详情

该方法返回步骤回调函数返回的值。

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

test('test', async ({ page }) => {
  const user = await test.step('Log in', async () => {
    // ...
    return 'john';
  });
  expect(user).toBe('john');
});

装饰器

你可以使用 TypeScript 方法装饰器将方法转换为步骤。每次调用被装饰的方法都会在报告中显示为一个步骤。

function step(target: Function, context: ClassMethodDecoratorContext) {
  return function replacementMethod(...args: any) {
    const name = this.constructor.name + '.' + (context.name as string);
    return test.step(name, async () => {
      return await target.call(this, ...args);
    });
  };
}

class LoginPage {
  constructor(readonly page: Page) {}

  @step
  async login() {
    const account = { username: 'Alice', password: 's3cr3t' };
    await this.page.getByLabel('Username or email address').fill(account.username);
    await this.page.getByLabel('Password').fill(account.password);
    await this.page.getByRole('button', { name: 'Sign in' }).click();
    await expect(this.page.getByRole('button', { name: 'View profile and more' })).toBeVisible();
  }
}

test('example', async ({ page }) => {
  const loginPage = new LoginPage(page);
  await loginPage.login();
});

盒子化

当步骤内部的某些内容失败时，你通常会看到错误指向失败的确切操作。例如，考虑以下登录步骤

async function login(page) {
  await test.step('login', async () => {
    const account = { username: 'Alice', password: 's3cr3t' };
    await page.getByLabel('Username or email address').fill(account.username);
    await page.getByLabel('Password').fill(account.password);
    await page.getByRole('button', { name: 'Sign in' }).click();
    await expect(page.getByRole('button', { name: 'View profile and more' })).toBeVisible();
  });
}

test('example', async ({ page }) => {
  await page.goto('https://github.com/login');
  await login(page);
});

Error: Timed out 5000ms waiting for expect(locator).toBeVisible()
  ... error details omitted ...

   8 |     await page.getByRole('button', { name: 'Sign in' }).click();
>  9 |     await expect(page.getByRole('button', { name: 'View profile and more' })).toBeVisible();
     |                                                                               ^
  10 |   });

正如我们在上面看到的，测试可能会失败，错误指向步骤内部。如果你希望错误突出显示 “login” 步骤而不是其内部，请使用 box 选项。盒子化步骤内部的错误指向步骤调用位置。

async function login(page) {
  await test.step('login', async () => {
    // ...
  }, { box: true });  // Note the "box" option here.
}

Error: Timed out 5000ms waiting for expect(locator).toBeVisible()
  ... error details omitted ...

  14 |   await page.goto('https://github.com/login');
> 15 |   await login(page);
     |         ^
  16 | });

你也可以为盒子化步骤创建一个 TypeScript 装饰器，类似于上面的常规步骤装饰器

function boxedStep(target: Function, context: ClassMethodDecoratorContext) {
  return function replacementMethod(...args: any) {
    const name = this.constructor.name + '.' + (context.name as string);
    return test.step(name, async () => {
      return await target.call(this, ...args);
    }, { box: true });  // Note the "box" option here.
  };
}

class LoginPage {
  constructor(readonly page: Page) {}

  @boxedStep
  async login() {
    // ....
  }
}

test('example', async ({ page }) => {
  const loginPage = new LoginPage(page);
  await loginPage.login();  // <-- Error will be reported on this line.
});

test.step.skip

添加于: v1.50

test.test.step.skip

将测试步骤标记为 “skip” 以临时禁用其执行，这对于当前失败并计划在近期修复的步骤很有用。 Playwright 将不会运行该步骤。

用法

你可以声明一个被跳过的步骤，Playwright 将不会运行它。

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

test('my test', async ({ page }) => {
  // ...
  await test.step.skip('not yet ready', async () => {
    // ...
  });
});

参数

title string #

步骤名称。
body function():Promise<Object>#

步骤主体。
options Object (可选)
- box boolean （可选）#
  
  是否在报告中将步骤放入盒子中。默认为 false。当步骤被放入盒子中时，从步骤内部抛出的错误会指向步骤调用位置。详见下文。
- location Location （可选）#
  
  指定步骤在测试报告和跟踪查看器中显示的自定义位置。默认情况下，显示 test.step() 调用的位置。
- timeout number （可选）#
  
  步骤完成的最大时间，以毫秒为单位。默认为 0 (无超时)。

返回值

Promise<void>#

test.use

添加于版本: v1.10

test.test.use

指定在单个测试文件或 test.describe() 组中使用的选项或 fixtures。最有用于设置一个选项，例如设置 locale 来配置 context fixture。

用法

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

test.use({ locale: 'en-US' });

test('test with locale', async ({ page }) => {
  // Default context and page have locale as specified
});

参数

options TestOptions #

包含本地选项的对象。

详情

test.use 可以在全局作用域或 test.describe 内部调用。在 beforeEach 或 beforeAll 内部调用是错误的。

也可以通过提供函数来覆盖 fixture。

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

test.use({
  locale: async ({}, use) => {
    // Read locale from some configuration file.
    const locale = await fs.promises.readFile('test-locale', 'utf-8');
    await use(locale);
  },
});

test('test with locale', async ({ page }) => {
  // Default context and page have locale as specified
});

属性

test.expect

添加于版本: v1.10

test.test.expect

expect 函数可以用于创建测试断言。阅读更多关于测试断言的信息。

用法

test('example', async ({ page }) => {
  await test.expect(page).toHaveTitle('Title');
});

类型

对象

已弃用

test.describe.parallel

添加于版本: v1.10

test.test.describe.parallel

不推荐使用

有关配置执行模式的首选方式，请参阅 test.describe.configure()。

声明一组可以并行运行的测试。默认情况下，单个测试文件中的测试会一个接一个地运行，但使用 test.describe.parallel() 允许它们并行运行。

test.describe.parallel(title, callback)
test.describe.parallel(callback)
test.describe.parallel(title, details, callback)

用法

test.describe.parallel('group', () => {
  test('runs in parallel 1', async ({ page }) => {});
  test('runs in parallel 2', async ({ page }) => {});
});

请注意，并行测试在单独的进程中执行，并且无法共享任何状态或全局变量。每个并行测试都执行所有相关的钩子。

您也可以省略标题。

test.describe.parallel(() => {
  // ...
});

参数

title string （可选）#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

一个在调用 test.describe.parallel() 时立即运行的回调函数。在此回调中添加的任何测试都将属于该组。

test.describe.parallel.only

添加于版本: v1.10

test.test.describe.parallel.only

不推荐使用

有关配置执行模式的首选方式，请参阅 test.describe.configure()。

声明一组可以并行运行的焦点测试组。这类似于 test.describe.parallel()，但会聚焦该组。如果有一些焦点测试或套件，则将运行所有这些测试或套件，但不会运行其他任何内容。

test.describe.parallel.only(title, callback)
test.describe.parallel.only(callback)
test.describe.parallel.only(title, details, callback)

用法

test.describe.parallel.only('group', () => {
  test('runs in parallel 1', async ({ page }) => {});
  test('runs in parallel 2', async ({ page }) => {});
});

您也可以省略标题。

test.describe.parallel.only(() => {
  // ...
});

参数

title string （可选）#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

一个在调用 test.describe.parallel.only() 时立即运行的回调函数。在此回调中添加的任何测试都将属于该组。

test.describe.serial

添加于版本: v1.10

test.test.describe.serial

不推荐使用

有关配置执行模式的首选方式，请参阅 test.describe.configure()。

声明一组应始终串行运行的测试。如果其中一个测试失败，则所有后续测试都将被跳过。组中的所有测试都将一起重试。

注意

不建议使用串行。通常最好使你的测试隔离，以便它们可以独立运行。

test.describe.serial(title, callback)
test.describe.serial(title)
test.describe.serial(title, details, callback)

用法

test.describe.serial('group', () => {
  test('runs first', async ({ page }) => {});
  test('runs second', async ({ page }) => {});
});

您也可以省略标题。

test.describe.serial(() => {
  // ...
});

参数

title string （可选）#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

一个在调用 test.describe.serial() 时立即运行的回调函数。在此回调中添加的任何测试都将属于该组。

test.describe.serial.only

添加于版本: v1.10

test.test.describe.serial.only

不推荐使用

有关配置执行模式的首选方式，请参阅 test.describe.configure()。

声明一组应始终串行运行的焦点测试组。如果其中一个测试失败，则所有后续测试都将被跳过。组中的所有测试都将一起重试。如果有一些焦点测试或套件，则将运行所有这些测试或套件，但不会运行其他任何内容。

注意

不建议使用串行。通常最好使你的测试隔离，以便它们可以独立运行。

test.describe.serial.only(title, callback)
test.describe.serial.only(title)
test.describe.serial.only(title, details, callback)

用法

test.describe.serial.only('group', () => {
  test('runs first', async ({ page }) => {
  });
  test('runs second', async ({ page }) => {
  });
});

您也可以省略标题。

test.describe.serial.only(() => {
  // ...
});

参数

title string （可选）#

组标题。
details Object (可选)添加于版本: v1.42#
- tag string | Array<string> (可选)
- annotation Object | Array<Object> (可选)
  - type string
  - description string (可选)
有关详细描述，请参阅 test.describe()。
callback function #

一个在调用 test.describe.serial.only() 时立即运行的回调函数。在此回调中添加的任何测试都将属于该组。

方法​

test​

test.afterAll​

test.afterEach​

test.beforeAll​

test.beforeEach​

test.describe​

test.describe.configure​

test.describe.fixme​

test.describe.only​

test.describe.skip​

test.extend​

test.fail​

test.fail.only​

test.fixme​

test.info​

test.only​

test.setTimeout​

test.skip​

test.slow​

test.step​

test.step.skip​

test.use​

属性​

test.expect​

已弃用​

test.describe.parallel​

test.describe.parallel.only​

test.describe.serial​

test.describe.serial.only​

方法

test

test.afterAll

test.afterEach

test.beforeAll

test.beforeEach

test.describe

test.describe.configure

test.describe.fixme

test.describe.only

test.describe.skip

test.extend

test.fail

test.fail.only

test.fixme

test.info

test.only

test.setTimeout

test.skip

test.slow

test.step

test.step.skip

test.use

属性

test.expect

已弃用

test.describe.parallel

test.describe.parallel.only

test.describe.serial

test.describe.serial.only