一、關(guān)于Robolectric3.0
文章中的所有代碼在此:https://github.com/geniusmart/LoveUT 欺缘,由于 Robolectric 3.0 和 3.1 版本(包括后續(xù)3.x版本)差異不小栋豫,該工程中包含這兩個(gè)版本對(duì)應(yīng)的測(cè)試用例 Demo 。
作為一個(gè)軟件開(kāi)發(fā)攻城獅谚殊,無(wú)論你多不屑多排斥單元測(cè)試丧鸯,它都是一種非常好的開(kāi)發(fā)方式,且不談TDD嫩絮,為自己寫的代碼負(fù)責(zé)丛肢,測(cè)試自己寫的代碼围肥,在自己力所能及的范圍內(nèi)提高產(chǎn)品的質(zhì)量,本是理所當(dāng)然的事情蜂怎。
那么如何測(cè)試自己寫的代碼穆刻?點(diǎn)點(diǎn)界面,測(cè)測(cè)功能固然是一種方式杠步,但是如果能留下一段一勞永逸的測(cè)試代碼蛹批,讓代碼測(cè)試代碼,豈不兩全其美篮愉?所以,寫好單元測(cè)試差导,愛(ài)惜自己的代碼试躏,愛(ài)惜顏值高的QA妹紙,愛(ài)惜有價(jià)值的產(chǎn)品(沒(méi)價(jià)值的设褐、政治性的颠蕴、屁股決定腦袋的產(chǎn)品滾粗),人人有責(zé)助析!
對(duì)于Android app來(lái)說(shuō)犀被,寫起單元測(cè)試來(lái)瞻前顧后,一方面單元測(cè)試需要運(yùn)行在模擬器上或者真機(jī)上外冀,麻煩而且緩慢寡键,另一方面,一些依賴Android SDK的對(duì)象(如Activity雪隧,TextView等)的測(cè)試非常頭疼西轩,Robolectric可以解決此類問(wèn)題,它的設(shè)計(jì)思路便是通過(guò)實(shí)現(xiàn)一套JVM能運(yùn)行的Android代碼脑沿,從而做到脫離Android環(huán)境進(jìn)行測(cè)試藕畔。本文對(duì)Robolectric3.0做了簡(jiǎn)單介紹,并列舉了如何對(duì)Android的組件和常見(jiàn)功能進(jìn)行測(cè)試的示例庄拇。
二注服、環(huán)境搭建
Gradle配置
在build.gradle中配置如下依賴關(guān)系:
testCompile "org.robolectric:robolectric:3.0"
通過(guò)注解配置TestRunner
@RunWith(RobolectricGradleTestRunner.class)
@Config(constants = BuildConfig.class)
public class SampleActivityTest {
}
Android Studio的配置
-
在Build Variants面板中,將Test Artifact切換成Unit Tests模式(注:新版本的as已經(jīng)不需要做這項(xiàng)配置)措近,如下圖:
working directory 設(shè)置為$MODULE_DIR$
如果在測(cè)試過(guò)程遇見(jiàn)如下問(wèn)題溶弟,解決的方式就是設(shè)置working directory的值:
java.io.FileNotFoundException: build\intermediates\bundles\debug\AndroidManifest.xml (系統(tǒng)找不到指定的路徑。)
設(shè)置方法如下圖所示:
更多環(huán)境配置可以參考官方網(wǎng)站瞭郑。
三可很、Activity的測(cè)試
- 創(chuàng)建Activity實(shí)例
@Test
public void testActivity() {
SampleActivity sampleActivity = Robolectric.setupActivity(SampleActivity.class);
assertNotNull(sampleActivity);
assertEquals(sampleActivity.getTitle(), "SimpleActivity");
}
- 生命周期
@Test
public void testLifecycle() {
ActivityController<SampleActivity> activityController = Robolectric.buildActivity(SampleActivity.class).create().start();
Activity activity = activityController.get();
TextView textview = (TextView) activity.findViewById(R.id.tv_lifecycle_value);
assertEquals("onCreate",textview.getText().toString());
activityController.resume();
assertEquals("onResume", textview.getText().toString());
activityController.destroy();
assertEquals("onDestroy", textview.getText().toString());
}
- 跳轉(zhuǎn)
@Test
public void testStartActivity() {
//按鈕點(diǎn)擊后跳轉(zhuǎn)到下一個(gè)Activity
forwardBtn.performClick();
Intent expectedIntent = new Intent(sampleActivity, LoginActivity.class);
Intent actualIntent = ShadowApplication.getInstance().getNextStartedActivity();
assertEquals(expectedIntent, actualIntent);
}
注:Robolectric 3.1 之后,不建議用 Intent.equals()
的方式來(lái)比對(duì)兩個(gè) Intent
凰浮,因此以上代碼將無(wú)法正常執(zhí)行我抠。目前建議用類似代碼來(lái)斷言:
assertEquals(expectedIntent.getComponent(), actualIntent.getComponent());
當(dāng)然苇本,Intent
有很多屬性,如果需要分別斷言的話比較麻煩菜拓,因此可以用一些第三方庫(kù)瓣窄,比如 assertj-android 的工具類 IntentAssert。
- UI組件狀態(tài)
@Test
public void testViewState(){
CheckBox checkBox = (CheckBox) sampleActivity.findViewById(R.id.checkbox);
Button inverseBtn = (Button) sampleActivity.findViewById(R.id.btn_inverse);
assertTrue(inverseBtn.isEnabled());
checkBox.setChecked(true);
//點(diǎn)擊按鈕纳鼎,CheckBox反選
inverseBtn.performClick();
assertTrue(!checkBox.isChecked());
inverseBtn.performClick();
assertTrue(checkBox.isChecked());
}
- Dialog
@Test
public void testDialog(){
//點(diǎn)擊按鈕俺夕,出現(xiàn)對(duì)話框
dialogBtn.performClick();
AlertDialog latestAlertDialog = ShadowAlertDialog.getLatestAlertDialog();
assertNotNull(latestAlertDialog);
}
- Toast
@Test
public void testToast(){
//點(diǎn)擊按鈕,出現(xiàn)吐司
toastBtn.performClick();
assertEquals(ShadowToast.getTextOfLatestToast(),"we love UT");
}
- Fragment的測(cè)試
如果使用support的Fragment贱鄙,需添加以下依賴
testCompile "org.robolectric:shadows-support-v4:3.0"
shadow-support包提供了將Fragment主動(dòng)添加到Activity中的方法:SupportFragmentTestUtil.startFragment(),簡(jiǎn)易的測(cè)試代碼如下
@Test
public void testFragment(){
SampleFragment sampleFragment = new SampleFragment();
//此api可以主動(dòng)添加Fragment到Activity中劝贸,因此會(huì)觸發(fā)Fragment的onCreateView()
SupportFragmentTestUtil.startFragment(sampleFragment);
assertNotNull(sampleFragment.getView());
}
- 訪問(wèn)資源文件
@Test
public void testResources() {
Application application = RuntimeEnvironment.application;
String appName = application.getString(R.string.app_name);
String activityTitle = application.getString(R.string.title_activity_simple);
assertEquals("LoveUT", appName);
assertEquals("SimpleActivity",activityTitle);
}
四、BroadcastReceiver的測(cè)試
首先看下廣播接收者的代碼
public class MyReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
SharedPreferences.Editor editor = context.getSharedPreferences(
"account", Context.MODE_PRIVATE).edit();
String name = intent.getStringExtra("EXTRA_USERNAME");
editor.putString("USERNAME", name);
editor.apply();
}
}
廣播的測(cè)試點(diǎn)可以包含兩個(gè)方面逗宁,一是應(yīng)用程序是否注冊(cè)了該廣播映九,二是廣播接受者的處理邏輯是否正確,關(guān)于邏輯是否正確瞎颗,可以直接人為的觸發(fā)onReceive()方法件甥,驗(yàn)證執(zhí)行后所影響到的數(shù)據(jù)。
@Test
public void testBoradcast(){
ShadowApplication shadowApplication = ShadowApplication.getInstance();
String action = "com.geniusmart.loveut.login";
Intent intent = new Intent(action);
intent.putExtra("EXTRA_USERNAME", "geniusmart");
//測(cè)試是否注冊(cè)廣播接收者
assertTrue(shadowApplication.hasReceiverForIntent(intent));
//以下測(cè)試廣播接受者的處理邏輯是否正確
MyReceiver myReceiver = new MyReceiver();
myReceiver.onReceive(RuntimeEnvironment.application,intent);
SharedPreferences preferences = shadowApplication.getSharedPreferences("account", Context.MODE_PRIVATE);
assertEquals( "geniusmart",preferences.getString("USERNAME", ""));
}
五哼拔、Service的測(cè)試
Service的測(cè)試類似于BroadcastReceiver引有,以IntentService為例,可以直接觸發(fā)onHandleIntent()方法倦逐,用來(lái)驗(yàn)證Service啟動(dòng)后的邏輯是否正確譬正。
public class SampleIntentService extends IntentService {
public SampleIntentService() {
super("SampleIntentService");
}
@Override
protected void onHandleIntent(Intent intent) {
SharedPreferences.Editor editor = getApplicationContext().getSharedPreferences(
"example", Context.MODE_PRIVATE).edit();
editor.putString("SAMPLE_DATA", "sample data");
editor.apply();
}
}
以上代碼的單元測(cè)試用例:
@Test
public void addsDataToSharedPreference() {
Application application = RuntimeEnvironment.application;
RoboSharedPreferences preferences = (RoboSharedPreferences) application
.getSharedPreferences("example", Context.MODE_PRIVATE);
SampleIntentService registrationService = new SampleIntentService();
registrationService.onHandleIntent(new Intent());
assertEquals(preferences.getString("SAMPLE_DATA", ""), "sample data");
}
六、Shadow的使用
Shadow是Robolectric的立足之本檬姥,如其名导帝,作為影子客们,一定是變幻莫測(cè)钦购,時(shí)有時(shí)無(wú),且依存于本尊陌僵。因此荞雏,框架針對(duì)Android SDK中的對(duì)象虐秦,提供了很多影子對(duì)象(如Activity和ShadowActivity、TextView和ShadowTextView等)凤优,這些影子對(duì)象悦陋,豐富了本尊的行為,能更方便的對(duì)Android相關(guān)的對(duì)象進(jìn)行測(cè)試筑辨。
1.使用框架提供的Shadow對(duì)象
@Test
public void testDefaultShadow(){
MainActivity mainActivity = Robolectric.setupActivity(MainActivity.class);
//通過(guò)Shadows.shadowOf()可以獲取很多Android對(duì)象的Shadow對(duì)象
ShadowActivity shadowActivity = Shadows.shadowOf(mainActivity);
ShadowApplication shadowApplication = Shadows.shadowOf(RuntimeEnvironment.application);
Bitmap bitmap = BitmapFactory.decodeFile("Path");
ShadowBitmap shadowBitmap = Shadows.shadowOf(bitmap);
//Shadow對(duì)象提供方便我們用于模擬業(yè)務(wù)場(chǎng)景進(jìn)行測(cè)試的api
assertNull(shadowActivity.getNextStartedActivity());
assertNull(shadowApplication.getNextStartedActivity());
assertNotNull(shadowBitmap);
}
2.如何自定義Shadow對(duì)象
首先俺驶,創(chuàng)建原始對(duì)象Person
public class Person {
private String name;
public Person(String name) {
this.name = name;
}
public String getName() {
return name;
}
}
其次,創(chuàng)建Person的Shadow對(duì)象
@Implements(Person.class)
public class ShadowPerson {
@Implementation
public String getName() {
return "geniusmart";
}
}
接下來(lái)棍辕,需自定義TestRunner暮现,添加Person對(duì)象為要進(jìn)行Shadow的對(duì)象(注:Robolectric 3.1 起可以省略此步驟)还绘。
public class CustomShadowTestRunner extends RobolectricGradleTestRunner {
public CustomShadowTestRunner(Class<?> klass) throws InitializationError {
super(klass);
}
@Override
public InstrumentationConfiguration createClassLoaderConfig() {
InstrumentationConfiguration.Builder builder = InstrumentationConfiguration.newBuilder();
/**
* 添加要進(jìn)行Shadow的對(duì)象
*/
builder.addInstrumentedPackage(Person.class.getPackage().getName());
builder.addInstrumentedClass(Person.class.getName());
return builder.build();
}
}
最后,在測(cè)試用例中栖袋,ShadowPerson對(duì)象將自動(dòng)代替原始對(duì)象拍顷,調(diào)用Shadow對(duì)象的數(shù)據(jù)和行為
@RunWith(CustomShadowTestRunner.class)
@Config(constants = BuildConfig.class,shadows = {ShadowPerson.class})
public class ShadowTest {
/**
* 測(cè)試自定義的Shadow
*/
@Test
public void testCustomShadow(){
Person person = new Person("genius");
//getName()實(shí)際上調(diào)用的是ShadowPerson的方法
assertEquals("geniusmart", person.getName());
//獲取Person對(duì)象對(duì)應(yīng)的Shadow對(duì)象
ShadowPerson shadowPerson = (ShadowPerson) ShadowExtractor.extract(person);
assertEquals("geniusmart", shadowPerson.getName());
}
}
七、關(guān)于代碼
文章中的所有代碼在此:https://github.com/geniusmart/LoveUT
另外塘幅,除了文中所示的代碼之外昔案,該工程還包含了Robolectric官方的測(cè)試?yán)樱粋€(gè)簡(jiǎn)單的登錄功能的測(cè)試电媳,可以作為入門使用踏揣,界面如下圖。
八匾乓、參考文章
http://robolectric.org
https://github.com/robolectric/robolectric
http://tech.meituan.com/Android_unit_test.html
關(guān)于代碼中的日志如何輸出捞稿、網(wǎng)絡(luò)請(qǐng)求、數(shù)據(jù)庫(kù)操作如何測(cè)試钝尸,請(qǐng)移步第二篇文章Android單元測(cè)試框架Robolectric3.0介紹(二)