[Cocoa]XCode下的iOS單元測試

XCode下的iOS單元測試羅朝輝 (http://www.cnblogs.com/kesalin/)本文遵循“署名-非商業用途-保持一致”創作公用協議

 

XCode 內建了 OCUnit 單元測試架構，但目前最好用的測試架構應該是 GHUnit。通過 GHUnit + OCMock 組合，我們可以在 iOS 下進行較強大的單元測試功能。本文將示範如何在 XCode 4.2 下使用 OCUnit， GHUnit 和 OCMock 進行單元測試。

OCUnit

在 XCode 下建立一個 OCUnitProject 工程，選中 Include Unit Tests 選擇框，

OCUnit 架構則會為我們自動添加 Unit Test 架構代碼：

 

XCode 在 OCUnitProjectTests.m 中為我們自動產生了一個 Fail 的測試：

- (void)testExample
{
    STFail(@"Unit tests are not implemented yet in OCUnitProjectTests");
}

 

讓我們來運行 Test，看看效果：

 

的紅色底線部分可以看出，測試沒有通過，符合預期。我們只要像類 OCUnitProjectTests 一樣編寫繼承自 SenTestCase 類的子類，在其中添加形式如：- (void) testXXX(); 的測試函數既可，注意必須是一個無參無傳回型別且名稱是以 test 為首碼的函數。

OCUnit 的有點是官方支援，於 XCode 整合的比較好。

 

GHUnit

GHUnit 是一個開源的單元測試架構，具有可視化介面，功能亦相當強大。Mark 寫了一篇 OCUnit vs GHUnit 的文章，有興趣的童鞋可以看一看。OCMock 是由 Mulle Kybernetik 為 OS X 和 iOS 平台編寫的遵循 mock object 理念的單元測試架構。

 

下面來介紹如何配置 GHUnit 和 OCMock

1，首先，建立一個名為 GHUnitProject 的單視圖應用程式，注意：不要選中 Include Unit Tests 選擇框。然後運行，應該出現白屏。

2，添加新的 test target，選中左邊的工程名，點擊右側的 Add Target，新增一個名為 Tests 的 Empty Application 應用程式，讓其附屬於 GHUnitProject注意：不要選中 Include Unit Tests 選擇框。

 

3，向 Tests 工程中（注意是 Tests 工程）添加 GHUnitIOS Framework。首先下載與 XCode 版本對應的 GHUnitIOS Framework。英文好的可以直接查看官方 iOS 版的安裝文檔：點此查看，跳過此第 3 節；否則請接著看。

3.1，解壓 GHUnitIOS 架構到 GHUnitProject 下，讓 GHUnitIOS.framework 與 Tests 在同一目錄下。

3.2，回到 XCode，右擊工程中的 Frameworks group，選中 Add Files to...菜單，選取 GHUnitIOS.framework ，注意 targets 要選擇 Tests。

3.3，設定 Tests 的 Build Settings：在 Other Linker Flags 中增加兩個 flag： -ObjC 和 -all_load。

3.4，刪除 Tests 工程中的 UTSAppDelegate.h 和  UTSAppDelegate.m 兩個檔案；

3.5，修改 Tests 工程中的 main.m 為:

#import <UIKit/UIKit.h>
#import <GHUnitIOS/GHUnitIOSAppDelegate.h>

int main(int argc, char *argv[])
{
    @autoreleasepool {
return UIApplicationMain(argc, argv, nil, NSStringFromClass([GHUnitIOSAppDelegate class]));
    }
}

 

3.6，選擇編譯目標 Tests>iPhone 5.0 Simulator，編譯運行，應該能得到如下效果。目前我們還沒有編寫任何實際測試，所以列表為空白。

 

4，編寫 GHUnit 測試。向 Tests 工程中添加名為 GHUnitSampleTest 的 Objective C class。其內容如下：
GHUnitSampleTest.h

#import <GHUnitIOS/GHUnit.h> 

@interface GHUnitSampleTest: GHTestCase
{
}

@end

GHUnitSampleTest.m

#import "GHUnitSampleTest.h"

@implementation GHUnitSampleTest

- (void)testStrings
{       
    NSString *string1 = @"a string";
    GHTestLog(@"I can log to the GHUnit test console: %@", string1);

// Assert string1 is not NULL, with no custom error description
    GHAssertNotNULL(string1, nil);

// Assert equal objects, add custom error description
    NSString *string2 = @"a string";
    GHAssertEqualObjects(string1, string2, @"A custom error message. string1 should be equal to: %@.", string2);
}

@end

 

然後編譯運行，點擊 Run，效果如下：

 

圖中的 All 欄顯示所以的測試，Failed 欄顯示沒有通過的測試。強大吧，GHUnit。你可以向 GHUnitSampleTest 添加新的測試，比如：

- (void)testSimpleFail
{
    GHAssertTrue(NO, nil);
}

 

我們可以向 Tests 添加更多測試類別，只要該類是繼承自 GHTestCase，且其中的測試方法都是無參無傳回值且方法名字是以 test 為首碼即可。

OCMock

下面我們來添加 OCMock。

1，我們只能以靜態庫的方式來添加 OCMock。在 GHUnitTest 目錄下建立 Libraries 目錄，該目錄是與 Tests 目錄平級的。下載靜態庫檔案，解壓標頭檔至該目錄下。
檔案下載：標頭檔 libOCMock.a ，framework 檔案：OCMock framework ，開啟下載好的 ocmock-1.77.dmg，拷貝其中的‘Release/Library/Headers/OCMock’
目錄至 Libraries 下。最終目錄結構如下：

 

2，在 GHUnitTest 工程中建立名為 Libraries 的 group，匯入libOCMock.a 和目錄 OCMock，注意 target 是 Tests。

 

3，設定 Tests 的 Build Setting。讓 Libray Search Paths 包含 $(SRCROOT)/Libraries：

 

在 Header Search Paths 中增加 $(SRCROOT)/Libraries，並選中 Recursive 選擇框。

 

4，編寫 OCMock 測試。向 Tests 工程中添加名為 OCMockSampleTest 的 Objective C class。其內容如下：
OCMockSampleTest.h

#import <GHUnitIOS/GHUnit.h>

@interface OCMockSampleTest : GHTestCase

@end

OCMockSampleTest.m

#import "OCMockSampleTest.h"
#import <OCMock/OCMock.h>

@implementation OCMockSampleTest

// simple test to ensure building, linking, 
// and running test case works in the project
- (void)testOCMockPass
{
    id mock = [OCMockObject mockForClass:NSString.class];
    [[[mock stub] andReturn:@"mocktest"] lowercaseString];

    NSString *returnValue = [mock lowercaseString];
    GHAssertEqualObjects(@"mocktest", returnValue, 
@"Should have returned the expected string.");
}

- (void)testOCMockFail
{
    id mock = [OCMockObject mockForClass:NSString.class];
    [[[mock stub] andReturn:@"mocktest"] lowercaseString];

    NSString *returnValue = [mock lowercaseString];
    GHAssertEqualObjects(@"thisIsTheWrongValueToCheck", 
                         returnValue, @"Should have returned the expected string.");
}

@end

 

編譯運行，點擊 Run，效果如。

 

至此，iOS 下的OCUnit，GHUnit，OCMock 單元測試介紹就到此結束了。當然還有其他一些測試架構，比如 google 出品的 GTM。

 

參考資料：
OCMock: http://ocmock.org/
Unit Testing in Xcode 4- use OCUnit and SenTest instead of GHUnit
GHUnit Reference: http://gabriel.github.com/gh-unit/