两步实现在C代码中快速集成gtest进行单元测试

我平时的技术支持工作主要是快速阅读和调试代码，没有太多的代测试和验证需求，所以对单元测试一直没有留意。

直到我开始从头写一些密码学的基本功能代码，例如各种哈希算法，分组密码算法，流密码算法，分组密码的各种工作模式，各种国密算法的时候，才意识到我也需要去了解并使用测试。

尤其是有一次，我已经验证正确的某个代码，在此基础上实现新功能时，修改了底层代码，看起来好像没啥问题，然后在将来的某一天才发现那个修改引入了bug，又得重头查找问题的原因。如果有完整的测试，恐怕当场就能发现，而不是在很久后的某一天。

关于我对驱动测试的重新认识，也非常感谢 Leo Wang 曾经推荐的一篇关于测试的文章。

几年前学习Android Update Engine的时候曾经留意过其使用单元测试，所以这次学习单元测试框架时特别去看了那个框架，再次深入了解学习gtest (GoogleTest)框架。

由于平时使用的是 C，而 gtest 基于 C++，因此没法直接使用，需要一些额外的工作来对接 C 和 C++。

初学 gtest 时，特别参考了这篇：《嵌入式平台使用gtest进行白盒测试》，再次一并对作者表示感谢。

废话说了一大堆，下面直入主题。本文主要介绍如何快速将 gtest 引入到现有的 C 语言程序中进行测试。

0. 导读

第 1,2 节展示了一个完整的示例，将自己写的用于测试 gcd 和 factorial 函数的两个文件(gcd.c, factorial.c)和 googletest 整合到一起，然后运行测试，略显繁琐。

如果只希望了解整合的步骤，请直接跳转到第 3 节。

1. 原理

将 gtest 框架应用到 C 程序的原理比较简单，主要分 3 步:

编译测试框架 googletest 源码得到 libgtest.a 库文件(也可以根据需要编译成动态链接库或共享库文件.so)
编译待测试的 C 代码得到一个功能库文件，例如 libfoo.a
写一个单元测试文件(如:foo_unitttest.cc), 编译链接上 libgtest.a 和 libfoo.a 生成可执行文件进行测试

如果代码规模不大，对代码模块化要求也不高的话，可以将第2和第3步合并到一起执行，变成:

编译测试框架 googletest 源码得到 libgtest.a 库文件
写一个单元测试文件(如:foo_unitttest.cc)，和待测试代码一起编译并链接到 libgtest.a 库得到可执行文件进行测试

2. 两步操作快速集成 gtest

2.1 准备 gtest 库文件和头文件

复制下面的代码分别保存为 CMakeLists.txt 和 gtest.mk 文件。

CMakeLists.txt

cmake_minimum_required(VERSION 3.14)
project(gtestlib)# GoogleTest requires at least C++11
set(CMAKE_CXX_STANDARD 11)include(FetchContent)
FetchContent_Declare(googletestURL https://github.com/google/googletest/archive/refs/tags/release-1.11.0.zip
)# For Windows: Prevent overriding the parent project's compiler/linker settings
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(googletest)

gtest.mk

.PHONY: all cleanCMAKE   = cmake
MAKE    = makeGTEST             = .GTEST_BUILD_DIR   = $(GTEST)/build
GTEST_INSTALL_DIR = $(GTEST)/gtest
GTEST_CMAKELIST   = $(GTEST)/CMakeLists.txtGTEST_LIB         = $(GTEST_INSTALL_DIR)/lib/libgtest.a
GTEST_LIBMAIN     = $(GTEST_INSTALL_DIR)/lib/libgtest_main.aall:if [ ! -e $(GTEST_LIB) ] || [ ! -e $(GTEST_LIBMAIN) ]; then \mkdir -p $(GTEST_BUILD_DIR) && \$(CMAKE) -S $(GTEST) -B $(GTEST_BUILD_DIR) -DBUILD_GMOCK=OFF -DCMAKE_INSTALL_PREFIX=$(GTEST_INSTALL_DIR) && \$(MAKE) -C $(GTEST_BUILD_DIR) && \$(MAKE) -C $(GTEST_BUILD_DIR) install; \ficlean:if [ -e $(GTEST_BUILD_DIR) ]; then \$(MAKE) -C $(GTEST_BUILD_DIR) clean; \firm -rf $(GTEST_BUILD_DIR)rm -rf $(GTEST_INSTALL_DIR)

将上面的两个文件存放到同一个文件夹下，然后执行make -f gtest.mk。

代码会自动下载 googletest 最新的 v1.11 版本进行编译，并将生成的库文件和头文件输出到当前文件夹的 gtest 目录下，如下：

$ tree gtest
gtest
├── include
│   └── gtest
│       ├── gtest-death-test.h
│       ├── gtest.h
│       ├── gtest-matchers.h
│       ├── gtest-message.h
│       ├── gtest-param-test.h
│       ├── gtest_pred_impl.h
│       ├── gtest-printers.h
│       ├── gtest_prod.h
│       ├── gtest-spi.h
│       ├── gtest-test-part.h
│       ├── gtest-typed-test.h
│       └── internal
│           ├── custom
│           │   ├── gtest.h
│           │   ├── gtest-port.h
│           │   ├── gtest-printers.h
│           │   └── README.md
│           ├── gtest-death-test-internal.h
│           ├── gtest-filepath.h
│           ├── gtest-internal.h
│           ├── gtest-param-util.h
│           ├── gtest-port-arch.h
│           ├── gtest-port.h
│           ├── gtest-string.h
│           └── gtest-type-util.h
└── lib├── cmake│   └── GTest│       ├── GTestConfig.cmake│       ├── GTestConfigVersion.cmake│       ├── GTestTargets.cmake│       └── GTestTargets-noconfig.cmake├── libgtest.a├── libgtest_main.a└── pkgconfig├── gtest_main.pc└── gtest.pc8 directories, 31 files

目录 gtest/inlcude 包含 gtest 的头文件，写测试时需要包含头文件gtest/gtest.h
目录 gtest/lib 包含 gtest 的库文件，链接时需要链接 libgtest.a 和 libgtest_main.a

特别说明:

由于是自动下载代码，所以需要 cmake 在 v3.14 以上;

gtest生成的两个库文件中，只有 libgtest.a 是必须的，另外一个库文件 libgtest_main.a是 gtest 运行的入口，实际上就是一个 main 函数，如果你在自己的单元测试中定义了自己的 main 函数去调用 gtest，那就不需要 libgtest_main.a。

2.2 编写测试代码

待测试文件

这里的测试文件有两个, 分别是 gcd.c 和 factorial.c。

foo.h, 头文件，用于函数声明

#ifndef __FOO_H__
#define __FOO_H__
#ifdef __cplusplus
extern "C"
{#endifint gcd(int a, int b);int factorial(int n);#ifdef __cplusplus
}
#endif
#endif

gcd.c，用于计算两个数的最大公约数

#include "foo.h"int gcd(int a, int b)
{if (b == 0){return a;}else{return gcd(b, a % b);}
}

factorial.c，用于计算一个数的阶乘

#include "foo.h"int factorial(int n)
{int i, res;res = 1;for (i=n; i>0; i--){res *= i;}return res;
}

单元测试文件

写一个单元测试文件 foo_unittest.cc，包含两组测试，分别用于测试函数 gcd 和 factorial:
foo_unittest.cc

#include "foo.h"
#include <gtest/gtest.h>TEST(GCDTest, EvenTest)
{EXPECT_EQ(2, gcd(4, 10));EXPECT_EQ(6, gcd(30, 18));EXPECT_EQ(15, gcd(30, 45));
}TEST(GCDTest, PrimeTest)
{EXPECT_EQ(1, gcd(23, 10));EXPECT_EQ(1, gcd(359, 71));EXPECT_EQ(1, gcd(47, 83));
}TEST(FactorialTest, HandlesZeroInput) {EXPECT_EQ(factorial(0), 1);
}TEST(FactorialTest, HandlesPositiveInput) {EXPECT_EQ(factorial(1), 1);EXPECT_EQ(factorial(2), 2);EXPECT_EQ(factorial(3), 6);EXPECT_EQ(factorial(8), 40320);
}#if 0
int main(int argc, char *argv[])
{testing::InitGoogleTest(&argc, argv);return RUN_ALL_TESTS();
}
#endif

在上面的代码中包含了两组一共4个测试:

一组 GCDTest, 用于测试 gcd 函数
一组 FactorialTest 用于测试 factorial 函数。

2.3 编译并运行测试

然后使用下面的语句编译上面的代码生成可执行的测试文件:

$ g++ gcd.c factorial.c foo_unittest.cc -o footest -I. -Igtest/include -Lgtest/lib -lgtest -lgtest_main -lpthread

注意: 这里使用 g++ 指令一口气编译了 gcd.c, factorial.c 和 foo_unittest.cc 一共 3 个文件，生成测试文件 footest。

执行测试:

参考上面的操作，实际上只需要将 g++ 指令中的代码文件替换成你实际的文件就可以了。

2.4 关于测试文件的说明

在 gcd.c, factorial.c 和 foo_unittest.cc 中都没有定义 main 函数。

只在 foo_unittest.cc 中，有一个注释掉的 main 函数:

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

这个 main 函数是 GoogleTest 的入口，会调用 testing::InitGoogleTest(&argc, argv) 初始化 GoogleTest 框架，随后的 RUN_ALL_TESTS() 会搜集所有的测试函数，并运行。

实际上这也是 libtest_main.a 的所有代码，在 googletest v1.11 的代码中，完整的 gtest_main.cc 的代码如下:

/* file: googletest-src/googletest/src/gtest_main.cc */
#include <cstdio>
#include "gtest/gtest.h"#if GTEST_OS_ESP8266 || GTEST_OS_ESP32
#if GTEST_OS_ESP8266
extern "C" {#endif
void setup() {testing::InitGoogleTest();
}void loop() { RUN_ALL_TESTS(); }#if GTEST_OS_ESP8266
}
#endif#elseGTEST_API_ int main(int argc, char **argv) {printf("Running main() from %s\n", __FILE__);testing::InitGoogleTest(&argc, argv);return RUN_ALL_TESTS();
}
#endif

在上面的代码中，针对 GTEST_OS_ESP8266 和 GTEST_OS_ESP32 的情形，单独定义了setup和loop函数，其余的代码都走 else 部分的 main 函数。

实际上 setup + loop 函数的功能和 main 函数是一样的，我猜测是 GTEST_OS_ESP8266 和 GTEST_OS_ESP32 默认有了 main 函数，所以这里无法再次定义 main 函数，于是将 googletest 的入口放入到 setup 和 loop 函数中。

可见，foo_unittest.cc的 main 函数和 gtest_main.cc 的代码是一样的。

如果自己定义了 main 函数，就不再需要链接 libgtest_main.a 了，否则的话就需要向上面那样在编译时链接上 libgtest_main.a

3. 总结

基于前面说得比较繁琐，这里将步骤总结如下:

保存文中 2.1 节的 CMakeLists.txt 和 gtest.mk
运行 make -f gtest.mk 会自动下载并编译输出 gtest 的库文件和头文件
执行如下编译指令编译并链接测试代码和 gtest 库文件

$ g++ gcd.c factorial.c foo_unittest.cc -o footest -I. -Igtest/include -Lgtest/lib -lgtest -lgtest_main -lpthread

命令中的 gcd.c 和 factorial.c 可以根据需要替换成一个或多个 C 代码文件, foo_unittest.cc 替换成自己的单元测试文件(里面包含了多组 TEST 或 TEST_F测试)。

对于嵌入式环境，由于需要设置交叉编译环境来编译 googletest 库，然后链接成目标环境的可执行文件，相对这里的 x86 环境会稍微复杂一些，下篇单独开篇说明。

4. 广告

洛奇工作中常常会遇到自己不熟悉的问题，这些问题可能并不难，但因为不了解，找不到人帮忙而瞎折腾，往往导致浪费几天甚至更久的时间。

所以我组建了几个微信讨论群(记得微信我说加哪个群，如何加微信见后面)，欢迎一起讨论:

一个密码编码学讨论组，主要讨论各种加解密，签名校验等算法，请说明加密码学讨论群。
一个Android OTA的讨论组，请说明加Android OTA群。
一个git和repo的讨论组，请说明加git和repo群。

在工作之余，洛奇尽量写一些对大家有用的东西，如果洛奇的这篇文章让您有所收获，解决了您一直以来未能解决的问题，不妨赞赏一下洛奇，这也是对洛奇付出的最大鼓励。扫下面的二维码赞赏洛奇，金额随意：

洛奇自己维护了一个公众号“洛奇看世界”，一个很佛系的公众号，不定期瞎逼逼。公号也提供个人联系方式，一些资源，说不定会有意外的收获，详细内容见公号提示。扫下方二维码关注公众号：