51Testing软件测试论坛
标题:
大神带你如何获得代码覆盖率(上)
[打印本页]
作者:
lsekfe
时间:
2023-1-30 09:59
标题:
大神带你如何获得代码覆盖率(上)
代码覆盖率
代码覆盖率是
软件测试
中一个重要的评价指标,主要是指程序运行过程中,被执行到的代码在总代码中的占比程度。
现在有很多插件可以实现这个功能,应用比较广的就是JaCoCo,虽然好久没更新了,类似Jetbrain旗下的IDE。默认提供了三种获得代码覆盖率的方式:Intellij IDEA、JaCoCo、Emma。
功能测试
代码覆盖率
常规的代码覆盖率通常是在
单元测试
中,通过编写
测试用例
,然后执行对应的单元测试,获得代码覆盖率。当然,现在也有挺多自动化生成单元测试的工具,比如EvoSuite,Randoop等。
但是,对于用户交互性比较强的应用,比如
Android
应用,这种单纯的单元测试显然是满足不了需要的。功能测试就是在真实的使用环境下,人工或者模拟真人对应用进行测试,在这种场景下,生成的代码覆盖率定义其为功能覆盖率。
JaCoCo与Gradle获取功能测试代码覆盖率
常见获取覆盖率的方法分两种,一种是在源码中,以打桩的形式,收集覆盖率数据,针对性较强,但是需要深入源码,另一种是改写应用入口,通过instrument启动应用,
记录
应用执行期间全局的代码覆盖率。这里,主要针对第二种,主要内容分为两个主要部分:
覆盖率数据获取
覆盖率数据解析
具体实现
入口文件改写
这里需要添加一个新的入口,接收instrument指令,启动代码覆盖率记录功能,并启动原始应用的入口Activity。涉及的一些代码,网上到处都是,我找了一些改写了一下,除去了一些冗余的代码,也去掉了一些bug。
这里主要包括2个java文件,为了方便管理,我们就单独创建一个package、test,避免和原始代码混淆。
一个Instrument启动器,目的是方便通过instrument指令启动带有coverage记录功能的activity。
package test;
import android.app.Instrumentation;
import android.content.Intent;
import android.os.Bundle;
import android.util.Log;
import java.io.File;
import java.io.IOException;
public class JacocoInstrumentation extends Instrumentation {
public static String TAG = "JacocoInstrumentation:";
private Intent mIntent;
@Override
public void onCreate(Bundle bundle) {
Log.d(TAG, "onCreate(" + bundle + ")");
super.onCreate(bundle);
String DEFAULT_COVERAGE_FILE_PATH = getContext().getFilesDir().getPath() + "/coverage.ec";
File file = new File(DEFAULT_COVERAGE_FILE_PATH);
if (!file.exists()) {
try {
file.createNewFile();
} catch (IOException e) {
Log.d(TAG, "异常 : " + e);
e.printStackTrace();
}
}
mIntent = new Intent(getTargetContext(), InstrumentedActivity.class);
mIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
start();//调用onStart
}
@Override
public void onStart() {
Log.d(TAG, "onStart()");
super.onStart();
startActivitySync(mIntent);
}
//adb shell am instrument com.tachibana.downloader/test.JacocoInstrumentation
}
复制代码
这个文件的主要功能有两点:
在/data/data/应用包名/files目录下创建coverage.ec,这个文件就是用来记录覆盖率数据的;
启动改写的Activity,这里是InstrumentedActivity。
为了不影响原始代码,创建一个原入口类的子类,实现记录覆盖率数据的功能,在实现目的的情况下,尽可能减少对原始代码的影响。
package test;
import android.util.Log;
import com.tachibana.downloader.ui.main.MainActivity;
import java.io.FileOutputStream;
import java.io.OutputStream;
public class InstrumentedActivity extends MainActivity {
public static String TAG = "InstrumentedActivity";
@Override
public void onDestroy() {
super.onDestroy();
Log.d(TAG, "onDestroy()");
generateCoverageReport();
}
private void generateCoverageReport() {
String DEFAULT_COVERAGE_FILE_PATH = getFilesDir().getPath() + "/coverage.ec";
Log.d(TAG, "generateCoverageReport():" + DEFAULT_COVERAGE_FILE_PATH);
try {
OutputStream out = new FileOutputStream(DEFAULT_COVERAGE_FILE_PATH, false);
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));
out.close();
} catch (Exception e) {
Log.d(TAG, e.toString(), e);
}
}
}
复制代码
如代码里展示的,我这里原始的入口类是com.tachibana.downloader.ui.main.MainActivity,我们继承这个Activity,并实现了一个generateCoverageReport方法,用来记录JaCoCo的数据,在这个Activity退出的时候,调用方法记录,实现覆盖率数据获取的功能。
这个函数也是从网上找的,从字面上来看,逻辑就是每次这个Activity的生命周期执行到onDestroy的时候,就记录一次数据,并且是覆盖式的记录。(对于覆盖式的记录,我是有点困惑的,这些数据是从应用启动就被一直存在内存,增量式增加还是记录在日志,每次调用这个方法的时候,jacoco去日志里面解析暂且认为这种方式没有问题吧,毕竟网上都是这么做的)。
这个Activity的作用也是2个:
记录ExecutionData,也就是覆盖率的原始数据;
Fake入口,继承了原始的入口Activity,在实现原始功能的同时,不影响原来代码。
AndroidManifest.xml改写
配置文件的改写主要分为3个部分:
增加权限,既然读写文件了,那读写文件的权限肯定是要有的:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
复制代码
Activity索引,我们新建了一个Fake入口,需要将这个Activity加入配置文件中,就加在<application>标签下,和其他的Activity一样。
<activity
android:name="test.InstrumentedActivity"
android:label="InstrumentationActivity" />
复制代码
配置Instrument,<instrumentation>标签与<application>标签同级,配置了才能通过adb指令执行到,需要自定义的属性有两个。name,就是上面写的那个,targetPackage,就是应用的包名,配置在AndroidManifest.xml里的那个。
<instrumentation
android:name="test.JacocoInstrumentation"
android:handleProfiling="true"
android:label="CoverageInstrumentation"
android:targetPackage="com.tachibana.downloader" />
复制代码
build.gradle改写
这里的配置主要针对JaCoCo,在应用构建过程,生成JaCoCo必须的一些数据,以及获取ec文件后的转义处理。
apply plugin: 'com.android.application'
apply plugin: 'jacoco'//引用插件
jacoco {//插件版本设置
toolVersion = "0.8.5"
}
android {
compileSdkVersion 30
buildToolsVersion "30.0.1"
defaultConfig {
applicationId "com.morn.aaa"
minSdkVersion 23
targetSdkVersion 30
versionCode 1
versionName "1.0"
testInstrumentationRunnerArguments clearPackageData: 'true'//instrument设置
}
buildTypes {
debug {
testCoverageEnabled = true//JaCoCo功能启动
}
}
}
//ec文件解析函数
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
csv.enable = true
}
classDirectories.from = fileTree(
dir: './build/intermediates/javac/debug',
excludes: ['**/R*.class',
'**/*$InjectAdapter.class',
'**/*$ModuleAdapter.class',
'**/*$ViewInjector*.class'
])
sourceDirectories.from = files(coverageSourceDirs)
executionData.from = files("$buildDir/outputs/code-coverage/connected/coverage.ec")
doFirst {
new File("$buildDir/intermediates/javac/").eachFileRecurse { file ->
if (file.name.contains('
这是app/build.gradle的一个例子,关键部分我都加了注释。
得到ec文件之后,需要将Android设备下的ec文件,放置到$buildDir/outputs/code-coverage/connected/coverage.ec然后运行jacocoTestReport这个task,运行成功后会在$buildDir/reports/jacoco目录下生成根据eoverage.ec转义的html等文件,html目录下的index.html可以可视化展示代码覆盖率数据。
[align=center][color=rgb(68, 68, 68)][url=http://www.51testing.com/batch.download.php?aid=143392][img]http://www.51testing.com/attachments/2023/01/15326825_2023012915333113zA0.png[/img][/url][/color][/align]
[/size][/font]
)) {
file.renameTo(file.path.replace('
这是app/build.gradle的一个例子,关键部分我都加了注释。
得到ec文件之后,需要将Android设备下的ec文件,放置到$buildDir/outputs/code-coverage/connected/coverage.ec然后运行jacocoTestReport这个task,运行成功后会在$buildDir/reports/jacoco目录下生成根据eoverage.ec转义的html等文件,html目录下的index.html可以可视化展示代码覆盖率数据。
[align=center][color=rgb(68, 68, 68)][url=http://www.51testing.com/batch.download.php?aid=143392][img]http://www.51testing.com/attachments/2023/01/15326825_2023012915333113zA0.png[/img][/url][/color][/align]
[/size][/font]
, '
这是app/build.gradle的一个例子,关键部分我都加了注释。
得到ec文件之后,需要将Android设备下的ec文件,放置到$buildDir/outputs/code-coverage/connected/coverage.ec然后运行jacocoTestReport这个task,运行成功后会在$buildDir/reports/jacoco目录下生成根据eoverage.ec转义的html等文件,html目录下的index.html可以可视化展示代码覆盖率数据。
[align=center][color=rgb(68, 68, 68)][url=http://www.51testing.com/batch.download.php?aid=143392][img]http://www.51testing.com/attachments/2023/01/15326825_2023012915333113zA0.png[/img][/url][/color][/align]
[/size][/font]
))
}
}
}
}
dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
}
复制代码
这是app/build.gradle的一个例子,关键部分我都加了注释。
得到ec文件之后,需要将Android设备下的ec文件,放置到$buildDir/outputs/code-coverage/connected/coverage.ec然后运行jacocoTestReport这个task,运行成功后会在$buildDir/reports/jacoco目录下生成根据eoverage.ec转义的html等文件,html目录下的index.html可以可视化展示代码覆盖率数据。
作者:
oliver.tang
时间:
2023-2-28 10:18
学习学习
欢迎光临 51Testing软件测试论坛 (http://bbs.51testing.com/)
Powered by Discuz! X3.2