DevOps实战（二）- Jenkins集成单元测试报告和Allure插件用法

叁歲伎倆 2022-01-27 01:25 574阅读 0赞

# 需求背景 #

> 1、通过使用maven-surefire-plugin插件，maven + junit会在项目下target/surefire-reports目录，提供两种格式的测试结果集，一种是txt格式，一种是xml格式，但这样阅读起来不够直观。通过Jenkins集成，可以拥有一个很直观的测试报告。
> 
> 2、Allure是一款轻量级，且灵活的开源测试报告生成框架。简单易用，易于集成，并且支持绝大多数测试框架， 例如TestNG、Pytest、JUint等。通过Jenkins集成后，可以拥有一个十分漂亮的测试报告输出。

# 准备工作 #

1、[Jenkins安装集成和案例分析][Jenkins]，见此文章

2、[如何进行单元测试编写和场景案例分析][Link 1]，见此文章

3、下面演示用到的项目源码，[见这里，下载源码][Link 2]，准备了四个测试案例

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70][]

4、Jenkins集成添加Allure插件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 1][]

# 详细步骤 #

### 1、maven-surefire-plugin插件用法介绍 ###

a. 在项目中pom.xml文件中引入插件

b. 执行命令mvn clean test

c. 会自动生成一个目录target/surefire-reports，输出报告结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 2][]

d. 开启Jenkins任务支持

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 4][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 5][]

e. 最终效果展示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 6][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 7][]

### 2、Allure插件用法介绍 ###

a. 在项目中pom.xml文件中引入插件，代码无需任何改动

<dependency>
    			<groupId>io.qameta.allure</groupId>
    			<artifactId>allure-junit4</artifactId>
    			<version>2.12.0</version>
    			<scope>test</scope>
    		</dependency>

<build>
    		<plugins>
    			<plugin>
    				<groupId>org.apache.maven.plugins</groupId>
    				<artifactId>maven-surefire-plugin</artifactId>
    				<configuration>
    					
    					<includes>
    						<include>**/*Test.java</include>
    					</includes>
    					
    					<excludes>
    						<exclude>**/Test*.java</exclude>
    					</excludes>
    					<testFailureIgnore>false</testFailureIgnore>
    					<argLine>
    						-javaagent:"${settings.localRepository}/org/aspectj/aspectjweaver/${aspectj.version}/aspectjweaver-${aspectj.version}.jar"
    					</argLine>
    					<properties>
    						<property>
    							<name>listener</name>
    							<value>io.qameta.allure.junit4.AllureJunit4</value>
    						</property>
    					</properties>
    				</configuration>
    				<dependencies>
    					<dependency>
    						<groupId>org.aspectj</groupId>
    						<artifactId>aspectjweaver</artifactId>
    						<version>${aspectj.version}</version>
    					</dependency>
    				</dependencies>
    			</plugin>
    		</plugins>
    	</build>

b. 执行命令mvn clean test

c. 会在项目根目录下，生成allure-results目录，测试结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 8][]

d. 开启Jenkins任务支持

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 3][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 9][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 10][]

e. 最终效果展示，报告入口位置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 11][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 12][]

# 问题解决 #

问题描述：

> **1、Allure报表打开显示为空，图上显示为"0测试案例，NaN%"**

解决方案：

> 1. 回到上面的Allure插件用法介绍，仔细查看一下（第d步Jenkins开启支持）详细说明步骤，其路径一定要配置对
> 
> 2. Jenkins服务部署和仓库代码，需要部署在同一个机器上。这里说的路径，是指本机上的路径，而非远程服务器上的

至此，全部介绍就结束了

# 其他资料 #

[1、官方Surefire插件说明文档][1_Surefire]

[2、官方allure-junit4集成说明文档][2_allure-junit4]

# 该系列教程 #

[DevOps实战系列][DevOps]

\------------------------------------------------------

[关于我][Link 3]（个人域名）

[我的开源项目集Github][Github]

期望和大家一起学习，共同进步，共勉，O(∩\_∩)O谢谢

欢迎交流问题，可加个人QQ 469580884，

或者，加我的群号 **751925591**，一起探讨交流问题

不讲虚的，只做实干家

Talk is cheap，show me the code

![20180411181545874][]

如果觉得内容赞，您可以请我喝杯咖啡：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70][]        ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1][]

[Jenkins]: https://blog.csdn.net/hemin1003/article/details/90371702
[Link 1]: https://blog.csdn.net/hemin1003/article/details/90214986
[Link 2]: https://github.com/hemin1003/spring-boot-study/tree/master/spring-boot2-study/spring-boot2-parent/spring-boot2-autotest
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70]: /images/20220127/6a84aa253ebf4824b1dc2d54fbaf4633.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 1]: /images/20220127/655aac51cd814be0bb884f9ea28d0861.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 2]: /images/20220127/c41a7c56be9441f99caa4eaf94c314fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 3]: /images/20220127/93fbc3944d0747f887b81f70db0e9514.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 4]: /images/20220127/42a7e90f38084e9fbdbbe6398ea2eb4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 5]: /images/20220127/c863b08b20174c5bae7967db5cf3f534.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 6]: /images/20220127/5c61af8222ea4ceebeca6f8ce3a7403a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 7]: /images/20220127/dc94210506984ff0bf6890d4b45850c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 8]: /images/20220127/6ea3103141bc4b2ebc71fa66a36ca96e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 9]: /images/20220127/f901aa81bd3545fd94988ce9a3562d82.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 10]: /images/20220127/4a907ccaa38b4056b39bb2c3f43eab21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 11]: /images/20220127/375945f70e7b4d899e22249e4b671e09.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlbWluMTAwMw_size_16_color_FFFFFF_t_70 12]: /images/20220127/b43c27a76d7646fdb8d7a569d19761b8.png
[1_Surefire]: http://maven.apache.org/surefire/index.html
[2_allure-junit4]: https://docs.qameta.io/allure/#_junit_4
[DevOps]: https://blog.csdn.net/hemin1003/article/category/8964225
[Link 3]: http://heminit.com/about/
[Github]: https://github.com/hemin1003
[20180411181545874]: /images/20220127/ea750c1eb5c14028af0cffc10bd75bb1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190816110426562.jpeg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20190816110923699.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9oZW1pbi5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70