JaCoCo入门

概述

代码覆盖率是一种指标度量自动化用例测试执行时，有多少行代码被覆盖到。

这篇文章将带大家漫步JaCoCo使用的常用知识点--生成一个Java项目的代码覆盖率报告。

Maven配置

为了用JaCoCo执行，我们需要在pom.xml中声明Maven JaCoCo插件

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.7.7.201606060606</version>
    <executions>
        <execution>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>report</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>

最新版：https://search.maven.org/classic/#search%7Cga%7C1%7Cg%3A%22org.jacoco%22%20AND%20a%3A%22jacoco-maven-plugin%22

代码覆盖率报告

在我们开始学习JaCoCo之前，我们需要准备一段待测代码。这里准备一个简单函数用来检验字串是不是回文（不论是从左向右顺读,还是从右向左倒读,结果都是一样）。

public boolean isPalindrome(String inputString) {
    if (inputString.length() == 0) {
        return true;
    } else {
        char firstChar = inputString.charAt(0);
        char lastChar = inputString.charAt(inputString.length() - 1);
        String mid = inputString.substring(1, inputString.length() - 1);
        return (firstChar == lastChar) && isPalindrome(mid);
    }
}

现在我再准备一个简单的JUnit测试用例：

@Test
public void whenEmptyString_thenAccept() {
    Palindrome palindromeTester = new Palindrome();
    assertTrue(palindromeTester.isPalindrome(""));
}

mvn clean install执行测试用例，将自动启动JaCoCo agent。将会在target目录下生成二进制覆盖率报告-- target/jacoco.exec。

如果你使用IDEA你就可以直接看到HTML报告，

target/site/jacoco/index.html

报告样子如下：

点击链接，可以查看详细报告：

如果你用的是Eclipse，你要安装EclEmma Eclipse plugin。

报告分析

我的报告显示指令覆盖率为21%，分支覆盖率为17%，3/5为圈复杂度等等。

报告中显示38条指令是字节码指令而不是Java代码指令。JaCoCo报告用钻石图标和代码背景色帮助更好地理解覆盖率。

• 红色钻石代表没有没有分支被执行到
• 黄色钻石代表仅部分分支被执行到
• 绿色钻石代表所有分支都有执行到

JaCoCo提供了以下三种重要指标：

• 行覆盖率
• 分支覆盖率
• 圈复杂度 根据由McCabe1996圈复杂度的定义是，在（线性）组合中，计算在一个方法里面所有可能路径的最小数目。 举个例子，如果没有if或者switch圈复杂度为1.我们只要一条路径就可以覆盖代码换句话说圈复杂度是覆盖所有代码的最小用例数。

原理

JaCoCo以Java agent的形式运行，当执行用例时负责调试字节码，跟踪每个指令，显示那些代码行被执行过。

为了采集覆盖率数据，JaCoCo在on the fly模式下，用ASM来调试代码，接收JVM Tools Interface来的事件。

JaCoCo除了on the fly模式还有offline模式。 这里就不解了。

代码覆盖率
现在我们对JaCoCo原理有了那么一点儿理解，我们现在提高代码覆盖率。

为了达到100%，我们要增加以下用例：

@Test
public void whenPalindrom_thenAccept() {
    Palindrome palindromeTester = new Palindrome();
    assertTrue(palindromeTester.isPalindrome("noon"));
}
    
@Test
public void whenNearPalindrom_thanReject(){
    Palindrome palindromeTester = new Palindrome();
    assertFalse(palindromeTester.isPalindrome("neon"));
}

我们再执行一次mvn clean install确保覆盖率达到了100%。

看行、分支、路径都完全覆盖了。

在真实的项目中覆盖率不可能做到100%，我们通常会设置一个最低的标准，达不到构建就会失败。

在pom.xml中增加 check goal

<execution>
    <id>jacoco-check</id>
    <goals>
        <goal>check</goal>
    </goals>
    <configuration>
        <rules>
            <rule>
                <element>PACKAGE</element>
                <limits>
                    <limit>
                        <counter>LINE</counter>
                        <value>COVEREDRATIO</value>
                        <minimum>0.50</minimum>
                    </limit>
                </limits>
            </rule>
        </rules>
    </configuration>
</execution>

我们设置的最低覆盖率为50%。执行

 mvn clean verify

验证是否生效。

总结

通过学习，我们学会了怎么用JaCoCo生成代码覆盖率报告。切记在项目中100%覆盖率不是必须的。

示例代码：

https://github.com/eugenp/tutorials/tree/master/testing-modules/testing-libraries