前言
在博客Android 单元测试之PowerMockito,主要介绍PowerMockito的使用和对Java测试用例的强大支持。但对于Android app开发来说,写起单元测试很痛苦:一方面单元测试需要运行在模拟器上或者真机上,不仅麻烦而且缓慢;另一方面,一些依赖Android SDK的对象(如Activity,Button等)的测试非常头疼。Robolectric可以解决此类问题,它的设计思路便是通过实现一套JVM能运行的Android代码,从而做到脱离Android环境进行测试。本文将结合项目对Robolectric做一个简单介绍,并列举在实践踩的各种坑。
Robolectric简介
我们可以使用Android提供的Instrumentation系统如ActivityUnitTestCase、ActivityInstrumentationTestCase2,将单元测试代码运行在模拟器或者是真机上。虽然这种方式可以work,但是速度非常慢,因为每次运行一次单元测试,都需要将整个项目打包成apk,上传到模拟器或真机上,就跟运行了一次app似得,这个显然不是单元测试该有的速度。此外,Google开源的测试框架如UIAutomator和Espresso也是基于Instrumentation的,更偏向于UI方面的自测化测试,要是应用在单元测试上速度也是不敢恭维的。
对了,说一句题外话,感兴趣的同学可以看一下ActivityUnitTestCase和ActivityInstrumentationTestCase2的源码,你会惊奇地发现,它们的实现方式还是有所区别,虽然都是依赖Instrumentation把Activity加载起来,运行在同一个进程中,但ActivityUnitTestCase是运行在UI主线程中的,而ActivityInstrumentationTestCase2是运行在子线程中的,所以在实际的使用中还是有区别的,ActivityUnitTestCase可以直接操控UI,而ActivityInstrumentationTestCase2则是不行,需要借助于runOnUiThread()方法来更新UI,否则会抛异常。
言归正传吧,我们还是接着说Robolectric。Robolectric通过实现一套JVM能运行的Android代码,然后在unit test运行的时候去截取android相关的代码调用,然后转到自己实现的代码去执行这个调用的过程。举个例子说明一下,比如Android里面有个类叫Button,Robolectric则实现了一个叫ShadowButton类。这个类基本上实现了Button的所有公共接口。假设你在unit test里面写到String text = button.getText().toString();
,在这个unit test运行时,Robolectric会自动判断你调用了Android相关的代码button.getText(),在底层截取这个调用过程,转到ShadowButton的getText方法来执行。而ShadowButton是真正实现了getText这个方法的,所以这个过程便可以正常执行。
除了实现Android里面的类的现有接口,Robolectric还做了另外一件事情,极大地方便了unit testing的工作。那就是他们给每个Shadow类额外增加了很多接口,方便我们读取对应Android类的一些状态。比如ImageView有一个方法叫setImageResource(resourceId)
,然而并没有一个对应的getter方法叫getImageResourceId(),这样你是没有办法测试这个ImageView是不是显示了你想要的image。而在Robolectric实现的ShadowImageView里面,则提供了getImageResourceId()这个接口,你可以用来测试它是否正确的显示了你想要的image。
Robolectric入门
build.gradle配置:
dependencies {
testCompile "org.robolectric:robolectric:3.3.2"
}
注解配置:
@RunWith(RobolectricTestRunner.class)
@Config(constants = BuildConfig.class, sdk = 23)
public class ExampleRobolectricTestCase {
......
}
说明:上面配置的是RobolectricTestRunner,而不是RobolectricGradleTestRunner,在Robolectric之前的版本是有这个RobolectricGradleTestRunner,但在最新的版本上却没有了,也不知道是为什么。但是有一点,使用最新版本后,倒是没有出现找不到资源文件res的警告。最新的Robolectric最高可支持Android API 23。
Android Studio环境配置:
- 在Build Variants面板中,将Test Artifact切换成Unit Tests模式,不过在新版本的Android Studio已经不需要做这项配置,如下图:
- Working directory设置
如果在运行测试方法过程中遇见如下异常:
或者如下警告:java.io.FileNotFoundException: build\intermediates\bundles\debug\AndroidManifest.xml ......
解决的方式就是将Working directory的值设置为$MODULE_DIR$。No such manifest file: build/intermediates/bundles/debug/AndroidManifest.xml ......
第一步设置如下:
第二步设置如下:
设置完毕后,再次run就可以了。
Robolectric实战
首先在build.gradle中的完整配置如下:
testCompile "junit:junit:4.12"
testCompile "org.assertj:assertj-core:1.7.0"
testCompile "org.robolectric:robolectric:3.3.2"
// PowerMock brings in the mockito dependency
testCompile 'org.powermock:powermock-module-junit4:1.6.5'
testCompile 'org.powermock:powermock-module-junit4-rule:1.6.5'
testCompile 'org.powermock:powermock-api-mockito:1.6.5'
testCompile 'org.powermock:powermock-classloading-xstream:1.6.5'
从配置中,可以看出在实际运用中,我们是使用JUnit4+Mockito+PowerMockito+Robolectric,这是一个牛逼的组合,在写单元测试用例时简直溜得飞起,通过PowerMockito弥补Mockito测试框架不能mock静态方法、final方法和private方法的不足,还可以在JVM中就可以很方便的调用Android相关的类和方法,速度也比较快。
然后定义抽象类BaseRobolectricTestCase:
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {ShadowLog.class}, constants = BuildConfig.class, sdk = 23)
@PowerMockIgnore({"org.mockito.*", "org.robolectric.*", "android.*", "org.json.*", "sun.security.*", "javax.net.*"})
public abstract class BaseRobolectricTestCase {
@Rule
public PowerMockRule rule = new PowerMockRule();
private static boolean hasInited = false;
@Before
public void setUp() {
ShadowLog.stream = System.out;
if (!hasInited) {
initRxJava();
hasInited = true;
}
MockitoAnnotations.initMocks(this);
}
public Application getApplication() {
return RuntimeEnvironment.application;
}
public Context getContext() {
return RuntimeEnvironment.application;
}
private void initRxJava() {
RxJavaPlugins.getInstance().registerSchedulersHook(new RxJavaSchedulersHook() {
@Override
public Scheduler getIOScheduler() {
return Schedulers.immediate();
}
});
RxAndroidPlugins.getInstance().registerSchedulersHook(new RxAndroidSchedulersHook() {
@Override
public Scheduler getMainThreadScheduler() {
return Schedulers.immediate();
}
});
}
}
这个抽象类代码比较多,主要是设置Robolectric单元测试的运行环境,方便在单元测试用例代码中进行复用。具体分下一下:
@RunWith(RobolectricTestRunner.class)
通过注解定义Robolectric运行的TestRunner;@Config(shadows = {ShadowLog.class}, constants = BuildConfig.class, sdk = 23)
通过配置shadows = {ShadowLog.class}
和ShadowLog.stream = System.out;
来设置Android log输出方式,使得单元测试运行时在控制台中可以看到Android代码中打印出的log日志;@PowerMockIgnore({"org.mockito.*", "org.robolectric.*", "android.*", "org.json.*", "sun.security.*", "javax.net.*"})
通过PowerMockIgnore注解定义所忽略的package路劲,防止所定义的package路径下的class类被PowerMockito测试框架mock;- 在setUp()方法中调用
MockitoAnnotations.initMocks(this);
初始化PowerMockito注解,为@PrepareForTest(YourStaticClass.class)注解提供支持; - 在代码中,我们可以看到定义了两个基本方法getApplication()和getContext(),在写测试代码中使用起来很方便,就像在Activity一样,增加测试的可读性;
- 如果项目中使用了rxjava框架,在对rxjava相关的代码进行单元测试时,通过initRxJava()方法将异步处理转化为同步处理,如此一来方便单元测试验证;
最后编写Activity测试用例代码:
public class ComplaintActivityTest extends BaseRobolectricTestCase {
@Test
@PrepareForTest({AppUtil.class, OAuthManager.class, NetUtil.class})
public void jumpCompensate() throws Exception {
PowerMockito.mockStatic(AppUtil.class);
PowerMockito.when(AppUtil.getVersionName()).thenReturn("1.4.0");
PowerMockito.mockStatic(OAuthManager.class);
OAuthManager mockOAuth = PowerMockito.mock(OAuthManager.class);
PowerMockito.when(OAuthManager.getInstance()).thenReturn(mockOAuth);
PowerMockito.when(mockOAuth.getSargerasToken()).thenReturn("c97faa92-34ea-4248-a19e-9a9fb848b29b");
AppApplication.mInstance = getApplication();
PowerMockito.mockStatic(NetUtil.class);
PowerMockito.when(NetUtil.isNetworkConnected(AppApplication.getInstance())).thenReturn(true);
PreferenceUtil.init();
PersistentPreferenceUtil.init();
ComplaintActivity complaintActivity = Robolectric.buildActivity(ComplaintActivity.class).create().get();
assertNotNull(complaintActivity);
complaintActivity.jumpCompensate();
Intent expectedIntent = new Intent(complaintActivity, HelpActivity.class);
ShadowActivity shadowActivity = Shadows.shadowOf(complaintActivity);
Intent actualIntent = shadowActivity.getNextStartedActivity();
Assert.assertEquals(expectedIntent.getComponent().getClassName(), actualIntent.getComponent().getClassName());
}
}
上面前一部分代码主要设置ComplaintActivity运行所依赖的属性,这也是在单元测试最为繁琐的地方,因为不是运行在真实的Android环境中。具体分析如下:
- 通过注解
@PrepareForTest({AppUtil.class, OAuthManager.class, NetUtil.class})
定义PowerMockito要mock的类; - 在Robolectric中读取不到apk的版本号,通过
PowerMockito.when(AppUtil.getVersionName()).thenReturn("1.4.0");
mock指定AppUtil.getVersionName()
的返回值"1.4.0",即版本号; - 通过
AppApplication.mInstance = getApplication();
使用Robolectric运行环境中的application对AppApplication.mInstance进行依赖注入,因为在很多类中都会用到AppApplication.mInstance进行初始化,例如SharedPreference、SQlite、单例类等,
上面代码就需要依赖AppApplication.mInstance进行初始化;PreferenceUtil.init(); PersistentPreferenceUtil.init();
ComplaintActivity complaintActivity = Robolectric.buildActivity(ComplaintActivity.class).create().get();
使用Robolectric创建ComplaintActivity对象,其中create()方法就是对应于调用Activity生命周期的onCreate()方法,此外Robolectric支持链式调用如:Robolectric.buildActivity(ComplaintActivity.class).create().resume().get();
;assertNotNull(complaintActivity);
验证complaintActivity是否跑起来;- 最后一部分代码就是调用jumpCompensate方法进行跳转,验证跳转的Intent是否符合预期;
至于其他的一些如Fragment、Dialog、Toast等验证,可以参考这篇博客,这里就不展开。
Robolectric常见的坑
- Application空指针问题
这是因为SharedPreferences和单例等类初始化时需要依赖Application对象,我们常见的用法是使用Application.getApplication()方法来获取,在Robolectric中则是需要使用RuntimeEnvironment.application来进行替换,上面就是通过依赖的方式进行替换。 - AppCompatActivity错误
假如你在Robolectric的@Config注解中配置了manifest = Config.NONE
,那就完蛋了,因为在网上根本找不解决的方法,你遇到如下异常不能使用support V7包的类:
解决的方式就是去掉java.lang.IllegalStateException: You need to use a Theme.AppCompat theme (or descendant) with this activity. at android.support.v7.app.AppCompatDelegateImplV7.createSubDecor(AppCompatDelegateImplV7.java:343) at android.support.v7.app.AppCompatDelegateImplV7.ensureSubDecor(AppCompatDelegateImplV7.java:312) at android.support.v7.app.AppCompatDelegateImplV7.initWindowDecorActionBar(AppCompatDelegateImplV7.java:172) at android.support.v7.app.AppCompatDelegateImplBase.getSupportActionBar(AppCompatDelegateImplBase.java:88) at android.support.v7.app.AppCompatActivity.getSupportActionBar(AppCompatActivity.java:110) at me.ele.shopcenter.components.BaseActivity.initActionBar(BaseActivity.java:104) at me.ele.shopcenter.components.BaseActivity.onCreate(BaseActivity.java:52) at me.ele.shopcenter.ui.order.ComplaintActivity.onCreate(ComplaintActivity.java:93) at android.app.Activity.performCreate(Activity.java:6251) at org.robolectric.util.ReflectionHelpers.callInstanceMethod(ReflectionHelpers.java:231)
manifest = Config.NONE
配置,这是坑爹的,我就遇到这个错误,花了好长一段时间才发现是这个配置导致的。 - Asset文件路径错误
需要用到context.getAssets().open(“XXX”)加载asset目录下的文件时,要是遇到以下错误:
解决方式是,不要用AssetManager来加载文件,而是自己使用Java API来加载文件,如:java.io.FileNotFoundException: build/intermediates/bundles/debug/assets/https.cer (No such file or directory) at java.io.FileInputStream.open0(Native Method) at java.io.FileInputStream.open(FileInputStream.java:195) at java.io.FileInputStream.<init>(FileInputStream.java:138) at org.robolectric.res.FileFsFile.getInputStream(FileFsFile.java:84) at org.robolectric.shadows.ShadowAssetManager.open(ShadowAssetManager.java:319) at android.content.res.AssetManager.open(AssetManager.java)
这个方式有点丑,需要用到你要加载的文件的绝对路径,灵活性低,不方便移植,不过这是我目前想到的解决方式。new FileInputStream(new File("/Users/michaelzhong/Desktop/shop/talaris_shop_center/app/src/main/assets/https.cer"));
- 找不到android.net.http.AndroidHttpClient的类文件
在Android API23开始,google就移除了HttpClient相关的类,有两种方法解决上述问题。
方法一:在build.gradle添加应用useLibrary ‘org.apache.http.legacy’
方法二:在test目录下添加HttpClient类(记得包名为android.net.http),如下:
说明:推荐使用第二种方式,第二种方法正式打包并不会把HttpClient的类加入,减少了包中无用的资源。