为网络接口编写单元测试(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阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • iOS网络架构讨论梳理整理中。。。 其实如果没有APIManager这一层是没法使用delegate的,毕竟多个单...
    yhtang阅读 5,160评论 1 23
  • AFHTTPRequestOperationManager 网络传输协议UDP、TCP、Http、Socket、X...
    Carden阅读 4,319评论 0 12
  • 我永远不会是你的第一 你曾说第一又怎样 你不明白 第一是一种安全感 第一是一种身份 第一是一种奢望 我真的很羡慕 ...
    Grass_大草阅读 172评论 3 1
  • 如果我在意的人对我忽冷忽热,而我又为此感到了患得患失,那么我便会选择不辞而别,因为我没那么多耐心去品尝患得患失的感觉。
    8ebc768416b0阅读 139评论 0 0