jacoco 增量方案使用说明书

鉴于上篇jacoco增量覆盖率实践实现了差异代码获取和jaocco二开后，很多咨询我的是测试的小伙伴，对java可能不太熟悉，想要直接使用又赶脚稍许迷茫，所以又写下这边文章来帮助迷茫中的小伙伴拉

• 组件说明

首先说明一下实现此增量方案所依赖的组件

1. 原生jacoco知识
2. code-diff服务
3. jacoco二开cli包

原生jacoco知识

首先你需要了解jacoco的实现步骤，知道单元测试覆盖率和功能测试覆盖率，而我们通常讲的增量覆盖率一般讲的也是功能测试覆盖率

其实单元测试和功能测试其实分别对应jacoco的offline模式和on-the-fly模式

offline模式就是在测试之前先对文件进行插桩，生成插过桩的class或jar包，测试插过桩的class和jar包，生成覆盖率信息到文件，最后统一处理，生成报告。

而on-the-fly模式则是JVM通过 -javaagent参数指定jar文件启动代理程序，代理程序在ClassLoader装载一个class前判断是否修改class文件，并将探针插入class文件，探针不改变原有方法的行为，只是记录是否已经执行。

实现on-the-fly模式需要一下几个步骤

1.使用启动我们应用服务的时候，需要添加jvm参数 -javaagent,如:

  -javaagent:[yourpath/]jacocoagent.jar=[option1]=[value1],[option2]=[value2]

具体实例如下：

java -javaagent:/tmp/jacoco/lib/jacocoagent.jar=includes=*,output=tcpserver,port=6300,address=localhost,append=true -jar demo-0.0.1-SNAPSHOT.jar 

其中有个几个关键参数需要我们注意

• includes=*

这个代表了，启动时需要进行字节码插桩的包过滤，*代表所有的class文件加载都需要进行插桩。

你可以写成:

includes=com.test.service.*

       这个参数我们可以用来做maven多模块的覆盖率，比如我们只想查看service服务层的覆盖率，我们可以通过设置包路径的方式进行只统计当前包的覆盖率

• output=tcpserver     

       output主要四个参数:

1. file: At VM termination execution data is written to the file specified in the destfile attribute.（当jvm停止掉的时候产出dump文件，即服务挂了产出dump文件）

2. tcpserver: The agent listens for incoming connections on the TCP port specified by the address and port attribute. Execution data is written to this TCP connection.（常用模式，将jacocoaget作为服务，每次通过cli包进行dump命令去获取dump包）

3. tcpclient: At startup the agent connects to the TCP port specified by the address and port attribute. Execution data is written to this TCP connection.（将jacocoagent做为客户端，向指定ip和端口的服务推送dump信息）

4. none: Do not produce any output.（不产出任何dump，dump个寂寞，忽略）

此处需要有个说明：在k8s容器里面由于ip是动态的，tcpserver模式的ip无法固定填写，可以填 0.0.0.0 然后通过实际容器 ip 就可以访问到，而这个实际ip,一般可以从cmdb服务中动态获取

• port=98080

这是jacoco开启的tcpserver的端口，请注意这个端口不能被占用

• address=192.168.110.1

这是对外开发的tcpserver的访问地址。可以配置127.0.0.1,也可以配置为实际访问ip
配置为127.0.0.1的时候，dump数据只能在这台服务器上进行dump，就不能通过远程方式dump数据。
配置为实际的ip地址的时候，就可以在任意一台机器上(前提是ip要通，不通都白瞎)，通过ant xml或者api方式dump数据。
举个栗子：
我如上配置了192.168.110.1:2014作为jacoco的tcpserver启动服务，
那我可以在任意一台机器上进行数据的dump，比如在我本机windows上用api或者xml方式调用dump。
如果我配置了127.0.0.1:2014作为启动服务器，那么我只能在这台测试机上进行dump，其他的机器都无法连接到这个tcpserver进行dump

如果不知道本机ip地址，可以使用0.0.0.0，这样ip地址会绑定主机ip

2.我们需要使用cli包去获取exec文件

java -jar jacococli.jar dump --address 192.169.110.1 --port 2014 --destfile ./jacoco-demo.exec

使用这个命令会在我们调用方的服务上生成一个exec文件

3.生成report

java -jar jacococli.jar report ./jacoco-demo.exec --classfiles /Users/oukotoshuu/IdeaProjects/demo/target/classes/com   --classfiles /Users/oukotoshuu/IdeaProjects/demo/target/classes/com  --sourcefiles /Users/oukotoshuu/IdeaProjects/demo/src/main/java --sourcefiles /Users/oukotoshuu/IdeaProjects/demo/src/main/java --html report --xml report.xml

还是通过cli包去生成报告文件，注意这个classfiles和sourcefiles 可以是多个，我们如果是多模块项目通过指定代码路径和编译文件路径去分开做统计

以上就是jacoc原生知识点，相信大部分童鞋是清楚滴。

code-diff服务

code-diff一个获取增量代码的服务，支持git(分支,tag,commitid)和svn(分支，rversion),具体实现已经在上篇讲解到，这里只讲使用

首先拉取代码，修改配置文件，主要修改git服务的账号和密码，以及拉取代码的存储地址

1、修改application.yml
##基于git
git:
  userName: admin
  password: 123456
  local:
    base:
      dir: D:\git-test
##基于svn
svn:
  userName: admin
  password: 123456
  local:
    base:
      dir: D:\svn-test

然后运行maven命令：

mvn  clean package -Dmaven.test.skip=true 

这样就可以获取到一个code-diff.jar包

找到一个服务器，将包扔上去，然后部署：

java -jar code-diff.jar

如此我们就算部署好差异代码服务了

运行项目，访问http://127.0.0.1:8085/doc.html（地址为部署服务ip）

  输入git地址，填写差异分支的旧版本，新版本，执行，就可以获取差异信息

{
		"code": 10000,
		"msg": "业务处理成功",
		"data": [
			{
				"classFile": "com/dr/application/InstallCert",
				"methodInfos": null,
				"type": "ADD"
			},
			{
				"classFile": "com/dr/application/app/controller/Calculable",
				"methodInfos": null,
				"type": "ADD"
			},
			{
				"classFile": "com/dr/application/app/controller/JenkinsPluginController",
				"methodInfos": null,
				"type": "ADD"
			},
			{
				"classFile": "com/dr/application/app/controller/LoginController",
				"methodInfos": [
		{
			"methodName": "captcha",
			"parameters": "HttpServletRequest&HttpServletResponse"
		},
		{
			"methodName": "login",
			"parameters": "LoginUserParam&HttpServletRequest"
		},
		{
			"methodName": "testInt",
			"parameters": "int&char"
		},
		{
			"methodName": "testInt",
			"parameters": "String&int"
		},
		{
			"methodName": "testInt",
			"parameters": "short&int"
		},
		{
			"methodName": "testInt",
			"parameters": "int[]"
		},
		{
			"methodName": "testInt",
			"parameters": "T[]"
		},
		{
			"methodName": "testInt",
			"parameters": "Calculable&int&int"
		},
		{
			"methodName": "testInt",
			"parameters": "Map<String,Object>&List<String>&Set<Integer>"
		},
		{
			"methodName": "display",
			"parameters": ""
		},
		{
			"methodName": "a",
			"parameters": "InnerClass"
		}
				],
				"type": "MODIFY"
			},
			{
				"classFile": "com/dr/application/app/controller/RoleController",
				"methodInfos": null,
				"type": "ADD"
			},
			{
				"class