WindowsプログラマのWebアプリへの挑戦日記。あとパンとか。

Archive for the ‘CppUnitの導入’ Category

ユニットテストの実践： CppUnitの導入（実装編）

木曜日, 5月 1st, 2008 Posted in C++, CppUnitの導入 | 1 Comment »

前回、CppUnitを導入しました。今回は実装編です。

本来はテストファーストで、CppUnitでテストケースを実装したあとにメインの実装を行うものなんでしょうけど、今回はすでに実装が終わったプロジェクトのユニットテストを行いました。今回作成したテストアプリはGUI版です。

まずはVCでプロジェクトを新規作成します。MFC AppWizard(exe)でダイアログベースで作成します。

[ﾌﾟﾛｼﾞｪｸﾄ]-[設定]から[ﾌﾟﾛｼﾞｪｸﾄの設定]ダイアログを起動し、[C/C++]タブのｶﾃｺﾞﾘ[ｺｰﾄﾞ生成]で使用するﾗﾝﾀｲﾑ ﾗｲﾌﾞﾗﾘで[ﾏﾙﾁｽﾚｯﾄﾞ(DLL、ﾃﾞﾊﾞｯｸﾞ)]を選択します。

同じく[C/C++]タブのｶﾃｺﾞﾘ[ﾌﾟﾛｾｯｻ]ｲﾝｸﾙｰﾄﾞﾌｧｲﾙのﾊﾟｽに、メインのプロジェクトのパスを入力します。

[ﾘﾝｸ]タブのｶﾃｺﾞﾘ[一般]ｵﾌﾞｼﾞｪｸﾄ･ﾗｲﾌﾞﾗﾘ ﾓｼﾞｭｰﾙに、設定の対象がDebugの場合、

code
< view plain text >
  1. cppunitd.lib testrunnerd.lib

Releaseの場合、

code
< view plain text >
  1. cppunit.lib testrunner.lib

と入力します。

ここで、メインアプリのプロジェクトをワークスペースに追加しときます。そして[ﾌﾟﾛｼﾞｪｸﾄ]-[依存関係]で、テストプロジェクトがメインプロジェクトに依存するように設定します。

テストアプリのStdAfx.hに次のincludeを記載します。

code
< view plain text >
  1. #include <cppunit/ui/mfc/TestRunner.h>
  2. #include <cppunit/ui/text/TestRunner.h>
  3. #include <cppunit/extensions/TestFactoryRegistry.h>
  4. #include <cppunit/extensions/HelperMacros.h>
  5. #include <cppunit/CompilerOutputter.h>

C++アプリケーションの効率的なテスト手法（CppUnit編）なんかには、StdAfx.hは削除するとの記載がありますが、ボクの環境では削除しなくても問題ないです。てか削除するとダイアログベースのアプリなんでビルドできませんので。コンソールアプリの場合は必要ないでしょうね。

テストアプリのアプリクラス（CWinAppを継承しているクラス）のInitInstance()を次のように書き換えます。

code
< view plain text >
  1. BOOL CTestApp::InitInstance()
  2. {
  3.     AfxEnableControlContainer();
  4.  
  5. #ifdef _AFXDLL
  6.     Enable3dControls();         // 共有 DLL 内で MFC を使う場合はここをコールしてください。
  7. #else
  8.     Enable3dControlsStatic();   // MFC と静的にリンクする場合はここをコールしてください。
  9. #endif
  10.  
  11.     CPPUNIT_NS::MfcUi::TestRunner runner;
  12.     runner.addTest( CPPUNIT_NS::TestFactoryRegistry::getRegistry().makeTest() );
  13.     runner.run();
  14.  
  15.     return FALSE;
  16. }

メインプロジェクトのテスト対象となるクラスと対になるテスト用クラスを作成するのが流儀のようです。次のようなクラスを作成します。

code
< view plain text >
  1. class CMainClass;
  2. class CTestClass : public CPPUNIT_NS::TestFixture  
  3. {
  4.     CPPUNIT_TEST_SUITE( CTestClass );
  5.     CPPUNIT_TEST( testFunc1 );
  6.     CPPUNIT_TEST( testFunc2 );
  7.     CPPUNIT_TEST_SUITE_END();
  8.  
  9. public:
  10.     CTestClass();
  11.     virtual ~CTestClass();
  12.  
  13.     void setUp();
  14.     void tearDown();
  15.  
  16.     void testFunc1();
  17.     void testFunc2();
  18.  
  19. private:
  20.     CMainClass* m_pApp;
  21. };

CPPUNIT_TEST_SUITEマクロとCPPUNIT_TEST_SUITE_ENDマクロの間にCPPUNIT_TESTマクロで、テスト対象となるテスト用の関数を登録します。setUp()はテスト用関数が実行される直前に呼ばれ、tearDown()はテスト終わったあとに呼ばれます。たとえばsetUp()でCMainClass* m_pAppをnewして、tearDown()でdeleteするような使い方になります。

では実装の方は、次のような感じ。

code
< view plain text >
  1. CPPUNIT_TEST_SUITE_REGISTRATION( CTestClass );
code
< view plain text >
  1. void CTestClass::setUp()
  2. {
  3.     m_pApp = new CMainClass();
  4. }
  5.  
  6. void CTestClass::tearDown()
  7. {
  8.     delete m_pApp;
  9. }
  10.  
  11. void CTestClass::testFunc1()
  12. {
  13.     CPPUNIT_ASSERT_EQUAL( TRUE, m_pApp->Func1( 0 ) );
  14.     CPPUNIT_ASSERT_EQUAL( FALSE, m_pApp->Func1( -1 ) );
  15. }
  16.  
  17. void CTestClass::testFunc2()
  18. {
  19.     CPPUNIT_ASSERT( m_pApp->Func2( 0 ) );
  20.     CPPUNIT_ASSERT( m_pApp->Func2( -1 ) );
  21. }

CPPUNIT_ASSERT_EQUALは、第一引数と第二引数が等しい場合にテスト成功。違ったらテスト失敗となります。CPPUNIT_ASSERTは、引数がTRUEだったらテスト成功。FALSEだったらテスト失敗となります。ほかにも、

code
< view plain text >
  1. CPPUNIT_ASSERT
  2. CPPUNIT_ASSERT_MESSAGE
  3. CPPUNIT_FAIL
  4. CPPUNIT_ASSERT_EQUAL_MESSAGE
  5. CPPUNIT_ASSERT_DOUBLES_EQUAL

などあります。ここでは詳しくは省略。

さて、ここでビルドするとリンクエラーが発生します。メインプロジェクトのCMainClass::Func1()やCMainClass::Func2()にリンクできないと。ここでしばらく悩みましたが、どうやらメインプロジェクトのCMainClassのCPPファイルを、テストプロジェクトに追加しないといけないようです。なんかこれ気持ち悪いんですけど。しょうがないんですかね。

これでちゃんとビルドが通ります。

実行するとダイアログが起動され、Browseからテストケースが確認できます。通常はALL Testsを選んでおいて、Autorun at startupにチェックを入れておけば、起動と同時にすべてのテストを実行してくれるので楽です。

【関連エントリ】
ユニットテストの実践： CppUnitの導入（インストール編）

ユニットテストの実践： CppUnitの導入（インストール編）

金曜日, 4月 25th, 2008 Posted in C++, CppUnitの導入 | 3 Comments »

恥ずかしながら今までユニットテストツールを使ったことがなかったんですが、soraさんおすすめの、アジャイルプラクティス 達人プログラマに学ぶ現場開発者の習慣を読んだら、いても立ってもいられなくなり、会社の環境にCppUnitを導入しました。

CppUnitとは、C++のユニットテストを自動化してくれるステキなツールです。

導入編

導入に関しては、それほど難しくないです。ボクが今回入れた環境は、Visual C++ 6.0です。手順としては以下の通り。

CppUnitをダウンロード。実は去年の夏くらいにダウンロードしてましたが、当時は導入をあきらめてました。今回はこのときにダウンロードしたCppUnitを使いました。（cppunit-1.12.0.tar.gz）

ダウンロードしたファイルを解凍します。解凍先を\CppUnit\とします。

次のプロジェクトをVC6で開いてビルドします。

code
< view plain text >
  1. \CppUnit\examples\msvc6\CppUnitTestApp\CppUnitTestApp.dsp

\CppUnit\lib以下にいろいろなDLLやらLIBやらが作成されます。ちなみにCppUnitTestAppはCppUnit自体のユニットテストです。実行するとGUIが表示されるのでいろいろいじってみましょう。

VCのメニュー[ﾂｰﾙ]-[ｵﾌﾟｼｮﾝ]からｵﾌﾟｼｮﾝダイアログを開き、[ﾃﾞｨﾚｸﾄﾘ]タブの表示するディレクトリ[ｲﾝｸﾙｰﾄﾞﾌｧｲﾙ]に

code
< view plain text >
  1. \CppUnit\include

を、表示するディレクトリ[ﾗｲﾌﾞﾗﾘﾌｧｲﾙ]に、

code
< view plain text >
  1. \CppUnit\lib

を追加します。ここに設定したディレクトリはすべてのプロジェクトに適応されます。プロジェクトごとに設定したい場合は[ﾌﾟﾛｼﾞｪｸﾄの設定]ダイアログでやってください。また、次のファイルを\windows\system32の中へコピーしてください。

code
< view plain text >
  1. testrunnerd.dll
  2. testrunner.dll

次回は実践編です。

【関連エントリ】
ユニットテストの実践： CppUnitの導入（実装編）