C++如何利用CMake配置自动化构建并运行单元测试

阿雪君_3344

阿雪君_3344

2026-08-01

1004人浏览

原创

ctest是cmake内置测试驱动器,启用需调用enable_testing()并用add_test()注册独立可执行文件;集成gtest需链接gtest::gtest_main,boost.test须定义boost_test_dyn_link。

c++如何利用cmake配置自动化构建并运行单元测试

CTest 是 CMake 内置的测试驱动器,不是可选插件

只要你调用 enable_testing(),CMake 就会启用 CTest 支持——它不依赖任何第三方测试框架,也不需要额外安装。很多开发者误以为必须先集成 gtest 或 Boost.Test 才能“有测试”,其实 CTest 本身就能跑任意可执行程序,并捕获其退出码作为通过/失败判断。

常见错误现象:make test 报错 “No tests defined” 或直接静默退出,往往是因为漏掉了 enable_testing(),或没用 add_test() 注册测试目标。

  • enable_testing() 必须出现在根 CMakeLists.txt 中,且要在所有 add_test() 之前
  • 每个测试必须是独立可执行文件(哪怕只有一行 return 0;),CTest 不接受库或脚本直接注册
  • 测试名不能含空格或特殊字符,否则 ctest -R "my test" 会匹配失败

用 add_test() 注册测试时,路径和工作目录容易出错

add_test() 的第一个参数是测试名,第二个是可执行文件路径——这个路径是构建时的相对路径(从构建目录算起),不是源码目录下的路径。比如你写了 add_test(NAME my_test COMMAND test_example),那 test_example 必须已由 add_executable() 构建出来,且位于 CMAKE_BINARY_DIR 或其子目录下。

容易踩的坑:

  • 没设置 WORKING_DIRECTORY,导致测试里读取的 data/input.txt 找不到——默认工作目录是构建根目录,不是测试可执行文件所在目录
  • 误把源码路径当构建路径,写成 COMMAND ${CMAKE_SOURCE_DIR}/tests/test_example,结果构建时找不到该文件(因为还没编译)
  • 在子目录 CMakeLists.txt 中调用 add_test(),但没确保父级已调用 enable_testing()

集成 gtest 时,链接 GTest::gtest_main 很关键

如果你用 find_package(GTest REQUIRED),就别自己写 main() 函数。直接链接 GTest::gtest_main,它会提供标准入口并自动运行所有 TEST 宏定义的用例。自己实现 main() 容易漏掉 testing::InitGoogleTest() 或 RUN_ALL_TESTS(),导致测试根本没执行。

C++ Code Review Master
C++ Code Review Master

组合式C++代码评审方案,融合静态分析、AI推理、多轮迭代评审和C++专项检查,适用于PR审查、增量代码审查、全项目评审和代码质量评分,触发词包括review cpp、cpp代码评审、C++review、代码审查。

下载

实操建议:

  • 测试可执行文件必须同时链接 GTest::gtest 和 GTest::gtest_main,只链前者会报 undefined reference 到 main
  • 不要对测试目标重复设置 set(CMAKE_CXX_STANDARD ...),继承父级即可;但需确保 GTest::gtest 编译标准与你的代码一致(比如都用 C++17)
  • 若用 FetchContent 拉取 gtest,务必在 project() 之后、add_executable() 之前调用 FetchContent_MakeAvailable(),否则 target_link_libraries 会找不到目标

Boost.Test 需要 BOOST_TEST_DYN_LINK 且不能和静态链接混用

Boost.Test 默认以动态方式链接其运行时(libboost_unit_test_framework.so/.dll),所以必须加 target_compile_definitions(cpp_test PRIVATE BOOST_TEST_DYN_LINK)。如果漏了这行,BOOST_AUTO_TEST_CASE 宏会展开失败,编译报 undefined reference to 'boost::unit_test::framework::master_test_suite()'。

更隐蔽的问题:

  • 若项目其他部分用了 Boost::system 等静态库,而 Boost.Test 动态链接,可能引发符号冲突或 ABI 不兼容(尤其在 macOS 上)
  • find_package(Boost 1.54 REQUIRED COMPONENTS unit_test_framework) 中的版本号不能低于实际安装版本,否则 find_package 会静默失败,后续 target_link_libraries 报错找不到 Boost::unit_test_framework
  • #define BOOST_TEST_MODULE 必须在 #include <boost></boost> 之前,顺序反了会导致宏未生效

最常被忽略的一点:CTest 的 ctest --output-on-failure 和 ctest -j 并非总能如实反映测试失败原因——尤其是当测试进程因信号(如 SIGSEGV)崩溃时,输出可能被截断。真要调试,得直接运行测试可执行文件,或加 valgrind / AddressSanitizer 启动。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.14

2208

9

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

979

6

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

2024.03.14

407

5

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

307

5

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

386

5

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.03.14

580

5

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2024.03.21

1389

9

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

2024.03.22

1197

7

c++和c语言学习顺序推荐
c++和c语言学习顺序推荐

对于初学者,建议先学习C语言,掌握编程基础后再转入C++,便于理解面向对象编程概念。有编程经验者可直接学习C++,快速接触高级编程技术。想了解更多c++和c语言的相关内容,可以阅读本专题下面的文章。

2024.03.25

1305

9

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Conan 2 Essentials 免费课程
Conan 2 Essentials 免费课程

共0课时 | 0人学习

CMake 与 Conan 集成实践
CMake 与 Conan 集成实践

共0课时 | 0人学习

Conan 2 高级依赖模型介绍
Conan 2 高级依赖模型介绍

共0课时 | 0人学习