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 动画。动画根据其持续时间获得不同的处理
  - 有限动画会快进到完成，因此它们将触发 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 动画。动画根据其持续时间获得不同的处理
  - 有限动画会快进到完成，因此它们将触发 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#

期望的标题或正则表达式。
options Object (可选)
- timeout number (可选)添加于: v1.18#
  
  重试断言的毫秒数。默认为 TestConfig.expect 中的 timeout。

Promise<void>#

toHaveURL

添加于: v1.20

pageAssertions.toHaveURL

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

用法

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

参数

urlOrRegExp string | RegExp添加于: v1.18#

期望的 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