如何在 iOS 7.1 中使用 NSURLSession 对 HTTP 请求和响应进行单元测试？

Question

我想知道如何使用 NSURLSession 对 HTTP 请求和响应进行“单元测试”。现在，我的完成块代码在作为单元测试运行时不会被调用。但是，当从AppDelegate (didFinishWithLaunchingOptions) 中执行相同的代码时，会调用完成块内的代码。正如此线程 NSURLSessionDataTask dataTaskWithURL completion handler not getting called 中所建议的，需要使用信号量和/或 dispatch_group “以确保主线程在网络请求完成之前被阻塞。”

我的 HTTP 发布代码如下所示。

@interface LoginPost : NSObject
- (void) post;
@end

@implementation LoginPost
- (void) post
{
 NSURLSessionConfiguration* conf = [NSURLSessionConfiguration defaultSessionConfiguration];
 NSURLSession* session = [NSURLSession sessionWithConfiguration:conf delegate:nil delegateQueue:[NSOperationQueue mainQueue]];
 NSURL* url = [NSURL URLWithString:@"http://www.example.com/login"];
 NSString* params = @"username=test@xyz.com&password=test";
 NSMutableRequest* request = [NSMutableURLRequest requestWithURL:url];
 [request setHTTPMethod:@"POST"];
 [request setHTTPBody:[params dataUsingEncoding:NSUTF8StringEncoding]];
 NSURLSessionDataTask* task = [session dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  NSLog(@"Response:%@ %@\n", response, error); //code here never gets called in unit tests, break point here never is triggered as well
  //response is actually deserialized to custom object, code omitted
 }];
 [task resume];
 }
@end

测试这个的方法如下所示。

- (void) testPost
{
 LoginPost* loginPost = [LoginPost alloc];
 [loginPost post];
 //XCTest continues by operating assertions on deserialized HTTP response
 //code omitted
}

在我的AppDelegate 中，完成块代码确实有效，如下所示。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
 //generated code
 LoginPost* loginPost = [LoginPost alloc];
 [loginPost post];
}

关于在单元测试中运行时如何执行完成块的任何指针？我是 iOS 的新手，所以一个清晰的例子真的很有帮助。

• 注意：我意识到我所要求的也可能不是严格意义上的“单元”测试，因为我依赖 HTTP 服务器作为我的测试的一部分（意思是，我所要求的更像是集成测试）。
• 注意：我知道还有另一个线程 Unit tests with NSURLSession 关于使用 NSURLSession 进行单元测试，但我不想模拟响应。

Answer 1

Xcode 6 现在使用XCTestExpectation 处理异步测试。在测试一个异步过程时，你建立这个过程将异步完成的“期望”，在发出异步过程之后，你等待期望得到满足一段固定的时间，当查询完成时，你将异步完成满足期望。

例如：

- (void)testDataTask
{
    XCTestExpectation *expectation = [self expectationWithDescription:@"asynchronous request"];

    NSURL *url = [NSURL URLWithString:@"http://www.apple.com"];
    NSURLSessionTask *task = [self.session dataTaskWithURL:url completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        XCTAssertNil(error, @"dataTaskWithURL error %@", error);

        if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
            NSInteger statusCode = [(NSHTTPURLResponse *) response statusCode];
            XCTAssertEqual(statusCode, 200, @"status code was not 200; was %d", statusCode);
        }

        XCTAssert(data, @"data nil");

        // do additional tests on the contents of the `data` object here, if you want

        // when all done, Fulfill the expectation

        [expectation fulfill];
    }];
    [task resume];

    [self waitForExpectationsWithTimeout:10.0 handler:nil];
}

---

我之前的回答在下面，早于XCTestExpectation，但我将保留它以用于历史目的。

---

因为您的测试在主队列上运行，并且由于您的请求是异步运行的，所以您的测试不会捕获完成块中的事件。您必须使用信号量或调度组来使请求同步。

例如：

- (void)testDataTask
{
    dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);

    NSURL *url = [NSURL URLWithString:@"http://www.apple.com"];
    NSURLSessionTask *task = [self.session dataTaskWithURL:url completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        XCTAssertNil(error, @"dataTaskWithURL error %@", error);

        if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
            NSInteger statusCode = [(NSHTTPURLResponse *) response statusCode];
            XCTAssertEqual(statusCode, 200, @"status code was not 200; was %d", statusCode);
        }

        XCTAssert(data, @"data nil");

        // do additional tests on the contents of the `data` object here, if you want

        // when all done, signal the semaphore

        dispatch_semaphore_signal(semaphore);
    }];
    [task resume];

    long rc = dispatch_semaphore_wait(semaphore, dispatch_time(DISPATCH_TIME_NOW, 60.0 * NSEC_PER_SEC));
    XCTAssertEqual(rc, 0, @"network request timed out");
}

信号量将确保在请求完成之前测试不会完成。

显然，我上面的测试只是发出一个随机的 HTTP 请求，但希望它能说明这个想法。而我的各种XCTAssert 语句将识别出四种类型的错误：

1. NSError 对象不为零。

2. HTTP 状态码不是 200。

3. NSData 对象为零。

4. 完成块未在 60 秒内完成。

您可能还会为响应的内容添加测试（在这个简化的示例中我没有这样做）。

请注意，上述测试有效，因为我的完成块中没有任何内容将任何内容分派到主队列。如果您使用需要主队列的异步操作进行测试（如果您不小心使用 AFNetworking 或自己手动分派到主队列，就会发生这种情况），您可能会遇到上述模式的死锁（因为我们正在阻塞等待网络请求完成的主线程）。但是对于NSURLSession，这种模式效果很好。

---

您询问了如何从命令行进行测试，独立于模拟器。有几个方面：

1. 如果你想从命令行进行测试，你可以在命令行中使用xcodebuild。例如，要从命令行在模拟器上进行测试，它会是（在我的示例中，我的方案称为NetworkTest）：

   xcodebuild test -scheme NetworkTest -destination 'platform=iOS Simulator,name=iPhone Retina (3.5-inch),OS=7.0'

   这将构建方案并在指定的目标上运行它。请注意，有很多关于 Xcode 5.1 问题的报告，使用 xcodebuild 从命令行在模拟器上测试应用程序（我可以验证这种行为，因为我有一台机器，上面的工作正常，但在另一台机器上冻结）。在 Xcode 5.1 中针对模拟器进行命令行测试似乎并不完全可靠。

2. 如果您不希望您的测试在模拟器上运行（无论是从命令行还是从 Xcode 都适用），那么您可以构建一个 MacOS X 目标，并为该构建提供一个关联的方案。例如，我在我的应用程序中添加了一个 Mac OS X 目标，然后为它添加了一个名为 NetworkTestMacOS 的方案。

   顺便说一句，如果您将 Mac OS X 方案添加到现有 iOS 项目，测试可能不会自动添加到方案中，因此您可能必须通过编辑方案手动执行此操作，导航到测试部分，然后在那里添加你的测试类。然后，您可以通过选择正确的方案从 Xcode 运行这些 Mac OS X 测试，或者您也可以从命令行执行：

   xcodebuild test -scheme NetworkTestMacOS -destination 'platform=OS X,arch=x86_64'

   另外请注意，如果您已经构建了目标，则可以通过导航到右侧的 DerivedData 文件夹（在我的示例中为 ~/Library/Developer/Xcode/DerivedData/NetworkTest-xxx/Build/Products/Debug）直接运行这些测试，然后直接从命令运行 xctest行：

   /Applications/Xcode.app/Contents/Developer/usr/bin/xctest -XCTest All NetworkTestMacOSTests.xctest

3. 将测试与 Xcode 会话隔离的另一种选择是在单独的 OS X 服务器上进行测试。请参阅 WWDC 2013 视频Testing in Xcode 的持续集成和测试部分。在这里讨论这远远超出了原始问题的范围，因此我将简单地向您推荐该视频，该视频对该主题进行了很好的介绍。

就个人而言，我真的很喜欢 Xcode 中的测试集成（它使测试的调试变得无限容易），并且通过拥有 Mac OS X 目标，您可以在该过程中绕过模拟器。但是，如果您想从命令行（或 OS X 服务器）执行此操作，上述方法可能会有所帮助。