Android jacoco实现代码覆盖率测试

作者: 惟吾德馨_慧 | 来源:发表于2019-07-15 19:46 被阅读0次

一、前言

代码覆盖率的检测可以在程序中快速找出没有测试到的地方，从而提高测试效率、提高产品质量。
JaCoCo是一个开源的覆盖率工具(官网地址：http://www.eclemma.org/JaCoCo/)，它针对的开发语言是java，其使用方法很灵活，可以嵌入到Ant、Maven中；可以作为Eclipse插件，可以使用其JavaAgent技术监控Java程序等等。
很多第三方的工具提供了对JaCoCo的集成，如sonar、Jenkins等。
JaCoCo包含了多种尺度的覆盖率计数器,包含指令级覆盖(Instructions,C0coverage)，分支（Branches,C1coverage）、圈复杂度(CyclomaticComplexity)、行覆盖(Lines)、方法覆盖(non-abstract methods)、类覆盖(classes)。
参考文章：jacoco 原理篇

二、Android studio集成jacoco

1.配置build.gradle

apply plugin: 'com.android.application'
apply plugin: 'jacoco' //加载代码覆盖库jacoco

jacoco {
    toolVersion = "0.7.9" //代码覆盖库jacoco版本号
}

android {
    compileSdkVersion 25
    buildToolsVersion "25.0.3"
    defaultConfig {
        applicationId "com.whh.initmvp"
        minSdkVersion 15
        targetSdkVersion 25
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            testCoverageEnabled = true //实现代码覆盖率
            minifyEnabled false //获取代码覆盖率需要设为false （**如果混肴文件配置完毕，设为true也可**）
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
        debug {
            testCoverageEnabled = true //实现代码覆盖率
            minifyEnabled false //获取代码覆盖率需要设为false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(include: ['*.jar'], dir: 'libs')
    testCompile 'junit:junit:4.12'

   //.....(此处忽略若干依赖库)

    //代码覆盖率jacoco(可不引入)
//    compile 'org.jacoco:org.jacoco.core:0.7.9'

}

//代码覆盖率相关配置 start
def coverageSourceDirs = [
        '../app/src/main/java'
]

task jacocoTestReport(type: JacocoReport) {
    group = "Reporting"
    description = "Generate Jacoco coverage reports after running tests."

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

    classDirectories = fileTree(
            //检测覆盖率的class所在目录(以项目class所在目录为准)
            dir: './build/intermediates/classes/debug', //gradle2.3 class所在目录
            //gradle3.2 class所在目录 dir: './build/intermediates/javac/debug/compileDebugJavaWithJavac/classes',
            //增加以上目录中不需要检测的文件列表
            excludes: ['**/R*.class',
                       '**/*$InjectAdapter.class',
                       '**/*$ModuleAdapter.class',
                       '**/*$ViewInjector*.class'
            ]
    )

    sourceDirectories = files(coverageSourceDirs) //设置需要检测覆盖率的目录
    executionData = files("$buildDir/outputs/code-coverage/connected/initmvp_coverage.ec") //存储APP运行时产生报告的路径
}
//代码覆盖率相关配置 end

需要注意：
1.1.compile 'org.jacoco:org.jacoco.core:0.7.9' 库包可不添加依赖；
1.2.classDirectories的设置应以项目编译后生成的class文件目录为准，比如：
gradle2.3 class所在目录：dir: './build/intermediates/classes/debug',
gradle3.2 class所在目录： dir: './build/intermediates/javac/debug/compileDebugJavaWithJavac/classes'
1.3.executionData的设置，自定义生成的报告的路径及报告名称，既然设定，在指定目录下需要有这样的文件，文件夹及文件名称都要一一对应，不可粗心输错；
1.4.注意以上注释的位置，每一个配置务必加上以保证检测代码覆盖率的实现；

2.运行APP时生成报告文件，写入数据保存在本地，因此需要加上文件读写权限，在Android 6.0需要在activity增加权限询问

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

3.为随时检测代码的覆盖率并写成报告，在BaseActivity中添加代码

//生成报告的所在SDcard目录
public static String DEFAULT_COVERAGE_FILE_PATH = Environment.getExternalStorageDirectory()+"/";

 @Override
    protected void onDestroy() {
        super.onDestroy();
        generateCoverageFile();
        Log.i(TAG, "lifecycle---" + TAG + " onDestroy");

    }

    /**
     * 生成executionData
     */
    public void generateCoverageFile() {

        OutputStream out = null;

        try {
            out = new FileOutputStream(DEFAULT_COVERAGE_FILE_PATH + "/initmvp_coverage.ec", false); //在SDcard根目录下生产检测报告，文件名自定义
            Object agent = Class.forName("org.jacoco.agent.rt.RT").getMethod("getAgent").invoke(null);
            // 这里之下就统计不到了
            out.write((byte[]) agent.getClass().getMethod("getExecutionData", boolean.class).invoke(agent, false));

            Log.i("whh", "BaseActivity.java BaseActivity generateCoverageFile write success");
        } catch (Exception e) {
            Log.i("whh", "BaseActivity.java BaseActivity generateCoverageFile Exception:" + e.toString());

        } finally {
            if (out != null) {
                try {
                    out.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

4.配置好build.gradle后，build项目，在Gradle窗口会出现几个工具项：

工具项

双击installDebug：build项目，并安装debug版本的APK到Android设备；
jacocoTestReport：APK在Android设备中运行，并生成initmvp_coverage.ec文件，将initmvp_coverage.ec文件导出到电脑硬盘，比如：D盘下的new文件夹

adb pull /sdcard/initmvp_coverage.ec D:\new

复制到项目的app/build/outputs/code-coverage/connected/目录下（创建目录方法：在Gradle窗口视图下，app->Tasks->verification->createDebugCoverageReport，双击createDebugCoverageReport，即可创建；也可手动创建，目录必须保证一致）
双击jacocoTestReport，在app\build\目录下生成reports文件夹