その４：アサーションの解説（２） - エンジニアのソフトウェア的愛情

残りのアサーションマクロのうちの、２つのグループの解説です。

無条件の成功と失敗

ここでのマクロは値や式を評価せず、直接に成功あるいは失敗を生成します。

SUCCEED()

成功を生成するマクロです。ただし、このマクロが評価されたとしてもテストが成功したというわけではありません。実際のところ、現時点では利用者にわかる出力もされません。

FAIL()

ADD_FAILURE()

FAILマクロとADD_FAILUREマクロは失敗を生成するマクロです。このうちFAILマクロが評価された場合、失敗が生成されその時点でテストは終了します。ADD_FAILUREマクロが評価された場合は、失敗は生成されますがテストは継続します。

評価方法を指定するアサーション

たとえば、次のように偶数か否かを評価する関数（述語関数）があり、その関数を使って値が偶数か否かテストする場合を考えます。

bool isEven(int n)
{
    return (n % 2) == 0;
}

TEST(MyPredTest, Test1)
{
    int n = 1;
    ASSERT_TRUE(isEven(n));
}

実行結果。

[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from MyPredTest
[ RUN      ] MyPredTest.Test1
test8.cpp:11: Failure
Value of: isEven(n)
  Actual: false
Expected: true
[  FAILED  ] MyPredTest.Test1
[----------] Global test environment tear-down
[==========] 1 test from 1 test case ran.
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] MyPredTest.Test1

このとき、関数が偽を返し、テストが失敗したことはわかりますが、評価された値（ここではnの値）はわかりません。
このような場合のために、評価する値と一緒に述語関数を与えることができるマクロASSERT_PREDn、EXCEPT_PREDnが用意されています。nには評価する値の個数が入り、現時点では１〜５まで用意されています。

Fatal assertion	Nonfatal assertion	Verifies
ASSERT_PRED1(pred1, val1)	EXPECT_PRED1(pred1, val1)	pred1(val1) returns true
ASSERT_PRED2(pred2, val1, val2)	EXPECT_PRED2(pred2, val1, val2)	pred2(val1, val2) returns true
...	...	...

bool isEven(int n)
{
    return (n % 2) == 0;
}

TEST(MyPredTest, Test2)
{
    int n = 1;
    ASSERT_PRED1(isEven, n); // 第一引数に述語関数を、第二引数以降に評価される値を記述
}

実行結果。

[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from MyPredTest
[ RUN      ] MyPredTest.Test2
test8.cpp:17: Failure
isEven(n) evaluates to false, where
n evaluates to 1
[  FAILED  ] MyPredTest.Test2
[----------] Global test environment tear-down
[==========] 1 test from 1 test case ran.
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] MyPredTest.Test2

さらにテスト結果の表示も指定したい場合のためにASSET_PRED_FORMATn、EXCEPT_PRED_FORMATnが用意されています。同様にnには評価する値の個数が入り、現時点では１〜５まで用意されています。

Fatal assertion	Nonfatal assertion	Verifies
ASSERT_PRED_FORMAT1(pred_format1, val1)	EXPECT_PRED_FORMAT1(pred_format1, val1)	pred_format1(val1) is successful
ASSERT_PRED_FORMAT2(pred_format2, val1, val2)	EXPECT_PRED_FORMAT2(pred_format2, val1, val2)	pred_format2(val1, val2) is successful
...	...	...

これらのマクロに与える述語関数は、n個の文字列とn個の値を引数に取り、::testing::AssertionResultを返す関数にします。

::testing::AssertionResult PredicateFormattern(const char* expr1, const char* expr2, ... const char* exprn, T1 val1, T2 val2, ... Tn valn);

ここで文字列（expr1, expr2, ...）には、マクロに与えた式そのままが文字列として格納され、値（val1, val2, ...）には、マクロに与えられた式の値が格納されます。

評価が成功だった場合には、::testing::AssertionSuccess()の戻り値を返します。
評価が失敗だった場合には、::testing::AssertionFailure(const ::testing::Message& msg)の戻り値を返します。ここでmsgは失敗時に出力される文字列で、下記の例のように挿入演算子operator <<を使ってメッセージを構築することができます。

::testing::AssertionResult isEvenF(const char* expr1, int val1)
{
    if((val1 % 2) == 0)
    {
        return ::testing::AssertionSuccess();
    }

    ::testing::Message msg;
    msg << "\"" << expr1 << "\" の値は \"" << val1 << "\" だった。これは偶数じゃない！";
    return ::testing::AssertionFailure(msg);
}

TEST(MyPredTest, Test3)
{
    int n = 1;
    ASSERT_PRED_FORMAT1(isEvenF, n);
}

実行結果。

[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from MyPredTest
[ RUN      ] MyPredTest.Test3
test8.cpp:35: Failure
"n" の値は "1" だった。これは偶数じゃない！
[  FAILED  ] MyPredTest.Test3
[----------] Global test environment tear-down
[==========] 1 test from 1 test case ran.
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] MyPredTest.Test3