基于docker和jenkins的java覆盖率工具jacoco配置

jacoco是常用的一个开源覆盖率工具，目前使用比较广泛，这段时间工作中也引入了覆盖率统计，这段时间也踩了不少坑，所以有必要记录下。

一　工具清单

(1) maven

(2) docker

(3) jenkins 工具，使用pipeline构建项目

(4) jacoco agent

(5) jacoco 的maven插件

(6) 测试相关工具(testng等）

二 搭建过程记录

1 安装jenkins的jacoco插件
在jenkins的系统管理中，点击manage plugins，进入到插件管理页面。在available下，搜索jacoco，然后进行安装。

安装完成后，按照提示重启jenkins。

2 在docker 镜像中加入java agnet的启动配置
编写dockerfile如下，

FROM base

ENV APP_NAME=appjava
ENV C_ENVIRONMENT="dev"
ENV JAVA_OPTS="-server"
ENV PROFILE=docker

COPY ./ENTRYPOINT.sh /data/ENTRYPOINT.sh
COPY ./jacocoagent.jar /tmp/jacocoagent.jar    #将本地javaagnet.jar加到镜像中。

#带java agnet参数运行java -jar命令，注意address要写0.0.0.0

ENTRYPOINT exec java -javaagent:/tmp/jacocoagent.jar=includes=*,output=tcpserver,port=6305,address=0.0.0.0 $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -Dspring.profiles.active=${PROFILE} -jar /data/${APP_NAME}.jar

COPY ./appbuild/target/${APP_NAME}.jar /data/${APP_NAME}.jar

#开放一个端口供客户端dump数据使用
EXPOSE 6305

3 构建docker容器
启动时，需要在docker run中加入端口映射（使用docker run的-P参数，如可将宿主机的6305端口映射至容器的6305端口）
启动容器后，使用telnet命令查看指定宿主机的Ip的端口是否打开，如果打开说明 java agent正常启动。
4 执行自动化或者手工测试
执行一些测试脚本或者手工测试，然后服务器端的java agent就会记录下测试的覆盖率数据。
5 使用maven的 jacoco插件dump覆盖率数据
在要进行构建的maven项目（可以是自动化测试所在的项目或者被测服务所在项目）加入jacoco的插件。在pom文件中加入下面的元素。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>2.22.2</version>
            <configuration>
            </configuration>
        </plugin>

        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.2</version>
            <executions>
                <execution>
                    <id>default-instrument</id>
                    <goals>
                        <goal>instrument</goal>
                    </goals>
                </execution>
                <execution>
                    <id>default-restore-instrumented-classes</id>
                    <goals>
                        <goal>restore-instrumented-classes</goal>
                    </goals>
                </execution>
                <execution>
                    <id>report</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
                <execution>
                    <id>check</id>
                    <goals>
                        <goal>check</goal>
                    </goals>
                </execution>
                <execution>
                    <id>prepare-agent</id>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!-- rules里面指定覆盖规则 -->
 <rules>
                    <rule implementation="org.jacoco.maven.RuleConfiguration">
                        <element>BUNDLE</element>
                        <limits>
                            <!-- 指定方法覆盖到80% -->
 <limit implementation="org.jacoco.report.check.Limit">
                                <counter>METHOD</counter>
                                <value>COVEREDRATIO</value>
                                <minimum>0.80</minimum>
                            </limit>
                            <!-- 指定指令覆盖到80% -->
 <limit implementation="org.jacoco.report.check.Limit">
                                <counter>INSTRUCTION</counter>
                                <value>COVEREDRATIO</value>
                                <minimum>0.80</minimum>
                            </limit>
                            <!-- 指定行覆盖到80% -->
 <limit implementation="org.jacoco.report.check.Limit">
                                <counter>LINE</counter>
                                <value>COVEREDRATIO</value>
                                <minimum>0.80</minimum>
                            </limit>
                            <!-- 指定类覆盖到100%，不能遗失任何类 -->
 <limit implementation="org.jacoco.report.check.Limit">
                                <counter>CLASS</counter>
                                <value>MISSEDCOUNT</value>
                                <maximum>0</maximum>
                            </limit>

                        </limits>
                    </rule>
                </rules>
            </configuration>
        </plugin>
    </plugins>
</build>

然后在pom中加入依赖。

<dependency>
    <groupId>org.jacoco</groupId>
    <artifactId>org.jacoco.agent</artifactId>
    <version>0.8.2</version>
    <classifier>runtime</classifier>
</dependency>

6 配置jenkins的pipeline类型的job
通过maven的jacoco插件从java agent端dump数据，然后在jenkins中展示覆盖率测试报告。

pipeline示例如下

node {

 def branch = scm.branches[0].name

    stage('checkout') {

 def paramBranch = "${env.BRANCH}"
 def nullStr = "null"
 if(paramBranch?.trim()&&(nullStr!=paramBranch)){
            echo paramBranch
            branch = "${env.BRANCH}"
 echo "set empty"
 }
        echo "代码分支"+branch
        checkout([
                $class: 'GitSCM',
                branches: [[name: branch]],
                doGenerateSubmoduleConfigurations: scm.doGenerateSubmoduleConfigurations,
                extensions: scm.extensions,
                userRemoteConfigs: scm.userRemoteConfigs
        ])

    }

 stage('test') {

 def maven = docker.image('maven:3-alpine')
        maven.inside('-v /root/.m2/:/root/.m2/'){
 sh 'mvn clean -f pom.xml test '
 }
 }
//将被测试代码checkout 出来，然后进行编译
 stage('rd code') {
 echo 'This is a checkout server step'
 sh 'rm -rf ./*'
 checkout([$class: 'GitSCM', branches: [[name: '*/master']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [], userRemoteConfigs: [[credentialsId: '1234111', url: 'http://example.git']]])
    }
//从远程java agent的服务端dump数据到本地，
//reset表示dump完成后，将覆盖率数据清空
 stage('dumpcoverage') {
 def maven = docker.image('maven:3-alpine')
        maven.inside('-v /root/.m2/:/root/.m2/'){
 sh  'mvn compile'
 sh 'mvn org.jacoco:jacoco-maven-plugin:0.8.2:dump -Djacoco.address=10.1.2.3 -Djacoco.port=6300 -Djacoco.reset=true'
 }
 }
//调用jacoco的jenkins插件进行生成覆盖率数据报告，execPattern 为exec数据文件的本地位置，classesPattern 要统计的代码的class文件路径，sourcePattern为要统计的源代码路径配置

 stage('jacoco'){
 jacoco(execPattern:'target/jacoco.exec',classPattern:'a/target/classes,b/target/classes',sourcePattern:'a/src/main/java,b/src/main/java')
    }
}

7 构建job，获取到覆盖率的结果如下图