跳到主要内容

无障碍测试

简介​

Playwright 可用于测试您的应用程序是否存在多种类型的无障碍问题。

这可以捕获的一些问题示例包括

  • 由于与背景颜色对比度差，视力障碍用户难以阅读的文本
  • 没有屏幕阅读器可识别标签的 UI 控件和表单元素
  • 具有重复 ID 的交互式元素，可能会混淆辅助技术

以下示例依赖于 com.deque.html.axe-core/playwright Maven 包，该包增加了在 Playwright 测试中运行 axe 无障碍测试引擎的支持。

免责声明​

自动化无障碍测试可以检测一些常见的无障碍问题，例如缺失或无效的属性。但许多无障碍问题只能通过手动测试发现。我们建议结合使用自动化测试、手动无障碍评估和包容性用户测试。

对于手动评估，我们推荐 Accessibility Insights for Web，这是一个免费的开源开发工具，可以指导您评估网站的 WCAG 2.1 AA 覆盖范围。

无障碍测试示例​

无障碍测试与其他 Playwright 测试一样。您可以为其创建单独的测试用例，或者将无障碍扫描和断言集成到现有的测试用例中。

以下示例演示了一些基本的无障碍测试场景。

示例 1：扫描整个页面​

本示例演示如何测试整个页面的自动化可检测无障碍违规。测试

  1. 导入 com.deque.html.axe-core/playwright 包。
  2. 使用正常的 JUnit 5 @Test 语法定义测试用例。
  3. 使用正常的 Playwright 语法打开浏览器并导航到被测页面。
  4. 调用 AxeBuilder.analyze() 对页面运行无障碍扫描。
  5. 使用正常的 JUnit 5 测试断言验证返回的扫描结果中没有违规。
import com.deque.html.axecore.playwright.*; // 1
import com.deque.html.axecore.utilities.axeresults.*;

import org.junit.jupiter.api.*;
import com.microsoft.playwright.*;

import static org.junit.jupiter.api.Assertions.*;

public class HomepageTests {
  @Test // 2
  void shouldNotHaveAutomaticallyDetectableAccessibilityIssues() throws Exception {
    Playwright playwright = Playwright.create();
    Browser browser = playwright.chromium().launch();
    BrowserContext context = browser.newContext();
    Page page = context.newPage();

    page.navigate("https://your-site.com/"); // 3

    AxeResults accessibilityScanResults = new AxeBuilder(page).analyze(); // 4

    assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations()); // 5
  }
}

示例 2：配置 axe 扫描页面的特定部分​

com.deque.html.axe-core/playwright 支持 axe 的许多配置选项。您可以使用 AxeBuilder 类的构建器模式来指定这些选项。

例如，您可以使用 AxeBuilder.include() 将无障碍扫描限制为仅对页面的特定部分运行。

调用 AxeBuilder.analyze() 时，它将扫描页面当前状态。要扫描基于 UI 交互显示的页面部分，请在使用 analyze() 之前使用定位器与页面交互。

public class HomepageTests {
  @Test
  void navigationMenuFlyoutShouldNotHaveAutomaticallyDetectableAccessibilityViolations() throws Exception {
    page.navigate("https://your-site.com/");

    page.locator("button[aria-label=\"Navigation Menu\"]").click();

    // It is important to waitFor() the page to be in the desired
    // state *before* running analyze(). Otherwise, axe might not
    // find all the elements your test expects it to scan.
    page.locator("#navigation-menu-flyout").waitFor();

    AxeResults accessibilityScanResults = new AxeBuilder(page)
      .include(Arrays.asList("#navigation-menu-flyout"))
      .analyze();

    assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations());
  }
}

示例 3：扫描 WCAG 违规​

默认情况下，axe 会检查各种无障碍规则。其中一些规则对应于 Web 内容无障碍指南 (WCAG) 中的特定成功标准，而另一些则是任何 WCAG 标准未明确要求的“最佳实践”规则。

您可以使用 AxeBuilder.withTags() 将无障碍扫描限制为仅运行标记为对应特定 WCAG 成功标准的规则。例如，Accessibility Insights for Web 的自动化检查仅包含测试 WCAG A 和 AA 成功标准违规的 axe 规则；要匹配该行为，您将使用标签 wcag2a、wcag2aa、wcag21a 和 wcag21aa。

请注意，自动化测试无法检测所有类型的 WCAG 违规。

AxeResults accessibilityScanResults = new AxeBuilder(page)
  .withTags(Arrays.asList("wcag2a", "wcag2aa", "wcag21a", "wcag21aa"))
  .analyze();

assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations());

您可以在 axe API 文档的“Axe-core Tags”部分找到 axe-core 支持的规则标签的完整列表。

处理已知问题​

在向应用程序添加无障碍测试时，一个常见问题是“如何抑制已知违规？” 以下示例演示了几种可以使用的技术。

从扫描中排除单个元素​

如果您的应用程序包含一些已知问题的特定元素，您可以使用 AxeBuilder.exclude() 将它们从扫描中排除，直到您能够修复问题。

这通常是最简单的选项，但它有一些重要的缺点

  • exclude() 将排除指定的元素及其所有后代。避免将其用于包含许多子元素的组件。
  • exclude() 将阻止对指定元素运行所有规则，而不仅仅是与已知问题对应的规则。

以下是在一个特定测试中排除扫描一个元素的示例

AxeResults accessibilityScanResults = new AxeBuilder(page)
  .exclude(Arrays.asList("#element-with-known-issue"))
  .analyze();

assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations());

如果该元素在许多页面中重复使用，请考虑使用测试夹具以在多个测试中重用相同的 AxeBuilder 配置。

禁用单个扫描规则​

如果您的应用程序包含许多针对特定规则的不同现有违规，您可以使用 AxeBuilder.disableRules() 暂时禁用单个规则，直到您能够修复问题。

您可以在要抑制的违规的 id 属性中找到要传递给 disableRules() 的规则 ID。axe 规则的完整列表可在 axe-core 的文档中找到。

AxeResults accessibilityScanResults = new AxeBuilder(page)
  .disableRules(Arrays.asList("duplicate-id"))
  .analyze();

assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations());

使用违规指纹识别特定已知问题​

如果您想允许更细粒度的已知问题集，可以使用以下模式

  1. 执行预期会发现一些已知违规的无障碍扫描
  2. 将违规转换为“违规指纹”对象
  3. 断言指纹集与预期指纹集相等

这种方法避免了使用 AxeBuilder.exclude() 的缺点，但代价是稍微增加了复杂性和脆弱性。

以下是仅基于规则 ID 和指向每个违规的“target”选择器使用指纹的示例

public class HomepageTests {
  @Test
  shouldOnlyHaveAccessibilityViolationsMatchingKnownFingerprints() throws Exception {
    page.navigate("https://your-site.com/");

    AxeResults accessibilityScanResults = new AxeBuilder(page).analyze();

    List<ViolationFingerprint> violationFingerprints = fingerprintsFromScanResults(accessibilityScanResults);

    assertEquals(Arrays.asList(
      new ViolationFingerprint("aria-roles", "[span[role=\"invalid\"]]"),
      new ViolationFingerprint("color-contrast", "[li:nth-child(2) > span]"),
      new ViolationFingerprint("label", "[input]")
    ), violationFingerprints);
  }

  // You can make your "fingerprint" as specific as you like. This one considers a violation to be
  // "the same" if it corresponds the same Axe rule on the same element.
  //
  // Using a record type makes it easy to compare fingerprints with assertEquals
  public record ViolationFingerprint(String ruleId, String target) { }

  public List<ViolationFingerprint> fingerprintsFromScanResults(AxeResults results) {
    return results.getViolations().stream()
      // Each violation refers to one rule and multiple "nodes" which violate it
      .flatMap(violation -> violation.getNodes().stream()
        .map(node -> new ViolationFingerprint(
          violation.getId(),
          // Each node contains a "target", which is a CSS selector that uniquely identifies it
          // If the page involves iframes or shadow DOMs, it may be a chain of CSS selectors
          node.getTarget().toString()
        )))
      .collect(Collectors.toList());
  }
}

使用测试夹具进行常见的 axe 配置​

TestFixtures 类是在许多测试中共享常见的 AxeBuilder 配置的好方法。一些可能有用的场景包括

  • 在所有测试中使用一组通用规则
  • 抑制在许多不同页面中出现的常见元素中的已知违规
  • 为多次扫描一致地附加独立的无障碍报告

以下示例演示了通过一个新的夹具来扩展 Test Runners 示例中的 TestFixtures 类，该夹具包含一些常见的 AxeBuilder 配置。

创建夹具​

此示例夹具创建一个 AxeBuilder 对象，该对象预配置了共享的 withTags() 和 exclude() 配置。

class AxeTestFixtures extends TestFixtures {
 AxeBuilder makeAxeBuilder() {
   return new AxeBuilder(page)
     .withTags(new String[]{"wcag2a", "wcag2aa", "wcag21a", "wcag21aa"})
     .exclude("#commonly-reused-element-with-known-issue");
 }
}

使用夹具​

要使用夹具，请将前面示例中的 new AxeBuilder(page) 替换为新定义的 makeAxeBuilder 夹具。

public class HomepageTests extends AxeTestFixtures {
  @Test
  void exampleUsingCustomFixture() throws Exception {
    page.navigate("https://your-site.com/");

    AxeResults accessibilityScanResults = makeAxeBuilder()
      // Automatically uses the shared AxeBuilder configuration,
      // but supports additional test-specific configuration too
      .include("#specific-element-under-test")
      .analyze();

    assertEquals(Collections.emptyList(), accessibilityScanResults.getViolations());
  }
}

请参阅实验性的JUnit 集成以自动初始化 Playwright 对象等。