CppUnit

JavaのJUnitをC++に移植したのがCppUnitだよ。何そのJUnitって？
SmalltalkのSUnitをもとに作られたのがJUnitだよ。何そのSUnitって？
要は単体テスト（Unit Test）をうまいこと自動化してくれるC++用のフレームワークがCppUnit。
XP(Extreme Programming）のテスト駆動開発(TDD)を考えているひとは是非取り入れたいものなんだよ。
よくわからないからまずは使ってみるよ。

インストール

debian環境でCppUnitを使うためにlibcppunitをインストール。

$ sudo aptitude install libcppunit-1.12.1 libcppunit-dev

libcppunit-1.12.1だけじゃなんかダメだったんでlibcppunit-devも。
必要ならlibcppunit-docも入れればいいと思うよ。

ドキュメント

CppUnit Documentation
一応ここにいろいろ書いてある。

Hello world

何はともあれCppUnitでテストしてみる。
An Hello, world program for CppUnit
にあるコードをHelloWorld.cppという名前で作成

//--- Hello, World! for CppUnit

#include <iostream>

#include <cppunit/TestRunner.h>
#include <cppunit/TestResult.h>
#include <cppunit/TestResultCollector.h>
#include <cppunit/extensions/HelperMacros.h>
#include <cppunit/BriefTestProgressListener.h>
#include <cppunit/extensions/TestFactoryRegistry.h>

class Test : public CPPUNIT_NS::TestCase
{
  CPPUNIT_TEST_SUITE(Test);
  CPPUNIT_TEST(testHelloWorld);
  CPPUNIT_TEST_SUITE_END();

public:
  void setUp(void) {}
  void tearDown(void) {} 

protected:
  void testHelloWorld(void) { std::cout << "Hello, world!" << std::endl; }
};

CPPUNIT_TEST_SUITE_REGISTRATION(Test);

int main( int ac, char **av )
{
  //--- Create the event manager and test controller
  CPPUNIT_NS::TestResult controller;

  //--- Add a listener that colllects test result
  CPPUNIT_NS::TestResultCollector result;
  controller.addListener( &result );        

  //--- Add a listener that print dots as test run.
  CPPUNIT_NS::BriefTestProgressListener progress;
  controller.addListener( &progress );      

  //--- Add the top suite to the test runner
  CPPUNIT_NS::TestRunner runner;
  runner.addTest( CPPUNIT_NS::TestFactoryRegistry::getRegistry().makeTest() );
  runner.run( controller );

  return result.wasSuccessful() ? 0 : 1;
}

コンパイル

$ g++ -o HelloWorld HelloWorld.cpp　-lcppunit 

-lcppunitがポイントね。

実行

$ ./HelloWorld
Test::testHelloWorldHello, world!
 : OK

上のやり方でコンパイルや実行がうまくいかない場合はインクルードパスとかライブラリパスを確認してね。

解説

あ、うん。OKだけど？でっていう？
一応解説をダラダラと書くよ。すげー読む気失せるよ。

CPPUNIT_TESTナントカっていうのがテストを簡単に書くためのマクロなんだけど、これを使うために
cppunit/extensions/HelperMacros.h
をincludeする。その他のcppunitのincludeはmainテスト実行部分のためのものだよ。

■クラス宣言

テストのためのクラスTestはCppUnitのTestCaseというクラスを継承して作るよ。
CPPUNIT_NSはCppUnitの名前空間、とはいっても実は
#define CPPUNIT_NS CppUnit
としてるだけだったりする。

CPPUNIT_TEST_SUITE(クラス名);
ここから一連のテストケース（テストスイート）を書くよーって言ってる。

CPPUNIT_TEST(メソッド名);
このメソッドのテストするよー宣言。上の例ではtestHelloWorldを宣言

CPPUNIT_TEST_END();
テストケースはここまでだよーって言ってる。上の例ではCPPUNIT_TEST(testHelloWorld);ひとつだけなんだけど、
他にもテストしたいメソッドがあれば、CPPUNIT_TEST_SUITE～CPPUNIT_TEST_ENDの間に並べて宣言しておけばいいよ。

setUp()とtearDown()はテストケースの事前処理と事後処理をそれぞれ書けるよ。
ここでは”Hello, World!”表示するだけなので、特に何もしてないよ

protected:に続くtestHelloWorldがテストケースになるメソッド。CPPUNIT_TEST(メソッド名);で書いたメソッドを宣言する。
ここでは実装も合わせて書いてるけど、クラス宣言の外で実装してもOKだよ。

クラス宣言ここまで。

CPPUNIT_TEST_SUITE_REGISTRATION(テストスイート名);
で、以上のテストスイートを登録しておく。

■main
ここからテスト実施部分のmain。だけど例によって書くの面倒くさくなってきたからテキトー。
controllerがテストのコントローラー
テスト結果resultとテスト進捗progressにはそれぞれイベントを受け取るためのリスナをつけとく。
テストランナーrunnerにテストスイートに登録されてるテストを持ってきて、controllerをrunすれば、テストケースが実行されるわけ。
で、テストがうまくいってれば最後に0を返して、コケてたら1を返す。

単に”Hello, World!”出力してるだけなのでピンと来ないよね
そういう人は、C++界では言わずと知れたεπιστημη（えぴすてーめー）氏の
第2回 C++アプリケーションの効率的なテスト手法（CppUnit編）
を見ればいいと思うんだ。値が期待通りか確認するケースとか、NGになる場合のケースなんかも紹介してるよ。
というか最初からこれ見ればいいような気もするんだ。今さらだけど。

テスト結果をXML形式で出力

で、επιστημη氏のサンプルでは、最後にreturnする前に結果を標準出力に吐くコードが入ってる。

#include <cppunit/CompilerOutputter.h>
//...
// output test result
  CPPUNIT_NS::CompilerOutputter outputter( &result, CPPUNIT_NS::stdCOut() );
  outputter.write();
//...

これを少し改造してXML形式で出力するように変更。

#include <cppunit/XmlOutputter.h>
  //....
  // output test result
  std::ofstream ofs("result.xml");
  CPPUNIT_NS::XmlOutputter outputter(&result, ofs,"UTF-8");
  outputter.write();
  //....

テスト結果をカレントディレクトリにresult.xmlという名前のXMLを出力するよ。

<?xml version="1.0" encoding='UTF-8' standalone='yes' ?>
<TestRun>
  <FailedTests></FailedTests>
  <SuccessfulTests>
    <Test id="1">
      <Name>Test::testHelloWorld</Name>
    </Test>
  </SuccessfulTests>
  <Statistics>
    <Tests>1</Tests>
    <FailuresTotal>0</FailuresTotal>
    <Errors>0</Errors>
    <Failures>0</Failures>
  </Statistics>
</TestRun>

なんでこれを出したかというと、この結果ファイルをHudsonに渡したかったの。Hudsonとの連携はまたあらためて。

テスト駆動開発

CppUnitでテストをするHello Worldを紹介したわけだけど、
大事なのは、しれっと書いてるtestHelloWorldの実装部分なんだ。これがすなわちテストケース。

このケース部分を早い段階で書いておいて、このテストをパスするように実装をしていくというのが、テスト駆動開発（TDD:Test Driven Development)という開発手法。
ケースがきちんと書けないうちは、仕様がはっきり定まっていないということになるわけで、早い段階であいまいな点を洗い出すきっかけになるんだ。
そしてあらかじめケースを書いておけば、いろいろな変更を加えた場合のリグレッションテストが楽になり、プロジェクト後期でその威力を発揮してくる。
はっきりいってプロジェクト中盤はかったるい。仕様が変更になる度、コードもケースも書き直さなくてはならなかったりするからね。
でも長期での開発保守を考えるならば、あらかじめ仕込んでおくと幸せになれるんだと思うよ。多分。ぜひプロジェクト開始時には一度検討して欲しいと思う。