选项名称的 CMake 命名约定以生成带有单元测试的项目？

Question

一些 CMake 项目为生成具有单元测试支持的项目添加了条件支持。项目根 CMakeLists.txt 文件中遵循的模式类似于：

cmake_minimum_required(VERSION 3.0)

(...)
# add subdirectories, libraries, executables, etc
(...)

option(ENABLE_TESTS "Generate project with unit test support" ON)
if(ENABLE_TESTS)
    enable_testing()
    add_subdirectory(tests)
endif()

虽然这种模式相当普遍，但我也注意到为单元测试选项选择的名称有些随意。尽管BUILD_TESTING 选项是在cmake v3.15 中引入的，但该名称在该版本之前远非标准名称。到目前为止，我注意到使用以下选项名称的项目：

• BUILD_TESTS
• BUILD_TESTING
• ENABLE_TESTS
• RUN_TESTS
• 等等……

考虑到这一点，有人知道是否有标准命名约定来控制是否将单元测试添加到 CMake 项目中？

Answer 1

是否有标准命名约定来控制是否将单元测试添加到 CMake 项目中？

我通常会看到这样的模式：

if (YOUR_LIBRARY_BUILD_TESTING AND BUILD_TESTING)
    enable_testing()
    add_subdirectory(tests)
endif()

这样：

• 您可以使用 -DYOUR_LIBRARY_BUILD_TESTING=1 -DBUILD_TESTING=1 启用库测试。
• 其他人可以使用-DHIS_LIBRARY_BUILD_TESTING=1 -DBUILD_TESTING=1 启用他的库测试
• 当其他人的库包含您的库时，他可以选择是否要构建您的库测试，并且通常他只想运行他的单元测试，而不是您的。
  • 另一种方法是在add_subdirectory 周围推送/弹出BUILD_TESTING，就像set(sav ${BUILD_TESTING}) set(BUILD_TESTING 0) add_subdirectory(your_library) set(BUILD_TESTING ${sav}) 一样，看起来很难看。如果您想要测试依赖库（例如，使用上游未测试的特定不同工具链），您必须编辑 cmake 文件。
• 您的库的包构建者、维护者和分发者只需将 -DBUILD_TESTING=0 设置为全面禁用所有可能的测试。

Modern cmake，相信目前的cmake教程，推荐：

if((CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR MYPROJECT_BUILD_TESTING) AND BUILD_TESTING)

这只是让您在测试自己的项目时省略设置MYPROJECT_BUILD_TESTING=1。

关于套件项目的一些简短研究，我看到VTK_BUILD_TESTING、PARAVIEW_BUILD_TESTING、VTKm_ENABLE_TESTING、SMTK_ENABLE_TESTING，甚至${PROJECT_NAME}_BUILD_TESTING。当启用特定项目的*_BUILD_TESTING 时，有些人似乎将BUILD_TESTING 强制设置为ON。

到目前为止，我注意到使用以下选项名称的项目

每个人都来使用他自己的约定，我相信这就是 cmake 被很好地采用的原因 - 它不会“强制”任何特定的事情。我相信大多数开发人员在编写 cmake 脚本时还不知道 BUILD_TESTING 变量，所以他们开始提出自己的约定 - 或者 BUILD_TESTING 是错误的名称，因为它只意味着测试将是 构建，而不是运行。无论如何，由于 BUILD_TESTING 是很久以前的 cmake，我建议将项目特定标志命名为 *_BUILD_TESTING。