Android代码覆盖率工具使用

前言
Android 开发统计代码覆盖率,在之前的老版本中,需要借助第三方工具,在现在的新版本中,只要使用JaCoCo插件,就可以完成简单覆盖率测试。
与 Espresso 框架结合,进行覆盖率测试
Android SDK 现在已经内置了对 Emma Test Coverage框架的支持,可以在官方文档中进行查阅。 具体由 JaCoCo 工具进行覆盖率相关内容。 1.1 配置: 在 build.gradle 中将 testCoverageEnabled
设置为 true

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

注:部分资料中,可能写需要在 build.gradle 中增加如下配置 apply plugin: 'jacoco'
或者 apply plugin: 'jacoco-android'

但是在实际使用发现,这个配置项并不需要。
使用:
为了能生成代码覆盖率报告,我们需要将Android设备或者模拟器连接到计算机,因为 在生成报告前,会执行 connectedCheck
任务。 之后,我们可以执行如下的命令行

/gradlew clean assemble

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

/gradlew createDebugCoverageReport

该任务会分析 /src/main/java/
路径下的代码和 /src/androidTest/java/
目录下测试用例。
在执行这个任务之后,我们可以在模块的如下路径中找到代码覆盖率报告 /build/outputs/reports/coverage/debug/

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

这里写图片描述

除了上面提到的文件,Gradle也会在如下的路径创建 coverage.ec
文件。 /build/outputs/code-coverage/connected/
碎片化带来的问题
由于 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 }
                             }
              }

在 build.gradle 中增加如下配置

apply plugin: 'jacoco' 

此框架中需要此配置。 然后在 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
    }
}

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

之后再执行命令行

/gradlew jacocoTestReport

执行该命令行后,会执行所有的单元测试用例,然后在如下位置生成报告。 build/reports/jacoco/jacocoTestReport/html 也可以通过浏览器对覆盖率情况进行查看

这里写图片描述

同时使用两个框架进行覆盖率测试
以为两个配置并不相同,可能会相互影响,网上也有不少解决方案,但是始终都是要修改gradle文件。
如://www.greatytc.com/p/4b03123b4f81
后来经过尝试发现。按照上述1, 2步骤配置后,两个框架的测试用例覆盖率检测其实并不冲突。 也就是说在配置好后,如果需要使用Espresso进行集成测试统计覆盖率,则执行如下命令

/gradlew clean assemble
/gradlew createDebugCoverageReport

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

/gradlew clean testDebugUnitTest jacocoTestReport
/gradlew jacocoTestReport

可以分别生成覆盖率报告
与 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
//www.greatytc.com/p/4b03123b4f81

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,914评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,935评论 2 383
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,531评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,309评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,381评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,730评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,882评论 3 404
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,643评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,095评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,448评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,566评论 1 339
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,253评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,829评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,715评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,945评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,248评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,440评论 2 348

推荐阅读更多精彩内容