C++在CMake中如何定义单元测试子工程(add_subdirectory)

酷涛吖_9597

酷涛吖_9597

2026-10-30

552人浏览

原创

不能直接在测试目录用add_subdirectory引入测试工程,因为测试依赖主工程已定义的target、头文件路径和链接库;若执行顺序错乱或重复project(),将导致target未定义、头文件找不到或链接失败。

c++在cmake中如何定义单元测试子工程(add_subdirectory)

为什么不能直接在测试目录里用 add_subdirectory 引入测试工程

因为 CMake 的 add_subdirectory 本质是“嵌套执行另一个 CMakeLists.txt”,而测试工程通常依赖主工程的头文件、编译定义甚至链接库——如果测试目录的 CMakeLists.txt 没提前知道这些信息,find_package 会失败,target_include_directories 会找不到路径,target_link_libraries 会报 target not found。

常见错误现象:CMake Error: target "mylib" is not defined 或 fatal error: mylib/myheader.h: No such file or directory。

  • 主工程必须先通过 add_library(mylib ...) 定义目标,且该目标作用域需对子目录可见(默认是的)
  • 测试子目录的 CMakeLists.txt 必须在主工程 target 创建之后才被 add_subdirectory 执行
  • 不要在测试目录里重复 project();CMake 不允许嵌套 project

正确结构:主工程中定义库,再用 add_subdirectory 加载测试

推荐目录结构:

myproject/
├── CMakeLists.txt          # 主 CMakeLists,定义 mylib + add_subdirectory(tests)
├── src/
│   └── mylib.cpp
├── include/mylib/myheader.h
└── tests/
    ├── CMakeLists.txt      # 只定义 test executable + link mylib
    └── test_main.cpp

主 CMakeLists.txt 关键顺序不能错:

  • 调用 project() 和 set(CMAKE_CXX_STANDARD 17) 等基础设置
  • 用 add_library(mylib ...) 构建接口库(建议 INTERFACE 或 STATIC,避免测试时重编译)
  • 用 target_include_directories(mylib PUBLIC $ $) 暴露头文件
  • 最后 写 add_subdirectory(tests)

测试子目录的 CMakeLists.txt 怎么写才不报错

它不能独立运行,只负责声明测试可执行文件并消费主工程产出。核心是:不重新找依赖,只用已定义的 target。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载

示例 tests/CMakeLists.txt:

if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
  find_package(GTest REQUIRED)
endif()
<p>add_executable(test_mylib test_main.cpp)
target_link_libraries(test_mylib PRIVATE mylib GTest::gtest_main)</p><h1>注意:mylib 是主 CMakeLists 中定义的 target 名,不是路径或变量名</h1><p>enable_testing()
add_test(NAME mylib_unit_tests COMMAND test_mylib)</p>
  • if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) 是防御性写法:防止 tests 被单独 cmake 调用时崩溃
  • target_link_libraries(... PRIVATE mylib) 中的 mylib 必须和主工程中 add_library(mylib ...) 的名字完全一致(大小写敏感)
  • 不要在 tests 里写 include_directories(../include) —— mylib 的 PUBLIC 包含路径已自动传递

为什么 add_subdirectory 加测试比 add_test 更灵活

add_test 只能注册已存在的可执行文件,而 add_subdirectory 让你把测试组织成完整子工程:支持多测试文件、自定义构建选项、条件编译(如 if(BUILD_TESTS))、甚至集成 Catch2 或 doctest 的宏注册机制。

但代价是耦合变强:测试代码和主工程共享同一个 CMake configure 阶段,修改测试 CMakeLists 可能触发整个工程重配置。容易被忽略的一点是:add_subdirectory 的路径是相对于当前 CMakeLists.txt 的,写成 add_subdirectory(tests/) 和 add_subdirectory(tests) 效果一样,但写成 add_subdirectory(../tests) 就会破坏作用域隔离,导致 target 查找失败。

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

2268

9

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

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

2024.03.14

1039

6

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

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

2024.03.14

447

5

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

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

2024.03.14

327

5

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

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

2024.03.14

426

5

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

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

2024.03.14

600

5

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

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

2024.03.21

1429

9

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

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

2024.03.22

1237

7

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

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

2024.03.25

1325

9

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习