跳到主要内容

快照测试

概述​

使用 Playwright 的快照测试，可以将页面的可访问性树断言与预定义的快照模板进行比较。

await page.GotoAsync("https://playwright.net.cn/");
await Expect(page.Locator("banner")).ToMatchAriaSnapshotAsync(@"
  - banner:
    - heading ""Playwright enables reliable end-to-end testing for modern web apps."" [level=1]
    - link ""Get started""
    - link ""Star microsoft/playwright on GitHub""
    - link /[\\d]+k\\+ stargazers on GitHub/
");

断言测试与快照测试​

快照测试和断言测试在测试自动化中服务于不同的目的

断言测试​

断言测试是一种有针对性的方法，您可以在其中断言元素或组件的特定值或条件。例如，使用 Playwright，Expect(Locator).ToHaveTextAsync() 验证元素是否包含预期的文本，而 Expect(Locator).ToHaveValueAsync() 确认输入字段具有预期的值。断言测试是特定的，通常检查元素或属性的当前状态是否与预期的预定义状态一致。它们适用于可预测的单值检查，但在测试更广泛的结构或变体时范围有限。

优点

  • 清晰性：测试的意图明确且易于理解。
  • 特异性：测试侧重于功能的特定方面，使其对不相关的更改更具鲁棒性。
  • 调试：失败提供有针对性的反馈，直接指向有问题的地方。

缺点

  • 对于复杂输出过于冗长：为复杂数据结构或大型输出编写断言可能既繁琐又容易出错。
  • 维护开销：随着代码的演进，手动更新断言可能非常耗时。

快照测试​

快照测试捕获元素、组件或数据在给定时刻的“快照”或表示，然后将其保存用于未来的比较。当重新运行测试时，当前状态与快照进行比较，如果存在差异，测试就会失败。这种方法对于复杂或动态结构特别有用，手动断言每个细节会花费太多时间。快照测试比断言测试更广泛、更全面，允许您跟踪随时间推移的更复杂变化。

优点

  • 简化复杂输出：例如，测试 UI 组件的渲染输出对于传统断言来说可能很繁琐。快照捕获整个输出以便于比较。
  • 快速反馈循环：开发人员可以轻松发现输出中意外的更改。
  • 鼓励一致性：有助于随着代码的演进保持一致的输出。

缺点

  • 过度依赖：可能会诱人地接受快照更改而不完全理解它们，这可能隐藏 bug。
  • 粒度：大型快照在出现差异时可能难以解释，尤其是当微小的更改影响输出的很大一部分时。
  • 适用性：不适用于输出频繁或不可预测变化的强动态内容。

何时使用​

  • 快照测试非常适合
    • 整个页面和组件的 UI 测试。
    • 复杂 UI 组件的广泛结构检查。
    • 输出结构很少更改的回归测试。
  • 断言测试非常适合
    • 核心逻辑验证。
    • 计算值测试。
    • 需要精确条件的细粒度测试。

通过结合使用快照测试进行广泛的结构检查和断言测试进行特定功能检查，您可以实现全面的测试策略。

Aria 快照​

在 Playwright 中，aria 快照提供页面的可访问性树的 YAML 表示。这些快照可以存储并稍后进行比较，以验证页面结构是否保持一致或满足定义的预期。

YAML 格式描述了页面上可访问元素的层次结构，详细说明了角色（roles）、属性（attributes）、值（values）和文本内容（text content）。结构遵循树状语法，其中每个节点代表一个可访问元素，缩进表示嵌套元素。

树中的每个可访问元素都表示为一个 YAML 节点

- role "name" [attribute=value]
  • role：指定元素的 ARIA 或 HTML 角色（例如，heading、list、listitem、button）。
  • "name"：元素的可访问名称。带引号的字符串表示精确值，/patterns/ 用于正则表达式。
  • [attribute=value]：括号中的属性和值表示特定的 ARIA 属性，例如 checked、disabled、expanded、level、pressed 或 selected。

这些值派生自 ARIA 属性或根据 HTML 语义计算得出。要检查页面的可访问性树结构，请使用Chrome DevTools 可访问性选项卡。

快照匹配​

Playwright 中的 Expect(Locator).ToMatchAriaSnapshotAsync() 断言方法将定位器范围的可访问结构与预定义的 aria 快照模板进行比较，有助于根据测试要求验证页面状态。

对于以下 DOM

<h1>title</h1>

您可以使用以下快照模板进行匹配

await Expect(page.Locator("body")).ToMatchAriaSnapshotAsync(@"
  - heading ""title""
");

匹配时，快照模板会与页面的当前可访问性树进行比较

  • 如果树结构与模板匹配，测试通过；否则，测试失败，表明预期和实际可访问性状态不匹配。
  • 比较区分大小写并折叠空白，因此忽略缩进和换行符。
  • 比较是顺序敏感的，这意味着快照模板中元素的顺序必须与页面可访问性树中的顺序匹配。

部分匹配​

您可以通过省略属性或可访问名称来对节点执行部分匹配，从而验证可访问性树的特定部分，而无需完全匹配。这种灵活性对于动态或不相关的属性很有帮助。

<button>Submit</button>

aria 快照

- button

在此示例中，匹配了按钮角色，但未指定可访问名称（“Submit”），从而允许测试通过，无论按钮的标签如何。

对于具有 checked 或 disabled 等 ARIA 属性的元素，省略这些属性允许进行部分匹配，只关注角色和层次结构。

<input type="checkbox" checked>

用于部分匹配的 aria 快照

- checkbox

在此部分匹配中，忽略了 checked 属性，因此无论复选框状态如何，测试都会通过。

同样，您可以通过省略特定的列表项或嵌套元素来部分匹配列表或组中的子元素。

<ul>
  <li>Feature A</li>
  <li>Feature B</li>
  <li>Feature C</li>
</ul>

用于部分匹配的 aria 快照

- list
  - listitem: Feature B

部分匹配允许您创建灵活的快照测试，以验证基本页面结构，而无需强制执行特定内容或属性。

严格匹配​

默认情况下，包含子集模板的模板将被匹配

<ul>
  <li>Feature A</li>
  <li>Feature B</li>
  <li>Feature C</li>
</ul>

用于部分匹配的 aria 快照

- list
  - listitem: Feature B

可以使用 /children 属性来控制子元素的匹配方式

  • contain (默认)：如果所有指定的子元素按顺序存在，则匹配
  • equal：如果子元素按顺序与指定列表完全匹配，则匹配
  • deep-equal：如果子元素按顺序与指定列表完全匹配，包括嵌套子元素，则匹配
<ul>
  <li>Feature A</li>
  <li>Feature B</li>
  <li>Feature C</li>
</ul>

由于 Feature C 未在模板中，aria 快照将失败

- list
  - /children: equal
  - listitem: Feature A
  - listitem: Feature B

使用正则表达式进行匹配​

正则表达式允许对具有动态或可变文本的元素进行灵活匹配。可访问名称和文本可以支持 regex 模式。

<h1>Issues 12</h1>

带有正则表达式的 aria 快照

- heading /Issues \d+/

生成快照​

在 Playwright 中创建 aria 快照有助于确保和维护应用程序的结构。您可以根据您的测试设置和工作流程以各种方式生成快照。

使用 Playwright 代码生成器生成快照​

如果您使用 Playwright 的代码生成器，通过其交互式界面可以简化 aria 快照的生成

  • “Assert snapshot”操作：在代码生成器中，您可以使用“Assert snapshot”操作自动为选定的元素创建快照断言。这是将 aria 快照捕获为您记录的测试流程的一部分的快速方法。
  • “Aria snapshot”选项卡：代码生成器界面中的“Aria snapshot”选项卡直观地表示选定定位器的 aria 快照，允许您探索、检查和验证元素角色、属性和可访问名称，以帮助创建和审查快照。

使用 Locator.ariaSnapshot 方法​

Locator.AriaSnapshotAsync() 方法允许您以编程方式创建定位器范围内的可访问元素的 YAML 表示，这对于在测试执行期间动态生成快照特别有用。

示例:

var snapshot = await page.Locator("body").AriaSnapshotAsync();
Console.WriteLine(snapshot);

此命令以 YAML 格式输出指定定位器范围内的 aria 快照，您可以根据需要验证或存储它。

可访问性树示例​

带有级别属性的标题​

标题可以包含指示其标题级别的 level 属性。

<h1>Title</h1>
<h2>Subtitle</h2>

aria 快照

- heading "Title" [level=1]
- heading "Subtitle" [level=2]

文本节点​

独立或描述性文本元素显示为文本节点。

<div>Sample accessible name</div>

aria 快照

- text: Sample accessible name

内联多行文本​

多行文本，例如段落，在 aria 快照中被规范化。

<p>Line 1<br>Line 2</p>

aria 快照

- paragraph: Line 1 Line 2

链接显示其文本或由伪元素组成的内​​容。

<a href="#more-info">Read more about Accessibility</a>

aria 快照

- link "Read more about Accessibility"

文本框​

类型为 text 的输入元素显示其 value 属性内容。

<input type="text" value="Enter your name">

aria 快照

- textbox: Enter your name

带项目的列表​

有序列表和无序列表包含其列表项。

<ul aria-label="Main Features">
  <li>Feature 1</li>
  <li>Feature 2</li>
</ul>

aria 快照

- list "Main Features":
  - listitem: Feature 1
  - listitem: Feature 2

分组元素​

组捕获嵌套元素，例如带有摘要内容的 <details> 元素。

<details>
  <summary>Summary</summary>
  <p>Detail content here</p>
</details>

aria 快照

- group: Summary

属性和状态​

常用的 ARIA 属性，例如 checked、disabled、expanded、level、pressed 和 selected，表示控件状态。

带有 checked 属性的复选框​

<input type="checkbox" checked>

aria 快照

- checkbox [checked]

带有 pressed 属性的按钮​

<button aria-pressed="true">Toggle</button>

aria 快照

- button "Toggle" [pressed=true]