eksponent/eksponent-pa11y

Eksponent pa11y

镜像概述

Eksponent pa11y是一个基于pa11y的Docker镜像，专门用于Web可访问性测试。它提供API接口，允许通过提交JSON配置文件来测试网页的可访问性合规性，并返回结构化的测试结果。该镜像简化了pa11y的部署和使用流程，适用于开发和测试环境中的自动化可访问性检测。

核心功能与特性

• 可访问性标准支持：支持WCAG（Web内容可访问性指南）标准，如WCAG2AAA
• 灵活配置：可自定义测试级别（如error）、超时时间、测试工具（如axe）及Chrome启动参数
• 多视口测试：支持为同一URL配置不同视口尺寸（如移动端320x480、桌面端1024x768）
• API接口：通过HTTP POST请求提交配置并获取JSON格式的测试结果
• 容器化部署：简化环境依赖，可快速在任何支持Docker的环境中部署

使用场景

• 网站开发过程中的可访问性自动化测试
• 多终端（移动端、桌面端）网页可访问性验证
• 符合WCAG标准的合规性检查
• 集成到CI/CD流程中进行持续可访问性检测

使用方法

构建镜像

通过以下命令构建Docker镜像：

bash
docker build -t eksponent/eksponent-pa11y .

运行容器

镜像默认暴露8080端口，可通过端口映射在本地访问：

bash
docker run -p 49160:8080 docker.xuanyuan.run/eksponent/pa11y

配置文件说明

通过JSON格式的配置文件定义测试参数，示例如下：

json
{
  "standard": "WCAG2AAA",  // 可访问性标准，如WCAG2AAA、WCAG2AA等
  "level": "error",         // 测试级别，可选error、warning、notice
  "defaults": {
    "timeout": 50000,       // 测试超时时间（毫秒）
    "runners": ["axe"],     // 使用的测试工具，如axe
    "ignore": [],           // 忽略的规则ID列表
    "chromeLaunchConfig": { // Chrome浏览器启动配置
      "args": ["--no-sandbox"] // Chrome启动参数
    }
  },
  "urls": [                 // 待测试的URL列表
    {
      "url": "https://eksponent.com",  // 测试URL
      "viewport": { "width": 320, "height": 480 }, // 视口尺寸
      "actions": [] // 测试前执行的操作（如点击、输入等）
    },
    {
      "url": "https://eksponent.com",
      "viewport": { "width": 1024, "height": 768 },
      "actions": []
    }
  ]
}

API调用示例

通过cURL发送POST请求提交配置并获取测试结果：

bash
curl --header "Content-Type: application/json" \
  --request POST \
  --data '{"standard": "WCAG2AAA","level": "error","defaults": {"runners": ["axe"], "timeout": 50000,"ignore": [],"chromeLaunchConfig": {"args": ["--no-sandbox"]}},"urls": [{"url": "https://eksponent.com","viewport": { "width": 320, "height": 480 },"actions": []},{"url": "https://eksponent.com","viewport": { "width": 1024, "height": 768 },"actions": []}]}' \
  http://192.168.99.100:49160/

请求成功后，将返回包含测试结果的JSON响应，包含每个URL在不同视口下的可访问性问题详情。