mobilejazz-contrib/XCTest-Async

XCTest category that adds some macros to help testing async calls

#XCTest-Async

This category expands the XCTest to add some macros to help testing asynchronous methods.

##Installation and usage

1. Add XCTest+Async.h to your project.

2. Add this line to your XCTest subclass

   #import "XCTest+Async.h" 

3. That's it, you can now start using the macros.

##Available Macros

• ASYNC_TEST_START: Initializes a test method to be able to test asynchronous calls. Should be placed at the begining of the method.
• ASYNC_TEST_DONE: Let's the method know the asynchronous call has finished.
• ASYNC_TEST_END: Sets a timeout of 10 seconds in which the method will wait for the ASYNC_TEST_DONE to be called. Should be placed at the end of the method.
• ASYNC_TEST_END_LONG_TIMEOUT: Sets a timeout of 120 seconds in which the method will wait for the ASYNC_TEST_DONE to be called. Should be placed at the end of the method.

##Examples

The following example shows how to get the information from this repository using the GitHub API and then it converts it to a dictionary.

- (void)testExample
{
	ASYNC_TEST_START;
	dispatch_queue_t kBgQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
	dispatch_async(kBgQueue, ^{
		NSData* repositoryData = [NSData dataWithContentsOfURL:[NSURL URLWithString:@"https://api.github.com/repos/mobilejazz/XCTest-Async"]];
		NSError* error;
		if (repositoryData) {
			NSDictionary* repositoryInfo = [NSJSONSerialization JSONObjectWithData:repositoryData
																		   options:kNilOptions
																			 error:&error];
			if (error) {
				XCTFail(@"The data was not a dictionary");
			}
			else {
				XCTAssertNotNil(repositoryInfo, @"XCTest-Async repo:");
				NSLog(@"Repos %@", repositoryInfo);
			}
		}
		else {
			XCTFail(@"The operation couldn't be completed");
		}
		ASYNC_TEST_DONE;
	});
	ASYNC_TEST_END;
}