PageAssertions

PageAssertions 类提供了断言方法，可用于在测试中对 Page 状态进行断言。

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

test('navigates to login', async ({ page }) => {
  // ...
  await page.getByText('Sign in').click();
  await expect(page).toHaveURL(/.*\/login/);
});

方法

toHaveScreenshot(name)

新增于: v1.23

pageAssertions.toHaveScreenshot(name)

此函数将等待直到连续两次页面截图结果相同，然后将最后一次截图与预期进行比较。

用法

await expect(page).toHaveScreenshot('image.png');

请注意，截图断言仅适用于 Playwright 测试运行器。

参数

name string | Array<string>#

快照名称。
options Object (可选)
- animations "disabled" | "allow" (可选)#
  
  当设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web Animations。动画根据其持续时间得到不同的处理：
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会被取消并回到初始状态，然后在截图后再次播放。
  默认为 "disabled"，即禁用动画。
- caret "hide" | "initial" (可选)#
  
  当设置为 "hide" 时，截图将隐藏文本插入符号。当设置为 "initial" 时，文本插入符号的行为将不变。默认为 "hide"。
- clip Object (可选)#
  - x number
    
    裁剪区域左上角的 x 坐标
  - y number
    
    裁剪区域左上角的 y 坐标
  - width number
    
    裁剪区域的宽度
  - height number
    
    裁剪区域的高度
  一个对象，指定结果图像的裁剪区域。
- fullPage boolean (可选)#
  
  当为 true 时，截取整个可滚动页面的截图，而不是当前可见视口。默认为 false。
- mask Array<Locator> (可选)#
  
  指定在进行截图时应遮罩的定位器。被遮罩的元素将被一个完全覆盖其边界框的粉色框 #FF00FF (可通过 maskColor 自定义) 叠加。遮罩也适用于不可见的元素，请参阅仅匹配可见元素以禁用此行为。
- maskColor string (可选)新增于: v1.35#
  
  指定被遮罩元素的叠加框颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。
- maxDiffPixelRatio number (可选)#
  
  可接受的不同像素占总像素的比例，介于 0 和 1 之间。默认值可在 TestConfig.expect 中配置。默认情况下未设置。
- maxDiffPixels number (可选)#
  
  可接受的不同像素数量。默认值可在 TestConfig.expect 中配置。默认情况下未设置。
- omitBackground boolean (可选)#
  
  隐藏默认的白色背景，允许捕获带有透明度的截图。不适用于 jpeg 图像。默认为 false。
- scale "css" | "device" (可选)#
  
  当设置为 "css" 时，截图将按照页面上的每个 CSS 像素生成一个实际像素。对于高 DPI 设备，这将使截图文件较小。使用 "device" 选项将按照每个设备像素生成一个实际像素，因此高 DPI 设备的截图将会是两倍大甚至更大。
  
  默认为 "css"。
- stylePath string | Array<string> (可选)新增于: v1.41#
  
  包含截图时应用的样式表的文件名。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截图。此样式表会穿透 Shadow DOM 并应用于内部框架。
- threshold number (可选)#
  
  在 YIQ 颜色空间中，比较图像中相同像素的可接受的感知颜色差异，介于零（严格）和一（宽松）之间，默认值可在 TestConfig.expect 中配置。默认为 0.2。
- timeout number (可选)#
  
  重试断言的时间，单位为毫秒。默认为 TestConfig.expect 中的 timeout。

返回值

Promise<void>#

toHaveScreenshot(options)

新增于: v1.23

pageAssertions.toHaveScreenshot(options)

此函数将等待直到连续两次页面截图结果相同，然后将最后一次截图与预期进行比较。

用法

await expect(page).toHaveScreenshot();

请注意，截图断言仅适用于 Playwright 测试运行器。

参数

options Object (可选)
- animations "disabled" | "allow" (可选)#
  
  当设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web Animations。动画根据其持续时间得到不同的处理：
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会被取消并回到初始状态，然后在截图后再次播放。
  默认为 "disabled"，即禁用动画。
- caret "hide" | "initial" (可选)#
  
  当设置为 "hide" 时，截图将隐藏文本插入符号。当设置为 "initial" 时，文本插入符号的行为将不变。默认为 "hide"。
- clip Object (可选)#
  - x number
    
    裁剪区域左上角的 x 坐标
  - y number
    
    裁剪区域左上角的 y 坐标
  - width number
    
    裁剪区域的宽度
  - height number
    
    裁剪区域的高度
  一个对象，指定结果图像的裁剪区域。
- fullPage boolean (可选)#
  
  当为 true 时，截取整个可滚动页面的截图，而不是当前可见视口。默认为 false。
- mask Array<Locator> (可选)#
  
  指定在进行截图时应遮罩的定位器。被遮罩的元素将被一个完全覆盖其边界框的粉色框 #FF00FF (可通过 maskColor 自定义) 叠加。遮罩也适用于不可见的元素，请参阅仅匹配可见元素以禁用此行为。
- maskColor string (可选)新增于: v1.35#
  
  指定被遮罩元素的叠加框颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。
- maxDiffPixelRatio number (可选)#
  
  可接受的不同像素占总像素的比例，介于 0 和 1 之间。默认值可在 TestConfig.expect 中配置。默认情况下未设置。
- maxDiffPixels number (可选)#
  
  可接受的不同像素数量。默认值可在 TestConfig.expect 中配置。默认情况下未设置。
- omitBackground boolean (可选)#
  
  隐藏默认的白色背景，允许捕获带有透明度的截图。不适用于 jpeg 图像。默认为 false。
- scale "css" | "device" (可选)#
  
  当设置为 "css" 时，截图将按照页面上的每个 CSS 像素生成一个实际像素。对于高 DPI 设备，这将使截图文件较小。使用 "device" 选项将按照每个设备像素生成一个实际像素，因此高 DPI 设备的截图将会是两倍大甚至更大。
  
  默认为 "css"。
- stylePath string | Array<string> (可选)新增于: v1.41#
  
  包含截图时应用的样式表的文件名。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截图。此样式表会穿透 Shadow DOM 并应用于内部框架。
- threshold number (可选)#
  
  在 YIQ 颜色空间中，比较图像中相同像素的可接受的感知颜色差异，介于零（严格）和一（宽松）之间，默认值可在 TestConfig.expect 中配置。默认为 0.2。
- timeout number (可选)#
  
  重试断言的时间，单位为毫秒。默认为 TestConfig.expect 中的 timeout。

返回值

Promise<void>#

toHaveTitle

新增于: v1.20

pageAssertions.toHaveTitle

确保页面具有给定的标题。

用法

await expect(page).toHaveTitle(/.*checkout/);

参数

titleOrRegExp string | RegExp新增于: v1.18#

预期的标题或 RegExp。
options Object (可选)
- timeout number (可选)新增于: v1.18#
  
  重试断言的时间，单位为毫秒。默认为 TestConfig.expect 中的 timeout。

返回值

Promise<void>#

toHaveURL

新增于: v1.20

pageAssertions.toHaveURL

确保页面导航到给定的 URL。

用法

// Check for the page URL to be 'https://playwright.net.cn/docs/intro' (including query string)
await expect(page).toHaveURL('https://playwright.net.cn/docs/intro');

// Check for the page URL to contain 'doc', followed by an optional 's', followed by '/'
await expect(page).toHaveURL(/docs?\//);

// Check for the predicate to be satisfied
// For example: verify query strings
await expect(page).toHaveURL(url => {
  const params = url.searchParams;
  return params.has('search') && params.has('options') && params.get('id') === '5';
});

参数

url string | RegExp | function(URL):boolean新增于: v1.18#

预期的 URL 字符串、RegExp 或接收 URL 的谓词函数以进行匹配。当通过上下文选项提供了 baseURL 且 url 参数为字符串时，这两个值将通过 new URL() 构造函数合并，用于与当前浏览器 URL 进行比较。
options Object (可选)
- ignoreCase boolean (可选)新增于: v1.44#
  
  是否执行不区分大小写的匹配。ignoreCase 选项（如果指定）优先于相应的正则表达式参数。提供的谓词会忽略此标志。
- timeout number (可选)新增于: v1.18#
  
  重试断言的时间，单位为毫秒。默认为 TestConfig.expect 中的 timeout。

返回值

Promise<void>#

属性

not

新增于: v1.20

pageAssertions.not

使断言检查相反的条件。例如，以下代码测试页面 URL 不包含 "error"

await expect(page).not.toHaveURL('error');

用法

expect(page).not

类型

PageAssertions

方法​

toHaveScreenshot(name)​

toHaveScreenshot(options)​

toHaveTitle​

toHaveURL​

属性​

not​

方法

toHaveScreenshot(name)

toHaveScreenshot(options)

toHaveTitle

toHaveURL

属性

not