Allure 测试报告生成工具

简介

Allure 测试报告生成工具

Allure 2 是一款开源、轻量级、跨平台的测试报告生成工具，能够将各类测试框架的执行结果转化为清晰、交互式、可视化的 HTML 报告。它支持多种编程语言和测试框架，包括 Pytest、JUnit、Cucumber 等。

务必阅读 Getting started with Allure Pytest 文档，了解其使用方法。不过文档稍微有点繁杂，本文稍微讲下重点。

集成 Allure 支持，可以分为两步，一是生成测试结果数据，二是生成美观的测试报告。这两步分为两个部件，生成测试结果数据只需要 pytest 集成Allure pytest 适配；有了测试结果目录，任意部署了 Allure 工具的机器皆可生成测试报告。

生成测试结果数据目录

Pytetst 框架中，要输出支持 Allure 工具的测试结果数据文件，需要安装 Allure pytest 适配器。

pip install allure-pytest

Allure Pytest 适配器提供了一些额外的配置选项，我的推荐配置如下：

pytest.toml

1
2
3
4


[pytest]
# "--alluredir=./allure-results" 指定测试结果文件的存放目录为根目录下 allure-results 目录(如果不存在，自动创建)
# "--clean-alluredir" 清除上次测试结果文件
addopts = ["--alluredir=./allure-results", "--clean-alluredir"]

然后在测试用例中添加用例注解，读者可以查看 Allure Pytest reference 了解全部 Allure 注解用法。最后运行测试用例，输出测试结果数据到测试结果文件的存放目录。

生成测试报告

部署 JAVA 环境

Allure 工具依赖 JAVA 环境，需要 java 8+ 版本。

点击JDK下载地址，下载最新版本(.zip)。
解压下载的文件到指定目录(例如：C:\tools\Java\jdk-24.0.1)，记住这个目录。
右键此电脑-属性-高级系统设置-环境变量。
在系统变量中新建一个变量名为 JAVA_HOME，值为 JDK 的安装目录(例如：C:\tools\Java\jdk-24.0.1)。
环境变量中找到Path，选中后点击编辑。
点击新建环境变量，值为：%JAVA_HOME%\bin;。
一路确定，直至相关弹窗全部关闭。
打开 cmd 窗口，输入 java -version，如果显示版本号，则表示部署成功。

  # 查看是否已经部署 JAVA 环境
  java -version
  # 如果没有 JAVA 环境，会输出仓库中可供安装的 JDK 各版本信息，按需选择即可。
  # headless 版本移除了 Java 的图形界面相关组件（如 AWT/Swing），体积更小，完全适配终端环境下运行 Allure。
  sudo apt install openjdk-17-jre-headless  # version 17.0.17+10-1~24.04, or
  sudo apt install openjdk-21-jre-headless  # version 21.0.9+10-1~24.04
  sudo apt install default-jre              # version 2:1.17-75
  sudo apt install openjdk-19-jre-headless  # version 19.0.2+7-4
  sudo apt install openjdk-20-jre-headless  # version 20.0.2+9-1
  sudo apt install openjdk-22-jre-headless  # version 22~22ea-1
  sudo apt install openjdk-11-jre-headless  # version 11.0.29+7-1ubuntu1~24.04
  sudo apt install openjdk-25-jre-headless  # version 25.0.1+8-1~24.04
  sudo apt install openjdk-8-jre-headless   # version 8u472-ga-1~24.04
  # 安装需要的 JDK 环境，比如：
  sudo apt install openjdk-21-jre-headless
  # 最后再验证一下是否部署成功
  java -version

部署 Allure 工具

访问 Allure 下载地址下载最新包(zip或者tar.gz)。

解压下载的文件到指定目录(例如：C:\tools\Java\jdk-24.0.1)，记住这个目录。
右键此电脑-属性-高级系统设置-环境变量。
在系统变量中新建一个变量名为 ALLURE_HOME，值为 Allure 工具的安装目录(例如：比如：C:\tools\allure-2.36.0)。
环境变量中找到 Path，选中后点击编辑。
点击新建环境变量，值为：%ALLURE_HOME%\bin;。
一路确定，直至相关弹窗全部关闭。
打开 cmd 窗口，输入 allure --version，如果显示版本号，则表示部署成功。

# 将压缩包解压到用户目录 ~/ 下
unzip allure-2.24.1.zip -d ~/
# 配置环境变量（永久生效）
echo 'export ALLURE_HOME="$HOME/allure-2.24.1"' >> ~/.bashrc
echo 'export PATH="$ALLURE_HOME/bin:$PATH"' >> ~/.bashrc
# 刷新环境变量
source ~/.bashrc
# 给 allure 文件添加执行权限
chmod +x ~/allure-2.24.1/bin/allure
# 顺带确保 bin 目录有执行权限
chmod 755 ~/allure-2.24.1/bin/
# 验证部署是否成功
allure --version

生成并查看测试报告

有两种方式：

输出报告文件目录，然后基于报告文件目录，生成测试报告。这种方式可以与同事分享报告文件目录。
直接生成测试报告。

# allure-results 即插件 allure-pytest 原始测试结果数据的目录。
# --clean 会清空输出目录（allure-report）中的所有旧文件，再生成新报告。
# --output-dir 指定输出目录（allure-report）。
allure generate allure-results --clean --output-dir allure-report
# 基于已保存的报表启动轻量本地服务，通过浏览器访问查看测试报告。
allure open allure-report

最后更新于 2026年03月12日

Pytest & 实用工具 Api 自动化测试框架