Allure+testNG(一):手把手教你用Allure生成优
如何使用Allure生成优美的可视化报告,我参考了很多文章,发现大家写的都不一样,而且写的很不清楚,大部分都会讲到和jenkins集成,但是很少会讲本地如何直接查看;而且在添加maven依赖的时候也遇到了一些坑,所以我决定自己记录一下,也希望大家遇到这些坑的时候能找到解决办法。
我参考的教程是《高大上的测试报告-Allure开源框架探索》
一、 Allure安装
以windows为例,其他系统可以参考官网 Allure官方文档
- 下载allure:
在下载的时候遇到了第一个坑,一般会让你去官网上下载或者按照官网的指引,使用scoop下载,可是我的电脑是win7,PowerShell没有自带;直接去官网的github下面下载真的好慢啊。
就在这个时候,我发现官方文档下面有个手动下载,这个地方点开来下载真的好快,好快。。。
image.png
如果所有的地方都下不到的话,那只能祭出我的某盘了 allure-commandline-2.9.0 - 运行bin目录下的allure.bat
- 添加 安装路径\allure-2.7.0\bin至环境变量PATH
完成以上步骤之后,测试一下是否安装成功 allure --version
User>Administrator>allure --version
2.9.0
二、 配置pom.xml
以下是我查看很多文章后总结出来最全的allure需要的依赖了
<properties>
<aspectj.version>1.8.10</aspectj.version> <!--AspectJ是一个基于Java语言的AOP框架-->
<allure.version>2.9.0</allure.version>
<!-- 解决mvn编译乱码问题-->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
这里我用的是testng生成测试报告
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<version>6.11</version>
</dependency>
allure的testng插件
<!--allure的testng插件-->
<dependency>
<groupId>ru.yandex.qatools.allure</groupId>
<artifactId>allure-testng-adaptor</artifactId>
<version>1.3.6</version>
<exclusions>
<exclusion>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- 依赖Guice -->
<dependency>
<groupId>com.google.inject</groupId>
<artifactId>guice</artifactId>
<version>4.0</version>
</dependency>
<dependency>
<groupId>io.qameta.allure</groupId>
<artifactId>allure-testng</artifactId>
<version>2.0-BETA14</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.20</version>
<configuration>
<argLine>
-javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
</argLine>
<!--生成allure-result的目录-->
<systemProperties>
<property>
<name>allure.results.directory</name>
<value>./target/allure-results</value>
</property>
</systemProperties>
</configuration>
<dependencies>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>${aspectj.version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
这里说一下自己踩的两个坑:
- 我们把allure生成的报告放在这个目录下./target/allure-results,而实际生成allure报告结果的时候往往会需要先clean再生成,而生成报告的时候不会自动在target这个目录下自动创建allure-results这个文件夹,所以我就改成了./allure-results这个路径,这样会在工程根目录下自动生成一个allure-results文件夹而不会报错了。
- aspectjweaver这个依赖我在使用maven自动导入依赖的时候一直标红,于是我自行下载了一个jar,然后手动导入就OK 了。
三、 生成allure报告
先把test下的测试cese跑一遍
mvn clean test
跑完之后会在工程的根目录下生成一个allure-results文件夹,里面都是json格式的文件,不要慌张,allure可以生成html网页通过web服务方式呈现出来。
allure提供了三种命令:
allure serve [path of allure result]
path of allure result就是allure生成的那些json格式文件所在的地址,这里就是前面说的allure-results文件夹
执行这个命令我们看看会发生什么:
D:\project\auto-test>allure serve allure-results
Generating report to temp directory...
Report successfully generated to C:\Users\ADMINI~1\AppData\Local\Temp\5753073181191844087\allure-report
Starting web server...
2019-11-15 12:02:44.786:INFO::main: Logging initialized @3140ms to org.eclipse.jetty.util.log.StdErrLog
Server started at <http://192.168.1.208:51608/>. Press <Ctrl+C> to exit
这个时候浏览器会自动将生成的html格式报告打开
这里我又遇到一个坑,打开了页面是这个样子的
image.png
后来发现是因为公司的vpn打开了,关掉之后就能正常展示
image.png
这里还有一个重点就是allure serve xxx这种方法会自动帮你生成报告到默认的地址C:\Users\ADMINI~1\AppData\Local\Temp\5753073181191844087\allure-report
所以这里还有一种命令,你可以生成一个指定的报告到指定位置
allure generate [path of allure result]
这个时候会生成一个allure-report在你定位的文件夹内,这个方法不会自动帮你启动浏览器
生成allure-report之后,你需要再次手动打开allure-report
allure open [path of allure report]
当然这个时候路径应该是allure-report所在的文件夹路径。
下一章再给大家介绍怎么更规范的去编写你的自动化case使报告更美观,符合你的要求。