断言
简介
Playwright 包含 expect 函数形式的测试断言。要进行断言，请调用 expect(value) 并选择一个反映预期的匹配器。有许多 通用匹配器，例如 toEqual、toContain 和 toBeTruthy，可用于断言任何条件。
expect(success).toBeTruthy();
Playwright 还包括特定于 web 的 异步匹配器，它们将等待直到满足预期条件。考虑以下示例
await expect(page.getByTestId('status')).toHaveText('Submitted');
Playwright 将重新测试具有 status 测试 ID 的元素，直到获取的元素具有 "Submitted" 文本。它将重新获取元素并不断检查，直到满足条件或达到超时。您可以传递此超时，也可以通过测试配置中的 testConfig.expect 值配置一次。
默认情况下，断言的超时设置为 5 秒。了解有关 各种超时 的更多信息。
自动重试断言
以下断言将在断言通过或断言超时达到之前一直重试。请注意，重试断言是异步的，因此您必须 await 它们。
非重试断言
这些断言允许测试任何条件，但不会自动重试。大多数情况下，网页会异步显示信息，使用非重试断言会导致测试不稳定。
尽可能首选 自动重试 断言。对于需要重试的更复杂断言，请使用 expect.poll 或 expect.toPass。
否定匹配器
通常，我们可以通过在匹配器前面添加 .not 来预期相反结果为真
expect(value).not.toEqual(0);
await expect(locator).not.toContainText('some text');
软断言
默认情况下，失败的断言将终止测试执行。Playwright 还支持软断言：失败的软断言不会终止测试执行，但会将测试标记为失败。
// Make a few checks that will not stop the test when failed...
await expect.soft(page.getByTestId('status')).toHaveText('Success');
await expect.soft(page.getByTestId('eta')).toHaveText('1 day');
// ... and continue the test to check more things.
await page.getByRole('link', { name: 'next page' }).click();
await expect.soft(page.getByRole('heading', { name: 'Make another order' })).toBeVisible();
在测试执行过程中的任何时间点，您都可以检查是否发生了任何软断言失败
// Make a few checks that will not stop the test when failed...
await expect.soft(page.getByTestId('status')).toHaveText('Success');
await expect.soft(page.getByTestId('eta')).toHaveText('1 day');
// Avoid running further if there were soft assertion failures.
expect(test.info().errors).toHaveLength(0);
请注意，软断言仅适用于 Playwright 测试运行程序。
自定义 expect 消息
您可以将自定义 expect 消息指定为 expect 函数的第二个参数，例如
await expect(page.getByText('Name'), 'should be logged in').toBeVisible();
此消息将在报告器中显示，包括通过和失败的 expect，提供有关断言的更多上下文。
当 expect 通过时，您可能会看到类似这样的成功步骤
✅ should be logged in @example.spec.ts:18
当 expect 失败时，错误将如下所示
Error: should be logged in
Call log:
- expect.toBeVisible with timeout 5000ms
- waiting for "getByText('Name')"
2 |
3 | test('example test', async({ page }) => {
> 4 | await expect(page.getByText('Name'), 'should be logged in').toBeVisible();
| ^
5 | });
6 |
软断言也支持自定义消息
expect.soft(value, 'my soft assertion').toBe(56);
expect.configure
您可以创建自己的预配置 expect 实例以拥有自己的默认值，例如 timeout 和 soft。
const slowExpect = expect.configure({ timeout: 10000 });
await slowExpect(locator).toHaveText('Submit');
// Always do soft assertions.
const softExpect = expect.configure({ soft: true });
await softExpect(locator).toHaveText('Submit');
expect.poll
您可以使用 expect.poll 将任何同步 expect 转换为异步轮询 expect。
以下方法将轮询给定函数，直到它返回 HTTP 状态 200
await expect.poll(async () => {
const response = await page.request.get('https://api.example.com');
return response.status();
}, {
// Custom expect message for reporting, optional.
message: 'make sure API eventually succeeds',
// Poll for 10 seconds; defaults to 5 seconds. Pass 0 to disable timeout.
timeout: 10000,
}).toBe(200);
您还可以指定自定义轮询间隔
await expect.poll(async () => {
const response = await page.request.get('https://api.example.com');
return response.status();
}, {
// Probe, wait 1s, probe, wait 2s, probe, wait 10s, probe, wait 10s, probe
// ... Defaults to [100, 250, 500, 1000].
intervals: [1_000, 2_000, 10_000],
timeout: 60_000
}).toBe(200);
expect.toPass
您可以重试代码块，直到它们成功通过。
await expect(async () => {
const response = await page.request.get('https://api.example.com');
expect(response.status()).toBe(200);
}).toPass();
您还可以指定自定义超时和重试间隔
await expect(async () => {
const response = await page.request.get('https://api.example.com');
expect(response.status()).toBe(200);
}).toPass({
// Probe, wait 1s, probe, wait 2s, probe, wait 10s, probe, wait 10s, probe
// ... Defaults to [100, 250, 500, 1000].
intervals: [1_000, 2_000, 10_000],
timeout: 60_000
});
请注意，默认情况下 toPass 的超时为 0，并且不会遵守自定义 expect 超时。
使用 expect.extend 添加自定义匹配器
您可以通过提供自定义匹配器来扩展 Playwright 断言。这些匹配器将在 expect 对象上可用。
在此示例中，我们添加了一个自定义 toHaveAmount 函数。自定义匹配器应返回一个 message 回调和一个 pass 标志，指示断言是否通过。
import { expect as baseExpect } from '@playwright/test';
import type { Page, Locator } from '@playwright/test';
export { test } from '@playwright/test';
export const expect = baseExpect.extend({
async toHaveAmount(locator: Locator, expected: number, options?: { timeout?: number }) {
const assertionName = 'toHaveAmount';
let pass: boolean;
let matcherResult: any;
try {
await baseExpect(locator).toHaveAttribute('data-amount', String(expected), options);
pass = true;
} catch (e: any) {
matcherResult = e.matcherResult;
pass = false;
}
const message = pass
? () => this.utils.matcherHint(assertionName, undefined, undefined, { isNot: this.isNot }) +
'\n\n' +
`Locator: ${locator}\n` +
`Expected: ${this.isNot ? 'not' : ''}${this.utils.printExpected(expected)}\n` +
(matcherResult ? `Received: ${this.utils.printReceived(matcherResult.actual)}` : '')
: () => this.utils.matcherHint(assertionName, undefined, undefined, { isNot: this.isNot }) +
'\n\n' +
`Locator: ${locator}\n` +
`Expected: ${this.utils.printExpected(expected)}\n` +
(matcherResult ? `Received: ${this.utils.printReceived(matcherResult.actual)}` : '');
return {
message,
pass,
name: assertionName,
expected,
actual: matcherResult?.actual,
};
},
});
现在我们可以在测试中使用 toHaveAmount。
import { test, expect } from './fixtures';
test('amount', async () => {
await expect(page.locator('.cart')).toHaveAmount(4);
});
与 expect 库的兼容性
不要将 Playwright 的 expect 与 expect 库 混淆。后者未完全集成到 Playwright 测试运行程序中，因此请确保使用 Playwright 自身的 expect。
组合来自多个模块的自定义匹配器
您可以从多个文件或模块中组合自定义匹配器。
import { mergeTests, mergeExpects } from '@playwright/test';
import { test as dbTest, expect as dbExpect } from 'database-test-utils';
import { test as a11yTest, expect as a11yExpect } from 'a11y-test-utils';
export const expect = mergeExpects(dbExpect, a11yExpect);
export const test = mergeTests(dbTest, a11yTest);
import { test, expect } from './fixtures';
test('passes', async ({ database }) => {
await expect(database).toHaveDatabaseUser('admin');
});