SnapshotAssertions

Playwright 提供了将页面和元素屏幕截图与存储在文件中的预期值进行比较的方法。

expect(screenshot).toMatchSnapshot('landing-page.png');

---

方法

toMatchSnapshot(name)

新增于: v1.22 snapshotAssertions.toMatchSnapshot(name)

注意

要比较屏幕截图，请改用 expect(page).toHaveScreenshot()。

确保传入的值，无论是 string 还是 Buffer，都与存储在测试快照目录中的预期快照匹配。

用法

// Basic usage.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png');

// Pass options to customize the snapshot comparison and have a generated name.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png', {
  maxDiffPixels: 27, // allow no more than 27 different pixels.
});

// Configure image matching threshold.
expect(await page.screenshot()).toMatchSnapshot('landing-page.png', { threshold: 0.3 });

// Bring some structure to your snapshot files by passing file path segments.
expect(await page.screenshot()).toMatchSnapshot(['landing', 'step2.png']);
expect(await page.screenshot()).toMatchSnapshot(['landing', 'step3.png']);

了解更多关于视觉比较的信息。

请注意，匹配快照仅适用于 Playwright 测试运行器。

参数

• name string | Array<string>#

  快照名称。

• options Object (可选)

  • maxDiffPixelRatio number (可选)#

    像素差异与总像素量的可接受比率，介于 0 和 1 之间。默认可通过 TestConfig.expect 配置。默认未设置。

  • maxDiffPixels number (可选)#

    可接受的像素差异数量。默认可通过 TestConfig.expect 配置。默认未设置。

  • threshold number (可选)#

    比较图像中相同像素在 YIQ 色彩空间中可接受的感知色差，范围在零 (严格) 到一 (宽松) 之间，默认值可通过 TestConfig.expect 配置。默认为 0.2。

---

toMatchSnapshot(options)

新增于: v1.22 snapshotAssertions.toMatchSnapshot(options)

注意

要比较屏幕截图，请改用 expect(page).toHaveScreenshot()。

确保传入的值，无论是 string 还是 Buffer，都与存储在测试快照目录中的预期快照匹配。

用法

// Basic usage and the file name is derived from the test name.
expect(await page.screenshot()).toMatchSnapshot();

// Pass options to customize the snapshot comparison and have a generated name.
expect(await page.screenshot()).toMatchSnapshot({
  maxDiffPixels: 27, // allow no more than 27 different pixels.
});

// Configure image matching threshold and snapshot name.
expect(await page.screenshot()).toMatchSnapshot({
  name: 'landing-page.png',
  threshold: 0.3,
});

了解更多关于视觉比较的信息。

请注意，匹配快照仅适用于 Playwright 测试运行器。

参数

• options Object (可选)

  • maxDiffPixelRatio number (可选)#

    像素差异与总像素量的可接受比率，介于 0 和 1 之间。默认可通过 TestConfig.expect 配置。默认未设置。

  • maxDiffPixels number (可选)#

    可接受的像素差异数量。默认可通过 TestConfig.expect 配置。默认未设置。

  • name string | Array<string> (可选)#

    快照名称。如果未传入，则在多次调用时使用测试名称和序号。

  • threshold number (可选)#

    比较图像中相同像素在 YIQ 色彩空间中可接受的感知色差，范围在零 (严格) 到一 (宽松) 之间，默认值可通过 TestConfig.expect 配置。默认为 0.2。