CMake项目使用ctest+gtest进行单元测试

已于 2023-04-21 17:11:45 修改
阅读量4.1k 收藏 21
点赞数 7
分类专栏： # C/C++ 文章标签： cmake ctest gtest 自动下载 依赖
于 2023-04-15 17:12:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/witton/article/details/130170686
版权

随着CMake工具越来越强大便捷，越来越多的C/C++项目转而使用CMake来进行编译管理，它还提供了用于测试的ctest命令来执行项目中编写的单元测试。

本文就以一个实例来介绍如何使用ctest来进行单元测试。

一、环境准备

本文实例环境VSCode+MinGW64+CMake+gtest。

需要在MinGW中安装gtest，如果没有安装也没有关系，在CMakeLists.txt中进行检测，如果发现没有安装，则自动下载源码进行编译。

二、新建项目

新建一个目录，比如demo，然后使用VSCode打开目录，创建一个CMake项目。
创建CMake项目可以使用VSCode的CMake向导来创建，也可以直接在目录中编写一个CMakeLists.txt来创建。

使用VSCode的CMake向导创建项目

在VSCode中按F1，在弹出的选项中选择CMake:快速入门

在这里插入图片描述

然后选择编译套件，如果需要搜索，可以选择[Scan for kits]

在这里插入图片描述

然后输入项目名称，比如demo

在这里插入图片描述

根据项目需要选择库（Library）或者可执行体（Executable），这里选择Executable

在这里插入图片描述

然后向导会自动新建CMakeLists.txt和main.cpp：

在这里插入图片描述

CMakeLists.txt：

cmake_minimum_required(VERSION 3.0.0)
project(demo VERSION 0.1.0)

include(CTest)
enable_testing()

add_executable(demo main.cpp)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

Main.cpp：

#include <iostream>

int main(int, char**) {
    std::cout << "Hello, world!\n";
}

自行创建CMake项目

其实就是自己编写上面的CMakeLists.txt和项目源码

可以从CMakeLists.txt中看到已经添加并启用了CTest

三、创建单元测试

1、添加需要测试的功能，比如建立一个func.h和func.cpp

func.h：

#ifndef __FUNC_H_INCLUDE_
#define __FUNC_H_INCLUDE_

int Factorial(int n);
bool IsPrime(int n);

#endif

func.cpp：

#include "func.h"

// Returns n! (the factorial of n).  For negative n, n! is defined to be 1.
int Factorial(int n) {
  int result = 1;
  for (int i = 1; i <= n; i++) {
    result *= i;
  }

  return result;
}

// Returns true if and only if n is a prime number.
bool IsPrime(int n) {
  // Trivial case 1: small numbers
  if (n <= 1) return false;

  // Trivial case 2: even numbers
  if (n % 2 == 0) return n == 2;

  // Now, we have that n is odd and n >= 3.

  // Try to divide n by every odd number i, starting from 3
  for (int i = 3;; i += 2) {
    // We only have to try i up to the square root of n
    if (i > n / i) break;

    // Now, we have i <= n/i < n.
    // If n is divisible by i, n is not prime.
    if (n % i == 0) return false;
  }

  // n has no integer factor in the range (1, n), and thus is prime.
  return true;
}

2、创建测试目录test，并在目录中添加CMakeLists.txt、tmain.cpp和单元测试代码test.cpp。

test/CMakeLists.txt：

add_executable(t tmain.cpp test.cpp ../func.cpp)
target_link_libraries(t PRIVATE gtest)

add_test(NAME t COMMAND t)

tmain.cpp：

#include <gtest/gtest.h>

int main()
{
    testing::InitGoogleTest();
    return RUN_ALL_TESTS();
}

test.cpp：

#include <gtest/gtest.h>
#include "../func.h"


// Tests Factorial().

// Tests factorial of negative numbers.
TEST(FactorialTest, Negative) {
  // This test is named "Negative", and belongs to the "FactorialTest"
  // test case.
  EXPECT_EQ(1, Factorial(-5));
  EXPECT_EQ(1, Factorial(-1));
  EXPECT_GT(Factorial(-10), 0);

  // <TechnicalDetails>
  //
  // EXPECT_EQ(expected, actual) is the same as
  //
  //   EXPECT_TRUE((expected) == (actual))
  //
  // except that it will print both the expected value and the actual
  // value when the assertion fails.  This is very helpful for
  // debugging.  Therefore in this case EXPECT_EQ is preferred.
  //
  // On the other hand, EXPECT_TRUE accepts any Boolean expression,
  // and is thus more general.
  //
  // </TechnicalDetails>
}

// Tests factorial of 0.
TEST(FactorialTest, Zero) { EXPECT_EQ(1, Factorial(0)); }

// Tests factorial of positive numbers.
TEST(FactorialTest, Positive) {
  EXPECT_EQ(1, Factorial(1));
  EXPECT_EQ(2, Factorial(2));
  EXPECT_EQ(6, Factorial(3));
  EXPECT_EQ(40320, Factorial(8));
}

// Tests IsPrime()

// Tests negative input.
TEST(IsPrimeTest, Negative) {
  // This test belongs to the IsPrimeTest test case.

  EXPECT_FALSE(IsPrime(-1));
  EXPECT_FALSE(IsPrime(-2));
  EXPECT_FALSE(IsPrime(INT_MIN));
}

// Tests some trivial cases.
TEST(IsPrimeTest, Trivial) {
  EXPECT_FALSE(IsPrime(0));
  EXPECT_FALSE(IsPrime(1));
  EXPECT_TRUE(IsPrime(2));
  EXPECT_TRUE(IsPrime(3));
}

// Tests positive input.
TEST(IsPrimeTest, Positive) {
  EXPECT_FALSE(IsPrime(4));
  EXPECT_TRUE(IsPrime(5));
  EXPECT_FALSE(IsPrime(6));
  EXPECT_TRUE(IsPrime(23));
}

项目的目录结构如下：

在这里插入图片描述

3、修改根目录CMakeLists.txt

需要在CMakeLists.txt中引用test目录，添加如下命令：

add_subdirectory(test)

4、运行测试

如果MinGW中安装有gtest则可以在VSCode中执行Run CTest了：

在这里插入图片描述

输出如下：

在这里插入图片描述

当然，也可以在VSCode中选择测试目标t直接运行测试：

在这里插入图片描述

有没发现使用ctest并不能像直接运行测试目标t那样显示出详细的测试项目，那是因为在CMakeLists.txt中是使用的通用方法add_test(NAME t COMMAND t)添加的测试，其实CMake是直接支持gtest的，只需要把add_test(NAME t COMMAND t)换成下面两句即可：

include(GoogleTest)
gtest_add_tests(TARGET t)

可以看到各测试项目的情况了：

在这里插入图片描述

而且运行Run CTest后，VSCode中也会提示有几个测试用例和通过情况：

在这里插入图片描述

使用gtest_add_tests有一个问题：一旦测试用例改变，它就需要重新执行cmake，否则无法知道改变后的测试用例。 所以CMake添加了gtest_discover_tests指令，它通过调用编译后的执行程序并添加参数--gtest_list_tests来获取测试用例的，所以不需要重新执行CMake。

既然如此，那前面的tmain.cpp需要作修改以接收参数：

tmain.cpp：

#include <gtest/gtest.h>

int main(int argc, char *argv[])
{
	testing::InitGoogleTest(&argc, argv);
	return RUN_ALL_TESTS();
}

此时把gtest_add_tests(TARGET t)替换成gtest_discover_tests(t)即可，修改后的CMakeLists.txt完整源码：

add_executable(t tmain.cpp test.cpp ../func.cpp)
target_link_libraries(t PRIVATE gtest)

include(GoogleTest)
gtest_discover_tests(t)

其实，gtest本身是带有一个main函数库的，只需要包链接gtest_main即可，不需要自己写tmain.cpp中的内容。可以把tmain.cpp删除，使用下面的CMakeLists.txt即可：

add_executable(t test.cpp ../func.cpp)
target_link_libraries(t PRIVATE gtest gtest_main)

include(GoogleTest)
gtest_discover_tests(t)

四、让CMake自动下载、编译依赖

前面有提到，要运行示例，必须要求安装了gtest，可以写入CMakeLists.txt中，使用CMake的find_package命令来查找，本例是需要GTest,添加find_package(GTest REQUIRED)，并且是必须要安装有，所有后面添加了REQUIRED参数，注意必须是大写。

如果找不到GTest则会报错：
在这里插入图片描述
这种方式要求在MinGW中安装有GTest，可以使用MinGW命令：pacman -S mingw-w64-x86_64-gtest来安装。

当然更友好的方式是如果系统没有安装则自己下载源码进行编译引用，在根目录的CMakeLists.txt中添加：

cmake_policy(SET CMP0135 NEW)
find_package(GTest)
if(NOT GTest_FOUND)
message("GTest not found, download it...")
include(FetchContent)
FetchContent_Declare(googletest URL https://github.com/google/googletest/archive/refs/heads/main.zip)
FetchContent_MakeAvailable(googletest)
endif()

这里find_package没有添加REQUIRED参数来强制要求，只是检测，后面判断检测结果GTest_FOUND，如果没有找到则从指定URL下载（FetchContent_Declare）并编译（FetchContent_MakeAvailable），由于使用URL下载需要添加cmake_policy(SET CMP0135 NEW)，不然会报警告：

[cmake]   The DOWNLOAD_EXTRACT_TIMESTAMP option was not given and policy CMP0135 is
[cmake]   not set.  The policy's OLD behavior will be used.  When using a URL
[cmake]   download, the timestamps of extracted files should preferably be that of
[cmake]   the time of extraction, otherwise code that depends on the extracted
[cmake]   contents might not be rebuilt if the URL changes.  The OLD behavior
[cmake]   preserves the timestamps from the archive instead, but this is usually not
[cmake]   what you want.  Update your project to the NEW behavior or specify the
[cmake]   DOWNLOAD_EXTRACT_TIMESTAMP option with a value of true to avoid this
[cmake]   robustness issue.

FetchContent_Declare也可以使用GIT_REPOSITORY从Git克隆下来，但是这种方式如果网络不好则比较慢。

注意为了使用这些高级指令，最好是安装最新的CMake版本，FetchContent最低要求3.11：

cmake_minimum_required(VERSION 3.11.0)

写得非常详细，如果觉得对你有帮助，欢迎点赞收藏！

witton
关注
  • 7
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ctest-gtest:CTest与Google Test
05-28
测试 CTest与Google Test
cmake + gtest 工程示例
09-01
这个包演示了如何结合cmake和gtest(googletest)，实现了单元测试。
cmake应用：集成gtest进行单元测试
2301_77645834的博客
06-06 800
对于追求质量的程序员，为自己的代码编写全面的单元测试是必备的基础技能，在编写单元测试的时候也能复盘自己的代码设计，是提高代码质量极为有效的手段。Google Test是Google开源的一个跨平台的C++单元测试框架，简称gtest，它提供了非常丰富的测试断言、判断宏，极大方便开发者编写测试用例的流程，也是很多开源项目使用的测试框架。这里的单元测试也只是作为示例，在真实的项目中，单元测试的编写往往更加复杂，而且这也还只是提高的软件鲁棒性中的一环，追求极致还需要更多努力。
【gtest】 C++ 的测试框架之使用 gtest 编写单元测试
最新发布
朝花夕拾
06-14 1119
本文介绍了如何使用 Google 的 C++ 测试框架 gtest 编写单元测试。首先，详细解释了 gtest 的安装和配置步骤，确保读者能够顺利搭建测试环境。接着，通过具体代码示例演示了基本的测试用例编写方法，包括 TEST 宏、断言、测试夹具等。文章还讨论了如何组织和运行测试，提高测试代码的可维护性。最后，分享了一些常见的测试技巧和最佳实践，帮助开发者更有效地进行单元测试，提高代码质量和稳定性。
集成gtest进行单元测试之cmake应用
OKCRoss的博客
05-25 845
对于追求质量的程序员，为自己的代码编写全面的单元测试是必备的基础技能，在编写单元测试的时候也能复盘自己的代码设计，是提高代码质量极为有效的手段。Google Test是Google开源的一个跨平台的C++单元测试框架，简称gtest，它提供了非常丰富的测试断言、判断宏，极大方便开发者编写测试用例的流程，也是很多开源项目使用的测试框架。这里的单元测试也只是作为示例，在真实的项目中，单元测试的编写往往更加复杂，而且这也还只是提高的软件鲁棒性中的一环，追求极致还需要更多努力。
[cmake]cmake引入三方库gtest
FL1768317420的博客
03-30 597
很多时候，我们需要在工程中引入第三方库，例如加解密、证书、tls等功能的openssl库。本文以C++开源测试框架库gtest为例介绍如何将该库引入到我们的工程中，并写一个简单的用例来验证。有两种方式将其引入到我们的工程中，一种是将gtest的源码直接与本地工程一起编译构建，一种是将gtest编译成链接库，本地工程引用该库。在介绍上述两种方式之前，需要先下载gtest的源码，下载方式。
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) {
【C++中级篇】gtest的使用方法及cmake配置
行走的漂流瓶的博客
02-17 3730
在一项c++工程中，会存在很多类，很多功能方法，如果每个对外的接口方法都通过在业务中发现问题，是一件相当糟糕的事儿，而且效率低下。如果针对每个接口都设计一个主函数进行验证，需要运行很多程序，为解决这个问题，单元测试模块应运而生，本期探讨下由google开发的单元测试模块gtest的使用方法。
下载包时出错的解决方式
D浩DzD的博客
01-31 4484
在安装依赖包的时候有些资源是在国外的网站，所以下载取来容易失败或者特别慢，可以使用以下方式试着解决， 一下步骤依次使用，若操作到第一步就解决了则不需要继续操作后面步骤了 一.设置 npm 镜像源 # 设置为国内镜像源 npm config set registry http://registry.npm.taobao.org # 查看当前镜像源 npm config get registry # 恢复原来镜像源 npm config set registry http://registry.npmjs.
【CMake】【GTest】CMAKE+GTEST
qq_43331089的博客
05-04 2962
【GTest】CMAKE+GTEST 项目中想用google test，项目也是用cmake管理的。 于是想用cmake 添加gtest set(CMAKE_PREFIX_PATH "/path/to/gtest/install/path/cmake/path" ${CMAKE_PREFIX_PATH}) enable_testing() set(GTEST_ROOT "/path/to/gtest/install/path") find_package(GTest R
CMake+GTest
程序员小志
09-01 391
【代码】CMake+GTest。
gtest单元测试---论算法工程师如何维护自己的代码
lovely_yoshino的博客
08-01 5003
0. 简介 在开发大量的程序后，我们发现每一个之前留下的BUG都需要耗费大量的时间去排查设计。这样会造成算法开发人员耗费大量的时间和精力。而gtest就是这样的一个工具，它是Google的一个开源框架，主要功能是用于编写单元测试，从而检查自己的程序是否符合预期行为。这当然是QA（测试工程师）最常用的工具，但是作为一名算法工程师也需要清楚自己的算法是否符合设计需求以及规范。 1. 认识 gtest 1.1 安装 gtest gtest作为一种测试框架，它可以在垮平台（Linux，Mac OS X，Window
CMake Test编写
young_monkeysun的博客
03-27 1274
项目目录如下sum_integers为项目源文件。main为从命令行获取测试数据并调用sum_integers的功能，并返回计算结果。test为在test文件中设定测试数据，并调用相应的程序将测试数据传输给main的可执行文件。由main可执行程序计算，并返回计算结果。test获取计算结果，根据test文件中的设定，判断测试成功与否。PRIVATE# 查找valgrind，并将MEMORYCHECK_COMMAND设置为其绝对路径# 将相关参数传递给valgrind。
cmake简单使用编译gtest工程
weixin_43550934的博客
05-18 395
用cmake 简化gtest编译过程
CMake之创建和运行测试
u010378559的博客
03-30 1438
CMake中使用CTest，GoogleTest创建和运行测试
stm32使用GTEST单元测试
06-06
在STM32中使用Google Test（GTest）进行单元测试，需要进行以下步骤： 1. 在STM32项目中添加GTest的头文件和源文件，包括gtest.h、gtest-all.cc、gtest_main.cc等。 2. 编写测试用例，可以参考GTest的文档进行编写。 3. 在STM32项目中添加测试代码和测试数据。 4. 使用GTest运行测试用例，并输出测试结果。 需要注意的是，在STM32中使用GTest进行单元测试需要借助一些第三方库和工具，例如使用CMake进行编译和构建，使用J-Link或ST-Link进行调试和烧录。因此，需要有一定的开发经验和基础知识才能进行此类操作。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值