GoogleTestの使い方と仕組み

技術

GoogleTestの使い方

（今回googlemockの説明はしません）

  1. GoogleTestのソースコードを持ってくる https://github.com/google/googletest

  2. GoogleTestをビルドする GoogleTestのビルド方法は二つある。1. あらかじめコンパイラしてライブラリ化しておく方法と、2. 自分のテストプログラムと同時にコンパイルする方法。

    1. あらかじめビルドする場合は、CMakeを使ってGNU向けのMakefile、もしくはWindowsの場合はVisual Studioのソリューションを作り、ビルドしライブラリ(静的ライブラリの場合gtest.lib)を作っておく。 具体的には、GoogleTestのソースをクローンもしくはダウンロードした際の、トップディレクトリの下にビルド用のディレクトリを作り(buildとする) buildディレクトリに入って cmake ../と打つ。cmake-guiの場合は、ソースディレクトリにGoogleTest自体のディレクトリを、ビルドディレクトリにbuildを選ぶ。出来たMakefile（Visual Studioの場合はソリューションファイル）を実行して作成。
    2. テストプログラムと同時にビルドする場合は、(install directory...)/googletest/src/ にあるgtest-all.ccを、ビルドの対象に設定する。（その際には、(install directory...)/googletest, (install directory...)/googletest/includeをビルド時のインクルードパスに追加することを忘れずに）

    個人的には2. がオススメ。この方法だと、特にWindowsのようなランタイムライブラリの整合のために、テストプログラム側のビルドオプションと、GoogleTest側のビルドオプション(GoogleTestのソリューションファイルでのランタイムライブラリを、マルチスレッドにしたりしなかったり、デバッグにしたりリリースにしたり）のといった変更の必要がなくなるから。

  3. テスト用のメインプログラムと、テストケースごとのテストプログラムを作り、ビルドする。

テスト用メインプログラム

GoogleTestを使ったテストプログラムのメイン関数はこんな感じになる。

#include "gtest/gtest.h"

int main(int argc, char **argv) {
  ::testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}
テストケースの記述

テストケースの記述は、TESTマクロもしくはフィクスチャを利用する場合はTEST_Fというマクロを使い、以下のように記述する。

TEST([TEST_CASE_NAME], [TEST_NAME])
{
  // user defined test routine
}

TEST_F_([CLASSS_NAME], [TEST_NAME])
{
  // user defined test routine
}

とにかくこれを好きなだけ書くと、RUN_ALL_TESTS()によって、全てのテストケースを自動で探して実行して、サマリを出してくれます。 TEST_CASE_NAME, TEST_NAMEには好きな名前を入れられる（サマリに分かりやすく表示するためのもの）。フィクスチャの場合は、[CLASS_NAME]に、フィクスチャに使うクラス名を入れる。 細かい使い方については以下を参照。 http://opencv.jp/googletestdocs/primer.html

GoogleTestの仕組み

一度分かってしまえば簡単なのだけれど、最初はフィクスチャは何の為にどうやって使うのだろう、という人もいると思うのでに、初心者向けに簡単な仕組みを説明します。

まず、フィクスチャというのは、最も良く使われるのは、複数のテストを実行するときに、テスト間で共通に実行する処理だったり、同じデータや変数を共有したい場合に使う。 例えばあるデータを読み込んで、少し変更して保存（シリアライズ）するようなテストで、読み込みは同じなのだけれど、保存はデータ変更の種別によって別々のテストケースとして分けたい、といった場合に、データの読み込み部分は共通化したい。こういうケースである。

こういうテスト間で共通の処理をやりたいケースでは、以下のようにフィクスチャを使ったテストを作る。 つまりユーザーは、テスト間に共通して持たせたいメンバを持ち、共通して実行させたい処理をSerializeTestのSetUp(), TeatDown()メソッドに書く。最後にTEST_Fのテスト関数本体のマクロ引数の一番目として、フィクスチャクラス名を書けば良い。

class SerializeTest : public testing::Test {
protected:
  // member
  FooData foo_data;
  
  // method
  SerializeTest() : foo_data() {}
  ~SerializeTest() {}
  
  virtual void SetUp() {
    openData("name");
    readFooData(&foo_data);
  }
  virtual void TearDown() {
    closeData("name");
  }
};

TEST_F(SerializeTest, change_a_type) {
  foo_data.a_type_data  = new_a_type_data;
  writeFooData(&foo_data);
  checkSerialize(&foo_data);
}

TEST_F(SerializeTest, change_b_type) {
  foo_data.b_type_data = new_b_type_data;
  writeFooData(&foo_data);
  checkSerialize(&foo_data);
}

これでテストを走らせると、RUN_ALL_TESTS()が実行され、TEST_Fのマクロを使って定義されたテスト関数を実行するときには、TEST_Fの引数の最初のクラスがフィクスチャのターゲットクラスとして呼び出されるようになる。 このプロセスの中身は以下のようになっている。

inline int RUN_ALL_TESTS() {
  return ::testing::UnitTest::GetInstance()->Run();
}

この呼び出しを追っていくと、UnitTest::Run()の中で、UnitTestImpl::RunAllTests()が呼び出され、その中で各テストケースを実行するTestCase::Run()、そしてTestInfo::Run()が呼び出されている。 TestInfo::Run()の中で実際に、フィクスチャとして定義したクラスのインスタンスがまず生成され、その時にフィクスチャクラスのコンストラクタも呼び出される。 そしてテスト実行前にSetUp()が実行され、テスト実行後にTearDown()が実行される。

ではここで、どういったクラスのインスタンスが生成されているかは、マクロの内容を追っていくことで分かる。

まず、マクロによってフィクスチャとしてテスト共通で維持すべきクラスの名前が、test_fixture_test_name_Testのように決められて（#defineの中の##は連結。上記の例ではSerializeTest_change_a_type_Testというクラス名になる）、 フィクスチャの定義でユーザーが作ったクラスを親クラスとします（上記の例ではSerializeTestクラスを親クラスとして子クラスの定義が作られる）。

この子クラスの定義では、コンストラクタと、TestBody()メソッド、TestFactoryImplを使って、インスタンスを生成しTestInfo*を返すメソッドが定義される。

そしてマクロ展開の最後が、この子クラスのメソッドのTestBody()のシグニチャ部までとなっており、メソッドの定義が、ユーザーが書いたテストルーチンとなるようになっている。

void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() <-- expanded by Macro
{
  // user defined body routine ...
}

まとめ

つまり、ユーザ視点で簡単にまとめると、各テスト毎にユーザーが書いたフィクスチャクラスがインスタンス化されて、コンストラクタ、SetUp()が実行される。 （テストケース毎では無いので、各テスト毎に毎回インスタンス化され、実行されることに注意。テストケースにつき一度しか実行したくない場合については、staticなメンバとメソッドを使う方法が上級ガイドに記述されている）

そして、テストクラスのTestBody()メソッドとして定義された TEST_F(test_fixture, test_name) の部分が実行され、最後にTearDown()が実行される。 これを全テストケースで繰り返す。以上。

マクロの定義抜粋

#if !GTEST_DONT_DEFINE_TEST
# define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name)
#endif

#define TEST_F(test_fixture, test_name)\
  GTEST_TEST_(test_fixture, test_name, test_fixture, \
              ::testing::internal::GetTypeId<test_fixture>())

#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \
  test_case_name##_##test_name##_Test

// Helper macro for defining tests.
#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\
class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\
 public:\
  GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\
 private:\
  virtual void TestBody();\
  static ::testing::TestInfo* const test_info_ GTEST_ATTRIBUTE_UNUSED_;\
  GTEST_DISALLOW_COPY_AND_ASSIGN_(\
      GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\
};\
\
::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\
  ::test_info_ =\
    ::testing::internal::MakeAndRegisterTestInfo(\
        #test_case_name, #test_name, NULL, NULL, \
        ::testing::internal::CodeLocation(__FILE__, __LINE__), \
        (parent_id), \
        parent_class::SetUpTestCase, \
        parent_class::TearDownTestCase, \
        new ::testing::internal::TestFactoryImpl<\
            GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\
void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody()