18、CMake中的CDash集成：CDash是什么、配置CDash提交、构建报告与测试结果上传

说到持续集成，很多团队会用Jenkins、GitLab CI这些工具。但CMake生态里有个老牌选手——CDash，专门为CMake项目量身定制。我个人觉得，如果你团队的项目重度依赖CMake，那CDash绝对值得一试。

CDash是什么？

CDash是一个构建与测试结果聚合平台。说白了，它就是个Web仪表盘，帮你收集、展示、对比每次构建的状态。

你想想看，一个项目几十个模块，跨平台编译，测试用例成百上千。每次提交代码后，哪些模块编译失败了？哪些测试挂了？挂的原因是什么？CDash就是来解决这些问题的。

我在项目中遇到过这样的情况：团队用Jenkins跑构建，但每次要看日志得翻半天。后来上了CDash，所有构建结果一目了然，还能对比历史数据，定位问题快多了。

配置CDash提交

要让项目往CDash提交数据，核心就两步：在CMakeLists.txt里配置CDash地址，然后用CTest命令上传。

嗯，这里要注意：CDash本身是个独立服务，需要先部署好。你可以用官方提供的Docker镜像，也可以自己搭。我建议新手先用官方的公共测试实例试试水，地址是 https://my.cdash.org。

第一步：在CMakeLists.txt中集成

# 启用测试
enable_testing()

# 设置CDash服务器地址
set(CTEST_DASHBOARD_ROOT "/path/to/build")
set(CTEST_SITE "my-laptop")
set(CTEST_BUILD_NAME "Ubuntu-GCC-Release")
set(CTEST_DROP_SITE "my.cdash.org")
set(CTEST_DROP_LOCATION "/submit.php?project=MyProject")
set(CTEST_DROP_SITE_CDASH TRUE)

这些变量告诉CTest：往哪个服务器、哪个项目提交数据。我个人习惯把CTEST_BUILD_NAME写得详细点，比如带上编译器版本、构建类型，这样在CDash上区分不同构建方便。

第二步：编写CTest脚本

通常我们会写一个CTestConfig.cmake或者直接用ctest -S驱动脚本。下面是个典型例子：

# dashboard.cmake
cmake_minimum_required(VERSION 3.10)

# 包含CDash配置
include(CTest)

# 设置项目信息
set(CTEST_PROJECT_NAME "MyProject")
set(CTEST_NIGHTLY_START_TIME "00:00:00 UTC")

# 配置、构建、测试
ctest_start("Nightly")
ctest_configure()
ctest_build()
ctest_test()

# 上传结果
ctest_submit()

运行方式很简单：

ctest -S dashboard.cmake

构建报告与测试结果上传

CDash最实用的地方，就是能让你看到每次构建的详细报告。包括：

• 配置阶段：CMake是否成功，有没有警告
• 编译阶段：哪些文件编译失败，错误信息是什么
• 测试阶段：每个测试用例的状态（通过/失败/超时），耗时多少

我曾经遇到过一个坑：测试在本地全过，但CDash上显示失败。后来发现是测试依赖了本地环境变量，而CDash构建环境没有设置。从那以后，我写测试都会显式设置环境变量，或者用set_tests_properties指定。

上传测试结果的关键配置

在CMakeLists.txt里，你可以给每个测试打标签，方便CDash分类：

add_test(NAME unit_test_math COMMAND test_math)
set_tests_properties(unit_test_math PROPERTIES
  LABELS "unit;math"
  TIMEOUT 30
  COST 1.0
)

上传时，CDash会把这些信息一起带上去。你可以在仪表盘上按标签筛选，只看单元测试或者集成测试的结果。

构建报告的定制化

有时候你不想上传所有信息，只想传个摘要。CTest提供了ctest_submit的parts参数：

# 只上传测试结果
ctest_submit(parts Test)

# 只上传编译结果
ctest_submit(parts Build)

# 全部上传
ctest_submit()

我个人习惯在CI脚本里分阶段上传：先传配置结果，再传编译结果，最后传测试结果。这样即使中间某步失败，前面的数据已经保存了，方便排查。

CDash的实用技巧

用CDash时间长了，我总结了几条经验：

• 命名规范很重要：构建名称里带上平台、编译器、构建类型，比如Linux-GCC11-Release，这样在CDash上筛选时一目了然。
• 定期清理旧数据：CDash默认保留所有历史数据，时间长了数据库会膨胀。建议设置数据保留策略，比如只保留最近30天的。
• 邮件通知别开太猛：默认配置下，每次失败都会发邮件。如果项目频繁提交，邮件会轰炸。我建议只对关键模块开启通知，或者汇总成日报。

嗯，CDash集成其实不复杂，核心就是配置好服务器地址，然后用CTest脚本驱动。但真正用好它，需要团队形成习惯——每次提交后都看一眼仪表盘，别让失败构建过夜。

说白了，CDash就是个可视化的问题追踪器。它不会帮你修bug，但能让你第一时间知道哪里出了问题。对于中大型CMake项目，这玩意儿能省下不少排查时间。

---