CMake学习--ctest全面介绍

ctest 是 CMake 自带的一个测试工具，主要用于自动化测试管理和执行。它与 CMake 的 CTest 模块紧密集成，使得构建和测试流程更加高效和自动化。本文将详细介绍 ctest 的功能、使用方法以及一些高级特性。

一、ctest 基础概念

ctest 是一个命令行工具，专门用于执行在 CMake 项目中定义的测试。测试通常是基于 C++ 的单元测试框架（如 Google Test）或者其他测试框架的。它的主要作用是：

• 运行测试：执行所有定义的测试用例。
• 报告结果：展示测试执行结果，帮助开发者快速发现问题。
• 集成到 CI/CD：自动化测试，集成到持续集成/持续部署流程中。

二、配置 ctest

1. CMake 配置

要使用 ctest，首先需要在 CMake 项目中配置测试。主要通过以下几个步骤完成：

1. 启用测试

   在 CMakeLists.txt 文件中启用测试支持：

   enable_testing()
   

2. 添加测试

   使用 add_test() 函数添加测试用例。测试用例通常是一个可执行文件或脚本：

   add_executable(my_test my_test.cpp)
   target_link_libraries(my_test gtest gtest_main)
   add_test(NAME MyTest COMMAND my_test)
   

   这里的 my_test 是一个测试可执行文件，gtest 和 gtest_main 是 Google Test 库。add_test() 定义了一个名为 MyTest 的测试，使用 my_test 可执行文件来执行测试。

2. 配置测试参数

你可以通过 CMake 配置测试的各种参数，如超时、标签等。例如，可以设置测试超时时间：

set_tests_properties(MyTest PROPERTIES TIMEOUT 60)

三、使用 ctest

1. 执行测试

在构建目录中运行 ctest 命令来执行测试：

ctest

此命令会运行所有已定义的测试，并输出测试结果。默认情况下，ctest 会以简洁的格式显示结果。

2. 查看测试结果

ctest 会提供以下几种输出格式：

• 简洁模式：只显示测试总结，如通过的测试数和失败的测试数。

  100% tests passed, 0 tests failed out of 5
  

• 详细模式：使用 -V 选项查看详细输出，包括每个测试的具体执行情况和失败原因。

  ctest -V
  

  详细输出帮助你了解每个测试的执行情况和具体错误信息。

• JSON 格式：使用 --output-junit 选项将结果输出为 JUnit 格式的 XML 文件，方便与其他工具集成。

  ctest --output-junit results.xml
  

3. 控制测试执行

ctest 提供了多个选项来控制测试执行，包括：

• 运行特定测试：通过 -R 选项运行符合正则表达式的测试。

  ctest -R MyTest
  

• 运行失败的测试：通过 --schedule-rerun 选项重新运行之前失败的测试。

  ctest --schedule-rerun
  

• 并行执行：通过 -j 选项指定并行执行的测试数量，提高测试效率。

  ctest -j 4
  

4. 使用测试标签

可以为测试添加标签，通过 -L 选项选择运行特定标签的测试：

set_tests_properties(MyTest PROPERTIES LABELS "unit")

ctest -L unit

四、高级特性

1. 测试套件

ctest 支持测试套件（test suites），允许将多个测试组织在一起。你可以在 CMake 中定义测试套件，ctest 会按套件执行测试：

add_test(NAME Suite1::Test1 COMMAND my_test1)
add_test(NAME Suite1::Test2 COMMAND my_test2)

2. 自定义测试运行器

ctest 允许自定义测试运行器，通过 ctest -S 选项使用 CTest 脚本来运行测试：

ctest -S my_script.cmake

3. 生成报告

ctest 可以生成不同格式的测试报告，包括：

• XML 报告：使用 --output-xml 选项生成 XML 报告，方便其他工具处理和分析。

  ctest --output-xml results.xml
  

• HTML 报告：通过 ctest 与外部工具结合，生成 HTML 格式的测试报告。

4. 与 Continuous Integration (CI) 集成

ctest 很容易集成到 CI/CD 流程中。大多数 CI 工具（如 Jenkins、GitLab CI）都支持运行 ctest 并解析测试结果。可以通过 CI 配置文件中定义构建和测试步骤，自动化执行和报告测试结果。

五、示例项目

假设你有一个简单的 CMake 项目，需要设置并运行测试。以下是完整的示例：

1. 项目结构

   my_project/
   ├── CMakeLists.txt
   ├── src/
   │   └── my_class.cpp
   ├── include/
   │   └── my_class.h
   └── tests/
       ├── CMakeLists.txt
       └── test_my_class.cpp
   

2. 根目录 CMakeLists.txt

   cmake_minimum_required(VERSION 3.10)
   project(MyProject)
   
   # 添加子目录
   add_subdirectory(src)
   add_subdirectory(tests)
   

3. src/CMakeLists.txt

   add_library(my_class my_class.cpp)
   target_include_directories(my_class PUBLIC ${CMAKE_SOURCE_DIR}/include)
   

4. tests/CMakeLists.txt

   enable_testing()
   
   find_package(GTest REQUIRED)
   include_directories(${GTEST_INCLUDE_DIRS})
   
   add_executable(test_my_class test_my_class.cpp)
   target_link_libraries(test_my_class ${GTEST_LIBRARIES} pthread my_class)
   
   add_test(NAME MyClassTest COMMAND test_my_class)
   

5. tests/test_my_class.cpp

   #include <gtest/gtest.h>
   #include "my_class.h"
   
   TEST(MyClassTest, DoSomething) {
       MyClass obj;
       EXPECT_NO_THROW(obj.doSomething());
   }
   

6. 运行测试

   mkdir build
   cd build
   cmake ..
   cmake --build .
   ctest
   

六、总结

ctest 是一个功能强大的工具，适用于各种测试场景。从简单的单元测试到复杂的集成测试，ctest 提供了丰富的功能来支持测试管理和自动化。通过配置和使用 ctest，你可以提升测试的效率和准确性，从而提高软件质量和可靠性。