dracoblue/xunit-metrics-exporter

xunit-metrics-exporter

镜像概述和主要用途

xunit-metrics-exporter是一个用于将xunit XML测试报告文件转换为Prometheus可采集指标的工具。它能够扫描指定目录下的xunit XML文件，解析测试结果（如成功、失败、跳过的测试用例数量）和持续时间，并以Prometheus兼容的格式暴露指标，方便集成到监控系统中。

核心功能和特性

• xunit XML解析：支持解析标准xunit格式的XML测试报告文件
• Prometheus指标生成：输出多种测试相关指标，包括测试套件结果、持续时间、失败/成功/跳过的测试总数等
• 自定义规则配置：通过规则文件指定需要扫描的xunit文件路径模式及路径替换规则
• 灵活部署：支持通过环境变量配置规则文件路径，适应不同部署场景

使用场景和适用范围

• CI/CD流水线测试结果监控：在持续集成流程中收集测试指标，实时监控测试状态
• 测试报告可视化：结合Prometheus和Grafana，构建测试结果仪表盘
• 多项目测试聚合：统一收集多个项目或模块的xunit测试结果指标

使用方法和配置说明

前提条件

需要准备规则文件（默认路径为./rules.json，可通过环境变量RULES_FILE_PATH指定其他路径），用于定义xunit文件扫描规则。

规则文件（rules.json）格式

规则文件为JSON数组，每个元素包含以下字段：

• glob：字符串，指定xunit XML文件的路径模式（支持通配符）
• filePathReplacers：数组，每个元素为包含两个字符串的数组，用于替换文件路径中的特定字符串（格式：[["需要替换的字符串", "替换后的字符串"]]）

示例规则文件：

json
[
  {
    "glob": "./results/*.xml",
    "filePathReplacers": [["cypress/integration/", ""]]
  }
]

Docker部署示例

使用docker-compose部署

创建docker-compose.yml文件：

yaml
version: "2.0"
services:
  xunit-metrics-exporter:
    image: dracoblue/xunit-metrics-exporter
    environment:
      - "RULES_FILE_PATH=/usr/src/app/rules.json"  # 指定规则文件路径
    volumes:
      - ./results:/usr/src/app/results  # 挂载包含xunit XML文件的目录
      - ./rules.json:/usr/src/app/rules.json  # 挂载规则文件
    ports:
      - "9442:9442"  # 暴露指标端口

准备测试文件

1. 在当前目录创建results文件夹，并添加测试XML文件（如results/test.xml），内容示例：

xml
<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="Mocha Tests" time="1.6930" tests="6" failures="1">
  <testsuite name="Root Suite" timestamp="2021-08-18T11:06:04" tests="0" file="cypress/integration/1-getting-started/todo.spec.js" time="0.0000" failures="0">
  </testsuite>
  <testsuite name="example to-do app" timestamp="2021-08-18T11:06:04" tests="3" time="0.7480" failures="1">
    <testcase name="example to-do app displays two todo items by default" time="0.0000" classname="displays two todo items by default">
      <failure message="Timed out retrying after 4000ms: expected &apos;&lt;li&gt;&apos; to have text &apos;Walk the dog2&apos;, but the text was &apos;Walk the dog&apos;" type="AssertionError"><![CDATA[AssertionError: Timed out retrying after 4000ms: expected '<li>' to have text 'Walk the dog2', but the text was 'Walk the dog'
    at Context.eval (https://example.cypress.io/__cypress/tests?p=cypress/integration/1-getting-started/todo.spec.js:128:36)]]></failure>
    </testcase>
    <testcase name="example to-do app can add new todo items" time="0.4830" classname="can add new todo items">
    </testcase>
    <testcase name="example to-do app can check off an item as completed" time="0.2650" classname="can check off an item as completed">
    </testcase>
  </testsuite>
  <testsuite name="with a checked task" timestamp="2021-08-18T11:06:12" tests="3" time="0.9450" failures="0">
    <testcase name="example to-do app with a checked task can filter for uncompleted tasks" time="0.3060" classname="can filter for uncompleted tasks">
    </testcase>
    <testcase name="example to-do app with a checked task can filter for completed tasks" time="0.3420" classname="can filter for completed tasks">
    </testcase>
    <testcase name="example to-do app with a checked task can delete all completed tasks" time="0.2970" classname="can delete all completed tasks">
    </testcase>
  </testsuite>
</testsuites>

2. 在当前目录创建rules.json文件，内容示例：

json
[
  {
    "glob": "/usr/src/app/results/*.xml",
    "filePathReplacers": [["cypress/integration/", ""]]
  }
]

启动服务

执行以下命令启动服务：

bash
docker-compose up -d

访问指标

Prometheus指标可通过http://localhost:9442访问，示例输出：

text
# HELP xunit_suite xunit result
# TYPE xunit_suite gauge
# HELP xunit_duration_seconds xunit duration
# TYPE xunit_duration_seconds gauge
xunit_suite{name="example to-do app",file_name="todo.spec.js",folder_name="1-getting-started",result="failure"} 1
xunit_duration_seconds{name="example to-do app",file_name="todo.spec.js",folder_name="1-getting-started",result="failure"} 0.748
xunit_suite{name="with a checked task",file_name="todo.spec.js",folder_name="1-getting-started",result="success"} 0
xunit_duration_seconds{name="with a checked task",file_name="todo.spec.js",folder_name="1-getting-started",result="success"} 0.945
# HELP xunit_failed_total xunit failed tests
# TYPE xunit_failed_total gauge
xunit_failed_total 1
# HELP xunit_successful_total xunit successful tests
# TYPE xunit_successful_total gauge
xunit_successful_total 5
# HELP xunit_skipped_total xunit skipped tests
# TYPE xunit_skipped_total gauge
xunit_skipped_total 0
# HELP xunit_duration_seconds_total xunit total duration
# TYPE xunit_duration_seconds_total gauge
xunit_duration_seconds_total 1.693

许可证

本项目由DracoBlue（[***]