iOS开发 | 如何为网络接口编写单元测试
纯工具类APP已经沦为炮灰,移动APP几乎都是基于网络的,因此写单元测试,网络是一个绕不开的话题。实际iOS开发中,凡是基于http的网络连接, AFNetworking 几乎已成为一个标准库,比如发起一个post请求,会创建AFHTTPSessionManager 对象:
AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
manager.responseSerializer.acceptableContentTypes = [NSSet setWithObjects:@"text/plain",@"text/html",nil];
并调用以下方法:
- (NSURLSessionDataTask *)POST:(NSString *)URLString
parameters:(id)parameters
progress:(void (^)(NSProgress * _Nonnull))uploadProgress
success:(void (^)(NSURLSessionDataTask * _Nonnull, id _Nullable))success
failure:(void (^)(NSURLSessionDataTask * _Nullable, NSError * _Nonnull))failure
网络接口为什么难测?
还记得《没有单元测试,何谈重构》 中的测试循环吗?让我们再来复习一下:
当我们为AFHTTPSessionManager编写单元测试时,会遇到以下问题:
1. 返回结果不可控
虽然我们可以准备我们想要的目标URLString、parameters等参数,但在实际网络中,progress、success、failure等block回调——也就是测试循环的“验证结果”部分——是不确定的。
即使能勉强控制测试的网络环境,保证服务器一定返回success,定制返回数据也困难重重:准备把目标返回数据都写在服务端?基于真实的网络,很难获得理想的数据。
鬼知道服务器会返回给你什么!
——某开发者云
2. 可能还有经济上的问题
假设要开发的是对接获取验证码接口的方法,难道运行一次就真的请求一个短信验证码?短信下发平台可是会¥扣钱¥的。更何况,万一第三方平台没有响应或超时,我们的测试就失败了,这种异步的、不确定的测试,无论从金钱还是时间上衡量,都不够经济,因此很难实现。
因此,我们需要有方法指定返回数据,并且不需要 实际访问网络,我们这里选择使用OCMock。
使用OCMock
OCMock是一个用于建立仿造对象的框架,它使用OC的运行时机制,可以自动的创建任何OC对象实例, 比如可以这样来仿制 AFHTTPSessionManager 对象:
id mockManager = [OCMockObject mockForClass:[AFHTTPSessionManager class]];
准备数据
接着我们就可以使用mockManager提供的 andDo
方法,“伪造”出一个success调用:
[[[mockManager expect] andDo:^(NSInvocation *invocation) {
void (^successBlock)(NSURLSessionDataTask *task, id responseObject) = nil;
[invocation getArgument:&successBlock atIndex:5];
successBlock([[NSURLSessionDataTask alloc] init],
@{@"keyTest":@"valueTest"}
);
}] POST:[OCMArg any]
parameters:nil
progress:[OCMArg any]
success:[OCMArg any]
failure:[OCMArg any]];
调用expect
方法用来告诉OCMock “接管” POST方法,附加的 andDo
block方法中,提供了 NSInvocation 对象,这使得我们有机会指定调用的block和返回值:
- 先声明 successBlock ,注意,格式要与调用的block声明一致;
- 通过 getArgument 指定调用success方法,atIndex用于指明希望调用参数的位置,这里要从2开始,前两位分别是self(target),selector(_cmd));
- 调用successBlock,传入希望返回的数据。
注意:[OCMArg any] 用于告诉OCMock,可以接受任何参数,反之,如果
expert
时,POST参数传@"aTestPath",调用时任何非@"aTestPath"的POST调用将被忽略。
调用接口
[mockManager POST:@"any path"
parameters:nil
progress:nil
success:^(NSURLSessionDataTask *task, id responseObject) {
XCTAssertEqual(@"valueTest", responseObject[@"keyTest"]);
} failure:^(NSURLSessionDataTask * _Nullable task,
NSError * _Nonnull error) {
}];
这时,success block将会回调,并传回我们在andDo
中指明的字典数据@{@"keyTest":@"valueTest"}
到此,我们已经有了一个测试网络应用的良好开端,基于这里介绍的技术,我们可以改造iOS开发中的网络接口,使之能更方便编写单元测试,欢迎关注溪石iOS,留言、私信分享你的感想和经验,共同探讨iOS单元测试中的奇技淫巧。