NUnit を使った開発とテスト

C# でクラスライブラリを開発することになった。テスティングフレームワークである NUnit を使ってテストコードを書きながら開発したい。

- NUnit を使うと何がいいのか

テストの結果を可視化しやすい。
NUnit というフレームワークに則ってテストできる。

上記二点がテスティングフレームワークを使う理由。

「テストコードを使って、自動的にテストができる」というのは、テスティングフレームワークの利点ではない。「コードをテストするためのコード」すなわちテストコードを書いてテストするというのは、プログラマなら無意識にやってるはず。

テスティングフレームワークは、テストコードの書き方とテスト結果の出力形式を規定してくれるだけ。些細なことに思えるかもしれないが、この規定するということは重要なことだ。テスティングフレームワークを使わずに独自のルールに則って書かれたテストコードは、テスティングフレームワークのルールに則って書かれたテストコードに比べると、書いた人以外には理解しにくい。テスト結果の出力形式についても同様。

テスティングフレームワークを使って書かれたテストコードは、その構造についてある程度予想がつく。テスト結果の出力についても、どこに注意を向ければよいかわかる。ルールに則って書かれてるんだから当たり前。それがテスティングフレームワークを使う理由だ。もちろん、テスティングフレームワークが提供する便利な機能を利用するのも理由の一つではある。

たとえば、ASP.NET を使わなくてもウェブアプリケーションは書ける。でも、ASP.NET を使うとフレームワークに則ったウェブアプリケーションを書ける。その結果、アプリケーションは共通の基盤に則った構造を持ち、構造と出力形式について予想が付く。

- NUnit のインストール

NUnit のインストールは超簡単。

NUnit - Home
http://nunit.org/

ダウンロードページから NUnit-2.2.0.msi http://www.nunit.org/downloads/NUnit-2.2.0.msi をダウンロード。Next 連打でインストール完了。

- NUnit の使い方の概要

NUnit がやってくれるのは、ルールに則って書かれたテストコードを実行してその結果を表示してくれることだけ。テストコードは NUnit が自動生成してくれるわけじゃないので、自分で書く必要がある。NUnit を使ったテストしながらの開発は、以下のような流れで進む。

テストコードを書く。
ここで NUnit でテストを実行。テストが失敗することを確認する。実装がないので、すべてのテストが失敗するはず。

適宜 NUnit でテストを実行しながら実装コードを書く。
全部のテストが成功すれば完了。

- NUnit の使い方の具体例

実装コード用のクラスとは別に、テストコードを記述したクラスを用意する。

テストコードを記述したクラスから、実装コードを記述したクラスを「プロジェクト参照」で参照する。
ソリューションエクスプローラ上にある、テストコードを記述したクラスの「参照設定」を右クリックして「参照の追加」を選択。「プロジェクト」タブから実装コードを記述したクラスを選択する。

テストコードを記述したクラスから、NUnit の DLL を参照する。
ソリューションエクスプローラ上にある、テストコードを記述したクラスの「参照設定」を右クリックして「参照の追加」を選択。「.NET」タブから nunit.framework を選択する。
テストコードを記述したクラスで using NUnit.Framework; を追加しておく。

実装コードを記述したクラスと、テストコードを記述したクラスの名前空間は同じものにしておく。

いちおうこれで準備完了。

- NUnit GUI の自動起動

デバッグ実行時に NUnit GUI が起動するように設定する。これをやらなくても NUnit を使うことはできるけど、やっておいた方が便利。

ソリューションエクスプローラから、テストコードを記述したプロジェクトのプロパティを開く。
構成プロパティのデバッグの開始動作のデバッグモードを「プロジェクト」から「プログラム」に変更して適用ボタンを押す。
デバッグモードが「プログラム」になると、スタートアプリケーションのパスを指定できるようになるので、NUnit GUI のパスを指定する。私は以下をコピー & ペーストした。

C:\Program Files\NUnit 2.2\bin\nunit-gui.exe

あとはテストコードを記述したプロジェクトを「スタートアッププロジェクト」に指定してデバッグ実行すると、自動的に NUnit GUI が立ち上がる。ただ、立ち上がるだけで自動的にテストを実行してはくれないみたい。自動的にやる方法はあると思うけど調べてない。

2005年06月15日追記。自動起動するように設定するよりも、NUnit GUI あらかじめ起動しておく方が私に合っていることに気づいた。2005-06-15 の「NUnit はテストコードの更新を自動検出してくれる」を参照。

- NUnit 用のテストコードの書き方の概要

[TestFixture] 属性を付けたクラスは、テストクラスとして NUnit に認識される。
[Test] 属性を付けたメソッドは、テストメソッドとして NUnit に認識される。
[Test] 属性を付けたメソッド中で NUnit.Framework.Assert() を使って値をテストする。