■[リーダブルコード]テストコード：テスト名はテスト機能名

どういうこと？

テスト関数は、テストする「メソッド」や「状況」でひとまとめにします。そして、その名前は以下のようにします。

Test_<対象メソッド名>_<状況>()

どうして？

テスト関数には、テストの内容を表した名前をつけるべきです。テストコードを読む人が、以下のことをすぐに理解できるようにするためです。

• テストするクラス
• テストする関数
• テストする状況やバグ

どうすれば？

テスト関数名は、テスト機能をうまく表現するように命名します。

例えば、「SortAndFilterDocs」というメソッドのテスト関数であれば、まずは「Test_」という接頭辞をつけて情報をひとまとめにします。

void Test_SortAndFilterDocs() {
	...
}

次に、状況に応じてこのテスト関数を分割するかどうかを考えます。分割する場合は、「Test_<関数名>_<状況>()」という形式にします。

void Test_SortAndFilterDocs_BasicSorting() {
	...
}

void Test_SortAndFilterDocs_NegativeValues() {
	...
}
...

長くて変な名前にならないかと怖がることはありません。他のコードから呼び出されるものではないので、長くなっても構いません。テスト関数の名前はコメントだと思えばいいのです。

ほとんどのテスティングフレームワークでは、テストが失敗したらその関数の名前が印字されるようになっています。だから、名前は説明的なほうが役に立ちます。

また、テストコードのヘルパー関数の名前は、アサートを使っているかどうかで分けるようにします。たとえば、「assert() を呼び出しているヘルパー関数は、すべて『Check...()』という名前にして、その他は普通のヘルパー関数のような名前にする」などのルールが考えられます。

Permalink | コメント(0) | トラックバック(0) | 07:05