ios - 如何在 Swift 中使用 OCMock 模拟来自 AFNetworking 的响应？

Question

这就是我获取网络客户端实例的方式:

let networkClient = DBNetworkClient(baseURL: NSURL(string: "http://mysite.pl/api"))

我还有一个方法:

func citiesWithParameters(parameters: [String: String], completionBlock: DBSearchOptionHandler) {

    GET("cities", parameters: parameters, success: { operation, response in

        if let error = NSError(response: response) {
            completionBlock([], error)
        } else {
            let cities = DBCity.parseCitiesWithDictionary(response as! NSDictionary)
            completionBlock(cities, nil)
        }

        }) { operation, error in

            completionBlock([], error)
    }
}

我是这样调用这个方法的:

networkClient.citiesWithParameters(parameters, completionBlock: { cities, error in 
    //do sth 
})

通过这种方式，我传递了一些参数，并从服务器获得了REAL 响应。当我要求这个时，我想 mock 那个回应。如何做到这一点？

func testCities() {

    let mockNetworkClient = OCMockObject.mockForClass(DBNetworkClient.classForCoder())        


    //what should I perform here to be able to do sth like this:

    let expectation = expectationWithDescription("")

    mockNetworkClient.citiesWithParameters(["a": "b"]) { cities, error in
        expectation.fulfill()
        XCTAssertNotNil(cities)
        XCTAssertNil(error) //since I know what is the response, because I mocked this
    }

    waitForExpectationsWithTimeout(10, handler: nil)
}

这就是我的方法 GET 在 DBNetworkClient 中定义的方式:

override func GET(URLString: String!, parameters: AnyObject!, success: ((AFHTTPRequestOperation!, AnyObject!) -> Void)!, failure: ((AFHTTPRequestOperation!, NSError!) -> Void)!) -> AFHTTPRequestOperation! {

    return super.GET(URLString, parameters: parameters, success: { (operation, response) in

        print("GET \(operation.request.URL)")
        print("GET \(response)")

        success(operation, response)

        }, failure: { (operation, error) in

            print("GET \(operation.request.URL)")
            print("GET \(operation.responseObject)")

            failure(operation, error)
    })
}

一旦我能够，我将奖励帮助我做到这一点的人 50 赏金。

Writing mock tests for AFNetworking不幸的是没有帮助。它对我不起作用。

Answer 1

我没有使用过 Alamofire，因此我不知道在哪里声明了你的 GET 方法，但你绝对应该 stub 这个方法而不是 citiesWithParameters。

例如，如果它在您的 DBNetworkClient 中声明:

func testCities()
{
    //1
    class DBNetworkClientMocked: DBNetworkClient
    {
        //2
        override func GET(URLString: String!, parameters: AnyObject!, success: ((AFHTTPRequestOperation!, AnyObject!) -> Void)!, failure: ((AFHTTPRequestOperation!, NSError!) -> Void)!) -> AFHTTPRequestOperation! {

            //3
            success(nil, ["San Francisco", "London", "Sofia"])

        }
    }

    //4
    let sut = DBNetworkClientMocked()
    sut.citiesWithParameters(["a":"b"]) { cities, error in

        //5
        XCTAssertNotNil(cities)
        XCTAssertNil(error)

    }
}

那么这里发生了什么:

1. 您定义的类是 DBNetworkClient 的子类，因此按照您发布的文章中的描述为它创建一个“模拟”。在该类中，我们将仅覆盖我们想要更改的方法( stub )，而其他方法保持不变。这是以前用 OCMock 完成的，称为部分模拟。
2. 现在您将 GET 方法 stub 以返回特定数据，而不是来自服务器的实际数据
3. 您可以在此处定义返回 stub 服务器的内容。可以是成功失败等。
4. 现在，在我们准备好模拟和 stub 之后，我们创建所谓的S对象Under Test(sut)。请注意，如果 DBNetworkClient 具有特定构造函数，您必须调用此构造函数而不是默认构造函数 - ()。
5. 我们执行我们想要测试的方法。在它的回调中，我们放入了所有断言。

到目前为止一切顺利。但是，如果 GET 方法是 Alamofire 的一部分，您需要使用一种称为依赖注入(inject)的技术(您可以通过谷歌搜索获取更多信息)。

因此，如果 GET 是在另一个类中声明的，并且仅在 citiesWithParameters 中被引用，我们如何才能 stub 呢？让我们看看这个:

//1
class DBNetworkClient
{
    //2
    func citiesWithParameters(parameters: [String: String], networkWorker: Alamofire = Alamofire(), completionBlock: DBSearchOptionHandler) {

        //3
        networkWorker.GET("cities", parameters: parameters, success: { operation, response in

            if let error = NSError(response: response) {
                completionBlock([], error)
            } else {
                let cities = DBCity.parseCitiesWithDictionary(response as! NSDictionary)
                completionBlock(cities, nil)
            }

            }) { operation, error in

                completionBlock([], error)
        }

    }
}

func testCities()
{
    //4
    class AlamofireMock: Alamofire
    {
        override func GET(URLString: String!, parameters: AnyObject!, success: ((AFHTTPRequestOperation!, AnyObject!) -> Void)!, failure: ((AFHTTPRequestOperation!, NSError!) -> Void)!) -> AFHTTPRequestOperation! {

            success(nil, ["San Francisco", "London", "Sofia"])

        }
    }

    //5
    let sut = DBNetworkClient()
    sut.citiesWithParameters(["a":"b"], networkWorker: AlamofireMock()) { cities, error in

        //6
        XCTAssertNotNil(cities)
        XCTAssertNil(error)

    }
}

1. 首先，我们必须稍微更改我们的 citiesWithParameters 以接收更多参数。这个参数就是我们的依赖注入(inject)。它是具有 GET 方法的对象。在现实生活中的例子中，它最好只是一个协议(protocol)，因为 citiesWithParameters 不需要知道任何比这个对象能够发出请求更多的东西。
2. 我已将 networkWorker 参数设置为默认值，否则您需要更改对 citiesWithParameters 的所有调用以满足新的参数要求。
3. 我们保持所有实现不变，只是现在我们调用我们注入(inject)的对象GET方法
4. 现在回到测试中，这次我们将模拟 Alamofire。我们做了与前面示例完全相同的事情，只是这次模拟类是 Alamofire 而不是 DBNetworkClient
5. 当我们调用 citiesWithParameters 时，我们将模拟对象作为 networkWorker 传递。这样，我们 stub 的 GET 方法将被调用，我们将从“假”服务器获取我们预期的数据。
6. 我们的断言保持不变

请注意，这两个示例没有使用 OCMock，而是完全依赖 Swift 的强大功能! OCMock 是我们在伟大的动态语言——Objective-C 中使用的一个很棒的工具。然而，在 Swift 上几乎完全没有活力和反射。这就是为什么即使在官方OCMock我们有以下声明的页面:

Will there be a mock framework for Swift written in Swift? Maybe. As of now it doesn't look too likely, though, because mock frameworks depend heavily on access to the language runtime, and Swift does not seem to provide any.

所提供的两个实现中缺少的是验证 GET 方法是否被调用。我会这样保留它，因为这不是最初的问题，您可以使用在模拟类中声明的 bool 值轻松实现它。

更重要的是，我假设 Alamofire 中的 GET 方法是实例方法，而不是类方法。如果不是这样，您可以在 DBNetworkClient 中声明新方法，它只需调用 Alamofire.GET 并在 citiesWithParameters 中使用该方法。然后你可以像第一个例子那样 stub 这个方法，一切都会好起来的。