C / C++ / 系统课时

用 CTest 统一运行测试

用 CTest 统一运行测试

当项目里的测试可执行文件越来越多,手工逐个运行很容易漏测。CTest 的价值是把这些测试注册成一个集合,让构建目录知道“有哪些测试、怎样启动”,之后用一条 ctest 命令统一执行并汇总结果。

学习目标

  • 理解 enable_testing() 与 add_test() 分别负责什么
  • 能把已有测试程序注册到 CTest
  • 能用 ctest 一次运行全部测试并定位失败项

CTest 管理的是测试入口

CTest 不负责替你编写断言,也不会自动发现任意可执行文件。CMake 配置阶段先通过 enable_testing() 开启测试支持,再用 add_test() 明确登记测试名称和启动命令。之后 CTest 读取构建目录中的测试元数据,按注册信息执行。

add_test() 注册的是“如何运行一次测试”。只要命令最终以退出码 0 结束,CTest 就把它视为通过;非零退出码通常表示失败。因此,测试程序必须把断言结果转换成正确的进程退出状态。

建立一个可运行的最小项目

下面的 test_calc.c 根据命令行参数运行两个测试场景。它不依赖第三方测试框架,便于观察 CTest 本身做了什么。

c
#include <stdio.h>
#include <string.h>

static int add(int a, int b) {
    return a + b;
}

static int safe_divide(int a, int b, int *out) {
    if (b == 0) {
        return -1;
    }
    *out = a / b;
    return 0;
}

int main(int argc, char **argv) {
    if (argc != 2) {
        fprintf(stderr, "usage: calc_test <case>\n");
        return 2;
    }

    if (strcmp(argv[1], "add") == 0) {
        return add(2, 3) == 5 ? 0 : 1;
    }

    if (strcmp(argv[1], "divide-zero") == 0) {
        int result = 0;
        return safe_divide(8, 0, &result) == -1 ? 0 : 1;
    }

    fprintf(stderr, "unknown case: %s\n", argv[1]);
    return 2;
}

预期结果

text
该源文件可被 C 编译器编译;传入 add 或 divide-zero 时,测试通过会以退出码 0 结束。

在同一目录创建 CMakeLists.txt。这里先生成测试程序,再把同一个目标以不同参数注册成两个测试。

cmake
cmake_minimum_required(VERSION 3.20)
project(ctest_demo C)

enable_testing()

add_executable(calc_test test_calc.c)

add_test(NAME calc_add
         COMMAND calc_test add)

add_test(NAME calc_divide_zero
         COMMAND calc_test divide-zero)

这段配置生效后,CMake 会在构建目录写入 CTest 所需的测试描述。COMMAND 中直接写目标名 calc_test,CMake 会在生成阶段把它解析为对应的测试可执行文件。

配置、构建并统一执行

先在项目根目录运行 cmake -S . -B build 完成配置,再运行 cmake --build build 生成 calc_test。两条命令成功后,用 CTest 执行已注册的测试集合;--output-on-failure 会在失败时显示该测试的标准输出和错误输出。

bash
ctest --test-dir build --output-on-failure

预期输出

text
Internal ctest changing into directory: <PATH>/build
Test project <PATH>/build
    Start 1: calc_add
1/2 Test #1: calc_add .........................   Passed    <TIME> sec
    Start 2: calc_divide_zero
2/2 Test #2: calc_divide_zero .................   Passed    <TIME> sec

100% tests passed, 0 tests failed out of 2

<PATH> 和 <TIME> 会随机器、生成器和运行速度变化。关键检查点是两条测试都被发现,并且最终失败数为 0。

测试没有被发现时怎么查

如果 ctest 显示没有测试,先确认 enable_testing() 位于顶层项目中,并且相关 add_test() 确实在配置阶段被执行。修改 CMakeLists.txt 后也要重新运行 CMake 配置,不能只重复执行旧构建目录里的 ctest。

还可以先只列出测试而不执行:

bash
ctest --test-dir build -N

预期输出

text
Test project <PATH>/build
  Test #1: calc_add
  Test #2: calc_divide_zero

Total Tests: 2

当项目开始包含单元测试、集成测试和不同模块的测试程序时,统一注册到 CTest 的好处会更明显:本地开发、CI 和发布前检查都可以复用同一套测试入口,而不必维护多份手工命令清单。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 CTest 统一运行测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通