Jacoco单元测试工具的使用——maven项目配置

Jacoco单元测试工具的使用

一、JaCoCo简述

JaCoCo是一个开源的覆盖率工具,它针对的开发语言是java,其使用方法很灵活,可以嵌入到Ant、Maven中;可以作为Eclipse插件,可以使用其JavaAgent技术监控Java程序等等。

很多第三方的工具提供了对JaCoCo的集成,如sonar、Jenkins等。

JaCoCo包含了多种尺度的覆盖率计数器,包含指令级覆盖(Instructions,C0coverage),分支(Branches,C1coverage)、圈复杂度(CyclomaticComplexity)、行覆盖(Lines)、方法覆盖(non-abstract methods)、类覆盖(classes)

二、JaCoCo基本概念

jacoco支持多种覆盖率的统计,包括:

  1. 行覆盖率:度量被测程序的每行代码是否被执行,判断标准行中是否至少有一个指令被执行。
  2. 类覆盖率:度量计算class类文件是否被执行。
  3. 分支覆盖率:度量if和switch语句的分支覆盖情况,计算一个方法里面的总分支数,确定执行和不执行的 分支数量。
  4. 方法覆盖率:度量被测程序的方法执行情况,是否执行取决于方法中是否有至少一个指令被执行。
  5. 指令覆盖:计数单元是单个java二进制代码指令,指令覆盖率提供了代码是否被执行的信息,度量完全 独立源码格式。
  6. 圈复杂度:在(线性)组合中,计算在一个方法里面所有可能路径的最小数目,缺失的复杂度同样表示测 试案例没有完全覆盖到这个模块。

三、Maven配置JaCoCo

3.1 mvn命令增加参数

在执行mvn命令时,加上“org.jacoco:jacoco-maven-plugin:{版本号}:prepare-agent”参数即可。

示例:

clean test org.jacoco:jacoco-maven-plugin:0.8.3:prepare-agent install -Dmaven.test.failure.ignore=true

其中0.8.3是jacoco的版本号

【-Dmaven.test.failure.ignore=true】建议加上,否则如果单元测试失败,就会直接中断,不会产生.exec文件

执行命令成功之后,会在当前项目目录的target下生成一个jacoco.exec文件,该文件就是覆盖率文件

image

生成exec文件位置

image

可以通过idea来查看这个覆盖率文件

image

image

覆盖率结果

image

3.2在pom文件中添加jacoco插件

3.2.1添加依赖

<dependencies>
	<!--junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
    <!--jacoco -->
    <dependency>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.8.3</version>
    </dependency>

</dependencies>

junit用于写单元测试的方法

3.2.2配置plugin

<build>
        <plugins>
            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.3</version
                <executions>
                    <execution>
                        <id>jacoco-initialize</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>check</id>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>jacoco-site</id>
                        <phase>package</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
</build>

- 在中配置执行步骤:
1)prepare-agent(即构建jacoco-unit.exec);
2)check(即根据在定义的规矩进行检测);
3)package(生成覆盖率报告,默认生成在target/site/index.html)

3.2.3设定覆盖率检测的文件范围

<configuration>
       <includes>
          <include>com/**/*</include>
       </includes>
</configuration>

configuration加在plugin标签里,executions外

表示对指定目录下的包进行覆盖率测试,com/**/*表示对com下的所有文件进行覆盖率测试

你也可以这样排除一个包和它的所有子包/子包:

<exclude>com/**/*</exclude>

通配符语法

*   Match zero or more characters
**  Match zero or more directories
?   Match a single character

3.2.4指定覆盖规则

<configuration>
          <includes>
            <include>com/**/*</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>

指定覆盖规则,只有在中配置了check才会生效,不满足覆盖条件的情况下mvn install命令将会执行失败

image

3.2.5指定覆盖测试报告的生成目录

<execution>
       <id>jacoco-site</id>
       <phase>package</phase>
       <goals>
             <goal>report</goal>
       </goals>
       <configuration>
             <dataFile>target/jacoco.exec</dataFile>
             <outputDirectory>target/jacocosite</outputDirectory>
       </configuration>
</execution>

要在execution的report下配置,outputDirectory标签里即是生成报告的目录

image

index.html就是生成的覆盖率测试报告

参考博客:https://www.cnblogs.com/fnlingnzb-learner/p/10637802.html
https://www.cnblogs.com/forfreewill/articles/13627983.html?ivk_sa=1024320u

posted @ 2021-09-28 17:21  TidalCoast  阅读(1424)  评论(0编辑  收藏  举报