用googletest写cpp单测

框架概述

Google Test（也称为 googletest）是由 Google 开发的 C++ 单元测试框架。它的首个版本是在2004年发布的，作为 Google 内部的测试框架使用。随后，Google Test 在开源社区中得到广泛应用，并在许多项目和组织中成为首选的 C++ 单元测试框架。

Google Test 提供了丰富的断言函数和测试宏，使开发人员能够编写清晰、易读、易维护的单元测试。它支持测试夹具、参数化测试、测试套件等功能，可以满足各种测试需求。

随着时间的推移，Google Test 持续改进和更新，添加了许多新功能和改进。它的代码库托管在 GitHub 上，并由社区进行维护和更新。

在2017年，Google Test 的最新版本是 1.8.1。然而，Google Test 框架的开发并没有止步于此，后续版本的开发和更新由广大的开发者社区共同推动，以满足不断变化的测试需求。

Google Test 的成功和流行，得益于其简单易用、灵活可扩展的特性，以及对高质量代码和单元测试的推崇。它已成为 C++ 社区中一个广泛采用的单元测试框架，为开发人员提供了强大的测试工具和实践。

googletest的官网地址：https://google.github.io/googletest/

googletest的开源地址：https://github.com/google/googletest

googletest的sample例子：https://github.com/google/googletest/tree/main/googletest/samples

bazel使用运行方式

在bazel中我们想要使用googletest，是非常简单的。

官网有一篇文章是直接说如何使用bazel引入googletest的：https://google.github.io/googletest/quickstart-bazel.html

在WORKSPACE中引入googletest

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
  name = "com_google_googletest",
  urls = ["https://github.com/google/googletest/archive/5ab508a01f9eb089207ee87fd547d290da39d015.zip"],
  strip_prefix = "googletest-5ab508a01f9eb089207ee87fd547d290da39d015",
)

编写BUILD的cc_test

假设目标文件是：

# https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
cc_library(
	name = "sample1",
	srcs = ["sample1.cc"],
	hdrs = ["sample1.h"],
)

cc_test(
  name = "sample1_unittest",
  srcs = ["sample1_unittest.cc"],
  deps = [
  	"@com_google_googletest//:gtest_main",
	":sample1",
	],
)

运行bazel test

bazel test --test_output=all media_cpp_demo/cpp_unit_test:sample1_unittest

这里会输出类似的信息：

INFO: From Testing //media_cpp_demo/cpp_unit_test:sample1_unittest:
==================== Test output for //media_cpp_demo/cpp_unit_test:sample1_unittest:
Running main() from gmock_main.cc
[==========] Running 6 tests from 2 test suites.
[----------] Global test environment set-up.
[----------] 3 tests from FactorialTest
[ RUN      ] FactorialTest.Negative
[       OK ] FactorialTest.Negative (0 ms)
[ RUN      ] FactorialTest.Zero
[       OK ] FactorialTest.Zero (0 ms)
[ RUN      ] FactorialTest.Positive
media_cpp_demo/cpp_unit_test/sample1_unittest.cc:25: Failure
Expected equality of these values:
  3
  Factorial(3)
    Which is: 6
[  FAILED  ] FactorialTest.Positive (0 ms)
[----------] 3 tests from FactorialTest (0 ms total)

[----------] 3 tests from IsPrimeTest
[ RUN      ] IsPrimeTest.Negative
[       OK ] IsPrimeTest.Negative (0 ms)
[ RUN      ] IsPrimeTest.Trivial
[       OK ] IsPrimeTest.Trivial (0 ms)
[ RUN      ] IsPrimeTest.Positive
[       OK ] IsPrimeTest.Positive (0 ms)
[----------] 3 tests from IsPrimeTest (0 ms total)

[----------] Global test environment tear-down
[==========] 6 tests from 2 test suites ran. (0 ms total)
[  PASSED  ] 5 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] FactorialTest.Positive

 1 FAILED TEST
================================================================================

其中很明确告诉我们哪些case运行了，哪些case成功/失败了。

具体写法

最好的写法参考就是googletest的git官网的sample例子。

googletest的sample例子：https://github.com/google/googletest/tree/main/googletest/samples

断言语句

在 Google Test 中，有多种断言函数可用于编写测试断言，包括 EXPECT_* 系列和 ASSERT_* 系列。这两个系列的断言函数在用法上非常相似，但在断言失败时的行为上略有不同。

下面列出了常用的断言函数示例：

• EXPECT_EQ 和 ASSERT_EQ: 验证两个值是否相等。
• EXPECT_NE 和 ASSERT_NE: 验证两个值是否不相等。
• EXPECT_TRUE 和 ASSERT_TRUE: 验证条件是否为真。
• EXPECT_FALSE 和 ASSERT_FALSE: 验证条件是否为假。
• EXPECT_LT 和 ASSERT_LT: 验证第一个值是否小于第二个值。
• EXPECT_LE 和 ASSERT_LE: 验证第一个值是否小于等于第二个值。
• EXPECT_GT 和 ASSERT_GT: 验证第一个值是否大于第二个值。
• EXPECT_GE 和 ASSERT_GE: 验证第一个值是否大于等于第二个值。

这些断言函数在断言失败时的行为略有不同：

• EXPECT_* 系列：如果断言失败，将会输出错误信息，但测试函数继续执行。
• ASSERT_* 系列：如果断言失败，将会输出错误信息，并终止当前测试函数的执行。

以下是一个示例，演示了如何使用这些断言函数：

#include <gtest/gtest.h>

TEST(MyTestSuite, ExampleTest) {
    int x = 5;
    int y = 10;

    // 验证相等关系
    EXPECT_EQ(x, 5);
    ASSERT_NE(x, y);

    // 验证条件
    EXPECT_TRUE(x > 0);
    ASSERT_FALSE(y < 0);

    // 验证大小关系
    EXPECT_LT(x, y);
    ASSERT_GE(y, 10);
}

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

在上述示例中，我们定义了一个测试用例 MyTestSuite.ExampleTest。在测试用例中，我们使用了不同的断言函数来验证条件和关系。根据断言函数的使用，你可以选择使用 EXPECT_* 或 ASSERT_* 系列来满足测试需求。

当运行测试时，如果断言失败，Google Test 将会输出错误信息以指示具体的断言失败的位置和条件。

根据测试需求和个人偏好，你可以选择使用适当的断言函数来编写测试断言，并根据测试情况选择使用 EXPECT_* 或 ASSERT_* 系列。

简单的测试用例

简单的测试用例就是使用宏Test

可以参考：https://github.com/google/googletest/blob/main/googletest/samples/sample1_unittest.cc

TEST(FactorialTest, Positive) {
  EXPECT_EQ(1, Factorial(1));
  EXPECT_EQ(2, Factorial(2));
  EXPECT_EQ(6, Factorial(3));
  EXPECT_EQ(40320, Factorial(8));
}

这里的 FactorialTest 是 测试夹具（TestSuite），而 Positive 是 测试用例（TestCase）。

最后输出的时候，会把相同的TestSuite放在一起展示。

多个测试用例共享数据

如果我们多个测试用例都有一些初始化操作操作呢？这里就需要用到宏 TEST_F 了。

可以参考：https://github.com/google/googletest/blob/main/googletest/samples/sample3_unittest.cc

TEST_F 是 Google Test 框架中的一个宏，用于定义基于测试夹具（Test Fixture）的测试用例。测试夹具提供了在多个测试用例之间共享的设置和状态。

使用 TEST_F 宏，你可以在测试夹具类中定义多个测试用例，并共享该类中的成员变量和函数。每个测试用例都会在运行之前执行夹具的设置（SetUp）函数，运行完毕后执行夹具的清理（TearDown）函数。

下面是一个使用 TEST_F 宏定义测试用例的示例代码：

#include <gtest/gtest.h>

// 测试夹具类
class MyTestFixture : public ::testing::Test {
protected:
  void SetUp() override {
    // 在每个测试用例之前执行的设置
  }

  void TearDown() override {
    // 在每个测试用例之后执行的清理
  }

  // 夹具类中的成员变量和函数
  int value;
};

// 使用 TEST_F 宏定义测试用例
TEST_F(MyTestFixture, TestCase1) {
  // 使用夹具类中的成员变量和函数进行测试断言
  value = 42;
  EXPECT_EQ(value, 42);
}

TEST_F(MyTestFixture, TestCase2) {
  // ...
}

// ...

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

在上述示例中，我们创建了一个名为 MyTestFixture 的测试夹具类，继承自 ::testing::Test。在夹具类中，我们可以定义成员变量和函数，以及重写 SetUp 和 TearDown 函数来设置和清理测试的共享状态。

然后，我们使用 TEST_F 宏定义测试用例。在每个测试用例中，我们可以使用夹具类中的成员变量和函数，并编写测试断言。

最后，我们初始化 Google Test 框架并运行所有的测试用例。

通过使用 TEST_F 宏，我们可以更方便地组织和管理基于测试夹具的测试用例，以确保它们共享相同的设置和状态，并提供更灵活的测试场景。

其实不难看出，简单的测试用例 TEST 其实是 TEST_F 的一个特例，TEST 更像是将 TEST_F 定义的 TestSuite 给后台隐式自动填补了。

自定义main函数

同样的，我们定义的测试用例中没有main函数，其实也是被框架隐式自动填补了。它的原型是：

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

我们也是可以在单元测试的文件中写上这么一个函数。

什么时候可能需要自己写main函数呢？

如果你的所有TestSuite都有一个通用的数据初始化逻辑，那么只能写在这个main函数中了。

如何才能写好的单元测试？

官网 https://google.github.io/googletest/primer.html 有简要说一下如何写一个good test case，其实写好的单元测试和语言无关，以下的指导原则适用所有语言的单元测试。

编写良好的单元测试是确保代码正确性和可靠性的关键。下面是一些关于如何编写好的单元测试的指导原则：

1. 明确测试目标：在编写单元测试之前，明确测试的目标是什么。了解要测试的代码单元的行为、输入和预期输出，以及可能的边界条件和异常情况。

2. 单一责任原则：确保每个单元测试只关注一个特定的功能或行为。将测试用例分解为独立且可重复执行的单元，以便更容易定位和修复问题。

3. 覆盖各种情况：编写测试用例时，确保覆盖不同的输入组合、边界条件和异常情况。测试应该验证代码在各种情况下的行为是否正确。

4. 独立性和可重复性：每个测试用例应该是相互独立且可重复执行的。测试用例之间不应该有依赖关系，避免测试之间的相互影响。

5. 名称清晰明确：给测试用例和断言起一个清晰明确的名称，以便能够准确描述测试的目的和预期结果。这样可以更容易理解测试的用途，并且在测试失败时更容易定位问题。

6. 使用合适的断言：选择适当的断言函数来验证代码的预期行为。确保断言清晰明确，并且测试失败时能够提供有用的错误信息，以便快速定位问题。

7. 辅助工具和框架：使用适当的单元测试框架和辅助工具，如 Google Test、Catch2、Mockito 等，来简化测试的编写和管理。这些工具可以提供丰富的断言和辅助函数，以及测试运行和报告生成等功能。

8. 保持测试的可维护性：随着代码的演进和变化，及时更新和维护测试用例。确保测试与代码保持同步，并且仍然能够有效地验证代码的正确性。

9. 考虑边界情况和异常处理：测试应该覆盖各种边界情况和异常处理，以验证代码在这些情况下的行为是否符合预期。包括边界值、异常输入、空值等。

10. 定期运行测试套件：确保定期运行整个测试套件，以便及早发现潜在的问题。集成测试运行到持续集成（CI）系统中，以便自动执行测试，并及时获取测试结果。

编写好的单元测试可以提供高度的代码覆盖率和可靠性，帮助你捕捉问题、防止回归和提供代码改进的信心。遵循上述原则并积极进行测试是确保代码质量的重要实践。

如何才能生成测试覆盖率

googletest 本身并不提供直接的测试覆盖率功能，但你可以结合其他工具来生成测试覆盖率报告。

如果你是使用bazel，那么这个步骤就更简单了。

生成代码覆盖率数据

这个bazel有个bazel coverage 的代码，就能生成覆盖率。

首先，先将BUILD文件做下修改，增加下生成覆盖率对应的参数。

# https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
cc_library(
	name = "sample1",
	srcs = ["sample1.cc"],
	hdrs = ["sample1.h"],
)

cc_test(
  name = "sample1_unittest",
  srcs = ["sample1_unittest.cc"],
  copts = ["-fprofile-arcs", "-ftest-coverage"],
  linkopts = ["-fprofile-arcs"],
  deps = [
  	"@com_google_googletest//:gtest_main",
		":sample1",
	],
)

其次，运行命令 bazel coverage media_cpp_demo/cpp_unit_test:sample1_unittest

输出展示覆盖率数据路径：

INFO: Build completed successfully, 25 total actions
//media_cpp_demo/cpp_unit_test:sample1_unittest                          PASSED in 0.3s
  /root/.cache/bazel/_bazel_root/aa4e8447fb143c448ba118077e918987/execroot/__main__/bazel-out/k8-fastbuild/testlogs/media_cpp_demo/cpp_unit_test/sample1_unittest/coverage.dat

这里的coverage.dat就是我们生成的覆盖率数据。

生成代码覆盖率html

这一步就需要依赖一个genhtml 工具。下载安装就不说了。

直接上命令：

genhtml ./bazel-out/k8-fastbuild/testlogs/media_cpp_demo/cpp_unit_test/sample1_unittest/coverage.dat --output-directory ./cov

将coverage.dat 生成html，并且将html放到./cov目录下。


打开就能看到如下的测定报告了

可以进一步点击查看是哪些行被覆盖了。

总结

CPP的单元测试和其他语言的单测也没有什么非常特别的地方，概念，方法都一样。

相较于如何写单元测试，更难的是如何写好单元测试。那是另外一个话题了。

参考

一文掌握谷歌 C++ 单元测试框架 GoogleTest