Google C++ Testing Framework

テスティングフレームワークの各種処理を含んだライブラリです。

ユーザが実装したソースコードを呼び出すmain関数を含んだライブラリです。

TESTマクロで実行するテストを定義します。

TEST(TestCaseName, TestName1)
{
  /** Do test */
}

TEST(TestCaseName, TestName2)
{
  /** Do test */
}

例えば、クラスをテストする場合には、TestCaseNameにクラス名を、 TestNameにメソッドの正常系のテスト、メソッドの異常系のテスト等を使用 すれば良いと思います。

ここで注意すべき点は、TESTマクロで定義されたテストの実行順序は保証さ れない点です。テスト実行時に生成した乱数で順序がかわります。 あるテストが成功した後で実行されるべきテストがある場合は、ひとつのテ ストとしてまとめなくてはなりません。

doSomethingという名前のメソッドの戻り値がtrueであることを期待する場 合、EXPECT_TRUEマクロを使用します。もしdoSomethingメソッドの戻り値が falseの場合にはテストは失敗し、falseになった旨が結果に出力されます。 EXPECT_FALSEはfalseであることを期待値とするマクロです。

TEST(TestCaseName, TestName)
{ 
  EXPECT_TRUE(doSomething());
}

doSomethingという名前のメソッドの戻り値が1であることを期待する場合、 EXPECT_EQマクロを使用します。EXPECT_TRUE(doSomething() == 1)との違い は、テストが失敗した場合にdoSomethingメソッドの戻り値が何であったか をEXPECT_EQでは結果に表示されます。EXPECT_NEは値が等しくないことを期 待値とするマクロです。

TEST(TestCaseName, TestName)
{ 
  EXPECT_EQ(doSomething(), 1);
}

文字列比較用のマクロです。EXPECT_EQ / EXPECT_NEと同様です。

Google C++ Testing Frameworkのマニュアルを参照して下さい。 条件が成立しない箇所でテストを停止するASSERT_XXXや、外部から与えられ たパラメータをテストで使用する方法等が記載されてます。

gtest.hで定義されているtesting::Testクラスを継承したクラスを定義し、 TEST_Fマクロでクラスに関連したテストを定義します。

class MyClass : public testing::Test {
  /** Define share resource */
};

TEST_F(MyClass, TestName)
{
  /** Do test */
};

TEST_Fで定義したテストではtesting::Testを継承したクラスのprivateフィー ルドにアクセスできない為（TEST_Fマクロはさらにクラスを継承するクラス を定義するマクロになっている？）、TEST_Fで定義したテストで使用するリ ソース用の変数やメソッドはprotectedフィールドやpublicフィールドに定 義する必要があります。

複数のTEST_Fで定義するテスト群で共有する変数はstaticな変数に、各テス トで独自に使用する変数はローカルな変数で定義します。

class MyClass : public testing::Test {
 protected:
  static int gValue;
  int mValue;
};

int MyClass::gValue;

TEST_F(MyClass, TestName1)
{
  mValue = 1; /** Local value for TestName1 */
  gValue = 1; /** Global value for MyClass */
};

TEST_F(MyClass, TestName)
{
  mValue = 2; /** Local value for TestName2 */
  gValue = 2; /** Global value for MyClass */
};

TEST_Fで定義した各テストの実行前にSetUpメソッドが呼ばれ、実行後に TearDownメソッドが呼ばれます。 これらはクラスのコンストラクタやデストラクタでも代替え可能かもしれま せん。 TEST_Fで定義したテスト毎に以下が実行されます。

1. クラスのコンストラクタが呼ばれる。
2. SetUpメソッドが呼ばれる。
3. TEST_Fで定義したテストが実行される。
3. TearDownメソッドが呼ばれる。
4. クラスのデストラクタが呼ばれる。

クラスのグローバルなメソッドです。TEST_Fで定義したテスト群が呼ばれる 前の最初にSetUpTestCaseメソッドが1度だけ呼ばれ、テスト群が呼ばれた後 の最後にTearDownTestCaseメソッドが1度だけ呼ばれます。 テスト群で共有する変数の初期化処理と終了処理を実行するのに用いること ができます。

以下の通りにクラスとテストを定義します。

#include <iostream>
#include <gtest/gtest.h>

class ShareResource : public testing::Test {
 protected:
  static int gValue;
  int mValue;

  static void SetUpTestCase() {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }

  static void TearDownTestCase() {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }

  void SetUp() {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }

  void TearDown() {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }

 public:
  ShareResource() : mValue(1) {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }

  ~ShareResource() {
    std::cout << __PRETTY_FUNCTION__ << std::endl;
  }
};

int ShareResource::gValue = 1;

TEST_F(ShareResource, printValue)
{
  std::cout << "mValue = " << mValue << std::endl;
  std::cout << "gValue = " << gValue << std::endl;
}

TEST_F(ShareResource, addOneAndPrintValue)
{
  mValue += 1;
  gValue += 1;
  std::cout << "mValue = " << mValue << std::endl;
  std::cout << "gValue = " << gValue << std::endl;
}

TEST_F(ShareResource, addTwoAndPrintValue)
{
  mValue += 2;
  gValue += 2;
  std::cout << "mValue = " << mValue << std::endl;
  std::cout << "gValue = " << gValue << std::endl;
}

以下の実行結果が得られました。ただし、各種テストの実行順序は Google C++ Testing Frameworkで保証されておりません。

$ ./tp
Running main() from gtest_main.cc
[==========] Running 4 tests from 2 test cases.
[----------] Global test environment set-up.
[----------] 3 tests from ShareResource
static void ShareResource::SetUpTestCase()
[ RUN      ] ShareResource.printValue
ShareResource::ShareResource()
virtual void ShareResource::SetUp()
mValue = 1
gValue = 1
virtual void ShareResource::TearDown()
virtual ShareResource::~ShareResource()
[       OK ] ShareResource.printValue (0 ms)
[ RUN      ] ShareResource.addOneAndPrintValue
ShareResource::ShareResource()
virtual void ShareResource::SetUp()
mValue = 2
gValue = 2
virtual void ShareResource::TearDown()
virtual ShareResource::~ShareResource()
[       OK ] ShareResource.addOneAndPrintValue (0 ms)
[ RUN      ] ShareResource.addTwoAndPrintValue
ShareResource::ShareResource()
virtual void ShareResource::SetUp()
mValue = 3
gValue = 4
virtual void ShareResource::TearDown()
virtual ShareResource::~ShareResource()
[       OK ] ShareResource.addTwoAndPrintValue (0 ms)
static void ShareResource::TearDownTestCase()
[----------] 3 tests from ShareResource (0 ms total)

[----------] 1 test from hello
[ RUN      ] hello.print
Hello, World
[       OK ] hello.print (0 ms)
[----------] 1 test from hello (0 ms total)

[----------] Global test environment tear-down
[==========] 4 tests from 2 test cases ran. (23 ms total)
[  PASSED  ] 4 tests.