简单了解c++开源测试框架googletest

GTest(googletest)是Google开发的一款开源的c/c++测试框架。
项目地址：https://github.com/google/googletest

1. 一个简单的例子

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

using namespace std;

int divfunc(int a, int b) { return (b) ? a / b : __INT_MAX__; }

TEST(CalculatorTestSet, divzero) {
  EXPECT_EQ(divfunc(10, 0), __INT_MAX__);
}

TEST(CalculatorTestSet, divpositive) {
  EXPECT_EQ(divfunc(10, 1), 10);
  EXPECT_EQ(divfunc(10, 2), 5);
}

int main(int argc, char** argv)
{
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

编译以上代码，需要链接编译好的gtest库

g++ main.cpp -o main.out -g -O0 -no-pie -I ./gtest/include/ -L ./gtest/lib/ -lgtest -lpthread

执行main.out得到如下结果：

[==========] Running 2 tests from 1 test case.
[----------] Global test environment set-up.
[----------] 2 tests from CalculatorTestSet
[ RUN      ] CalculatorTestSet.divzero
[       OK ] CalculatorTestSet.divzero (0 ms)
[ RUN      ] CalculatorTestSet.divpositive
[       OK ] CalculatorTestSet.divpositive (0 ms)
[----------] 2 tests from CalculatorTestSet (0 ms total)

[----------] Global test environment tear-down
[==========] 2 tests from 1 test case ran. (0 ms total)
[  PASSED  ] 2 tests.

2. 关于一些命名规范

出于历史原因，gtest使用test case表示一组测试集合(test suite)，用test来表示一个测试用例(test case)

#define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name)

上面是TEST宏定义，TEST宏有两个参数，第一个参数表示测试集的名称，第二个参数表示测试用例的名称。从代码上可以看到gtest源码中分别使用test case 和 test来表示测试集和测试用例。

3. 断言

googletest通过断言(assertions)来检查一个判断是否为真。
gtest中最常用的断言是ASSERT_*宏和EXPECT_*宏
其中ASSERT宏一旦判断失败，会立即退出程序。EXPECT宏则相反，即使一个用例失败，仍然会继续执行后面的用例，不会立即退出。

ASSERT_EQ(x.size(), y.size()) << "Vectors x and y are of unequal length";

上面展示了ASSERT宏的一种用法，可以使用"<<"来打印额外的信息

下表列出了常见的一些宏值：

Fatal assertion	Nonfatal assertion	Verifies
ASSERT_TRUE(condition)	EXPECT_TRUE(condition)	condition is true
ASSERT_FALSE(condition)	EXPECT_FALSE(condition)	condition is false
ASSERT_EQ(val1, val2)	EXPECT_EQ(val1, val2)	val1 == val2
ASSERT_NE(val1, val2)	EXPECT_NE(val1, val2)	val1 != val2
ASSERT_LT(val1, val2)	EXPECT_LT(val1, val2)	val1 < val2
ASSERT_LE(val1, val2)	EXPECT_LE(val1, val2)	val1 <= val2
ASSERT_GT(val1, val2)	EXPECT_GT(val1, val2)	val1 > val2
ASSERT_GE(val1, val2)	EXPECT_GE(val1, val2)	val1 >= val2
ASSERT_STREQ(str1,str2)	EXPECT_STREQ(str1,str2)	两个c风格字符串内容一样
ASSERT_STRNE(str1,str2)	EXPECT_STRNE(str1,str2)	两个c风格字符串内容不同
ASSERT_STRCASEEQ(str1,str2)	EXPECT_STRCASEEQ(str1,str2)	同ASSERT_STREQ，忽略大小写
ASSERT_STRCASENE(str1,str2)	EXPECT_STRCASENE(str1,str2)	同ASSERT_STRNE，忽略大小写

4. TEST宏

使用TEST()宏创建测试函数

TEST(TestSuiteName, TestName) {
  ... test body ...
}

5. 3. 使用RUN_ALL_TESTS()宏调用测试函数，

RUN_ALL_TESTS()返回0表示所有用例执行成功，返回1表示有用例执行失败。在main函数中执行RUN_ALL_TESTS函数时有两点需要注意：

• 执行RUN_ALL_TESTS需要先执行InitGoogleTest
• 必须对RUN_ALL_TESTS的返回值做处理，不然会报编译错误

下面的代码列出来RUN_ALL_TESTS的典型用法：

int main(int argc, char **argv) {
  ::testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}