allure 报告定制修改

最新推荐文章于 2025-02-11 16:52:28 发布

原创最新推荐文章于 2025-02-11 16:52:28 发布 · 2.1k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

自动化测试专栏收录该内容

3 篇文章

订阅专栏

Allure 报告定制修改

主要介绍了一下Allure报告主Logo及网页标题的修改。

Allure安装及使用

项目在使用pytest过程中，需要使用allure来生成美化报告。

下载Allure
Allure 下载
Allure的使用：
使用方法在此不多赘述，网上有许多教程
可以参考：https://blog.youkuaiyun.com/weixin_42668772/article/details/120843070

Logo替换

找到allure报告的安装路径：
我的是在C盘：C:\Windows\allure-2.20.1\plugins\custom-logo-plugin\static
然后找到：下图位置 --将需要更换的图片放至这个文件夹中，名字起名为： allure_logo.jpg，建议最好放svg文件
2. 在 custom-logo-plugin/static/styles.css 文件中：
修改url信息如下：

/*.side-nav__brand {
  background: url('custom-logo.svg') no-repeat left center !important;
  margin-left: 10px;
}*/
.side-nav__brand {
  background: url('allure_logo.jpg') no-repeat left center !important;
  margin-left: 10px;
  height: 80px;
  background-size: contain !important;
}

.side-nav__brand-text {
	display: none;
}

再点击config，在allure.yml中加上-custom-logo-plugin：

再运行allure就可以看到修改的logo和名称了

报告名称，网页标题及小Logo替换

想要再进一步定制报告，可以参考Stackoverflow的答案：
How to customize allure report title and logo

首先，先下载allure的源码：
链接: allure

下载完成后，可参考如下步骤来依次修改报告名称，网页标题及logo，在做完如下的修改完成后，还需要参考使用Gradle来重新生成allure库使修改生效。

报告名称的替换
切换到allure2-master_2\allure2-master\allure-generator\src\main\java\io\qameta\allure\summary\SummaryPlugin.java中，将.setReportName(“Allure Report”)中的字符串替换成自己需要的

    @Override
    protected SummaryData getData(final List<LaunchResults> launches) {
        final SummaryData data = new SummaryData()
                .setStatistic(new Statistic())
                .setTime(new GroupTime())
                .setReportName("Allure Report");
        launches.stream()
                .flatMap(launch -> launch.getResults().stream())
                .forEach(result -> {
                    data.getStatistic().update(result);
                    data.getTime().update(result);
                });
        return data;
    }

网页标题替换
allure2-master_2\allure2-master\allure-generator\build\resources\main\tpl\index.html.ftl
将title标签中的Allure Report替换成自己想要的标题即可

<head>
    <meta charset="utf-8">
    <title>Allure Report</title>
    <link rel="favicon" href="favicon.ico?v=2">
    <link rel="stylesheet" type="text/css" href="styles.css">

网页小logo的替换
切换到路径：allure2-master_2\allure2-master\allure-generator\src\main\javascript
将favicon.ico替换成自己的ico文件

使用Gradle重新生成allure库

在做完上述自定义修改后，需要使用Gradle来重新生成allure的库文件，这样再次生成的报告才会变成我们想要的格式。
也可以直接运行allure源码文件下的gradlew.bat文件来一键执行。下面介绍的是自己配置Gradle的步骤：

Gradle安装

JDK安装
Gradle安装前，确保已安装JDK，windows下进入命令行，使用命令： java -version来检查
如果未安装，请先安装JDK。
Gradle安装
Gradle Download: Releases
点击binary-only来下载zip文件
下载完成后，可以参考：Gradle Installation Guide
将Gradle/bin路径加入到系统变量中。

使用gradle -v检查是否生效

C:\Users\XXX>gradle -v

------------------------------------------------------------
Gradle 7.6
------------------------------------------------------------

Build time:   2022-11-25 13:35:10 UTC
Revision:     daece9dbc5b79370cc8e4fd6fe4b2cd400e150a8

Kotlin:       1.7.10
Groovy:       3.0.13
Ant:          Apache Ant(TM) version 1.10.11 compiled on July 10 2021
JVM:          1.8.0_352 (Red Hat, Inc. 25.352-b08)
OS:           Windows 10 10.0 amd64

Gradle编译（要用梯子，不然容易失败，主要是因为要从github下载一些依赖）
再次进入allure文件夹内，切换到allure2-master_2\allure2-master\allure-generator, 使用命令行输入gradle build

C:\Users\XXX>gradle build
Starting a Gradle Daemon (subsequent builds will be faster)

> Task :allure-generator:buildWeb
Hash: df200e619fd30fcdcaef
Version: webpack 4.46.0
Time: 16805ms
Built at: 12/01/2022 10:12:58 AM
      Asset      Size  Chunks                    Chunk Names
     app.js   754 KiB       0  [emitted]  [big]  main
favicon.ico  66.1 KiB          [emitted]
 styles.css  1.47 MiB       0  [emitted]  [big]  main
Entrypoint main [big] = styles.css app.js
....（省略）

完成后将.jar文件替换
gradle build执行完成后，切换到allure2-master_2\allure2-master\allure-generator\build\libs文件夹下，应该生成如下文件：
将allure-generator-2.21-SNAPSHOT.jar文件重命名为allure-generator-2.21.jar，其中2.21版本号可以修改，根据本地allure的版本来命名即可。

将该.jar文件替换至：系统盘中allure\lib文件夹下，替换allure-generator-XXX.jar，再次使用allure重新生成报告即可。

可能遇到的一些问题：

代理问题
由于公司政策的限制，不使用代理gradle在配置时会出错，因此可以修改allure文件夹下的allure2-master_2\allure2-master\gradle.properties文件，增加如下信息：
XXX.XXX.XXX修改为本公司支持的代理，端口也需要对应

systemProp.http.proxyHost=XXX.XXX.XXX
systemProp.http.proxyPort=8080
systemProp.https.proxyHost=XXX.XXX.XXX
systemProp.https.proxyPort=8080

参考文件

感谢这些信息分享，在此做了一些微小的汇总工作：