prometsource/docker-pa11y-ci

Pa11y CI命令行工具Docker容器

该镜像由Promet维护，包含Pa11y CI命令行工具，用于执行网页可访问性测试。当前使用Pa11y 5.1.0版本，Pa11y CI降级至1.3.1版本（解决高版本加载Chromium失败问题）。

核心功能

• 支持WCAG 2AA等可访问性标准测试
• 配置测试URL列表
• 设置错误/警告/通知的失败阈值
• 忽略指定类型的警告或通知
• 设置测试超时时间
• 排除特定页面元素不参与测试
• 保存测试页面截图
• 执行预测试操作（如点击元素、填写表单等）

使用场景

• 网页开发过程中的可访问性合规检查
• 自动化测试流程中集成网页无障碍测试
• 批量检测多个网页的可访问性问题

配置说明

Docker Compose示例

yaml
version: '3.4'
services:
  pa11y:
    image: prometsource/docker-pa11y-ci:0.10
    volumes:
       - ./config.json:/workspace/config.json

配置文件示例（config.json）

以下示例配置使用Google Chrome测试指定URL，遵循WCAG2AA标准：

javascript
{
  "defaults": {
    "standard": "WCAG2AA"
  },
  "chromeLaunchConfig": {
    "executablePath": "/usr/bin/google-chrome-stable",
    "ignoreHTTPSErrors": false
  },
  "urls": [
    "http://pa11y.org/",
    "http://pa11y.org/contributing",
    "https://www.google.com"
  ]
}

命令执行（Docker Compose）

假设服务名为"pa11y"，执行测试命令：

bash
docker-compose run pa11y /bin/bash -c "pa11y-ci --config /workspace/config.json"

高级配置选项

设置失败阈值

允许的错误/警告/通知数量，超过则测试失败：

javascript
{
  "defaults": {
    "standard": "WCAG2AA",
    "threshold": 2
  }
}

忽略警告或通知

全局或按页面忽略指定类型：

javascript
{
  "defaults": {
    "standard": "WCAG2AA",
    "ignore": ["notice", "warning"]
  },
  "urls": [
    {
      "url": "http://pa11y.org/",
      "includeWarnings": true
    }
  ]
}

设置超时时间

测试超时前的等待时长：

javascript
{
  "defaults": {
    "standard": "WCAG2AA",
    "timeout": 500
  }
}

排除元素测试

跳过指定页面元素：

javascript
{
  "urls": [
    {
      "url": "http://pa11y.org/",
      "hideElements": "#ad-server"
    }
  ]
}

保存截图

测试后保存页面截图：

javascript
{
  "urls": [
    {
      "url": "http://pa11y.org/",
      "screenCapture": "/path/to/folder/my-screen-capture.png"
    }
  ]
}

预测试操作

执行点击、填写表单等操作后再测试：

javascript
{
  "urls": [
    {
      "url": "http://pa11y.org/",
      "actions": [
        "click element #tab-1",
        "wait for element #tab-1-content to be visible",
        "set field #fullname to John Doe",
        "check field #terms-and-conditions",
        "uncheck field #subscribe-to-marketing",
        "screen capture example.png",
        "wait for fragment to be #page-2",
        "wait for path to not be /login",
        "wait for url to be https://example.com/",
        "wait for #my-image to emit load",
        "navigate to https://another-example.com/"
      ]
    }
  ]
}

资源

• 项目官网
• https://github.com/pa11y
• Pa11y中的操作使用