在Android中利用Instrumentation進行單元測試

 

任何程式的開發都離不開單元測試來保證其健壯和穩定。Android的程式自然也不例外。從Android SDK 0.9開始，就有了比較成熟的測試架構，但是直到目前最新的1.1版本，也沒有詳細的文檔介紹這個內容，只是簡單的給了一個Api Demos裡的幾個單元測試代碼。因此，我在這裡對此內容做一下梳理和總結：

　　JUnit還能用嗎？

　　在 Java下做單元測試必然用到JUnit。這裡說的JUnit是指從Apache基金會下載的junit.jar裡提供的一系列單元測試功能。這些功能顯然是運行在JDK之上的。在Android下已經沒有了JDK，自然也無法運行JUnit。但是這並不妨礙我們利用JUnit編寫單元測試。只不過在運行單元測試時，一定要用JDK來運行，利用java命令來啟動JUnit的某個Runner。如果是用Eclipse的話，可以在Run
Configuration裡建立一個JUnit。但是一定要記得在Classpath選項卡裡將Bootstrap Entries中的Android Library改成JRE，並且添加junit.jar。

 

很明顯的，這種測試就是正規的Java單元測試，和Android沒有任何關係。你無法測試任何關於Android系統中的API，你寫的Activity，人機介面等等。所以，如果你想測試僅僅是一些封裝資料的對象，或者是純粹的數值計算，還是可以用這種方法的。

　　Android裡面的junit.framework包是怎麼回事？

　　很多人看到這個包的時候，第一反應是Android是不是已經完整整合了JUnit。很遺憾這不是事實。如果你按照JUnit的運行方法，卻不像上面那樣改用JDK，就一定會得到一個異常：

# # An unexpected error has been detected by Java Runtime Environment: # # Internal Error (classFileParser.cpp:2924), pid=4900, tid=4476 #Error: ShouldNotReachHere() # # Java VM: Java HotSpot(TM) Client VM (10.0-b19 mixed mode windows-x86) # An error report file with more information is saved as: # E:\Mydoc\EclipseWorkspace\TestAndroid\hs_err_pid4900.log # # If you would like to submit a bug report, please visit: #http://java.sun.com/webapps/bugreport/crash.jsp #

　　實際上，TestCase這個類用於在Android擔當所有獨特的TestCase的基類的作用，它是一個Abstract Class。Android單元測試類繼承關係圖如下所示：

 

之所以有那麼多XXXTestCase主要是為了簡化工作。例如當你想對一個訪問資料庫的功能進行測試時，首先需要自己啟動並初始化資料庫。在這裡是類似的，如果你想測試一個Activity，首先要啟動它。而ActivityTestCase就會自動幫你做完這些事情。而 ActivityUnitTestCase會更注重測試的獨立性，它會讓測試與Android底層的聯絡降到最低。其餘的類可以查看相關的Javadoc
來按需挑選。要編寫測試，就是找到合適的XXXTestCase作為基類來繼承，並且編寫自己的測試方法。

　　很明顯的，最簡單的編寫測試的方法就是繼承AndroidTestCase寫一個自己的TestCase。然後為自己的一組TestCase寫一個Activity介面，由介面控制 TestCase的啟動，運行和結果報告。但是，你很快會發現，為何要給測試寫一個介面呢？這太詭異了。這時就需要一種技術，它可以利用命令列（Shell）來啟動一組測試，並且通過命令列的形式給出結果。這就是所謂的Instrumentation。

　什麼是Instrumentation？

　　一般在開發Android程式的時候，需要寫一個manifest檔案，其結構是：

<application android:icon="@drawable/icon" android:label="@string/app_name"> <activity android:name=".TestApp" android:label="@string/app_name"> …… </activity> </application>

　　這樣，在啟動程式的時候就會先啟動一個Application，然後在此Application運行過程中根據情況載入相應的Activity，而Activity是需要一個介面的。但是Instrumentation並不是這樣的。你可以將Instrumentation理解為一種沒有圖形介面的，具有啟動能力的，用於監控其他類（用Target Package聲明）的工具類。任何想成為Instrumentation的類必須繼承android.app.Instrumentation。下面是這個類的解釋：

　　“Base class for implementing application instrumentation code. When running with instrumentation turned on, this class will be instantiated for you before any of the application code, allowing you to monitor all of the interaction the system has with the
application. An Instrumentation implementation is described to the system through an AndroidManifest.xml's <instrumentation> tag.“

　　對於單元測試，我們需要認真瞭解的就是android.test.InstrumentationTestRunner類。這是Android單元測試的主入口。它相當於JUnit當中TestRunner的作用。

　　那麼如何載入它呢，首先要在manifest檔案中加入一行關於Instrumentation的聲明。比如Android Api Demos中的測試裡的manifest是這麼寫的（我濾掉了所有的注釋）：

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.android.apis.tests"> <application> <uses-library android:name="android.test.runner" /> </application> <instrumentation android:name="android.test.InstrumentationTestRunner" android:targetPackage="com.example.android.apis" android:label="Tests for Api Demos."/> </manifest>

　　如果用Eclipse的ADT外掛程式（0.8版本以上），也可以用圖形介面來添加，如：

 

編輯好 manifest，就可以打包（build，可以用Eclipse ADT來做，也可以用aapt命令手工完成），然後安裝到虛擬機器上（用adb install命令）。之後就可以利用命令列的方式來載入你的單元測試了。在Android Shell中載入一個Instrumentation的方法是利用以下命令：

　　adb shell am instrument –w XXXXXX

　　其中-w是指定Instrumentation類的參數標誌。一個簡單的例子是：

　　adb shell am instrument -w com.android.foo/android.test.InstrumentationTestRunner

　　當然，也可以利用adb shell先進入android命令列模式，再直接寫am instrument –w XXXXXXX。下面將具體介紹如何將根據需要載入一組單元測試。

 

如何在Android中利用Instrumentation來進行測試？

　　在介紹具體的命令之前，我們先理解一下單元測試的層次。一組單元測試可以被組織成若干個TestSuite。每個TestSuite包含若干 TestCase（某個繼承android.jar的junit.framework.TestCase的類）。每個TestCase又包含若干個 Test（具體的test方法）。

　　如果假設com.android.foo是你的測試代碼的包的根。當執行以下命令時，會執行所有的TestCase的所有Test。測試的對象就是在Target Package中指定的包中的代碼：

　　adb shell am instrument -w com.android.foo/android.test.InstrumentationTestRunner

　　如果你想運行一個TestSuite，首先繼承android.jar的junit.framework.TestSuite類，實現一個 TestSuite（比如叫com.android.foo.MyTestSuite），然後執行以下命令執行此TestSuite

　　adb shell am instrument -e class com.android.foo.MyTestSuite -w com.android.foo/android.test.InstrumentationTestRunner

　　其中的-e表示額外的參數，文法為-e [arg1] [value1] [arg2] [value2] …這裡用到了class參數。

　　如果僅僅想運行一個TestCase（比如叫com.android.foo.MyTestCase），則用以下命令：

　　adb shell am instrument -e class com.android.foo.MyTestCase -w com.android.foo/android.test.InstrumentationTestRunner

　　如果僅僅想運行一個Test（比如就是上面MyTestCase的testFoo方法），很類似的，就這樣寫：

　　adb shell am instrument -e class com.android.foo.MyTestCase#testFoo -w com.android.foo/android.test.InstrumentationTestRunner

　　然後，所有的測試結果會輸出到控制台，並會做一系列統計，如標記為E的是Error，標記為F的是Failure，Success的測試則會標記為一個點。這和JUnit的語義一致。如果希望斷點調試你的測試，只需要直接在代碼上加上斷點，然後將運行命令參數的-e後邊附加上debug true後運行即可。更加詳細的內容可以看InstrumentationTestRunner的Javadoc。我希望Android能儘快有正式的文檔來介紹這個內容。

　　如何在Android的單元測試中做標記？

　　在 android.test.annotation包裡定義了幾個annotation，包括 @LargeTest，@MediumTest，@SmallTest，@Smoke，和@Suppress。你可以根據自己的需要用這些 annotation來對自己的測試分類。在執行單元測試命令時，可以在-e參數後設定“size large”/ “size medium”/ “size small”來執行具有相應標記的測試。特別的@Supperss可以取消被標記的Test的執行。

　　完整的操作過程

　　總結以上所有的內容，編寫並運行完整的測試需要以下的步驟：

 

以上步驟中，在 Android內建的例子中，我發現它有兩個manifest.xml。也就是說在步驟3中原始碼和測試代碼分別產生了兩個不同的包。然後步驟4利用 adb install命令安裝到了虛擬機器上。由於我沒有找到Eclipse ADT有辦法可以為一個只有Instrumentation，沒有Activity的Application打包並安裝，於是採用了略微不同的辦法完成了這個工作。下文中將一一詳細介紹整個過程。

 

1、編寫程式

　　我建立了一個項目TestApp，參數為：

Package Name: com.android.testapp Activity Name: MainActivity Application Name: TestApp

　　以下是MainActivity的原始碼：

packagecom.android.testapp; importandroid.app.Activity; importandroid.os.Bundle; publicclassMainActivityextendsActivity { /** Called when the activity is first created. */ @Override publicvoidonCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); } publicintsum(inta,intb) { returna + b; } publicintsubstract(inta,intb) { returnb - a; } }

　　其中，我故意將減法的a – b寫成了b – a。

 

2、編寫測試程式

　　然後，我建立了一個Source Folder，名為test，並在裡面建立了包com.android.testapp.test。並定義了一個TestCase，名為TestMainActivity，原始碼如下：

package com.android.testapp.test; import com.android.testapp.MainActivity; import android.test.ActivityInstrumentationTestCase; import android.test.suitebuilder.annotation.MediumTest; public class TestMainActivity extends ActivityInstrumentationTestCase<MainActivity> { public TestMainActivity() { super("com.android.testapp", MainActivity.class); } public TestMainActivity(String pkg, Class<MainActivity> activityClass) { super(pkg, activityClass); } @MediumTest public void testSum() { assertEquals(3, getActivity().sum(1, 2)); } @MediumTest public void testSubstract() { assertEquals(-1, getActivity().substract(1, 2)); } }

　　我繼承了ActivityInstrumentationTestCase。這個TestCase在執行時會自動幫我啟動相應的Activity。

　　接下來就是程式的Manifest：

<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.android.testapp" android:versionCode="1" android:versionName="1.0.0"> <application android:icon="@drawable/icon" android:label="@string/app_name"> <activity android:name=".MainActivity" android:label="@string/app_name"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> <uses-library android:name="android.test.runner" /> </application> <instrumentation android:targetPackage="com.android.testapp" android:name="android.test.InstrumentationTestRunner" android:label="Test Unit Tests"></instrumentation> </manifest>

　　在這個檔案中，我將 Activity和Instrumentation的聲明寫到了一起，而沒有像Apis Demo那樣分開。請注意裡面的<uses-library>標籤。如果沒有那句，在運行測試時會報告找不到TestRunner。這是由於 Android在build的時候只把需要的東西打包，所以你必須明確的告訴Android Builder這一點。

 

3、Build和Install

　　在 Eclipse上，這兩個步驟是一起完成的。只要點一下Run即可。只不過如果你不在Run Configuration裡將安裝後的Launch Action設為“Do Nothing”，就會自動運行一下你的MainActivity。對於我們，設為Do Nothing即可。如：

完成後，利用命令：

　　adb shell pm list packages

　　可以在已經安裝的pkg列表裡看到com.android.testapp。

　　4、運行測試，查看結果

　　之後就開啟命令列，運行以下命令

　　adb shell am instrument –e class com.android.testapp.test.TestMainActivity –w com.android.testapp/android.test.InstrumentationTestRunner

　　即可看到如下的結果：

可以看到，單元測試正確的找到了減法中的錯誤。結果中的成功的測試顯示為”.”，一個失敗的顯示為”F”。只不過我還是不太理解為什麼我唯寫了兩個測試方法，Tests run卻顯示了3。