CMake:利用CTest进行单元测试

最新推荐文章于 2024-02-22 15:01:44 发布
最新推荐文章于 2024-02-22 15:01:44 发布
阅读量487 收藏 2
点赞数
分类专栏： cmake学习 文章标签： c++ linux cmake c语言 单元测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jjjstephen/article/details/132443046
版权

CMake:利用CTest进行单元测试

导言

CTest是CMake的测试工具，本篇通过编写和测试能够对整数求和的代码，以窥探CTest其中的功能一二。为了说明CMake没有对实际测试的语言进行任何限制，我们不仅使用C++可执行文件测试代码，还使用Python脚本和shell脚本作为测试代码。为了简单起见，我们将不使用任何测试库来实现，但是我们将在后面的笔记中熟悉C++测试框架。

项目结构

.
├── CMakeLists.txt
├── main.cpp
├── sum_integers.cpp
├── sum_integers.h
├── test.cpp
├── test.py
└── test.sh

项目地址：

https://gitee.com/jiangli01/tutorials/tree/master/cmake-tutorial/chapter4/01

CMakeLists.txt

cmake_minimum_required(VERSION 3.10 FATAL_ERROR)

project(test_ctest LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

find_package(PythonInterp REQUIRED)
find_program(BASH_EXECUTABLE NAMES bash REQUIRED)

# example library
add_library(sum_integers sum_integers.cpp)

# main code
add_executable(sum_up main.cpp)
target_link_libraries(sum_up sum_integers)

# testing binary
add_executable(cpp_test test.cpp)
target_link_libraries(cpp_test sum_integers)

enable_testing()

add_test(
  NAME bash_test
  COMMAND ${BASH_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test.sh $<TARGET_FILE:sum_up>
)

add_test(
  NAME cpp_test
  COMMAND $<TARGET_FILE:cpp_test>
)

add_test(
  NAME python_test_long
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test.py --executable $<TARGET_FILE:sum_up>
)

add_test(
  NAME python_test_short
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test.py --short --executable $<TARGET_FILE:sum_up>
)

find_program(BASH_EXECUTABLE NAMES bash REQUIRED)

用于查找系统中的bash可执行文件，并将可执行文件的路径存储在变量BASH_EXECUTABLE中。这可以用于在CMake构建过程中执行bash脚本或命令。

enable_testing()

测试这个目录和所有子文件夹(因为我们把它放在主CMakeLists.txt)。

add_test(
  NAME cpp_test
  COMMAND $<TARGET_FILE:cpp_test>
)

定义了一个新的测试，并设置测试名称和运行命令。

上述代码中，使用了生成器表达式:$<TARGET_FILE:cpp_test>。生成器表达式，是在生成构建系统生成时的表达式。我们将在后续的学习内容中介绍和学习生成器表达式。然后，可以声明$<TARGET_FILE:cpp_test>变量，将使用cpp_test可执行目标的完整路径进行替换。

NOTE
生成器表达式在测试时非常方便，因为不必显式地将可执行程序的位置和名称，可以硬编码到测试中。以一种可移植的方式实现这一点非常麻烦，因为可执行文件和可执行后缀(例如，Windows上是.exe后缀)的位置在不同的操作系统、构建类型和生成器之间可能有所不同。使用生成器表达式，我们不必显式地了解位置和名称。

也可以将参数传递给要运行的test命令：

add_test(
  NAME python_test_short
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test.py --short --executable $<TARGET_FILE:sum_up>
)

NOTE
CTest可以以任何编程语言运行测试集。CTest关心的是，通过命令的返回码测试用例是否通过。CTest遵循的标准约定是：返回零意味着成功，非零返回意味着失败。可以返回零或非零的脚本，都可以做测试用例。

相关源码

sum_integers.h

#ifndef SUM_INTEGERS_H
#define SUM_INTEGERS_H
#include <vector>
int sum_integers(const std::vector<int> &integers);
#endif // ! SUM_INTEGERS_H

sum_integers.cpp

#include "sum_integers.h"

int sum_integers(const std::vector<int>& integers) {
  auto sum = 0;
  for (auto i : integers) {
    sum += i;
  }
  return sum;
}

main.cpp

#include <iostream>
#include <string>

#include "sum_integers.h"

int main(int argc, char *argv[]) {
  std::vector<int> integers;
  for (auto i = 1; i < argc; i++) {
    integers.push_back(std::stoi(argv[i]));
  }
  auto sum = sum_integers(integers);
  std::cout << sum << std::endl;

  return 0;
}

test.cpp

#include "sum_integers.h"

int main() {
  auto integers = {1, 2, 3, 4, 5};
  if (sum_integers(integers) == 15) {
    return 0;
  } else {
    return 1;
  }
}

test.py

import subprocess
import argparse
# test script expects the executable as argument
parser = argparse.ArgumentParser()
parser.add_argument('--executable', help='full path to executable')
parser.add_argument('--short',
					default=False,
                    action='store_true',
                    help='run a shorter test')
args = parser.parse_args()
def execute_cpp_code(integers):
    result = subprocess.check_output([args.executable] + integers)
    return int(result)
if args.short:
    # we collect [1, 2, ..., 100] as a list of strings
    result = execute_cpp_code([str(i) for i in range(1, 101)])
    assert result == 5050, 'summing up to 100 failed'
else:
    # we collect [1, 2, ..., 1000] as a list of strings
    result = execute_cpp_code([str(i) for i in range(1, 1001)])
    assert result == 500500, 'summing up to 1000 failed'

test.sh

#!/usr/bin/env bash
EXECUTABLE=$1
OUTPUT=$($EXECUTABLE 1 2 3 4)
if [ "$OUTPUT" = "10" ]
then
    exit 0
else
    exit 1
fi

输出结果

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

Test project /home/jiangli/repo/tutorials/cmake-tutorial/chapter4/01/build
    Start 1: bash_test
1/4 Test #1: bash_test ........................   Passed    0.00 sec
    Start 2: cpp_test
2/4 Test #2: cpp_test .........................   Passed    0.00 sec
    Start 3: python_test_long
3/4 Test #3: python_test_long .................   Passed    0.03 sec
    Start 4: python_test_short
4/4 Test #4: python_test_short ................   Passed    0.03 sec

100% tests passed, 0 tests failed out of 4

Total Test time (real) =   0.08 sec

附录

1. 考虑以下定义:

add_test(
  NAME python_test_long
  COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test.py --executable $<TARGET_FILE:sum_up>
)

前面的定义可以通过显式指定脚本运行的WORKING_DIRECTORY重新表达，如下:

add_test(
  NAME python_test_long
  COMMAND ${PYTHON_EXECUTABLE} test.py --executable $<TARGET_FILE:sum_up>
  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

测试名称可以包含/字符，按名称组织相关测试也很有用，例如：

add_test(
  NAME python/long
  COMMAND ${PYTHON_EXECUTABLE} test.py --executable $<TARGET_FILE:sum_up>
  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)

有时候，我们需要为测试脚本设置环境变量。这可以通过set_tests_properties实现:

set_tests_properties(python_test
  PROPERTIES
    ENVIRONMENT
      ACCOUNT_MODULE_PATH=${CMAKE_CURRENT_SOURCE_DIR}
      ACCOUNT_HEADER_FILE=${CMAKE_CURRENT_SOURCE_DIR}/account/account.h
      ACCOUNT_LIBRARY_FILE=$<TARGET_FILE:account>
)

这种方法在不同的平台上并不总可行，CMake提供了解决这个问题的方法。下面的代码片段与上面给出的代码片段相同，在执行实际的Python测试脚本之前，通过CMAKE_COMMAND调用CMake来预先设置环境变量：

add_test(
  NAME
      python_test
  COMMAND
    ${CMAKE_COMMAND} -E env
    ACCOUNT_MODULE_PATH=${CMAKE_CURRENT_SOURCE_DIR}
    ACCOUNT_HEADER_FILE=${CMAKE_CURRENT_SOURCE_DIR}/account/account.h
    ACCOUNT_LIBRARY_FILE=$<TARGET_FILE:account>
    ${PYTHON_EXECUTABLE}
    ${CMAKE_CURRENT_SOURCE_DIR}/account/test.py
)

同样，要注意使用生成器表达式$<TARGET_FILE:account>来传递库文件的位置。

2. 不同平台测试命令
我们已经使用ctest命令执行测试，CMake还将为生成器创建目标(Unix Makefile生成器为make test，Ninja工具为ninja test，或者Visual Studio为RUN_TESTS)。这意味着，还有另一种(几乎)可移植的方法来运行测试：

$ cmake --build . --target test

当使用Visual Studio生成器时，我们需要使用RUN_TESTS来代替:

$ cmake --build . --target RUN_TESTS
jjjstephen
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
CMake关于ctest的示例
05-31
建议多参考官方文档：https://cmake.org/cmake/help/latest/manual/ctest.1.html?highlight=ctest
ctest:ctest是用C编写的软件的单元测试框架
05-02
CTEST ctest是使用C / C ++编写的软件的单元测试框架。 特征： 以最小的麻烦添加测试（无需手动添加到套件或测试列表！） 支持测试套件 支持每个测试的setup（）teardown（） 测试失败时，输出格式不会混乱，因此易于解析。 显示经过的时间，因此您可以快速进行测试 使用着色来轻松识别错误 仅在输出到终端（不是文件/进程）时使用着色 它很小（超过300行代码！） 易于集成（仅1个头文件） 有跳过选项可以跳过某些测试（不再评论测试） Linux + OS / X支持 测试例 CTEST (suite, test1) { ASSERT_STR ( " foo " , " foo " ); } CTEST (suite, test2) { ASSERT_EQUAL ( 1 , 2 ); } CTEST (suite, test_dbl) {
【Cmake】Ctest测试工具
bandaoyu的note
08-08 6233
CTest是CMake集成的一个测试工具，在使用CMakeLists.txt文件编译工程的时候，CTest会自动configure、build、test和展现测试结果。创建CTestConfig.cmake在上层目录中，在cmake文件中，我们可以声明项目的名字和上传到的地址。原文链接：https://blog.csdn.net/xu_yun_huan_yue/article/details/120155307。2. 在test/CMakeLists.txt中写你的测试需要的即可（可以如下面那样写）....
ctest
11-27
ctest, 字符设备驱动模块 例子，
CTest
bacanpi5506的博客
12-03 1025
一、初识CTest CTest是CMake集成的一个测试工具，在使用CMakeLists.txt文件编译工程的时候，CTest会自动configure、build、test和展现测试结果 CTest有两个模式： 模式一：使用CMake configure 和 build工程，在CMakeLists.txt文件中，使用特殊的命令取创建tests。...
ctest使用
m0_37574068的博客
10-15 6814
enable_testing() add_test(NAME COMMAND WORKING_DIRECTORY) 命令行顺序：cmake -> windows:build/linux:make -> ctest 踩坑1 如果报错找不到可执行文件，是因为默认在如下路径中查找。想要自定义ctest的查找路径，需要设置WORKING_DIRECTORY 踩坑2...
【CMake】使用ctest配置googletest
beidou111的博客
11-03 2258
以下讨论均为C++我们首先要理解什么是测试。测试就是把程序的某个函数单独拿出来，然后为它单独写一个main函数。运行这个main函数，看看打印结果是不是预期的，那就是测试了。由于测试是软件开发通用流程的一部分，因此当然可以用第三方工具来规范化测试流程。其中GoogleTest就是谷歌家推出的测试框架。它为你定义了一些方便的宏，还提供了好看的测试输出（比如测试失败的时候到底哪里错了？正确值是多少？）。我们要记住，它只是个方便的工具，你完全你可自己手写一个简陋的测试框架，只要写自己的main函数即可。
CMake的CTest方法
huyanjie0327的专栏
06-26 1万+
参考：http://hahack.com/codes/cmake/ Demo目录结构如下： Test/ ├── add.cpp └── CMakeLists.txt add.cpp #include #include int main(int argc, char *argv[]) { if (argc != 3) { std::cout << "pa
cmake工程框架，带gtest单元测试
06-21
本项目提供的"cmake工程框架，带gtest单元测试"，就是一个很好的示例，它展示了如何利用CMake与Google Test（gtest）框架集成，来对C++代码进行单元测试。 首先，`CMake`是一种高级的构建工具，它通过生成特定平台...
learning-cmake：学习cmake
01-28
配合Google Test等单元测试库，可以方便地进行自动化测试。 对于多目标项目，CMake提供了`add_executable()`和`add_library()`命令，可以创建多个可执行文件和库。而`target_sources()`、`target_include_...
C语言 单元测试 gtest教程 ctestcode Unitest
11-30
基于google gtest gmock的 实战教程。 演示，单元测试在C语言上 运用 简单上手，通俗易懂，提高代码质量，和编程效率
CMake测试之道：轻松构建自动化测试
最新发布
07-26
本文将深入探讨如何利用 CMake 构建自动化测试流程，并从基础知识到高级配置，逐一讲解如何有效地使用 CMake 实现测试自动化。 #### 1. CMake 测试概述 CMake 的测试功能主要由 CTest 工具提供支持。CTest 是一个...
vim-cmake：VimNeovim插件，用于处理CMake项目
02-01
这个插件利用 Vim 的强大功能和灵活性，结合 CMake 的构建系统特性，提供了高效的工作流程，使得开发者在编写、构建和调试 CMake 项目时能够更加便捷。 ### 插件主要功能 1. **CMakeLists.txt 自动补全**：vim-...
cmake 使用 ctest 测试
热门推荐
EastonWoo的专栏
09-12 2万+
cmake  使用 ctest  测试 1). test.cpp /// @file test.cpp /// @brief /// @author EastonWoo /// 0.01 /// @date 2015-09-12 #include #include int main(int argc, const char *argv[]) {  
007 - CMake 运行 CTest 进行测试
EricTeo
06-03 1万+
CMake 运行 CTest 进行测试 文章目录CMake 运行 CTest 进行测试引言使用方式根目录加 `enable_testing()`加上测试 `add_test`编译运行看结果`add_test` 命令设置测试属性WILL_FAILTIMEOUTTIMEOUT_AFTER_MATCHPASS_REGULAR_EXPRESSIONFAIL_REGULAR_EXPRESSIONSKIP_REGULAR_EXPRESSIONSKIP_RETURN_CODE其他属性 引言 写代码嘛，总归是要写一些测试
CTest在CMake项目中的详细使用步骤（一）
m0_52536237的博客
02-22 1156
在QT Creator上编写的存在多个UI界面的cmake项目的测试。
CMake创建CTest工程
fduffyyg的博客
01-22 235
CMake创建CTest工程
CMake：跨平台构建利器
而CTest模块则提供了集成的测试框架，与Google Test等单元测试库配合，方便进行自动化测试。 CMake以其跨平台、易于定制和管理的特点，成为许多大型开源项目和商业软件首选的构建工具。开发者可以通过学习CMake，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值