iUnitTestでやった事 - リンゴの水やり？(はてな)

2009-11-26 木

■[iUnitTest]iUnitTestでやった事

須藤さんにコメントをもらったのに行けないので、実際の議題にマッチするか分かりませんがこちらにまとめておきます。

テーマが、「テスティングフレームワークに必要なもの - 書きやすさとデバッグのしやすさ」とあるので、書きやすさとデバックのしやすさについて書きます。

書きやすさ

iUnitTestはIUTTestクラスから派生したクラスのtestから始まるメソッドをメタ情報から探し出して来て自動的にテストします。

慣習的*1にはテストクラス名はTestで終わるようにしますが、IUTTestのサブクラスであれば名称は問いません。

// クラス名はTestで終わっているが、慣習的な物でBarとかでも良い
@interface FooTest : IUTTest {
}
@end

@implementation FooTest

- (void)testHoge
{
    ASSERT(YES);
}

@end

必要なテストを追加するだけでiUnitTestがテストしてくれます。

一時的に外したい場合はtestXXXという名称を_testXXXの様に_を付けてtestから始まらない様にする事で外す事ができます。反面、戻すのを忘れてテストし忘れという事があるのは注意が必要です。

iUnitTestはiPhoneのアプリケーションとしてテストを実行します*2。この点は他と大きく異なる点で、面食らうかも知れません。

Xcodeのテンプレートを用意しているので、それを用いてもらえれば雛型が出来上がります。

そして、アプリ用プロジェクトとテスト用プロジェクトの2本立てで進めます。

テスト用プロジェクトにはアプリのソースコードを参照という形で追加します。そうする事でテスト用プロジェクト内でソースを修正してもアプリ用プロジェクトのソースに反映される*3様にします。

反面、後からソースを追加した場合は、同期がとれないので他のプロジェクトでも追加する必要があります。私は、1つのフォルダにまとめて、変更があった場合は一旦フォルダごと外して、もう一度追加するという事をしたりします。このやり方はXcodeでRailsが参考になると思います。

この方法の利点はアプリ用のプロジェクトに不要なコードが一切入らないので見通しが良い事です。

書きやすさというテーマから外れてしまってる気も・・・

デバッグのしやすさ

iUnitTestはiPhone アプリケーション内に結果が表示されます。失敗すると、ソースファイルと行数が表示されるので、当初はその情報を元に該当箇所を探していました。この作業はけっこうめんどうなので、どうにかしたいと思っていて、opencodeというサービスを立ち上げて通信でXcodeに情報を伝える様にしました。こうする事で、iPhoneシミュレータ上の失敗した表示のセルをクリックするとXcode上で該当コードが表示される様になりました。こちらで書いてます。

その後、どんどんテストを追加してASSERTの回数が1000とか2000になってくると、終了するまで時間がかかる様になるので、時間短縮する為の方法を2つ追加しました。

一つ目は、一度全部テストし、失敗が出ると次回は失敗したテストだけをテストします。失敗したテストが全て通るとまた全部のテストを行う様にし、不具合のあるうちは、不具合箇所だけをテストし時間短縮出来る様にしました。

二つ目は一つ目の特性を生かして、わざと失敗するテストを追加して新しく追加したクラスだけテストする方法です。

他のユニットテストでは特定のクラスやメソッドだけテストするコマンドやインターフェイスが用意されていたりしますがiUnitTestにはありません。iPhoneソフトなのでUIを追加したとろで操作が面倒になるのが目に見えているし、Xcode上でソースをメンバーから外す方法もあるので、ソースコードにマークを入れる事で対応する様にしました。

// Uncomment it, if you want to test this class except other passed test classes.
//#define TESTS_ALWAYS
#ifdef TESTS_ALWAYS
- (void)testThisClassAlways { ASSERT_FAIL(@"fail always"); }
+ (BOOL)forceTestsAnyway { return YES; }
#endif

テンプレートから生成したテストファイルには上のコードがあり、#define TESTS_ALWAYSのコメントを外すと、testThisClassAlwaysをテストする様になります。最初は全てのテストを実行しますが、ダミーのtestThisClassAlwaysが失敗するので、次からはそのクラスだけテストする様になります。

本当はスタックトレースとか表示出来れば良いなと思う所もありますが、Xcodeでブレークポイントを設定すれば、Xcode上で見れるのでXcodeを使った方が便利だと思います。

自分が工夫した所はこんな所です。