我們都知道 Spock 是一個(gè)單測框架，其特點(diǎn)是語法簡明。但當(dāng)我們使用 Spock 寫了一堆單元測試之后，如何生成對(duì)應(yīng)的單測覆蓋率報(bào)告呢？一般來說，我們會(huì)使用兩個(gè)插件來一起完成單測覆蓋率報(bào)告的生成，分別是：
- Maven Surefire Plugin
- JaCoCo Plugin
其中 Maven Surefire Plugin 是用來在 Maven 的編譯階段運(yùn)行單測代碼，而 JaCoCo 則是用來生成具體的單測覆蓋率報(bào)告。本文將新建一個(gè)非 Web 項(xiàng)目來演示如何生成 Spock 的單測覆蓋率報(bào)告。
初始化項(xiàng)目
這里初始化項(xiàng)目一個(gè)普通的 Java 項(xiàng)目，并引入對(duì)應(yīng)的 Spock 依賴，如下代碼所示：
<!-- spock 依賴-->
<dependency>
<groupId>org.spockframework</groupId>
<artifactId>spock-core</artifactId>
<version>2.0-M2-groovy-3.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.6.2</version>
<scope>test</scope>
</dependency>
接著寫一個(gè)計(jì)算器類，用于演示單測覆蓋率，如下代碼所示：
package tech.shuyi;
public class AdvancedCalculator {
Integer add(int a, int b) {
return a + b;
}
Integer subtract(int a, int b) {
return a - b;
}
Integer multi(int a, int b) {
return a * b;
}
Integer divide(int a, int b) {
return a / b;
}
}
接著在 test.groovy.tech.shuyi 目錄寫一個(gè) Groovy 單測，如下代碼所示：
package tech.shuyi
import spock.lang.Specification
class AdvancedCalculatorTest extends Specification {
def calendar = new AdvancedCalculator()
def "Add"() {
expect: calendar.add(1, 2) == 3
}
def "Substract"() {
expect: calendar.subtract(2, 1) == 1
}
def "Multi"() {
expect: calendar.multi(2, 3) == 6
}
def "Divide"() {
expect: calendar.divide(16, 4) == 4
}
}
接著我們嘗試運(yùn)行一下單測文件，如無異常應(yīng)該是成功的。
引入插件
在這里，我們要引入對(duì)應(yīng)的兩個(gè)插件，并做一些簡單地配置。
首先，在 pom.xml 文件引入 Surefire 插件配置，如下代碼所示：
<!-- surefire plugin with spock and junit -->
<plugin>
<groupId>org.codehaus.gmavenplus</groupId>
<artifactId>gmavenplus-plugin</artifactId>
<version>1.9.0</version>
<executions>
<execution>
<goals>
<goal>compileTests</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M7</version>
<configuration>
<!-- 配置單測失敗幾次后停止執(zhí)行 -->
<skipAfterFailureCount>0</skipAfterFailureCount>
<!-- 不允許跳過單測 -->
<skipTests>false</skipTests>
</configuration>
</plugin>
接著引入 JaCoCo Plugin 的配置，如下代碼所示：
<!-- JaCoCo plugin -->
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.7</version>
<configuration>
<includes>
<include>tech/**/*</include>
</includes>
</configuration>
<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>
生成報(bào)告
做好上述報(bào)告后，直接執(zhí)行 mvn test? 就可以生成單測覆蓋率報(bào)告了。如果沒有什么異常的話，程序會(huì)生成單測覆蓋率報(bào)告文件，地址為：target/site/jacoco/index.html。
我們使用瀏覽器打開該文件可以瀏覽到單測覆蓋率情況，如下圖所示：
單測覆蓋率報(bào)告
疑問
關(guān)于如何配置這兩個(gè)插件的資料很多，但都運(yùn)行不起來。后面我參考了官網(wǎng)的配置，就成功配置好了。
- Surefire Plugin 官網(wǎng)文檔：Maven Surefire Plugin – Introduction
- JaCoCo Plugin 官網(wǎng)文檔：JaCoCo - Maven Plug-in
但對(duì)于這兩個(gè)插件，我還是有一定疑問的，例如：
- 這兩個(gè)插件到底都是啥作用？
- 是否一定要搭配一起使用？
通過 Surefire 插件官網(wǎng)，我們可以大概知道其作用為：在編譯的 test 階段，用于執(zhí)行程序的單元測試，最終生成 txt? 和 xml? 格式的報(bào)告，存放地址為 ${basedir}/target/surefire-reports/TEST-*.xml。
由此可見，Surefire 的主要作用還是用于執(zhí)行程序的單測程序，而不是生成報(bào)告。當(dāng)然，官網(wǎng)文檔也說了，你可以使用 Maven Surefire Report Plugin 來生成 HTML 格式的報(bào)告。我根據(jù)這個(gè)文檔（Maven Surefire Report Plugin – Usage）配置了一下 surefire-report 插件，成功地生成 HTML 格式的報(bào)告，如下圖所示。
surefire-report 插件生成的 HTML 報(bào)告
可以看到 surefire-report 插件生成的 HTML 報(bào)告還是比較簡陋的，跟 JaCoCo 插件生成的相比，顯然后者更加可視化一些。
看到這里，我相信大家應(yīng)該能弄明白前面兩個(gè)問題了：
- 這兩個(gè)插件到底都是啥作用？
- 是否一定要搭配一起使用？
簡單地說，Surefire 插件主要是運(yùn)行單測，生成單測數(shù)據(jù)。對(duì)于 JaCoCo 插件而言，其作用是基于 Surefire 插件去生成可視化的報(bào)告。JaCoCo 插件需要基于 Surefire 插件使用，如果去掉 Surefire 插件，JaCoCo 就生成不了報(bào)告了。
