CMake中如何将多个含Catch2测试的库合并为单个测试执行文件？

问题根源 #

Catch2的TEST_CASE依赖静态全局对象在程序启动时自动注册到测试框架，但共享库（.so/.dll）中的静态对象默认不会被主程序自动初始化，链接器会因未直接引用符号而优化掉部分库的代码，导致仅第一个链接的库的测试用例被执行。

解决方案 #

以下三种方案均可在保持各测试目录独立的前提下，实现单个可执行文件运行所有测试用例：

方案1：将子测试库改为静态库

静态库在链接时会把所有目标文件合并到主可执行文件中，静态注册的测试对象会被正确初始化。修改子目录的CMakeLists.txt：

# Directory1/CMakeLists.txt
add_library(libTest1 STATIC testFile1.cpp)
target_link_libraries(libTest1 PRIVATE Catch2::Catch2)

# Directory2/CMakeLists.txt
add_library(libTest2 STATIC testFile2.cpp)
target_link_libraries(libTest2 PRIVATE Catch2::Catch2)

主程序的链接逻辑无需修改，编译后所有测试用例会被整合到testApp中，运行时即可全部执行。

方案2：强制链接器保留共享库所有符号

若必须使用共享库，可通过链接器选项强制主程序加载共享库的全部符号，避免优化。在主程序的CMakeLists.txt中添加：

target_link_options(testApp PRIVATE
    # GCC/Clang 环境
    -Wl,--whole-archive libTest1 libTest2 -Wl,--no-whole-archive
    # MSVC 环境（需单独配置）
    $<$<CXX_COMPILER_ID:MSVC>:/WHOLEARCHIVE:libTest1.lib /WHOLEARCHIVE:libTest2.lib>
)

注意需将libTest1和libTest2放在--whole-archive与--no-whole-archive之间，避免影响其他库的链接行为。

方案3：为共享库添加显式初始化函数

在每个测试库中定义初始化函数，主程序主动调用以触发静态对象构造：

1. 在testFile1.cpp中添加：

extern "C" void init_libTest1() {
    // 空函数即可，调用会触发库内静态对象初始化
}

2. 在testFile2.cpp中添加init_libTest2()函数
3. 在Main.cpp中调用初始化函数：

extern "C" void init_libTest1();
extern "C" void init_libTest2();

int main() {
    init_libTest1();
    init_libTest2();
    return Catch::Session().run();
}

该方式灵活性高，适合必须使用共享库的场景。

内容的提问来源于stack exchange，提问作者TorqueNoFriction