跳转到主要内容

视觉比较

简介​

Playwright Test 支持使用 await expect(page).toHaveScreenshot() 生成和视觉比较屏幕截图。首次执行时，Playwright Test 将生成参考屏幕截图。后续运行将与参考进行比较。

example.spec.ts
import { test, expect } from '@playwright/test';

test('example test', async ({ page }) => {
  await page.goto('https://playwright.net.cn');
  await expect(page).toHaveScreenshot();
});
警告

浏览器渲染可能因主机操作系统、版本、设置、硬件、电源（电池 vs. 电源适配器）、无头模式和其他因素而异。为了获得一致的屏幕截图，请在生成基线屏幕截图的相同环境中运行测试。

生成屏幕截图​

当您第一次运行上述命令时，测试运行器会显示

Error: A snapshot doesn't exist at example.spec.ts-snapshots/example-test-1-chromium-darwin.png, writing actual.

那是因为还没有黄金文件。此方法拍摄了许多屏幕截图，直到两个连续的屏幕截图匹配，并将最后一个屏幕截图保存到文件系统。现在可以将其添加到仓库中。

包含黄金预期的文件夹名称以您的测试文件名称开头

drwxr-xr-x  5 user  group  160 Jun  4 11:46 .
drwxr-xr-x  6 user  group  192 Jun  4 11:45 ..
-rw-r--r--  1 user  group  231 Jun  4 11:16 example.spec.ts
drwxr-xr-x  3 user  group   96 Jun  4 11:46 example.spec.ts-snapshots

快照名称 example-test-1-chromium-darwin.png 由几部分组成

  • example-test-1.png - 自动生成的快照名称。或者，您可以将快照名称指定为 toHaveScreenshot() 方法的第一个参数

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

  • chromium-darwin - 浏览器名称和平台。由于不同的渲染、字体等，屏幕截图在不同浏览器和平台之间会有所不同，因此您需要为它们提供不同的快照。如果您在配置文件中使用多个项目，则将使用项目名称代替 chromium。

快照名称和路径可以通过 Playwright 配置中的 testConfig.snapshotPathTemplate 进行配置。

请注意，toHaveScreenshot() 也接受快照文件路径段数组，例如 expect().toHaveScreenshot(['relative', 'path', 'to', 'snapshot.png'])。但是，此路径必须保留在每个测试文件（即 a.spec.js-snapshots）的快照目录中，否则会抛出错误。

更新屏幕截图​

有时您需要更新参考屏幕截图，例如当页面发生更改时。使用 --update-snapshots 标志执行此操作。

npx playwright test --update-snapshots

选项​

maxDiffPixels​

Playwright Test 使用 pixelmatch 库。您可以传递各种选项来修改其行为

example.spec.ts
import { test, expect } from '@playwright/test';

test('example test', async ({ page }) => {
  await page.goto('https://playwright.net.cn');
  await expect(page).toHaveScreenshot({ maxDiffPixels: 100 });
});

如果您想在项目中的所有测试之间共享默认值，您可以在 Playwright 配置中指定它，无论是全局还是按项目

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  expect: {
    toHaveScreenshot: { maxDiffPixels: 100 },
  },
});

stylePath​

您可以在截屏时将自定义样式表应用到您的页面。这允许过滤掉动态或易变元素，从而提高屏幕截图的确定性。

screenshot.css
iframe {
  visibility: hidden;
}
example.spec.ts
import { test, expect } from '@playwright/test';

test('example test', async ({ page }) => {
  await page.goto('https://playwright.net.cn');
  await expect(page).toHaveScreenshot({ stylePath: path.join(__dirname, 'screenshot.css') });
});

如果您想在项目中的所有测试之间共享默认值，您可以在 Playwright 配置中指定它，无论是全局还是按项目

playwright.config.ts
import { defineConfig } from '@playwright/test';
export default defineConfig({
  expect: {
    toHaveScreenshot: {
      stylePath: './screenshot.css'
    },
  },
});

非图像快照​

除了屏幕截图，您还可以使用 expect(value).toMatchSnapshot(snapshotName) 来比较文本或任意二进制数据。Playwright Test 会自动检测内容类型并使用适当的比较算法。

这里我们将文本内容与参考进行比较。

example.spec.ts
import { test, expect } from '@playwright/test';

test('example test', async ({ page }) => {
  await page.goto('https://playwright.net.cn');
  expect(await page.textContent('.hero__title')).toMatchSnapshot('hero.txt');
});

快照存储在测试文件旁边的一个单独目录中。例如，my.spec.ts 文件将生成快照并将其存储在 my.spec.ts-snapshots 目录中。您应该将此目录提交到您的版本控制（例如 git），并审查对其的任何更改。