当前位置：首页 > article >正文

maven项目下使用Jacoco测试覆盖率

article 2024/9/20 12:27:02

【本文前提是了解maven项目及其Pom.xml机制，不熟悉可以看该博客的0.Pre部分Auto-Unit-Test-Case-Generator -- java项目自动测试生成-CSDN博客】

JaCoCo（Java Code Coverage）是一个开源的代码覆盖率工具，专门用于测量 Java 应用程序的代码覆盖率。

注意，测试覆盖率自然是在src/test目录下的某个包/类：

myproject/
├── .gitignore
├── pom.xml
├── README.md
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── MyMainClass.java
│   │   ├── resources/
│   │   │   ├── application.properties
│   │   │   └── log4j.properties
│   │   └── webapp/
│   │       ├── WEB-INF/
│   │       │   └── classes/
│   │       └── index.html
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── example/
│       │           └── MyMainClassTest.java
│       └── resources/
│           └── test-application.properties
└── target/
    ├── classes/
    │   ├── com/
    │   │   └── example/
    │   │       └── MyMainClass.class
    │   ├── application.properties
    │   └── log4j.properties
    ├── generated-sources/
    ├── maven-archiver/
    │   └── pom.properties
    ├── maven-status/
    ├── test-classes/
    ├── test/
    │   └── com/
    │       └── example/
    │           └── MyMainClassTest.class
    ├── surefire-reports/
    └── classes/

Step1:准备工作-修改pom.xml:

1.1 添加插件1--maven-surefire-plugin：

【注意{argLine}】

插件添加位置：如前文的项目树状图，我要测试myproject，那就在同级的pom.xml内添加即可，下同；

通过使用 ${argLine}，你可以在其他地方（如父 POM 或其他插件配置）定义的 argLine 值被继承下来。这使得你可以集中管理 JVM 参数，而不是在每个插件配置中重复定义。

 <build>
        <plugins>   
 <!-- 以下是需要复制的内容，以上是方便查找复制的位置-->      
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.2</version>
                <configuration>
                    <argLine> ${argLine} </argLine>
                    <forkCount>4</forkCount>
                    <reuseForks>true</reuseForks> 
                </configuration>
            </plugin>

1.2 添加插件2--Jacoco:

 <build>
        <plugins>   
 <!-- 以下是需要复制的内容，以上是方便查找复制的位置-->   
<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.7</version>
  
    <executions>
        <execution>
            <id>pre-test</id>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>post-test</id>
            <phase>test</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Step2：运行如下命令:

执行路径在: src/test下的某级目录;如下图，我是在子模块目录下执行的；

mvn test jacoco:report

2.1 运行结果：

[INFO] --- jacoco-maven-plugin:0.8.7:report (post-test) @ aa-bb-xx ---

[INFO] Loading execution data file /home/xx/target/jacoco.exec

[INFO] Analyzed bundle 'aa :: bb :: xx' with 133 classes

[INFO] BUILD SUCCESS