（4.5.6）Android 代码覆盖率工具使用

前言

Android 开发统计代码覆盖率，在之前的老版本中，需要借助第三方工具，在现在的新版本中，只要使用JaCoCo插件，就可以完成简单覆盖率测试。

与 Espresso 框架结合，进行覆盖率测试

Android SDK 现在已经内置了对 Emma Test Coverage框架的支持，可以在官方文档中进行查阅。 

具体由 JaCoCo 工具进行覆盖率相关内容。 

1.1 配置： 

在 build.gradle 中将 

testCoverageEnabled

 设置为 

true

android {
buildTypes {
debug {
testCoverageEnabled = true
}
}
}

1
2
3
4
5
6
7
1
2
3
4
5
6
7

注：部分资料中，可能写需要在 build.gradle 中增加如下配置 

apply plugin: 'jacoco'

 或者 

apply plugin: 'jacoco-android'

但是在实际使用发现，这个配置项并不需要。

使用：

为了能生成代码覆盖率报告，我们需要将Android设备或者模拟器连接到计算机，因为 在生成报告前，会执行 

connectedCheck

 任务。 

之后，我们可以执行如下的命令行

./gradlew clean assemble

1
1

此命令会清空所有的编译产生class，防止之前的测试对后续造成影响。

./gradlew createDebugCoverageReport

1
1

该任务会分析 

/src/main/Java/

 路径下的代码和 

/src/androidTest/java/

 目录下测试用例。

在执行这个任务之后，我们可以在模块的如下路径中找到代码覆盖率报告 

/build/outputs/reports/coverage/debug/

我们可以在浏览器中打开 index.html 文件，可以看见可视化的报告。 同时，在同一级目录下，我们也可以找到可以供持续集成覆盖率分析使用的 report.xml 文件。



除了上面提到的文件，Gradle也会在如下的路径创建 

coverage.ec

 文件。 

/build/outputs/code-coverage/connected/

Java Counters

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



 
如上图所示，标示绿色的为分支覆盖充分，标黄色的为部分分支覆盖，标红色的为未执行该分支。

碎片化带来的问题

由于 Espresso 需要在真机或者虚拟机上运行，由于android碎片化严重，经常出现各种问题。现进行一个问题与解决方案的汇总。

小米的问题

问题现象：小米手机异常：com.android.ddmlib.InstallException: Failed to establish session
解决方案：在开发者选项中，关闭 MIUI 优化选项。 
http://en.miui.com/thread-255506-1-1.html

与 Robolectric 框架结合，进行覆盖率测试

谷歌对 

Robolectric

 框架支持力度一般，所以发现 JaCoCo 工具在使用此框架时候，需要进行的配置较多。

配置

在 build.gradle 中将 

testCoverageEnabled

 设置为 

true

android {
buildTypes {
debug {
testCoverageEnabled = true
}
}
}

1
2
3
4
5
6
7
1
2
3
4
5
6
7

在 build.gradle 中增加如下配置

apply plugin: 'jacoco'

1
1

此框架中需要此配置。 

然后在 gradle 文件中插入如下的配置，对JaCoCo进行设置

jacoco {
toolVersion = "0.7.1.201405082137"   //版本号可用最新
}

def coverageSourceDirs = [
'../app/src/main/java'
]

task jacocoTestReport(type:JacocoReport, dependsOn: "testDebugUnitTest") {
group = "Reporting"

description = "Generate Jacoco coverage reports"

classDirectories = fileTree(
dir: '../app/build/intermediates/classes/debug',
excludes: ['**/R.class',
'**/R$*.class',
'**/*$ViewInjector*.*',
'**/BuildConfig.*',
'**/Manifest*.*']          // 去掉不进行检查的文件
)

additionalSourceDirs = files(coverageSourceDirs)
sourceDirectories = files(coverageSourceDirs)
executionData = files('../app/build/jacoco/testDebugUnitTest.exec')

reports {
xml.enabled = true
html.enabled = true
}
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

task jacocoTestReport(type:JacocoReport, dependsOn: "testDebugUnitTest")

这行的配置，中间的

dependsOn

一定要设置成
testDebugUnitTest 后续才可以正确执行覆盖率测试。

https://github.com/kvandermast/my-robolectric-app

在这个例子中，此配置成了 

testDebug

，实际测试发现会报错 

Task 'jacocoTestReport' not found in root project '<project name>'.

使用

先执行如下的命令行，清除之前的残留配置。

./gradlew clean testDebugUnitTest jacocoTestReport

1
1

之后再执行命令行

./gradlew jacocoTestReport

1
1

执行该命令行后，会执行所有的单元测试用例，然后在如下位置生成报告。 

build/reports/jacoco/jacocoTestReport/html 

也可以通过浏览器对覆盖率情况进行查看

同时使用两个框架进行覆盖率测试

以为两个配置并不相同，可能会相互影响，网上也有不少解决方案，但是始终都是要修改gradle文件。

如：http://www.jianshu.com/p/4b03123b4f81

后来经过尝试发现。按照上述1， 2步骤配置后，两个框架的测试用例覆盖率检测其实并不冲突。 

也就是说在配置好后，如果需要使用Espresso进行集成测试统计覆盖率，则执行如下命令

./gradlew clean assemble
./gradlew createDebugCoverageReport

1
2
1
2

如果需要使用Robolectric执行单元测试统计覆盖率，则执行如下命令

./gradlew clean testDebugUnitTest jacocoTestReport
./gradlew jacocoTestReport

1
2
1
2

可以分别生成覆盖率报告

与 Jenkins CI 的结合

为了能在 Jenkins CI 上发布报告，可以使用代码覆盖率插件，但是并不能确认插件的稳定性。另一种解决方案是 HTML Publisher plugin，我们可以增加相应动作，在 Jenkins 的任务中，通过默认的HTML界面产生覆盖率报告，我认为这是一种非常方便的方式，易于创建，并且方便进行代码导航，能定位到没有覆盖的代码行，方法和分支。

参考文档

http://blog.wittchen.biz.pl/test-coverage-report-for-android-application/ 已翻译，中文链接如下：
https://github.com/weijianfeng/Translation-Project/blob/master/Project/1/Test%20coverage%20report%20for%20Android%20application.md
https://github.com/kvandermast/my-robolectric-app
https://github.com/aresLove/android-tech-frontier/tree/master/issue-7/%E4%BD%BF%E7%94%A8Robolectric%E5%92%8CAndroid%E7%94%9F%E6%88%90%E4%BB%A3%E7%A0%81%E8%A6%86%E7%9B%96%E7%8E%87%E6%8A%A5%E5%91%8A
http://www.jianshu.com/p/4b03123b4f81