DocTest 1.0 For Ruby リリース

作者 Sebastien Auvray , 翻訳者 編集部 投稿日 2008年7月6日

セクション

設計/アーキテクチャ,

デベロップメント

トピック

Ruby ,

動的言語 ,

ユニットテスト ,

言語 ,

ソフトウェアテスト ,

TDD ,

プログラミング ,

テスト ,

BDD

Python標準ライブラリに組み込まれた各種の DocTest Rubyインプリメンテーションは､1年前からTom Locke(リンク)、Roger Packによって(リンク)利用されるようになり、その後Dr Nicも(リンク)追随した。

DocTestを使用すれば、標準のインタープリタシェル（IRB for Ruby）からの出力に基づいて容易にテストを生成し、docstringにカットアンドペーストすることが可能である。

次のように IRB テスト出力を関数のコメントとしてコピー/ペーストする。

# doctest: Add 5 and 5 to get 10# >> five_and_five
# => 10
def five_and_five
  5 + 5
end

後でテストを実行することができる。

$ rubydoctest five.rb
=== Testing 'five.rb'...
 OK  | Add 5 and 5 to get 10
1 comparisons, 1 doctests, 0 failures, 0 errors

これは、gitリポジトリからの(リンク)最新のソースを使用して実行される。最新のgemはまもなく利用可能になる。


このようなdocstring主導型のテストのプラス面としては、

• IRBライブテストに精通している場合には、利用価値があり、使いやすい。
• テストを一箇所で確認できる。
• 単純である。

... マイナス面としては、

• 大規模なdocstringは避け、個別のテストファイルに置く必要がある。
• 複雑なテストアサーションが利用できない場合がある。
• 大規模な出力のテストが面倒である。
  

Duane Johnsonは(リンク)、バージョン1.0を(リンク)利用可能するために Tom Lockeのリポジトリに変更をマージした。


DocTestの使用法を実演するスクリーンキャストが(リンク)利用できる。

InfoQは、Duane Johnson氏にインタビューし、DocTestとdocstring主導型テストについて聞いた。


 InfoQ: 最初に、なぜDocTestを作成したのですか? 前の2つのインプリメンテーションを考察されたそうですが。

Duane Johnson: わたしは現在、テストとドキュメンテーションがほとんど含まれていない大きなRubyプロジェクト（memorypress.com(リンク)）の改良に取り組んでいます。このプロジェクトをクリーンアップグレードするには、意図せずプログラムを破損することがないように、ある種のテストを実施する必要があります。問題は、作業内容とそれらのテストへの取り組み方が必ずしも明確でないために、わたしが「テスト」にかける大半の時間がirbコンソールで費やされることです。つまり、テストは、わたしにとって試験的な作業であり、動作方法を正式に定義すると同時に動作方法を確認する必要があるのです。Ruby DocTestは、成功した試験結果をコードベースにコピーアンドペーストして、完成したテストをチェックすることができるため、完全なコンビネーションです。

• 次へ >