kochetkovma/allure-server

Allure Portal (Allure Report Server)

镜像概述和主要用途

Allure Portal（Allure Report Server）是一个用于管理Allure测试报告的服务器应用。它允许用户上传Allure测试结果、生成可视化报告，并通过Web界面或API访问这些报告，适用于持续集成/持续部署(CI/CD)流程中测试结果的集中管理与展示。

查看示例：allure.iopump.ru 或 allure-server.herokuapp.com

核心功能和特性

• 支持Allure 2测试结果格式
• 提供REST API接口，用于上传结果、生成报告、查询和删除数据
• 内置Web UI（基于Vaadin 14），提供直观的报告管理界面
• 支持数据持久化，可通过挂载卷保存测试结果和报告
• 按逻辑路径（path）分组管理报告及其历史记录

使用场景和适用范围

• CI/CD流程中自动化测试报告的生成与展示
• 团队共享测试结果，便于问题定位和测试趋势分析
• 集中管理多个项目或分支的测试报告
• 测试结果的长期存储与历史版本追踪

使用方法和配置说明

运行容器

基本运行

shell
docker pull kochetkovma/allure-server:latest
docker run -p 8080:8080 kochetkovma/allure-server:latest

使用docker-compose

shell
# 下载项目中的docker-compose.yml
# 地址: https://github.com/kochetkov-ma/allure-server/blob/master/docker-compose.yml
docker-compose up -d

访问 http://localhost:8080，将自动重定向到OpenAPI（Swagger UI）界面。

数据持久化

如需在本地文件系统存储数据，可挂载卷：

shell
docker run -p 8080:8080 -v /allure-server-store:/allure kochetkovma/allure-server:latest

上传测试结果

仅支持Allure 2格式的测试结果。将测试结果打包为zip归档文件（例如根目录下的allure-results.zip），通过以下命令上传：

shell
curl --location --request POST 'http://localhost:8080/api/result' \
--form 'allureResults=@/allure-results.zip;type=application/zip'

响应示例：

json
{
    "fileName": "allure-results.zip",
    "uuid": "1037f8be-68fb-4756-98b6-779637aa4670"
}

注意：保存返回的uuid，用于后续生成报告。必须指定表单项的Content-Type为application/zip，服务器仅处理zip格式的归档文件。

生成报告

通过POST请求生成报告，请求体为JSON格式：

shell
curl --location --request POST 'http://localhost:8080/api/report' \
--header 'Content-Type: application/json' \
--data-raw '{
  "reportSpec": {
    "path": [
      "master",
      "666"
    ],
    "executorInfo": {
      "buildName": "#666"
    }
  },
  "results": [
    "1037f8be-68fb-4756-98b6-779637aa4670"
  ],
  "deleteResults": false
}'

响应示例：

json
{
    "path": "master/666",
    "url": "http://localhost:8080/allure/reports/master/666/index.html"
}

警告：生成的报告及其历史记录通过path键分组，该键可理解为项目、任务或分支的逻辑标识，而非实际路径。相同path的最新报告将被标记为"活跃"，Web UI中的"path"列同样为逻辑路径。

访问生成的报告

生成报告后，可通过响应中的url直接访问，例如：http://localhost:8080/allure/reports/master/666/index.html

API查询与管理

• 获取所有报告：

  shell
  curl --location --request GET 'http://localhost:8080/api/report'
  

• 按路径（如分支名master）获取报告：

  shell
  curl --location --request GET 'http://localhost:8080/api/report?path=master'
  

• 获取所有已上传的测试结果：

  shell
  curl --location --request GET 'http://localhost:8080/api/result'
  

• 清除测试结果或报告：

  shell
  curl --location --request DELETE 'http://localhost:8080/api/result'
  curl --location --request DELETE 'http://localhost:8080/api/report'
  

Web UI

Allure Server提供Web界面用于访问报告和结果，默认路径为/ui，根路径/会自动重定向到/ui。例如：http://localhost:8080/ui。

Web UI功能与REST API一致，基于Vaadin 14实现。

主页面示例：https://github.com/kochetkov-ma/allure-server/blob/master/ui-example.png

更多信息

项目地址：https://github.com/kochetkov-ma/allure-server