单元测试主要用来检测某个工作单元的结果是否符合预期,以此保证该工作单元的逻辑正确。上次写封装一个 Swift-Style 的网络模块的时候在结尾提了一下单元测试的重要性,评论中有朋友对网络层的单元测试有一些疑惑。我推荐他去看《单元测试的艺术》(这本书让我对单元测试有了新的认识),但由于该书是以 C# 为例写的,可能会对 iOS 开发的朋友造成一定的阅读障碍,所以我还是决定填一下坑,简单介绍一下用 Swift 进行网络层单元测试的方法。不过由于 Swift 的函数式特性,像《单元测试的艺术》中那样单纯地用 OOP 思维编写测试可能会有些麻烦,本文临近结尾部分写了一点自己用过的使用“伪装函数”进行测试的方法,可能大家以前没见过,我自己也是突然想到的,欢迎提出各种意见。
网络层的单元测试之所以让人感觉难以下手,原因主要有两点:
· 网络是个不稳定的外部依赖。
· 网络操作一般会涉及异步过程,而异步过程难以测试。
要直接测试网络和异步调用,可以使用XCTest提供的expectationWithDescription+waitForExpectationsWithTimeout,举个例子:
func testFetchDataWithAPI_invalidAPI_failureResult() {
let expectation = expectationWithDescription("")
let timeout = 15 as NSTimeInterval
NetworkManager
.defaultManager
.fetchDataWithAPI(.Invalid, responseKey: "") {
expectation.fulfill()
XCTAssertTrue($0.isFailure)
}
waitForExpectationsWithTimeout(timeout, handler: nil)
}
测试方法按 test方法名_测试场景_期望结果 的格式命名。首先在异步回调外面调用expectationWithDescription方法得到一个expectation,这个方法接受一个字符串,用来描述本次测试,我传了个空串,因为我们的测试方法名已经足够清晰了。然后在回调中调用expectation.fulfill()表明满足测试条件,接下来就可以进行断言。最后别忘了在回调外面加上waitForExpectationsWithTimeout(timeout, handler: nil),如果时间超过timeout回调还没有执行,就会测试失败,hander会在超时后调用,可以写一些清空状态和还原现场的操作,以免影响之后的测试,譬如task?.cancel()。但是我这边什么都没做,因为优秀的单元测试之间本来就不应该互相有影响。
上面的测试非常简单吧,但是按《单元测试的艺术》一书中的观点,这样的测试已经不能算是单元测试,而是步入集成测试的范畴了:
集成测试是对一个工作单元进行的测试,这个测试对被测试的工作单元没有完全的控制,并使用该单元的一个或多个真实的依赖物,例如时间、网络、数据库、线程或随机数产生器等。
上述这个测试非常不稳定,它依赖于真实的网络状况,我们可能因为网络不佳测试失败,而不是因为我们的代码本身有逻辑错误,而且这个测试有可能非常慢,慢到你不愿意每次一修改代码就去跑一遍测试,这样的单元测试就有可能形同虚设。
集成测试当然也非常重要,但一般开发人员也就写写单元测试。其实 Alamofire 就有采用我上面说的方法进行测试,所以如果你的网络层像我一样是以 Alamofire 为基础构建的,那就表示你不太需要再去写这样的测试了,你只要保证跟 Alamofire 无关的那些代码本身逻辑正确,以及正确调用了 Alamofire 即可。
譬如针对我的这个方法:
/** Fetch raw object - parameter api: API address - parameter method: HTTP method, default = POST - parameter parameters: Request parameters, default = nil - parameter responseKey: Key of target value, use '.' to get nested objects, e.g. "data.vehicle_list" - parameter jsonArrayHandler: Handle result with raw object - returns: Optional request object which is cancellable. */ func fetchDataWithAPI(api: API, method: Alamofire.Method = .POST, parameters: [String: String]? = nil, responseKey: String, networkCompletionHandler: NetworkCompletionHandler) -> Cancellable? { guard let url = api.url else { printLog("URL Invalid: \\(api.rawValue)") return nil } return Alamofire.request(method, url, parameters: parameters).responseJSON { networkCompletionHandler(self.parseResult($0.result, responseKey: responseKey)) } } |
我一般会去测试它的返回值是否符合预期:
func testFetchDataWithAPI_invalidURL_returnNil { let task = NetworkManager .defaultManager .fetchDataWithAPI(.InvalidURL, responseKey: "") {} XCTAssertNil(task) } func testFetchDataWithAPI_validAPI_returnNotNil { let task = NetworkManager .defaultManager .fetchDataWithAPI(.ValidURL, responseKey: "") {} XCTAssertNotNil(task) } |