报告工具：Allure

作者：瞿丹丹  浏览 1739 发布时间： 更新时间：

一、Allure 概述

Allure 是一款 开源、灵活的测试报告生成工具，主要用于 软件测试领域，支持多种测试框架（如 JUnit、TestNG、pytest、NUnit 等）。它能将测试结果以 美观、交互式的报告形式 呈现，帮助团队快速定位问题、评估测试质量，是持续集成 / 持续部署（CI/CD）流程中的常用工具。

二、核心功能

1. 多维度测试结果可视化

  • 统计图表：
    • 自动生成 趋势图、饼图、柱状图 等，直观展示测试通过率、失败率、执行耗时分布等核心指标。
    • 示例：通过 “失败用例趋势图” 可快速定位版本迭代中的质量波动。
  • 分层级导航：
    • 按 功能模块（Feature）、用户故事（Story）、标签（Tag） 等维度对测试用例进行分组，支持树状结构导航，便于聚焦特定测试范围。

2. 测试用例细节追溯

  • 步骤级展示：
    • 使用 @allure.step 注解标记测试步骤，报告中按顺序展示执行逻辑，甚至支持嵌套步骤（如 “登录 → 搜索 → 下单”）。
    • 每个步骤附带 执行状态（成功 / 失败 / 跳过）、耗时、日志输出，帮助复现问题路径。
  • 附件与日志集成：
    • 支持嵌入 截图、日志文件、API 响应数据 等附件（如自动化测试中页面异常时的截图）。
    • 自动捕获测试框架原生日志（如 pytest 的 stdout/stderr），无需手动配置。

3. 灵活的筛选与搜索

  • 动态过滤：
    • 支持按 状态（通过 / 失败 / 错误）、标签、模块、执行时间 等条件筛选用例，快速定位问题子集。
    • 示例：筛选 “近一周内失败且标签为‘API’的用例”，针对性分析接口缺陷。
  • 全文搜索：
    • 可搜索用例名称、步骤描述、错误信息等文本内容，提升问题定位效率。

4. CI/CD 流程集成

  • 自动化报告生成：
    • 与 Jenkins、GitLab CI、GitHub Actions 等 CI 工具无缝集成，在流水线中自动执行测试并生成报告。
    • 示例：代码提交后，Jenkins 触发测试任务，完成后自动发布 Allure 报告至指定地址。
  • 历史报告对比：
    • 支持保存多版本报告，通过 “趋势分析” 功能对比不同版本的测试结果变化（如通过率提升、新增缺陷模块）。

5. 多语言与框架兼容

  • 测试框架支持：
    • 原生适配 JUnit、TestNG（Java）、pytest、Behave（Python）、Mocha、Jest（JavaScript） 等主流框架，通过插件机制扩展支持更多框架（如 PHPUnit）。
  • 编程语言兼容：
    • 支持 Java、Python、JavaScript、C# 等多语言项目，只需在各语言中引入对应插件（如 allure-pytest、allure-js-commons）。

三、核心优势

1. 数据驱动的决策支持

  • 从 “结果展示” 到 “洞察分析”：

    传统报告仅罗列用例状态，而 Allure 通过图表和分层导航，帮助团队快速识别 高频缺陷模块、低效用例、性能瓶颈，为测试策略优化提供数据依据。

    • 示例：通过 “模块失败率饼图” 发现某功能模块缺陷占比达 40%，优先安排专项测试。

2. 提升跨团队协作效率

  • 非技术人员友好：

    交互式 HTML 报告无需专业知识即可理解，产品经理、项目经理可通过图表快速了解测试进展，减少技术团队与业务团队的沟通成本。

  • 问题定位责任明确：

    每个失败用例附带 开发者标签（@allure.owner）、代码链接，直接定位负责人，缩短缺陷修复流程。

3. 敏捷开发与 DevOps 适配

  • 持续反馈闭环：

    在 CI/CD 流程中实时生成报告，确保代码变更后的质量问题 分钟级暴露，符合敏捷开发 “快速验证、快速修复” 的理念。

  • 轻量化集成成本：

    只需在测试脚本中添加少量注解（如标签、步骤标记），无需重构现有测试框架，适合已存在测试体系的项目快速接入。

4. 可扩展性与生态丰富

  • 插件生态：

    社区提供丰富插件（如 allure-commandline、allure-docker-service），支持报告加密、云存储集成、自定义样式等扩展功能。

  • 自定义报告模板：

    通过 JSON 结果文件 和 Handlebars 模板引擎，可自定义报告样式、字段和布局，满足企业个性化需求。

5. 长期维护与社区活跃

  • 开源且持续更新：

    Allure 由 Qameta 团队 维护，定期发布新版本（如支持最新测试框架、优化性能），社区活跃（GitHub 星标超 21K），文档和教程资源丰富。

四、基本使用流程

1. 环境准备

1.1安装 Allure 命令行工具

  • Windows：通过 Chocolatey 安装

    1. bash 运行
    2. choco install allure

  • macOS：通过 Homebrew 安装

    1. bash 运行
    2. brew install allure

  • Linux：下载二进制包并配置环境变量

    1. bash 运行
    2. wget https://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/2.22.1/allure-commandline-2.22.1.tgz
    3. tar -zxvf allure-commandline-2.22.1.tgz -C /opt/
    4. export PATH="/opt/allure-2.22.1/bin:$PATH"

  • 验证安装

    1. bash 运行
    2. allure --version # 应输出版本号，如 2.22.1

1.2安装测试框架适配器

根据使用的测试框架，安装对应的 Allure 适配器（以 Python 的 pytest 为例）：

  1.     bash 运行
  2.     pip install allure-pytest

2. 编写测试用例并添加 Allure 注解

在测试代码中使用 Allure 注解标记测试用例和步骤。

示例（Python + pytest）：

  1.     python 运行
  2.     import allure
  3.     @allure.feature("用户管理模块") # 功能模块
  4.     @allure.story("用户注册") # 用户故事
  5.     class TestUserRegistration:
  6.     @allure.title("成功注册新用户") # 测试用例标题
  7.     @allure.severity("critical") # 优先级
  8.     def test\_register\_success(self):
  9.     with allure.step("输入有效用户名和密码"):
  11.     \# 测试步骤 1
  12.     username = "test\_user"
  13.     password = "test\_password"
  14.     with allure.step("提交注册请求"):
  16.     \# 测试步骤 2
  17.     response = self.register\_api(username, password)
  18.     with allure.step("验证注册成功"):
  20.     \# 测试步骤 3
  21.     assert response.status\_code == 200
  22.     allure.attach(str(response.json()), "响应数据", allure.attachment\_type.JSON) # 添加附件

3. 执行测试并生成结果数据

运行测试时，指定 Allure 结果输出目录：

  1.     bash 运行
  2.     pytest --alluredir=./allure-results # 生成 JSON 格式结果文件

结果文件结构

  1.     plaintext
  2.     allure-results/
  3.     ├── 1-result.json # 测试用例结果
  4.     ├── attachment-1.png # 附件（如截图）
  5.     ├── environment.xml # 环境信息
  6.     └── categories.json # 分类规则

4. 生成 HTML 报告

使用 Allure 命令行工具将结果文件转换为可视化报告：

  1.     bash 运行
  2.     allure generate ./allure-results -o ./allure-report --clean # 生成报告到指定目录

参数说明

  • generate：生成报告的命令
  • ./allure-results：结果文件目录
  • -o ./allure-report：指定报告输出目录
  • --clean：生成前清空目标目录

5. 查看报告

  • 本地预览

    1. bash 运行
    2. allure open ./allure-report # 启动内置服务器并打开浏览器

    报告将在浏览器中打开，默认地址：http://localhost:63342/allure-report/

  • 生产环境部署

    将生成的 allure-report 目录部署到 Web 服务器（如 Nginx、Apache），通过 URL 访问。

6. 高级操作：持续集成（CI）集成

以 GitHub Actions 为例，在自动化流程中集成 Allure 报告：

6.1创建工作流配置文件（.github/workflows/test.yml）：

  1.     yaml 运行
  2.     name: Test with Allure Report
  4.     on: [push]
  6.     jobs:
  7.         test:
  8.             runs-on: ubuntu-latest
  9.             steps:
  10.                 - uses: actions/checkout@v4
  12.                 - name: Set up Python
  13.                     uses: actions/setup-python@v5
  14.                     with:
  15.                         python-version: 3.10
  16.                 - name: Install dependencies
  17.                     run: |
  18.                         python -m pip install --upgrade pip
  19.                         pip install pytest allure-pytest
  20.                 - name: Run tests
  21.                     run: pytest --alluredir=allure-results
  22.                 - name: Generate Allure report
  23.                     uses: simple-elf/allure-report-action@v2
  24.                     with:
  25.                         allure_results: allure-results
  26.                         allure_report: allure-report
  27.                         allure_history: allure-history
  28.                 - name: Deploy report to GitHub Pages
  29.                     if: github.ref == 'refs/heads/main'
  30.                     uses: peaceiris/actions-gh-pages@v3
  31.                     with:
  32.                         github_token: ${{ secrets.GITHUB\_TOKEN }}
  33.                         publish_dir: ./allure-report

6.2访问报告

报告将自动部署到 GitHub Pages，访问路径：https://.github.io//

7. 常见配置选项

7.1环境信息配置

在 allure-results 目录中创建 environment.properties 文件：

  1.     properties 运行
  2.     Browser=Chrome
  3.     Browser.Version=114.0
  4.     Environment=Staging
  5.     API\_URL=https://api.example.com

7.2测试用例分类规则

创建 categories.json 文件自定义失败分类：

  1. json 运行
  2. [
  3.     {
  4.         "name": "功能缺陷",
  5.         "matchedStatuses": ["failed"],
  6.         "messageRegex": ".*AssertionError.*"
  7.     },
  8.     {
  9.         "name": "环境问题",
  10.         "matchedStatuses": ["broken"],
  11.         "messageRegex": ".*ConnectionRefusedError.*"
  12.     }
  13. ]

8. 故障排除

  • 报告中缺少步骤或附件
    • 检查测试代码中是否正确使用 allure.step 和 allure.attach
    • 确保附件路径正确且文件存在
  • 命令行工具找不到
    • 检查环境变量是否正确配置
    • 尝试使用绝对路径调用 allure 命令
  • 报告样式错乱
    • 确保使用 allure open 或 Web 服务器访问，不要直接打开 HTML 文件
    • 清除浏览器缓存后重试

五、常用功能与高级特性

1. 标记与分组

  • 使用标签（@allure.tag）、功能（@allure.feature）、故事（@allure.story）对用例分类，报告中可按维度筛选。

  • 示例（pytest）：

    1. python 运行
    2. import allure
    3. @allure.feature("用户登录模块")
    4. @allure.story("正常登录场景")
    5. def test\_login\_success():
    6.     assert True

2. 附件与日志

  • 在测试用例中添加附件（如截图、日志文件）：

    1. python 运行
    2. with allure.step("上传文件"):
    3.     allure.attach.file("screenshot.png", name="截图", attachment\_type=allure.attachment\_type.PNG)

  • 自动捕获测试框架的日志输出，显示在报告的 “日志” 标签页中。

3. 动态步骤展示

  • 使用 @allure.step 装饰器或上下文管理器定义测试步骤，报告中按步骤展示执行详情：

    1. python 运行
    2. @allure.step("登录系统")
    3. def login(username, password):
    5.     \# 登录逻辑
    6.     pass

4. 与 CI 工具集成（以 Jenkins 为例）

  • 在 Jenkins 流水线中添加阶段：

    1. groovy 运行
    2.     stage('生成 Allure 报告') {
    3.         steps {
    4.             sh 'pytest --alluredir=allure-results' # 执行测试并生成结果
    5.             sh 'allure generate allure-results -o allure-report --clean' # 生成报告
    6.         }
    7.     post {
    8.         always {
    9.             allure includeProperties: false, jdk: '', results: \[\[path: 'allure-report'\]\] # 关联 Jenkins Allure 插件
    10.         }
    11.     }
    12. }