快照断言

Playwright 提供方法来比较页面和元素快照与存储在文件中的预期值。

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

---

方法

toMatchSnapshot(name)

添加于：v1.22 snapshotAssertions.toMatchSnapshot(name)

注意

要比较快照，请改用 expect(page).toHaveScreenshot()。

确保传入的值（字符串或缓冲区）与存储在测试快照目录中的预期快照匹配。

用法

// 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 字符串 | 数组<字符串>#

  快照名称。

• options 对象 (可选)

  • maxDiffPixelRatio 数字 (可选)#

    不同像素与总像素之间的可接受比率，介于 0 和 1 之间。默认值可通过 TestConfig.expect 配置。默认情况下未设置。

  • maxDiffPixels 数字 (可选)#

    可能不同的像素数的可接受数量。默认值可通过 TestConfig.expect 配置。默认情况下未设置。

  • threshold 数字 (可选)#

    比较图像中相同像素之间的 YIQ 颜色空间 中可接受的感知颜色差异，介于零（严格）和一（宽松）之间，默认值可通过 TestConfig.expect 配置。默认为 0.2。

---

toMatchSnapshot()

添加于：v1.22 snapshotAssertions.toMatchSnapshot()

注意

要比较快照，请改用 expect(page).toHaveScreenshot()。

确保传入的值（字符串或缓冲区）与存储在测试快照目录中的预期快照匹配。

用法

// 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 对象 (可选)

  • maxDiffPixelRatio 数字 (可选)#

    不同像素与总像素之间的可接受比率，介于 0 和 1 之间。默认值可通过 TestConfig.expect 配置。默认情况下未设置。

  • maxDiffPixels 数字 (可选)#

    可能不同的像素数的可接受数量。默认值可通过 TestConfig.expect 配置。默认情况下未设置。

  • name 字符串 | 数组<字符串> (可选)#

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

  • threshold 数字 (可选)#

    比较图像中相同像素之间的 YIQ 颜色空间 中可接受的感知颜色差异，介于零（严格）和一（宽松）之间，默认值可通过 TestConfig.expect 配置。默认为 0.2。