GHUnitとは

GHUnitとはMac OS X、 iOS用の単体テストフレームワークです。 Xcode標準のテストフレームワークであるSenTestingKitと互換性があり、標準フレームワークには無い多くの便利な機能を持っています。

SenTestingKitと比べたGHUnitの利点は以下の通りです。

非同期処理のテストが容易
- 通信等のテストを簡単に記述できる
実機上でのテストが容易
- アプリケーションとして端末上で実行される
- メモリ容量の制限等、ハードウェアに影響を受ける処理のテストを行える
テストを部分的に実行可能
- 失敗したテストケースだけ再度実行できる
- メモリリーク箇所や動作速度低下のボトルネック箇所を特定しやすい

pixivのiOSアプリでは、サイズの大きな画像をネットワーク経由で大量に取得する事が多く、メモリ不足による強制終了や、通信不良による動作速度の低下に悩まされていました。

そのため、画像読み込みの不具合解消と効率化を行うべく、テスト用環境としてGHUnitの導入を行いました。

これから実際の使用使用方法について紹介します。

GHUnitの導入

ビルド

最新版はGithubから取得できます。

https://github.com/gabriel/gh-unit

取得したファイルを以下のようにビルドします。

cd ./Project-iOS
make

ビルドに成功すると、以下にフレームワークのディレクトリが生成されます。

./Project-iOS/build/Framework/GHUnitIOS.framework

インストール

インストールページを参考にインストールを行います。インストール方法については割愛します。

非同期テストケースの作成

以下のような、GHAsyncTestCaseのサブクラスを作成します。

#import <GHUnitIOS/GHUnit.h> 
@interface PIXNewtorkTests : GHAsyncTestCase
@end
@implementation PIXNewtorkTests
@end

テスト用メソッド

GHAsyncTestCaseを用いたテストの流れは以下の通りです。

prepareを呼び出す
非同期処理を開始する
waitForStatus:timeout:を呼び出し、完了通知を待つ
非同期処理完了後、notify:forSelector:で完了を通知する

NSURLConnectionで通信を行う場合は、以下のようなテストメソッドを記述します。

- (void)testNSURLConnection
{
  [self prepare];
  NSURL *url = [NSURL URLWithString:@"http://pixiv.net"];
  NSURLRequest *request = [NSURLRequest requestWithURL:url];
  NSURLConnection *connection = [NSURLConnection connectionWithRequest:request delegate:self];
  [connection start];
  [self waitForStatus:kGHUnitWaitStatusSuccess timeout:10.0];
}
- (void)connectionDidFinishLoading:(NSURLConnection *)connection {
  // 成功時
  [self notify:kGHUnitWaitStatusSuccess forSelector:@selector(testNSURLConnection)];
}
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error
{
  // エラー時
  GHTestLog(@"error:%@", error);
  [self notify:kGHUnitWaitStatusFailure forSelector:@selector(testNSURLConnection)];
}
- (void)connection:(NSURLConnection *)connection didReceiveData:(NSData *)data {
  NSString *responseString = [[[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding] autorelease];
  GHTestLog(@"responseString:%@", responseString);
}

iOS5からはNSURLConnectionに、Blocksを利用した非同期通信用メソッドができましたが、そちらでも問題なくテストをすることができます。（以下、ARC環境を想定）

- (void)testWithBlocks
{
  [self prepare];
  NSURL *url = [NSURL URLWithString:@"http://pixiv.net"];
  NSURLRequest *request = [NSURLRequest requestWithURL:url];
  NSOperationQueue *queue = [[NSOperationQueue alloc] init];
  [NSURLConnection sendAsynchronousRequest:request queue:queue completionHandler:^(NSURLResponse *response, NSData *data, NSError *error) {
    if (error) {
      GHTestLog(@"error:%@", error);
      [self notify:kGHUnitWaitStatusFailure forSelector:@selector(testWithBlocks)];
    } else {
      NSString *responseString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
      GHTestLog(@"responseString:%@", responseString);
      [self notify:kGHUnitWaitStatusSuccess forSelector:@selector(testWithBlocks)];
    }
  }];
  [self waitForStatus:kGHUnitWaitStatusSuccess timeout:10.0];
}