為網絡接口編寫單元測試(OCMock注入)

上篇《iOS開發 | 如何為網絡接口編寫單元測試》發表后,收到不少小伙伴的簡信,提出了不少問題,其中一個典型問題是:為已有的項目添加單元測試時,不知道如何入手。
為了回答這個問題,本篇將針對一個實例,演示測試網絡接口的實戰技巧。
我們來看一下,AF源碼中的Post類有個典型的網絡請求:

+ (NSURLSessionDataTask *)globalTimelinePostsWithBlock:(void (^)(NSArray *posts, NSError *error))block {
    return [[AFAppDotNetAPIClient sharedClient] GET:@"stream/0/posts/stream/global" 
parameters:nil 
progress:nil 
success:^(NSURLSessionDataTask * __unused task, id JSON) {
        NSArray *postsFromResponse = [JSON valueForKeyPath:@"data"];
        NSMutableArray *mutablePosts = [NSMutableArray arrayWithCapacity:[postsFromResponse count]];
        for (NSDictionary *attributes in postsFromResponse) {
            Post *post = [[Post alloc] initWithAttributes:attributes];
            [mutablePosts addObject:post];
        }

        if (block) {
            block([NSArray arrayWithArray:mutablePosts], nil);
        }
    } failure:^(NSURLSessionDataTask *__unused task, NSError *error) {
        if (block) {
            block([NSArray array], error);
        }
    }];
}

AFAppDotNetAPIClient繼承自AFHTTPSessionManager,調用GET方法,success回調處理了網絡返回的字典數據JSON,并將“data”中的數據解析成Post對象,存入數組,然后通過block返回給調用者,確實是非常典型的網絡數據處理。
我們想測試這個方法,

首要目標是確定在網絡獲得正常的數據時,能正確返回Post數組。

第一步:準備測試數據

1. 服務器返回的json數據

由于這里沒有一般項目中的《接口說明手冊》等開發文檔,我們通過瀏覽器訪問實際網絡
https://api.app.net/stream/0/posts/stream/global,獲得服務器返回的實際json數據,做為我們的標準測試數據,這么做只是為了獲得一個實際數據的樣板,并不意味著我們的測試需要依賴網絡,后續可以按自己的需要編輯多個本地json文件,做為測試數據;
保存的json數據如下(文件名data.json,這里只展示部分截圖):

服務器返回的原始數據

2.將 json數據轉成字典

這里使用YYKit提供的NSData+YYAdd 擴展中的 dataNamed()方法,它可以將文件中的json讀取為NSData對象:

NSData *jsonData = [NSData dataNamed:@"data.json"];
NSError *err;
NSDictionary *dic = [NSJSONSerialization JSONObjectWithData:jsonData
                                                    options:NSJSONReadingMutableContainers
                                                      error:&err];

第二步:調用目標方法

現在我們有了測試數據dic,接著需要將dic傳給success block,

觀察globalTimelinePostsWithBlock()的實現,我們發現這是一個類方法,如果我們mock一個Post對象,替換掉其block,這么做就繞過了globalTimelinePostsWithBlock的內部實現,顯然一點意義都沒有,因為主要邏輯都在AFAppDotNetAPIClient的success回調里;
而AFAppDotNetAPIClient是個單例,其實例及方法調用被封裝在方法中,無法從外部傳入mock對象,于是,我們的挑戰變成了找一個mock單例對象的方法,是否有這樣的方法呢?

使用OCMClassMock偽造單例對象

我們還是求助于OCMock來幫忙:OCMock3很貼心的加入了對單例對象的支持:

id classMock = OCMClassMock([AFAppDotNetAPIClient class]);
OCMStub([classMock sharedClient]).andReturn(mockManager);
[Post globalTimelinePostsWithBlock:^(NSArray *posts, NSError *error) {
    NSLog(@"~~~");
}];

我們來解釋下代碼中OCMStub的作用:替換AFAppDotNetAPIClient的shareClient方法,在其被調用時,返回andReturn中指定的對象mockManager。
mockManager就是我們傳入測試數據的機會,完整測試用例如下:

- (void)testExample {
    id mockManager = [OCMockObject mockForClass:[AFAppDotNetAPIClient class]];
    [[[mockManager expect] andDo:^(NSInvocation *invocation) {
        void (^successBlock)(NSURLSessionDataTask *task, id responseObject) = nil;
        [invocation getArgument:&successBlock atIndex:5];
        NSData *jsonData = [NSData dataNamed:@"data.json"];
        NSError *err;
        NSDictionary *dic = [NSJSONSerialization JSONObjectWithData:jsonData
                                                            options:NSJSONReadingMutableContainers
                                                              error:&err];
        successBlock([[NSURLSessionDataTask alloc] init],
                     dic
                     );
    }] GET:[OCMArg any]
     parameters:nil
     progress:[OCMArg any]
     success:[OCMArg any]
     failure:[OCMArg any]];
    
    id classMock = OCMClassMock([AFAppDotNetAPIClient class]);
    OCMStub([classMock sharedClient]).andReturn(mockManager);
    [Post globalTimelinePostsWithBlock:^(NSArray *posts, NSError *error) {
        XCTAssert(posts.count == 20, @"應該返回20個Post對象");
        XCTAssertTrue([posts[0] isKindOfClass:[Post class]]);
    }];
    [classMock stopMocking];
}

注意測試結束后,使用[classMock stopMocking];恢復單例的狀態,以免影響其他測試用例。
這個例子中,我們選擇GET方法的success做為測試目標,沒有深入GET方法內部進行測試,因為我們相信AFNetworking已經做了足夠的測試,而我們的重點在于應用內部邏輯,

利用一系列技巧,我們既為方法的內部調用提供了測試數據,又沒有重寫目標方法的任何代碼。

這樣的“分界點”選擇,在測試實戰中是常見的挑戰。
本文展示了針對類方法,單例對象,從json轉成字典等單元測試常見問題的解決方案,希望能對網絡做測試的小伙伴提供一些啟發,歡迎來信,留言進一步交流。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,732評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,214評論 3 426
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,781評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,588評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,315評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,699評論 1 327
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,698評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,882評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,441評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,189評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,388評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,933評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,613評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,023評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,310評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,112評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,334評論 2 377

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,818評論 18 139
  • iOS網絡架構討論梳理整理中。。。 其實如果沒有APIManager這一層是沒法使用delegate的,畢竟多個單...
    yhtang閱讀 5,232評論 1 23
  • AFHTTPRequestOperationManager 網絡傳輸協議UDP、TCP、Http、Socket、X...
    Carden閱讀 4,371評論 0 12
  • 我永遠不會是你的第一 你曾說第一又怎樣 你不明白 第一是一種安全感 第一是一種身份 第一是一種奢望 我真的很羨慕 ...
    Grass_大草閱讀 178評論 3 1
  • 如果我在意的人對我忽冷忽熱,而我又為此感到了患得患失,那么我便會選擇不辭而別,因為我沒那么多耐心去品嘗患得患失的感覺。
    8ebc768416b0閱讀 146評論 0 0