如何对异步 API 进行单元测试？

Question

我已将 Google Toolbox for Mac 安装到 Xcode 中，并按照说明进行操作在此处设置单元测试。

一切都很好，我可以在所有对象上测试我的同步方法，效果非常好。然而，我实际上想通过调用委托上的方法来测试大多数复杂的 API 异步返回结果 - 例如，对文件下载和更新系统的调用将立即返回，然后在文件下载完成时运行 -fileDownloadDidComplete: 方法。

我如何将其作为单元测试进行测试？

看来我想要 testDownload 函数，或者至少是测试框架“等待” fileDownloadDidComplete: 方法运行。

编辑：我现在已经改用 XCode 内置 XCTest 系统，并发现 Github 上的 TVRSMonitor提供了一种使用信号量等待异步操作完成的简单方法。

例如：

- (void)testLogin {
  TRVSMonitor *monitor = [TRVSMonitor monitor];
  __block NSString *theToken;

  [[Server instance] loginWithUsername:@"foo" password:@"bar"
                               success:^(NSString *token) {
                                   theToken = token;
                                   [monitor signal];
                               }

                               failure:^(NSError *error) {
                                   [monitor signal];
                               }];

  [monitor wait];

  XCTAssert(theToken, @"Getting token");
}

Answer 1

我遇到了同样的问题，并找到了适合我的不同解决方案。

我使用“老派”方法通过使用信号量将异步操作转换为同步流，如下所示：

// create the object that will perform an async operation
MyConnection *conn = [MyConnection new];
STAssertNotNil (conn, @"MyConnection init failed");

// create the semaphore and lock it once before we start
// the async operation
NSConditionLock *tl = [NSConditionLock new];
self.theLock = tl;
[tl release];    

// start the async operation
self.testState = 0;
[conn doItAsyncWithDelegate:self];

// now lock the semaphore - which will block this thread until
// [self.theLock unlockWithCondition:1] gets invoked
[self.theLock lockWhenCondition:1];

// make sure the async callback did in fact happen by
// checking whether it modified a variable
STAssertTrue (self.testState != 0, @"delegate did not get called");

// we're done
[self.theLock release]; self.theLock = nil;
[conn release];

然后确保调用

[self.theLock unlockWithCondition:1];

In 委托。

Answer 2

我很高兴这个问题在大约一年前被提出并得到回答，但我忍不住不同意给出的答案。测试异步操作，特别是网络操作，是一个非常常见的要求，正确执行非常重要。在给定的示例中，如果您依赖于实际的网络响应，您就会失去测试的一些重要价值。具体来说，您的测试取决于您正在通信的服务器的可用性和功能正确性；这种依赖性使您的测试

• 更加脆弱（如果服务器出现故障会发生什么？）
• 不太全面（如何一致地测试故障响应或网络错误？）
• 显着变慢想象一下这样的测试：

单元测试应该在几分之一秒内运行。如果每次运行测试时都必须等待多秒的网络响应，那么您不太可能频繁运行它们。

单元测试主要是关于封装依赖关系；从被测试代码的角度来看，会发生两件事：

1. 您的方法可能通过实例化 NSURLConnection 来发起网络请求。
2. 您指定的委托通过某些方法调用接收响应。

您的委托不会也不应该关心响应来自哪里，无论是来自远程服务器的实际响应还是来自您的测试代码。您可以利用这一点，通过简单地自己生成响应来测试异步操作。您的测试将运行得更快，并且您可以可靠地测试成功或失败响应。

这并不是说您不应该针对您正在使用的真实 Web 服务运行测试，但这些是集成测试，属于它们自己的测试套件。该套件中的故障可能意味着 Web 服务已发生更改，或者只是停止运行。由于它们更脆弱，因此自动化它们的价值往往比自动化单元测试的价值要低。

关于如何准确地测试对网络请求的异步响应，您有几个选择。您可以通过直接调用方法来简单地单独测试委托（例如[someDelegate connection:connection didReceiveResponse:someResponse]）。这会有点作用，但有点错误。您的对象提供的委托可能只是特定 NSURLConnection 对象的委托链中的多个对象之一；如果您直接调用委托的方法，您可能会丢失链上另一个委托提供的一些关键功能。作为更好的替代方案，您可以存根您创建的 NSURLConnection 对象，并让它将响应消息发送到其整个委托链。有些库将重新打开 NSURLConnection （以及其他类）并为您执行此操作。例如： https://github.com/pivotal/ PivotalCoreKit/blob/master/SpecHelperLib/Extensions/NSURLConnection%2BSpec.m

Answer 3

St3fan，你是个天才。多谢！

这就是我根据你的建议做到的。

“Downloader”定义了一个协议，其中包含在完成时触发的 DownloadDidComplete 方法。
有一个 BOOL 成员变量“downloadComplete”用于终止运行循环。

-(void) testDownloader {
 downloadComplete = NO;
 Downloader* downloader = [[Downloader alloc] init] delegate:self];

 // ... irrelevant downloader setup code removed ...

 NSRunLoop *theRL = [NSRunLoop currentRunLoop];

 // Begin a run loop terminated when the downloadComplete it set to true
 while (!downloadComplete && [theRL runMode:NSDefaultRunLoopMode beforeDate:[NSDate distantFuture]]);

}


-(void) DownloaderDidComplete:(Downloader*) downloader withErrors:(int) errors {
    downloadComplete = YES;

    STAssertNotEquals(errors, 0, @"There were errors downloading!");
}

当然，运行循环可能会永远运行......我稍后会改进！

Answer 4

我编写了一个小助手，可以轻松测试异步 API。首先是助手：

static inline void hxRunInMainLoop(void(^block)(BOOL *done)) {
    __block BOOL done = NO;
    block(&done);
    while (!done) {
        [[NSRunLoop mainRunLoop] runUntilDate:
            [NSDate dateWithTimeIntervalSinceNow:.1]];
    }
}

您可以这样使用它：

hxRunInMainLoop(^(BOOL *done) {
    [MyAsyncThingWithBlock block:^() {
        /* Your test conditions */
        *done = YES;
    }];
});

只有当 done 变为 TRUE 时它才会继续，因此请确保在完成后对其进行设置。当然，如果您愿意，您可以为助手添加超时，

Answer 5

这很棘手。我认为您需要在测试中设置一个运行循环，并且还需要能够为异步代码指定该运行循环。否则，回调将不会发生，因为它们是在运行循环上执行的。

我想你可以在循环中运行运行循环一段很短的时间。并让回调设置一些共享状态变量。或者甚至可能只是简单地要求回调终止运行循环。这样你就知道测试已经结束了。您应该能够通过在一定时间后停止循环来检查超时。如果发生这种情况，则发生超时。

我从来没有这样做过，但我想我很快就会这样做。请分享您的结果:-)

Answer 6

如果您使用 AFNetworking 或 ASIHTTPRequest 等库，并通过 NSOperation （或这些库的子类）管理您的请求，那么使用 NSOperationQueue 在测试/开发服务器上测试它们很容易：

在测试中：

// create request operation

NSOperationQueue* queue = [[NSOperationQueue alloc] init];
[queue addOperation:request];
[queue waitUntilAllOperationsAreFinished];

// verify response

这实际上运行一个runloop 直到操作完成，允许所有回调像平常一样在后台线程上发生。

Answer 7

为了详细说明@St3fan的解决方案，您可以在发起请求后尝试：

- (BOOL)waitForCompletion:(NSTimeInterval)timeoutSecs
{
    NSDate *timeoutDate = [NSDate dateWithTimeIntervalSinceNow:timeoutSecs];

    do
    {
        [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:timeoutDate];
        if ([timeoutDate timeIntervalSinceNow] < 0.0)
        {
            break;
        }
    }
    while (!done);

    return done;
}

另一种方式：

//block the thread in 0.1 second increment, until one of callbacks is received.
    NSRunLoop *theRL = [NSRunLoop currentRunLoop];

    //setup timeout
    float waitIncrement = 0.1f;
    int timeoutCounter  = (int)(30 / waitIncrement); //30 sec timeout
    BOOL controlConditionReached = NO;


    // Begin a run loop terminated when the downloadComplete it set to true
    while (controlConditionReached == NO)
    {

        [theRL runMode:NSDefaultRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:waitIncrement]];
        //control condition is set in one of your async operation delegate methods or blocks
        controlConditionReached = self.downloadComplete || self.downloadFailed ;

        //if there's no response - timeout after some time
        if(--timeoutCounter <= 0)
        {
            break;
        }
    }

Answer 8

我发现使用起来非常方便 https://github.com/premosystems/XCAsyncTestCase

它添加了三个非常方便的XCTestCase 的方法

@interface XCTestCase (AsyncTesting)

- (void)waitForStatus:(XCTAsyncTestCaseStatus)status timeout:(NSTimeInterval)timeout;
- (void)waitForTimeout:(NSTimeInterval)timeout;
- (void)notify:(XCTAsyncTestCaseStatus)status;

@end

允许非常干净的测试。项目本身的一个例子：

- (void)testAsyncWithDelegate
{
    NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.google.com"]];
    [NSURLConnection connectionWithRequest:request delegate:self];
    [self waitForStatus:XCTAsyncTestCaseStatusSucceeded timeout:10.0];
}

- (void)connectionDidFinishLoading:(NSURLConnection *)connection
{
    NSLog(@"Request Finished!");
    [self notify:XCTAsyncTestCaseStatusSucceeded];
}

- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error
{
    NSLog(@"Request failed with error: %@", error);
    [self notify:XCTAsyncTestCaseStatusFailed];
}

Answer 9

我实施了 Thomas Tempelmann 提出的解决方案，总体来说它对我来说效果很好。

然而，有一个问题。假设要测试的单元包含以下代码：

dispatch_async(dispatch_get_main_queue(), ^{
    [self performSelector:selector withObject:nil afterDelay:1.0];
});

选择器可能永远不会被调用，因为我们告诉主线程锁定直到测试完成：

[testBase.lock lockWhenCondition:1];

总的来说，我们可以完全摆脱 NSConditionLock 并简单地使用 GHAsyncTestCase 类代替。

这就是我在代码中使用它的方式：

@interface NumericTestTests : GHAsyncTestCase { }

@end

@implementation NumericTestTests {
    BOOL passed;
}

- (void)setUp
{
    passed = NO;
}

- (void)testMe {

    [self prepare];

    MyTest *test = [MyTest new];
    [test run: ^(NSError *error, double value) {
        passed = YES;
        [self notify:kGHUnitWaitStatusSuccess];
    }];
    [test runTest:fakeTest];

    [self waitForStatus:kGHUnitWaitStatusSuccess timeout:5.0];

    GHAssertTrue(passed, @"Completion handler not called");
}

更干净并且不会阻塞主线程。

Answer 10

我刚刚写了一篇关于此的博客文章（事实上，我创建了一个博客，因为我认为这是一个有趣的主题）。我最终使用了方法调配，这样我就可以使用任何我想要的参数来调用完成处理程序，而无需等待，这对于单元测试来说似乎很有用。像这样的东西：

- (void)swizzledGeocodeAddressString:(NSString *)addressString completionHandler:(CLGeocodeCompletionHandler)completionHandler
{
    completionHandler(nil, nil); //You can test various arguments for the handler here.
}

- (void)testGeocodeFlagsComplete
{
    //Swizzle the geocodeAddressString with our own method.
    Method originalMethod = class_getInstanceMethod([CLGeocoder class], @selector(geocodeAddressString:completionHandler:));
    Method swizzleMethod = class_getInstanceMethod([self class], @selector(swizzledGeocodeAddressString:completionHandler:));
    method_exchangeImplementations(originalMethod, swizzleMethod);

    MyGeocoder * myGeocoder = [[MyGeocoder alloc] init];
    [myGeocoder geocodeAddress]; //the completion handler is called synchronously in here.

    //Deswizzle the methods!
    method_exchangeImplementations(swizzleMethod, originalMethod);

    STAssertTrue(myGeocoder.geocoded, @"Should flag as geocoded when complete.");//You can test the completion handler code here. 
}

博客条目对于任何关心的人。

Answer 11

看起来 Xcode 6 将解决这个问题。 https://developer.apple.com /library/prerelease/ios/documentation/DeveloperTools/Conceptual/testing_with_xcode/testing_3_writing_test_classes/testing_3_writing_test_classes.html

Answer 12

我的答案是，从概念上讲，单元测试不适合测试异步操作。异步操作（例如向服务器发出请求并处理响应）不是在一个单元中发生，而是在两个单元中发生。

要将响应与请求关联起来，您必须以某种方式阻止两个单元之间的执行，或者维护全局数据。如果您阻止执行，则您的程序将无法正常执行，并且如果您维护全局数据，则您添加了本身可能包含错误的无关功能。这两种解决方案都违反了单元测试的整体理念，并要求您将特殊的测试代码插入到您的应用程序中；然后在单元测试之后，您仍然需要关闭测试代码并进行老式的“手动”测试。花在单元测试上的时间和精力至少被浪费了一部分。