代码测试覆盖率检查——jacoco

jacoco是java的代码测试覆盖率检查工具，并且提供了maven插件，可以直接在maven中使用。并且gitlab中也提供了coverage图标可以通过设置拿到Jacoco测试覆盖率的报告。

maven项目中使用

maven的pom文件的配置：

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.4</version>
    <configuration>
        <destFile>target/coverage-reports/jacoco-unit.exec</destFile>
        <dataFile>target/coverage-reports/jacoco-unit.exec</dataFile>
        <includes>
            <include>**/service/**</include>
            <include>**/controller/**</include>
            <!--<include>**/service/impl/*.class</include>-->
        </includes>
        <!-- rules里面指定覆盖规则 -->
        <rules>
            <rule implementation="org.jacoco.maven.RuleConfiguration">
                <element>BUNDLE</element>
                <limits>　　
                    <!-- 方法覆盖到50% -->
                    <limit implementation="org.jacoco.report.check.Limit">
                        <counter>METHOD</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>0.50</minimum>
                    </limit>
                    <!-- 分支覆盖到50% -->
                    <limit implementation="org.jacoco.report.check.Limit">
                        <counter>BRANCH</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>0.50</minimum>
                    </limit>
                    <!-- 类覆盖到100%，不能遗失任何类 -->
                    <limit implementation="org.jacoco.report.check.Limit">
                    <counter>CLASS</counter>
                    <value>MISSEDCOUNT</value>
                    <maximum>0</maximum>
                    </limit>
                </limits>
            </rule>
        </rules>
    </configuration>
    <executions>
        <execution>
            <id>jacoco-initialize</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <!--这个check:对代码进行检测，控制项目构建成功还是失败-->
        <execution>
            <id>check</id>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
        <!--这个report:对代码进行检测，然后生成index.html在 target/site/index.html中可以查看检测的详细结果-->
        <execution>
            <id>jacoco-site</id>
            <phase>package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>

在maven的pom配置中，可以指定代码的覆盖率，分别从Instructions, Branches, Cyclomatic Complexity, Lines, Methods, Classes角度来指定覆盖率要求。
maven的pom文件中可以指定jacoco-unit.exec文件路径以及文件名。
还可以通过<includes>节点来指定哪些类需要进行单元测试。
注意： 这里的覆盖率要求在maven打包命令是不会生效的，只有在执行maven install的时候会按照覆盖率要求，如果不满足覆盖率则会报错。
另外maven的测试类需要遵循相应的规范命名，否则无法运行测试类，不能生成测试报告，以及覆盖率报告。jacoco使用的是maven-surefire-plugin插件，它的默认测试类名规范是：

Test*.java ：以Test开头的Java类；
*Test.java ：以Test结尾的Java类;
*TestCase.java：以TestCase结尾的Java类；

或者可以在pom中自定义测试类

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-surefire-plugin</artifactId>
	<configuration>
		<includes>
			<include>**/*Tests.java</include>
			<include>**/*Test.java</include>
		</includes>
		<excludes>
			<exclude>**/Abstract*.java</exclude>
		</excludes>
	</configuration>
</plugin>

jacoco报告表头解释

1. Instructions
   Jacoco计算的最小单位就是字节码指令。指令覆盖率表明了在所有的指令中，哪些被指令过以及哪些没有被执行。这项指数完全独立于源码格式并且在任何情况下有效，不需要类文件的调试信息。
2. Branches
   Jacoco对所有的if和switch指令计算了分支覆盖率。这项指标会统计所有的分支数量，并同时支出哪些分支被执行，哪些分支没有被执行。这项指标也在任何情况都有效。异常处理不考虑在分支范围内。
3. Cyclomatic Complexity
   Jacoco为每个非抽象方法计算圈复杂度，并也会计算每个类，包，组的复杂度。根据McCabe1996的定义，圈复杂度可以理解为覆盖所有的可能情况最少使用的测试用例数。这项参数也在任何情况下有效。
4. Lines
   该项指数在有调试信息的情况下计算。因为每一行代码可能会产生若干条字节码指令，所以我们用三种不同状态表示行覆盖率
5. Methods
   每一个非抽象方法都至少有一条指令。若一个方法至少被执行了一条指令，就认为它被执行过。因为JaCoco直接对字节码进行操作，所以有些方法没有在源码显示（比如某些构造方法和由编译器自动生成的方法）也会被计入在内。
6. Classes
   每个类中只要有一个方法被执行，这个类就被认定为被执行。同5一样，有些没有在源码声明的方法被执行，也认定该类被执行。

gitlab上项目代码测试覆盖率检测

gitlab可以配合jacoco的测试报告，来获取到检测到的覆盖率数据。
在项目的.gitlab-ci.yml文件中配置mvn clean test && cat target/site/jacoco/index.html根据自己的实际情况来配置如果是打包前面一段则配置mvn clean package，如果报告路径有修改，则改为对应文件目录。
在gitlab中的Setting-CI/DI中的pipelines展开可以设置覆盖率检查的正则表达式，而JaCoCo则是根据检测报告html来生成覆盖率。对应的覆盖率获取gitlab已经提供了相应的正则表达式，可以直接使用。