C++ 单元测试框架：`Google Test`, `Catch2` 的深入实践

单元测试，拯救你的代码（和你的发际线）—— Google Test 和 Catch2 深入实践

各位程序员朋友们，大家好！今天咱们来聊点严肃又有趣的话题：单元测试。我知道，一提到测试，很多人脑海里立刻浮现出“加班”、“bug”、“上线前夕的噩梦”之类的关键词。别急着划走，单元测试可不是来添堵的，它其实是拯救你代码质量、减少加班、甚至保住你发际线的救星！

想象一下，你辛辛苦苦写了几百行代码，信心满满地觉得完美无瑕，结果一运行，直接崩了。排查半天，发现竟然是一个小小的拼写错误，或者一个边界条件没考虑到。是不是想捶胸顿足？有了单元测试，这些低级错误就能在早期被扼杀在摇篮里，让你避免在后期维护时焦头烂额。

今天，咱们就来深入探讨两个C++界非常流行的单元测试框架：Google Test 和 Catch2。我会尽量用通俗易懂的语言，结合生动的例子，让你彻底掌握它们的使用技巧，从此告别“盲写代码”的时代。

一、为什么选择单元测试框架？

你可能会说：“我自己写几个 if 语句，也能进行简单的测试啊！” 没错，自己写测试当然可以，但单元测试框架能提供更多便利：

结构化测试： 框架提供了组织测试用例的结构，让你的测试代码更清晰、更易于维护。
丰富的断言： 框架内置了各种断言，例如相等、不等、大于、小于等等，让你方便地验证代码的正确性。
自动发现测试： 框架可以自动发现项目中的测试用例，并批量运行，省时省力。
详细的报告： 框架会生成详细的测试报告，告诉你哪些测试通过了，哪些测试失败了，以及失败的原因。

总而言之，单元测试框架能让你更高效、更专业地进行测试，就像有了趁手的兵器，打起怪来自然更轻松。

二、 Google Test：老牌劲旅，功能强大

Google Test（简称 gtest）是 Google 开源的 C++ 测试框架，历史悠久，功能强大，社区活跃。它采用 xUnit 架构，提供了一套完整的测试工具，适合各种规模的项目。

1. 初体验：安装与配置

安装 Google Test 的方法有很多，可以用包管理器，也可以自己编译源码。这里以 CMake 为例，简单说明一下：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 添加 Google Test 子模块
include(FetchContent)
FetchContent_Declare(
    googletest
    GIT_REPOSITORY https://github.com/google/googletest.git
    GIT_TAG        v1.13.0 # 选择一个合适的版本
)
FetchContent_MakeAvailable(googletest)

# 添加可执行文件
add_executable(MyProject main.cpp)

# 添加测试可执行文件
add_executable(MyProjectTests test.cpp)

# 链接 Google Test 库
target_link_libraries(MyProjectTests gtest_main)

# 将测试添加到 CTest
include(GoogleTest)
gtest_discover_tests(MyProjectTests)

这段 CMake 代码做了几件事：

引入 Google Test 作为子模块。
创建了一个测试可执行文件 MyProjectTests。
链接了 Google Test 库 gtest_main，它包含了 main 函数，负责运行测试。
使用 gtest_discover_tests 自动发现测试用例。

2. 编写第一个测试用例

假设我们有一个简单的函数 Add，用于计算两个整数的和：

// add.h
int Add(int a, int b) {
  return a + b;
}

接下来，我们可以编写一个测试用例来验证 Add 函数的正确性：

// test.cpp
#include "gtest/gtest.h"
#include "add.h"

TEST(AddTest, PositiveNumbers) {
  ASSERT_EQ(Add(2, 3), 5);
}

TEST(AddTest, NegativeNumbers) {
  ASSERT_EQ(Add(-2, -3), -5);
}

TEST(AddTest, Zero) {
  ASSERT_EQ(Add(0, 0), 0);
}

这段代码做了几件事：

包含了 gtest/gtest.h 头文件，它包含了 Google Test 的所有 API。
包含了 add.h 头文件，它包含了我们要测试的 Add 函数的声明。
使用 TEST 宏定义了三个测试用例：PositiveNumbers、NegativeNumbers 和 Zero。
在每个测试用例中，使用 ASSERT_EQ 断言来验证 Add 函数的返回值是否符合预期。

TEST 宏接受两个参数：测试套件名称和测试用例名称。测试套件名称用于组织测试用例，可以根据功能模块进行划分。

ASSERT_EQ 是 Google Test 提供的断言宏之一，用于判断两个值是否相等。如果相等，则测试通过；否则，测试失败。Google Test 还提供了其他断言宏，例如 ASSERT_NE（不等）、ASSERT_GT（大于）、ASSERT_LT（小于）等等。

3. 运行测试

编译并运行 MyProjectTests 可执行文件，你将会看到类似下面的输出：

[==========] Running 3 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 3 tests from AddTest
[ RUN      ] AddTest.PositiveNumbers
[       OK ] AddTest.PositiveNumbers (0 ms)
[ RUN      ] AddTest.NegativeNumbers
[       OK ] AddTest.NegativeNumbers (0 ms)
[ RUN      ] AddTest.Zero
[       OK ] AddTest.Zero (0 ms)
[----------] 3 tests from AddTest (0 ms total)

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

这表明所有测试用例都通过了。如果某个测试用例失败了，输出会包含详细的错误信息，帮助你快速定位问题。

4. Google Test 的高级特性

Google Test 还提供了许多高级特性，例如：

参数化测试： 可以用不同的参数运行同一个测试用例，减少代码重复。
Fixture： 可以为每个测试用例设置相同的环境，例如创建数据库连接、初始化对象等等。
Mock 对象： 可以模拟依赖项的行为，隔离被测代码，进行更彻底的测试。

这些高级特性可以帮助你编写更复杂、更全面的测试用例，确保代码的质量。

三、 Catch2：现代 C++，简洁优雅

Catch2 是一个现代的 C++ 测试框架，它以简洁、易用而著称。Catch2 采用 header-only 方式，无需编译安装，只需包含头文件即可使用。

1. 初体验：安装与配置

Catch2 的安装非常简单，只需从 GitHub 下载 catch.hpp 头文件，并将其包含到你的项目中即可。

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 添加可执行文件
add_executable(MyProject main.cpp)

# 添加测试可执行文件
add_executable(MyProjectTests test.cpp)

# 链接 Catch2 库 (实际上不需要，因为是 header-only)
# target_link_libraries(MyProjectTests catch2)

# 设置 C++ 标准
set_target_properties(MyProjectTests PROPERTIES
    CXX_STANDARD 17
    CXX_STANDARD_REQUIRED ON
)

注意，Catch2 是 header-only 库，所以不需要链接库。但是，你需要确保你的编译器支持 C++17 标准。

2. 编写第一个测试用例

同样以 Add 函数为例，我们可以编写一个 Catch2 测试用例：

// test.cpp
#define CATCH_CONFIG_MAIN  // 这行代码只需要在一个文件中定义

#include "catch.hpp"
#include "add.h"

TEST_CASE("Add positive numbers") {
  REQUIRE(Add(2, 3) == 5);
}

TEST_CASE("Add negative numbers") {
  REQUIRE(Add(-2, -3) == -5);
}

TEST_CASE("Add zero") {
  REQUIRE(Add(0, 0) == 0);
}

这段代码做了几件事：

定义了 CATCH_CONFIG_MAIN 宏，它会生成 main 函数，负责运行测试。这行代码只需要在一个文件中定义。
包含了 catch.hpp 头文件，它包含了 Catch2 的所有 API。
包含了 add.h 头文件，它包含了我们要测试的 Add 函数的声明。
使用 TEST_CASE 宏定义了三个测试用例。
在每个测试用例中，使用 REQUIRE 断言来验证 Add 函数的返回值是否符合预期。

TEST_CASE 宏接受一个参数：测试用例的名称。

REQUIRE 是 Catch2 提供的断言宏之一，用于判断一个表达式是否为真。如果为真，则测试通过；否则，测试失败。Catch2 还提供了其他断言宏，例如 CHECK（类似于 REQUIRE，但即使失败也会继续执行后续代码）、REQUIRE_THROWS（判断是否抛出异常）等等。

3. 运行测试

编译并运行 MyProjectTests 可执行文件，你将会看到类似下面的输出：

===============================================================================
All tests passed (3 assertions in 3 test cases)

这表明所有测试用例都通过了。如果某个测试用例失败了，输出会包含详细的错误信息，帮助你快速定位问题。

4. Catch2 的高级特性

Catch2 也提供了许多高级特性，例如：

Section： 可以将一个测试用例分成多个 section，每个 section 独立运行，方便调试。
Generator： 可以生成测试数据，用于参数化测试。
Matchers： 可以自定义断言，例如判断字符串是否包含某个子串、判断浮点数是否接近等等。

这些高级特性可以让你编写更灵活、更强大的测试用例。

四、 Google Test vs Catch2：如何选择？

Google Test 和 Catch2 都是优秀的 C++ 单元测试框架，它们各有优点：

Google Test： 功能强大，社区活跃，适合各种规模的项目。但配置稍微复杂，语法相对繁琐。
Catch2： 简洁易用，header-only 方式，适合小型项目和快速原型开发。但功能相对较少，社区规模较小。

如何选择呢？我的建议是：

如果你需要一个功能强大、社区活跃的框架，并且不介意稍微复杂的配置，那么选择 Google Test。
如果你需要一个简洁易用、header-only 的框架，并且项目规模不大，那么选择 Catch2。

当然，最终的选择还是取决于你的个人喜好和项目需求。

五、结语：让测试成为你的好朋友

单元测试是保证代码质量的重要手段，它可以帮助你尽早发现 bug，减少加班，甚至保住你的发际线。Google Test 和 Catch2 都是优秀的 C++ 单元测试框架，掌握它们的使用技巧，将会让你在编程的道路上更加自信、更加从容。

记住，测试不是负担，而是你的好朋友。让测试成为你代码的一部分，让它守护你的代码质量，让你远离 bug 的困扰！

希望这篇文章对你有所帮助。如果你有任何问题，欢迎在评论区留言，我们一起探讨！

单元测试，拯救你的代码（和你的发际线）—— Google Test 和 Catch2 深入实践

发表回复 取消回复

发表回复取消回复