从精准化测试看ASM在Android中的强势插入-JaCoco初探

用户1907613

发布于 2021-09-08 12:08:20

3.1K0

发布于 2021-09-08 12:08:20

文章被收录于专栏：Android群英传

点击上方蓝字关注我，知识会给你力量

在Java技术栈上，基本上提到覆盖率，大家就会想到JaCoco「Java Code Coverage的缩写」，几乎所有的覆盖率项目，都是使用JaCoco，可想而知它的影响力有多大，我们在Android项目中，也集成了JaCoco，官网文档如下。

https://docs.gradle.org/current/userguide/jacoco_plugin.html

但是这里的JaCoco是与单元测试配合使用的，与一般的业务测试场景不太一样，所以，我们需要自己依赖JaCoco来做改造。

初探

官网镇楼

https://www.eclemma.org/jacoco/

从官网上就能看出这是一个极具历史感的项目。最后生成的覆盖率文件，是在源代码的基础上，用颜色标记不同的执行状态。

image-20210716171811946

在上面这张图中，绿色代表已执行, 红色代表未执行, 黄色代表执行了一部分，这样就可以算出代码的覆盖率数据。

使用全量报表

JaCoco默认的插桩方式是全部插桩，在Android项目中，要使用JaCoco的全量报表功能非常简单，因为JaCoco插件已经集成在Gradle中了，所以我们只需要开启JaCoco即可。

首先，在根目录gradle文件中加入JaCoco的依赖

classpath "org.jacoco:org.jacoco.core:0.8.4"

然后在App的gradle文件中增加插件的依赖。

apply plugin: 'jacoco'

并在android标签中，增加开关。

testCoverageEnabled = true

接下来引入JaCoco的Report模块，同时exclude掉core，因为其在gradle中已经有依赖了。

implementation('org.jacoco:org.jacoco.report:0.8.4') {
    exclude group: 'org.jacoco', module: 'org.jacoco.core'
}

创建生成Report的Task

def coverageSourceDirs = ['../xxxx/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.setFrom(fileTree(
                dir: './build/intermediates/javac/xxxxx', 
                excludes: ['**/R*.class']))
        sourceDirectories.setFrom(files(coverageSourceDirs))
        executionData.setFrom(files("$buildDir/outputs/code-coverage/connected/coverage.exec"))
        doFirst {new File("$buildDir/intermediates/javac/masterDebug/classes/com/qidian/QDReader").eachFileRecurse { file ->
                        if (file.name.contains('$$')) {
                                file.renameTo(file.path.replace('$$', '$'))
                        }
                }
        }
}

在项目中合适的地方来调用这两个方法，分别用来创建JaCoco的Exec文件和写入Exec文件。

private void createExecFile() {
    String DEFAULT_COVERAGE_FILE_PATH = "/mnt/sdcard/" + getPackageName();
    String DEFAULT_COVERAGE_FILE = DEFAULT_COVERAGE_FILE_PATH + "/coverage.ec";
    File file_path = new File(DEFAULT_COVERAGE_FILE_PATH);
    File file = new File(DEFAULT_COVERAGE_FILE);
    Log.d(TAG, "file_path = " + file_path);
    if (!file.exists()) {
        try {
            file_path.mkdirs();
            file.createNewFile();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

private void writeExecFile() {
    OutputStream out = null;
    try {
        out = new FileOutputStream("/mnt/sdcard/" + getPackageName() + "/coverage.ec", true);
        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));
    } catch (Exception e) {
        Log.d(TAG, e.toString(), e);
        e.printStackTrace();
    } finally {
        if (out != null) {
            try {
                out.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

在创建Exec文件后，进行测试，然后写入Exec文件，等测试完毕后，把生成的Exec文件通过ADB pull到本地，再执行jacocoTestReport这个Task即可生成全量的JaCoco覆盖率报告。

花了这么长时间写了这么多，其实并没什么卵用，只是让大家看下如何来使用JaCoco的标准用法。