概述
Android的单元测试可以分为两部分:
- Local unit tests:运行于本地JVM
- Instrumented test:运行于真机或者模拟器
如果使用Local测试,需要保证测试过程中不会调用Android系统API,否则会抛出RuntimeException异常,因为Local测试是直接跑在本机JVM的,而之所以我们能使用Android系统API,是因为编译的时候,我们依赖了一个名为“android.jar”的jar包,但是jar包里所有方法都是直接抛出了一个RuntimeException,是没有任何任何实现的,这只是Android为了我们能通过编译提供的一个Stub!当APP运行在真实的Android系统的时候,由于类加载机制,会加载位于framework的具有真正实现的类。由于我们的Local是直接在PC上运行的,所以调用这些系统API便会出错。
那么问题来了,我们既要使用Local测试,但测试过程又难免遇到调用系统API那怎么办?其中一个方法就是mock objects,比如借助Mockito,另外一种方式就是使用Robolectric
, Robolectric就是为解决这个问题而生的。它实现一套JVM能运行的Android代码,然后在unit test运行的时候去截取android相关的代码调用,然后转到他们的他们实现的Shadow代码去执行这个调用的过程
如何使用?
为项目添加依赖
1 | testCompile "org.robolectric:robolectric:3.1.4" |
Robolectric在第一次运行时,会下载一些sdk依赖包,每个sdk依赖包大概50M,下载速度比较慢,用户可以直接在网上下载相应依赖包,放置在本地maven仓库地址中,默认路径为:C:\Users\username\.m2\repository\org\robolectric
指定RobolectricTestRunner为运行器
为测试用例添加注解,指定测试运行器为RobolectricTestRunner。注意,这里要通过Config指定constants = BuildConfig.class
,Robolectric 会通过constants推导出输出路径,如果不进行配置,Robolectric可能不能找到你的manifest、resources和assets资源
1 | (RobolectricTestRunner.class) |
什么是Shadow类
Shadow是Robolectric的立足之本,如其名,作为影子,一定是变幻莫测,时有时无,且依存于本尊。Robolectric定义了大量模拟Android系统类行为的Shadow类,当这些系统类被创建的时候,Robolectric会查找对应的Shadow类并创建一个Shadow类与原始类关联。每当系统类的方法被调用的时候,Robolectric会保证Shadow对应的方法会调用。这些Shadow对象,丰富了本尊的行为,能更方便的对Android相关的对象进行测试。
比如,我们可以借助ShadowActivity验证页面是否正确跳转了
1 | /** |
@Config配置
可以通过@Config
定制Robolectric的运行时的行为。这个注解可以用来注释类和方法,如果类和方法同时使用了@Config,那么方法的设置会覆盖类的设置。你可以创建一个基类,用@Config配置测试参数,这样,其他测试用例就可以共享这个配置了
配置SDK版本
Robolectric会根据manifest文件配置的targetSdkVersion选择运行测试代码的SDK版本,如果你想指定sdk来运行测试用例,可以通过下面的方式配置
1 | (sdk = Build.VERSION_CODES.JELLY_BEAN) |
配置Application类
Robolectric会根据manifest文件配置的Application配置去实例化一个Application类,如果你想在测试用例中重新指定,可以通过下面的方式配置
1 | (application = CustomApplication.class) |
指定Resource路径
Robolectric可以让你配置manifest、resource和assets路径,可以通过下面的方式配置
1 | "some/build/path/AndroidManifest.xml", (manifest = |
使用第三方Library Resources
当Robolectric测试的时候,会尝试加载所有应用提供的资源,但如果你需要使用第三方库中提供的资源文件,你可能需要做一些特别的配置。不过如果你使用gradle来构建Android应用,这些配置就不需要做了,因为Gradle Plugin会在build的时候自动合并第三方库的资源,但如果你使用的是Maven,那么你需要配置libraries变量:
1 | (RobolectricTestRunner.class) |
使用限定的资源文件
Android会在运行时加载特定的资源文件,如根据设备屏幕加载不同分辨率的图片资源、根据系统语言加载不同的string.xml,在Robolectric测试当中,你也可以进行一个限定,让测试程序加载特定资源.多个限定条件可以用破折号拼接在在一起。
1 | /** |
Properties文件
如果你嫌通过注解配置上面的东西麻烦,你也可以把以上配置放在一个Properties文件之中,然后通过@Config指定配置文件,比如,首先创建一个配置文件robolectric.properties:
1 | # 放置Robolectric的配置选项: |
然后把robolectric.properties文件放到src/test/resources目录下,运行的时候,会自动加载里面的配置
系统属性配置
- robolectric.offline:true代表关闭运行时获取jar包
- robolectric.dependency.dir:当处于offline模式的时候,指定运行时的依赖目录
- robolectric.dependency.repo.id:设置运行时获取依赖的Maven仓库ID,默认是sonatype
- robolectric.dependency.repo.url:设置运行时依赖的Maven仓库地址,默认是https://oss.sonatype.org/content/groups/public/
- robolectric.logging.enabled:设置是否打开调试开关
以上设置可以通过Gradle进行配置,如:
1 | android { |
驱动Activity生命周期
利用ActivityController
我们可以让Activity执行相应的生命周期方法,如:
1 |
|
通过ActivityController,我们可以模拟各种生命周期的变化。但是要注意,我们虽然可以随意调用Activity的生命周期,但是Activity生命周期切换有自己的检测机制,我们要遵循Activity的生命周期规律。比如,如果当前Activity并非处于stop状态,测试代码去调用了controller.restart方法,此时Activity是不会回调onRestart和onStart的。
除了控制生命周期,还可以在启动Activity的时候传递Intent:
1 | /** |
onRestoreInstanceState回调中传递Bundle:
1 | /** |
在真实环境下,视图是在onCreate之后的某一时刻在attach到Window上的,在此之前,View是处于不可操作状态的,你不能点击它。在Activity的onPostResume方法调用之后,View才会attach到Window之中。但是,在Robolectric之中,我们可以用控制器的visible
方法使得View变为可见,变为可见之后,就可以模拟点击事件了
1 |
|
追加模块
为了减少依赖包的大小,Robolectric的shadows类成了好几部分:
SDK Package | Robolectric Add-On Package |
---|---|
com.android.support.support-v4 | org.robolectric:shadows-support-v4 |
com.android.support.multidex | org.robolectric:shadows-multidex |
com.google.android.gms:play-services | org.robolectric:shadows-play-services |
com.google.android.maps:maps | org.robolectric:shadows-maps |
org.apache.httpcomponents:httpclient | org.robolectric:shadows-httpclient |
用户可以根据自身需求添加以下依赖包,如
1 | dependencies { |
自定义Shadow类
- Shadow类需要一个public的无参构造方法以方便Robolectric框架可以实例化它,通过@Implements注解与原始类关联在一起
- 若原始类有
有参构造方法
,在Shadow类中定义public void类型的名为__constructor__
的方法,且方法参数与原始类的构造方法参数一直 - 定义与原始类方法签名一致的方法,在里面重写实现,Shadow方法需用@Implementation进行注解
下面我们来创建RobolectricBean的Shadow类
原始类:
1 | public class RobolectricBean { |
Shadow类:
1 | /** |
Shadow类中访问原始类的field
Shadow类中可以定义一个原始类的成员变量,并用@RealObject注解,这样,Shadow类就能访问原始类的field了,但是注意,通过@RealObject注解的变量调用方法,依然会调用Shadow类的方法,而不是原始类的方法,只能用它来访问原始类的field。
1 | (Point.class) |
如何在测试用例中让Shadow生效
在Config注解中添加shadows
参数,指定对应的Shadow生效
1 | (RobolectricTestRunner.class) |
注意,自定义的Shadow类不能通过Shadows.shadowOf()
获取,需要用ShadowExtractor.extract()
来获取,获取之后进行类型转换:
1 | ShadowRobolectricBean shadowBean = (ShadowRobolectricBean) ShadowExtractor.extract(bean); |
常用测试场景
页面跳转验证
1 | /** |
UI组件状态验证
1 | /** |
验证Dialog
1 | /** |
验证Toast
1 | /** |
验证Fragment
1 | (RobolectricTestRunner.class) |
验证BroadcastReceiver
首先看下广播接收器:
1 | public class MyReceiver extends BroadcastReceiver { |
广播的测试点可以包含两个方面
- 验证应用程序是否注册了该广播
- 验证广播接收器的处理逻辑是否正确,关于逻辑是否正确,可以直接人为的触发onReceive()方法,让然后进行验证
1 | (RobolectricTestRunner.class) |
验证Service
Service和Activity一样,都有生命周期,Robolectric也提供了Service的生命周期控制器,使用方式和Activity类似,这里就不做详细解释了
1 | (RobolectricTestRunner.class) |