SpringBoot-Jacoco单元测试覆盖率报告

x33g5p2x  于10个月前 转载在 Spring  
字(3.2k)|赞(0)|评价(0)|浏览(223)

添加Maven

添加测试依赖

<dependencies>      
    <!--spring-boot测试-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
     </dependencies>

添加jacoco的配置和依赖

<!-- 自动查找主类 用于打包 和 jacoco的配置 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

            <plugin>
                <groupId>org.jacoco</groupId>
                <artifactId>jacoco-maven-plugin</artifactId>
                <version>0.8.1</version>
                <executions>
                    <execution>
                        <id>prepare-agent</id>
                        <goals>
                            <goal>prepare-agent</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>report</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>post-unit-test</id>
                        <phase>test</phase>
                        <goals>
                            <goal>report</goal>
                        </goals>
                        <configuration>
                            <dataFile>target/jacoco.exec</dataFile>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

编写单元测试类

package com;

import com.baidu.HelloAppllication;
import com.baidu.controller.GradeClassController;
import com.baidu.service.GradeClassService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.List;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = HelloAppllication.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class TestApp {

    @Autowired
    private GradeClassService selectAllGradeSize;

    @Test
    public  void  show1(){
        List<String> list = selectAllGradeSize.selectGradeClassAssignGrade();

        System.out.println(list);

    }

}

运行 Jacoco

在IDEA中右侧有Maven插件然后 点击install就行了,

如果使用的不是IDEA那么可以使用Maven的命令

mvn install
mvn jacoco:report //生成报告

然后jacoco就会运行一遍所有单元测试,然后生成单元测试报表

查看报告

进入项目 /target/site/ ,其下的整个 Jacoco-ut 都是报告相关内容,可以点击 index.html 进行具体查看

报表解释

在做单元测试时,代码覆盖率常常被拿来作为衡量测试好坏的指标,甚至,用代码覆盖率来考核测试任务完成情况,比如,代码覆盖率必须达到80%或 90%。

Jacoco从多种角度对代码进行了分析,包括指令(Instructions,C0 Coverage),分支(Branches,C1 Coverage),圈复杂度(Cyclomatic Complexity),行(Lines),方法(Methods),类(Classes)。

1. Instructions

Jacoco计算的最小单位就是字节码指令。指令覆盖率表明了在所有的指令中,哪些被指令过以及哪些没有被执行。这项指数完全独立于源码格式并且在任何情况下有效,不需要类文件的调试信息。

2. Branches

Jacoco对所有的if和switch指令计算了分支覆盖率。这项指标会统计所有的分支数量,并同时支出哪些分支被执行,哪些分支没有被执行。这项指标也在任何情况都有效。异常处理不考虑在分支范围内。
在有调试信息的情况下,分支点可以被映射到源码中的每一行,并且被高亮表示。
红色钻石:无覆盖,没有分支被执行。
黄色钻石:部分覆盖,部分分支被执行。
绿色钻石:全覆盖,所有分支被执行。

3. Cyclomatic Complexity

Jacoco为每个非抽象方法计算圈复杂度,并也会计算每个类,包,组的复杂度。根据McCabe1996的定义,圈复杂度可以理解为覆盖所有的可能情况最少使用的测试用例数。这项参数也在任何情况下有效。

4. Lines

该项指数在有调试信息的情况下计算。因为每一行代码可能会产生若干条字节码指令,所以我们用三种不同状态表示行覆盖率
红色背景:无覆盖,该行的所有指令均无执行。
黄色背景:部分覆盖,该行部分指令被执行。
绿色背景:全覆盖,该行所有指令被执行。

5. Methods

每一个非抽象方法都至少有一条指令。若一个方法至少被执行了一条指令,就认为它被执行过。因为JaCoco直接对字节码进行操作,所以有些方法没有在源码显示(比如某些构造方法和由编译器自动生成的方法)也会被计入在内。

6. Classes

每个类中只要有一个方法被执行,这个类就被认定为被执行 ,有些没有在源码声明的方法被执行,也认定该类被执行。

可以点击进入,红色没有覆盖,绿色覆盖了

相关文章