Google Test Primer 实战指南:在 miniblink49 仓库中用 gtest 编写 C++ 单元测试
Google Test Primer 实战指南:在 miniblink49 仓库中用 gtest 编写 C++ 单元测试
Google Test(Google C++ Testing Framework)是 Chromium/V8 生态中事实标准的 C++ 单元测试框架,而 miniblink49 仓库的 v8_7_5/testing/gtest 目录中完整携带了其源码、文档与构建脚本,是仓库内置的测试基础设施。本文以 Primer.md 为核心骨架,结合仓库内真实源码与示例,系统讲解如何搭建测试工程、使用断言、组织测试用例(test case)与测试夹具(fixture),并编写 main() 启动测试程序,帮助你直接在浏览器内核的开发环境中落地一套高质量、可维护的 C++ 单元测试。
为什么选择 Google Test:Primer 中的设计理念
Primer 开篇即阐述了一套关于"什么才是好测试"的判断标准,这些理念直接决定了 Google Test 的 API 形态:
- 独立且可重复(Independent and Repeatable):每个测试都在独立的对象上运行,测试之间互不干扰。某个测试失败时,可以单独隔离运行以便快速调试。
- 良好组织、反映被测代码结构(Well Organized):通过 test case 对相关测试分组,可共享数据与子例程;这种一致的模式在开发者切换项目时尤其有价值。
- 可移植、可复用(Portable and Reusable):Google Test 支持 Linux、Windows、Mac 等多种操作系统,以及 gcc、MSVC 等不同编译器,兼容或不兼容异常环境的构建。
- 失败时提供充分信息(Informative Failures):测试失败不会立刻中止整个程序,而是停止当前测试、继续运行下一个;配合非致命失败(nonfatal failure),一次"编辑-编译-运行"循环可以暴露并修复多个缺陷。
- 免除杂务、聚焦内容(Content-Focused):框架自动跟踪所有已定义的测试,无需手工登记注册即可运行全部测试。
- 足够快(Fast):通过 fixture 在多个测试间复用共享资源,只需为 setup/teardown 支付一次成本,同时保持测试之间的相互独立。
由于 Google Test 基于流行的 xUnit 架构,熟悉 JUnit 或 PyUnit 的开发者可以快速上手;Primer 承诺约 10 分钟即可掌握基础。这也是它在 miniblink49 这类以 Chromium 系代码为基础的仓库中被普遍采用的原因——从 gin/test/v8_test.h 可以看到,仓库内的测试代码直接以 #include "testing/gtest/include/gtest/gtest.h" 引入框架,并让测试类继承 testing::Test。
搭建一个新的测试工程
编写测试程序的第一步,是把 Google Test 编译成库并链接进你的测试目标。仓库中 gtest 的根目录为 v8_7_5/testing/gtest,Primer 给出了多种构建系统支持:
| 构建系统 | 目录/文件 | 说明 |
|---|---|---|
| Visual Studio | msvc/ |
提供 gtest.vcproj 工程 |
| Mac Xcode | xcode/ |
Xcode 工程 |
| GNU make | make/ |
含 make/Makefile |
| Borland C++ Builder | codegear/ |
Borland 工程 |
| autotools | configure.ac |
官方已标记 deprecated |
| CMake | CMakeLists.txt |
官方推荐 |
手动编译的最小方案
如果你的构建系统不在上述列表中,参考 make/Makefile 的编译方式即可:将 src/gtest-all.cc 编译为库,并把 GTEST_ROOT 与 GTEST_ROOT/include 加入头文件搜索路径(GTEST_ROOT 指 gtest 根目录)。随后创建测试程序构建目标时,同样确保 GTEST_ROOT/include 在头文件搜索路径中,编译器才能找到 "gtest/gtest.h",并在链接阶段链接 gtest 库(例如在 Visual Studio 中为工程添加对 gtest.vcproj 的依赖)。
GN 构建中的集成方式
miniblink49 采用 Chromium 体系的 GN 构建,仓库 v8_7_5/testing/gtest/BUILD.gn 展示了如何将 gtest 封装成构建目标:
static_library("gtest"):核心目标,sources显式列出了include/gtest/gtest.h、gtest-death-test.h、gtest-message.h、gtest-param-test.h、gtest-spi.h、gtest_prod.h等公开头文件,并对外暴露gtest_direct_config(定义了UNIT_TEST宏)。source_set("gtest_main"):提供内置main()的目标,便于测试程序直接复用。
同时 BUILD.gn 也证实了 Primer 中"测试必须能跨平台编译"的承诺:它针对 Mac/iOS 追加了 ../gtest_mac.h、../gtest_mac.mm 等 Objective-C 支持源文件,通过 gtest_include_multiprocess、gtest_include_platform_test、gtest_include_objc_support 等开关按需裁剪。
基本概念:Assertion、Test、TestCase 与 Fixture
Primer 定义了四层核心概念,理解它们之间的层级关系是使用框架的前提:
- 断言(Assertion):检查某个条件是否为真的语句。结果可能是成功(success)、非致命失败(nonfatal failure)或致命失败(fatal failure)。致命失败会中止当前函数,否则程序继续正常执行。
- 测试(Test):使用断言验证被测代码行为的单元。若测试崩溃或存在失败断言,则测试失败;否则成功。
- 测试用例(Test Case):包含一个或多个测试的集合,应按被测代码的结构组织;当多个测试需要共享对象与子例程时,放入 测试夹具(Test Fixture) 类。
- 测试程序(Test Program):可包含多个 test case。
断言(Assertions):三大类别与完整对照表
Google Test 的断言是形如函数调用的宏。断言失败时,框架会打印断言所在的源文件、行号以及失败信息;你还可以通过 << 操作符追加自定义失败信息。任何能流式输出到 ostream 的类型都可以流式传入断言宏——包括 C 字符串和 string 对象;宽字符串(wchar_t*、Windows UNICODE 模式下的 TCHAR*、std::wstring)在打印时会转换为 UTF-8。
断言的成对设计是其核心机制:ASSERT_* 失败时产生致命失败并中止当前函数;EXPECT_* 失败时产生非致命失败,函数继续运行。通常优先使用 EXPECT_* 以便在一次测试中报告多个失败,但在"失败后继续执行没有意义"的场景(如接下来要解引用一个可能为空的指针)必须使用 ASSERT_*。
自定义失败消息示例(Primer 原例):
ASSERT_EQ(x.size(), y.size()) << "Vectors x and y are of unequal length";
for (int i = 0; i < x.size(); ++i) {
EXPECT_EQ(x[i], y[i]) << "Vectors x and y differ at index " << i;
}
基本布尔断言
| 致命断言 | 非致命断言 | 验证内容 |
|---|---|---|
ASSERT_TRUE(condition); |
EXPECT_TRUE(condition); |
condition 为真 |
ASSERT_FALSE(condition); |
EXPECT_FALSE(condition); |
condition 为假 |
可用平台:Linux、Windows、Mac。
二元比较断言
| 致命断言 | 非致命断言 | 验证内容 |
|---|---|---|
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 |
使用要点(结合 Primer 的详细说明):
- 失败时 Google Test 会同时打印
val1与val2两个操作数。 - 参数类型必须支持相应比较运算符,否则编译报错;自 v1.6.0 起不再强制要求参数支持
<<流式输出(若支持则用于打印,否则框架尽力而为地打印)。 - 用户自定义类型只要定义了对应比较运算符(如
==、<)即可使用;定义过运算符时优先使用ASSERT_*()系列,因为失败时除比较结果外还会打印两个操作数。 - 参数总是恰好求值一次,因此参数带副作用是安全的;但与其他 C/C++ 函数一样,参数的求值顺序未定义,代码不应依赖特定顺序。
ASSERT_EQ()对指针做的是指针相等判断。比较两个 C 字符串(const char*)的内容应使用ASSERT_STREQ();断言 C 字符串为NULL应写ASSERT_STREQ(NULL, c_string);而比较string对象则用ASSERT_EQ。本组宏同时支持窄字符串与宽字符串(string/wstring)。- 历史注记:2016 年 2 月之前
*_EQ约定按ASSERT_EQ(expected, actual)调用,存量代码多为该顺序;现在两个参数地位等同。
字符串比较断言
本组断言比较两个 C 字符串;比较 string 对象请改用 EXPECT_EQ、EXPECT_NE 等。
| 致命断言 | 非致命断言 | 验证内容 |
|---|---|---|
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_STRCASENE(str1, str2); |
EXPECT_STRCASENE(str1, str2); |
内容不同,忽略大小写 |
注意:断言名中的 "CASE" 表示忽略大小写。*STREQ* 与 *STRNE* 也接受宽 C 字符串(wchar_t*),宽字符串比较失败时其值会以 UTF-8 窄字符串打印。NULL 指针与空字符串被视为不同。子串、前缀、后缀、正则匹配等更高级的字符串断言见仓库内的 AdvancedGuide.md。
简单测试:TEST() 宏与命名规范
创建测试只需三步:
- 用
TEST()宏定义并命名一个测试函数——它是普通的不返回值 C++ 函数。 - 在函数体内,用各类断言检查被测代码的行为。
- 测试结果由断言决定:任何断言失败(无论致命或非致命),或测试崩溃,整个测试失败;否则成功。
TEST(test_case_name, test_name) {
... test body ...
}
TEST() 的两个参数从一般到具体:第一个是 test case 名称,第二个是该 test case 内的 测试名称。两者都必须是合法的 C++ 标识符,且不应包含下划线(_)。测试的完整名称由 test case 名与测试名组成;不同 test case 中的测试可以重名。
Primer 以阶乘函数 int Factorial(int n); 为例演示了完整用例:
// Tests factorial of 0.
TEST(FactorialTest, HandlesZeroInput) {
EXPECT_EQ(1, Factorial(0));
}
// Tests factorial of positive numbers.
TEST(FactorialTest, HandlesPositiveInput) {
EXPECT_EQ(1, Factorial(1));
EXPECT_EQ(2, Factorial(2));
EXPECT_EQ(6, Factorial(3));
EXPECT_EQ(40320, Factorial(8));
}
Google Test 按 test case 分组汇总测试结果,逻辑相关的测试应放在同一 test case 中(即 TEST() 的第一个参数相同)。仓库 samples/sample1_unittest.cc 是这一模式在生产示例中的完整演绎:它将 Factorial() 与 IsPrime() 的测试分别归入 FactorialTest 与 IsPrimeTest 两个 test case,并在注释中强调"框架保证每个测试恰好运行一次,但不保证执行顺序,因此测试结果不应依赖顺序"。
测试夹具(Test Fixtures):多测试共享同一套数据配置
当两个或更多测试操作相似数据时,应使用 test fixture 复用同一套对象配置。创建 fixture 的步骤:
- 从
::testing::Test派生一个类,类体以protected:或public:开头,以便子类访问 fixture 成员。 - 在类内部声明计划使用的对象。
- 如需要,编写默认构造函数或
SetUp()函数为每个测试准备对象——最常见的错误是把SetUp()误拼成Setup()(小写 u)。 - 如需要,编写析构函数或
TearDown()释放SetUp()中分配的资源;何时用构造/析构、何时用SetUp()/TearDown(),可参考仓库内 FAQ.md 的对应条目。 - 如有必要,为测试定义共享的子例程。
使用 fixture 时改用 TEST_F() 而非 TEST():
TEST_F(test_case_name, test_name) {
... test body ...
}
TEST_F() 的第一个参数必须是 test fixture 类的名字(_F 即 fixture)。C++ 宏系统无法用一个宏同时处理两种测试形态,因此用错宏会导致编译错误;同样,必须在 TEST_F() 之前先定义 fixture 类,否则会得到 "virtual outside class declaration" 的编译错误。
每个 TEST_F() 测试运行时,Google Test 会:① 在运行时创建全新的 fixture 对象 → ② 立即通过 SetUp() 初始化 → ③ 运行测试 → ④ 调用 TearDown() 清理 → ⑤ 删除 fixture 对象。同一 test case 内不同测试拥有不同的 fixture 对象,且框架总是在创建下一个 fixture 之前删除当前对象,绝不跨测试复用同一 fixture——某个测试对 fixture 的修改不会影响其他测试,这正是"测试独立且可重复"理念的落地点。
Queue 完整示例:从 fixture 定义到断言策略
Primer 为 FIFO 队列类 Queue<E> 演示了完整流程。先定义 fixture 类(按惯例命名为 FooTest,其中 Foo 是被测类):
class QueueTest : public ::testing::Test {
protected:
virtual void SetUp() {
q1_.Enqueue(1);
q2_.Enqueue(2);
q2_.Enqueue(3);
}
// virtual void TearDown() {}
Queue<int> q0_;
Queue<int> q1_;
Queue<int> q2_;
};
此处不需要 TearDown(),因为析构函数已足够完成清理。随后用 TEST_F() 编写测试:
TEST_F(QueueTest, IsEmptyInitially) {
EXPECT_EQ(0, q0_.size());
}
TEST_F(QueueTest, DequeueWorks) {
int* n = q0_.Dequeue();
EXPECT_EQ(NULL, n);
n = q1_.Dequeue();
ASSERT_TRUE(n != NULL);
EXPECT_EQ(1, *n);
EXPECT_EQ(0, q1_.size());
delete n;
n = q2_.Dequeue();
ASSERT_TRUE(n != NULL);
EXPECT_EQ(2, *n);
EXPECT_EQ(1, q2_.size());
delete n;
}
DequeueWorks 中 ASSERT_* 与 EXPECT_* 的混用展示了黄金法则:想在断言失败后继续暴露更多错误时用 EXPECT_*;失败后继续没有意义时用 ASSERT_*。这里第二次断言使用 ASSERT_TRUE(n != NULL),是因为随后要解引用指针 n——若 n 为 NULL,继续执行将导致段错误。
仓库 samples/sample3_unittest.cc 是该示例的完整实现,并额外补充了两个重要细节:fixture 是代码共享而非数据共享;断言宏(如 EXPECT_TRUE、FAIL)需要知道当前测试是谁,本质上是 Test 类的成员函数调用,因此不能在全局函数中使用,这也是测试子例程必须放进 fixture 的技术原因。示例中的 MapTester() 辅助函数就是典型做法:它作为 fixture 的成员被 TEST_F(QueueTest, Map) 调用,内部使用 ASSERT_EQ 校验队列尺寸、EXPECT_EQ 逐元素校验映射结果。
运行测试与编写 main() 函数
RUN_ALL_TESTS() 的运行机制
TEST() 与 TEST_F() 会隐式注册测试,因此无需像其他框架那样手工罗列测试即可运行。调用 RUN_ALL_TESTS() 即可执行链接单元内的所有测试——它们可以来自不同 test case,甚至不同源文件;全部成功返回 0,否则返回 1。
RUN_ALL_TESTS() 的执行流程:
- 保存所有 Google Test flags 的状态。
- 为第一个测试创建 fixture 对象。
- 通过
SetUp()初始化。 - 在 fixture 对象上运行测试。
- 通过
TearDown()清理。 - 删除 fixture。
- 恢复所有 Google Test flags 的状态。
- 对下一个测试重复以上步骤,直到全部执行完毕。
若第 2 步(fixture 构造函数)产生致命失败,则跳过第 3~5 步;若第 3 步(SetUp())产生致命失败,则跳过第 4 步。
重要约束:不能忽略 RUN_ALL_TESTS() 的返回值(gcc 会直接编译报错)。这是因为自动化测试服务依据进程退出码而非 stdout/stderr 判断测试是否通过,因此 main() 必须返回 RUN_ALL_TESTS() 的值。另外,RUN_ALL_TESTS() 只能调用一次——多次调用会与某些高级特性(如线程安全的 death tests)冲突。
标准 main() 样板
#include "this/package/foo.h"
#include "gtest/gtest.h"
namespace {
// The fixture for testing class Foo.
class FooTest : public ::testing::Test {
protected:
// 以下函数若函数体为空,可随意删减。
FooTest() {
// 可在此为每个测试做 setup 工作。
}
virtual ~FooTest() {
// 可在此做不抛出异常的清理工作。
}
// 若构造/析构不足以完成每个测试的 setup 与清理,可定义如下方法:
virtual void SetUp() {
// 此处代码在构造函数之后、每个测试之前立即调用。
}
virtual void TearDown() {
// 此处代码在每个测试之后、析构函数之前立即调用。
}
// 这里声明的对象可被 Foo 的 test case 中所有测试使用。
};
// Tests that the Foo::Bar() method does Abc.
TEST_F(FooTest, MethodBarDoesAbc) {
const string input_filepath = "this/package/testdata/myinputfile.dat";
const string output_filepath = "this/package/testdata/myoutputfile.dat";
Foo f;
EXPECT_EQ(0, f.Bar(input_filepath, output_filepath));
}
// Tests that Foo does Xyz.
TEST_F(FooTest, DoesXyz) {
// 此处测试 Foo 的 Xyz 功能。
}
} // namespace
int main(int argc, char **argv) {
::testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}
::testing::InitGoogleTest() 负责解析命令行中的 Google Test flags 并移除已识别的 flag,从而允许通过命令行参数控制测试程序行为(详见 AdvancedGuide.md)。必须在调用 RUN_ALL_TESTS() 之前调用它,否则 flags 无法正确初始化。在 Windows 上 InitGoogleTest() 同时支持宽字符串,可用于 UNICODE 模式编译的程序。
如果不想手写 main(),直接链接 gtest_main 库即可。仓库 v8_7_5/testing/gtest/src/gtest_main.cc 提供了这份内置实现:
GTEST_API_ int main(int argc, char **argv) {
printf("Running main() from gtest_main.cc\n");
testing::InitGoogleTest(&argc, argv);
return RUN_ALL_TESTS();
}
miniblink49 的 gin 模块正是这么做的:测试程序的 main() 通过 base/test/launcher/unit_test_launcher.h 驱动的 base::TestSuite 启动(见 gin/test/run_all_unittests.cc),而各测试文件则直接 #include "testing/gtest/include/gtest/gtest.h" 并使用 TEST/TEST_F 编写用例,例如 gin/converter_unittest.cc、gin/interceptor_unittest.cc、gin/wrappable_unittest.cc。其中 gin/test/v8_test.h 定义的 V8Test 类继承自 testing::Test,在 SetUp()/TearDown() 中管理 V8 的 IsolateHolder、base::MessageLoop 与 v8::Persistent<v8::Context>,是"用 fixture 封装测试公共环境"的教科书式案例。
Visual C++ 用户的注意事项
Primer 特别警告了 Visual C++ 下的一个陷阱:如果把测试放进库中而 main() 在另一个库或 .exe 中,测试不会运行。原因在于 Visual C++ 的链接器 bug——Google Test 通过静态对象注册测试,这些对象虽未被其他地方引用,但其构造函数仍需执行;当链接器发现库中没有任何内容被外部引用时,会把整个库丢弃。
解决办法:在测试库代码中声明一个导出函数(静态库可省略 __declspec(dllexport)):
__declspec(dllexport) int PullInMyLibrary() { return 0; }
然后在 main() 程序中调用它,强制保留该库的引用:
int PullInMyLibrary();
static int dummy = PullInMyLibrary();
此外,若测试定义在静态库中,还需在 main() 程序的链接选项中追加 /OPT:NOREF(MSVC IDE 路径:工程属性 → 配置属性 → 链接器 → 优化,将 References 设置为 Keep Unreferenced Data (/OPT:NOREF)),防止链接器丢弃测试生成的符号。最后一个坑:若以静态库形式使用 Google Test(即 gtest.vcproj 的默认形态),测试也必须放在静态库中;若必须放进 DLL,则必须把 Google Test 也改为 DLL 构建,否则测试不会正确运行。Primer 的最终结论是:尽量别把测试写进库中。
已知限制与进一步学习
Primer 声明 Google Test 在设计上是线程安全的:在提供 pthreads 库的系统上实现是线程安全的,但在其他系统(如 Windows)上,目前不建议并发地从两个线程同时使用断言——多数测试在主线线程中断言,因此这通常不是问题。若你愿意贡献力量,可在平台相关的 gtest-port.h 中实现必要的同步原语。
接下来可以继续阅读仓库内以下资料:
- Samples.md:官方示例索引,samples/ 目录下有 10 个由浅入深的示例(sample1 简单函数测试、sample3 fixture、sample6 事件监听、sample8 值参数化等)。
- AdvancedGuide.md:高级特性,涵盖 death tests、值参数化测试、类型参数化测试、测试事件监听器、golden 文件测试等。
- FAQ.md:常见问题解答,包括构造/析构与
SetUp()/TearDown()的选择等。 - 参考 miniblink49 内 gin 模块的
*_unittest.cc文件,观察真实浏览器内核项目中 gtest 与 fixture 的落地方式。