Allure2 安装和配置

Allure2 安装和配置

前置条件:本机需已安装 Java 11 及以上(JDK 或 JRE),并已正确配置 JAVA_HOME(或系统能找到 java 命令)。Allure 依赖 Java 运行。


1. 下载

  1. 打开 Allure 2 Releases
  2. 在列表中选择一个版本(例如标记为 Latest 的版本)。
  3. 在 Assets 中找到与系统对应的 zip 包(名称通常类似 allure-2.x.x.zip),下载到本地。

2. 解压与目录约定

将 zip 解压到固定目录,便于配置环境变量(路径可按习惯调整,下文以示例路径说明)。

系统 建议解压位置(示例)
Windows C:\Tools\allure
macOS /opt/allure~/Tools/allure
Linux /opt/allure~/Tools/allure

解压后目录结构应包含 bin 子目录,且其中有可执行入口(Windows 为 allure.bat,类 Unix 为 allure)。


3. Windows:配置环境变量

  1. 假设解压路径为 C:\Tools\allure\allure-2.x.x(以实际文件夹名为准)。
  2. 打开:此电脑 → 属性 → 高级系统设置 → 环境变量。
  3. (可选)新建系统变量 ALLURE_HOME,值为 Allure 根目录,例如:
    C:\Tools\allure\allure-2.x.x
  4. 编辑系统变量 Path,新建一项:
  • 若已设 ALLURE_HOME%ALLURE_HOME%\bin
  • 若未设:直接写完整路径,例如 C:\Tools\allure\allure-2.x.x\bin
  1. 关闭并重新打开 命令提示符或 PowerShell,再验证。

4. macOS(zsh):配置 PATH

假设解压到 /opt/allure/allure-2.x.x(按实际路径修改)。
nano ~/.zshrc
追加:
export ALLURE_HOME=/opt/allure/allure-2.x.x
export PATH=“$ALLURE_HOME/bin:$PATH”
保存后执行:
source ~/.zshrc
若使用 bash,把上述内容写入 ~/.bash_profile~/.bashrc 后同样 source 一次。


5. Linux:配置 PATH

假设解压到 /opt/allure/allure-2.x.x
当前用户长期使用(写入 ~/.bashrc~/.profile,视发行版而定):
export ALLURE_HOME=/opt/allure/allure-2.x.x
export PATH=“$ALLURE_HOME/bin:$PATH”
全机所有用户(可选):
sudo nano /etc/profile.d/allure.sh
写入同上两行后:
source /etc/profile.d/allure.sh
若解压目录在普通用户家目录且无 sudo,只配置用户级 ~/.bashrc 即可。


6. 验证

在新开的终端(Windows 为新开 cmd/PowerShell)中执行:
allure --version
能打印版本号即表示 PATH 配置成功。若提示找不到 java 或 Java 相关错误,请先检查 Java 安装与 JAVA_HOME


7. 常用命令提示

  • 本地打开已生成的报告目录:
    allure open <报告目录路径>
  • 从 Allure 结果目录生成并打开报告(视你项目产物路径而定):
    allure serve <allure-results 目录路径>

8. 注意事项

  1. ALLURE_HOME 指向解压后的 Allure 根目录(包含 bin 的那一层),不要写成 bin 本身。
  2. 升级版本时:下载新 zip、解压到新目录,把 ALLURE_HOMEPath 中的路径改成新版本目录即可。
  3. 类 Unix 系统若 allure 无法执行,可检查 bin/allure 是否有执行权限:
    chmod +x "$ALLURE_HOME/bin/allure"