CMake:利用Google Test库进行单元测试

最新推荐文章于 2024-07-23 19:45:19 发布
最新推荐文章于 2024-07-23 19:45:19 发布
阅读量418 收藏
点赞数
分类专栏： cmake学习 文章标签： c++ linux cmake c语言 单元测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jjjstephen/article/details/132574851
版权
本文介绍了如何在CMake项目中使用GoogleTest进行单元测试，利用FetchContent模块下载并集成GoogleTest库，同时展示了如何配置CMakeLists.txt以支持单元测试并编写测试用例。
摘要由CSDN通过智能技术生成

CMake:利用Google Test库进行单元测试

导言

本篇，我们将学习如何在CMake的帮助下使用Google Test框架实现单元测试。与前一个配置（Catch2）相比，Google Test框架不仅仅是一个头文件，也是一个库，包含两个需要构建和链接的文件。可以将它们与我们的代码项目放在一起，但是为了使代码项目更加轻量级，我们将选择在配置时，下载一个定义良好的Google Test，然后构建框架并链接它。我们将使用较新的FetchContent模块(从CMake版本3.11开始可用)。关于FetchContent相关使用将在后续的笔记中学习。

此外，我们将在相关测试内容学习完成后挑选一个框架(Google Test目前更加流行)写一个小的项目实践，尽可能多的将该框架下的功能加以熟悉。

项目结构

NOTE

main.cpp、sum_integers.cpp和sum_integers.hpp与上一篇内容相同，我们对test.cpp将做相关的修改。

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

项目地址：

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

CMakeLists.txt

cmake_minimum_required(VERSION 3.11 FATAL_ERROR)

project(test_gtest LANGUAGES CXX)

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

set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)

add_library(sum_integers sum_integers.cpp)

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

option(ENABLE_UNIT_TESTS "Enable unit tests" ON)
message(STATUS "Enable testing: ${ENABLE_UNIT_TESTS}")

if(ENABLE_UNIT_TESTS)
  include(FetchContent)

  FetchContent_Declare(
    googletest
    GIT_REPOSITORY https://gitcode.net/mirrors/google/googletest.git
    GIT_TAG        release-1.8.0
  )

  FetchContent_GetProperties(googletest)

  if(NOT googletest_POPULATED)
    FetchContent_Populate(googletest)

    # Prevent GoogleTest from overriding our compiler/linker options
    # when building with Visual Studio
    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
    # Prevent GoogleTest from using PThreads
    set(gtest_disable_pthreads ON CACHE BOOL "" FORCE)

    # adds the targers: gtest, gtest_main, gmock, gmock_main
    add_subdirectory(
      ${googletest_SOURCE_DIR}
      ${googletest_BINARY_DIR}
    )

    # Silence std::tr1 warning on MSVC
    if(MSVC)
      foreach(_tgt gtest gtest_main gmock gmock_main)
        target_compile_definitions(${_tgt}
          PRIVATE
            "_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING"
        )
      endforeach()
    endif()
  endif()

  add_executable(cpp_test "")

  target_sources(cpp_test
    PRIVATE
      test.cpp
  )

  target_link_libraries(cpp_test
    PRIVATE
      sum_integers
      gtest_main
  )

  enable_testing()

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

注意： CMake 3.11版本以后才可以使用FetchContent模块。

set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)

告诉CMake在 Windows 平台上自动从共享库（DLL）中导出所有符号（函数、变量、类等）。

当将此选项设置为 ON 时，CMake会自动在库的代码中插入导出指令，确保它们可以被外部链接。这在 Windows 上特别重要，因为需要明确的导出声明才能让符号从 DLL 外部访问。

然而，启用此选项可能会导致生成较大的二进制文件，并可能意外地暴露符号。如果链接了多个库，还可能导致符号冲突。因此，虽然它简化了符号的导出，但需要仔细考虑其影响，以及是否适用于自己的项目。

option(ENABLE_UNIT_TESTS "Enable unit tests" ON)
message(STATUS "Enable testing: ${ENABLE_UNIT_TESTS}")
if(ENABLE_UNIT_TESTS)
    # all the remaining CMake code will be placed here
endif()

检查ENABLE_UNIT_TESTS。默认情况下，它为ON，但有时需要设置为OFF，以免在没有网络连接时，也能使用Google Test。

include(FetchContent)

FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://gitcode.net/mirrors/google/googletest.git
  GIT_TAG        release-1.8.0
)

使用了FetchContent模块来下载和集成Google Test库（googletest）。

  • include(FetchContent)：用于包含FetchContent模块，该模块允许在项目中获取外部依赖项。

  • FetchContent_Declare(googletest ...)：使用FetchContent_Declare宏来声明要获取的外部依赖项。在这种情况下，它声明了一个名为googletest的外部依赖项。

  • GIT_REPOSITORY：这是指定用于获取库的Git存储库的URL。

  • GIT_TAG：这是Git存储库中的特定标签或分支，指定希望获取的库的版本。在这里，它指定了Google Test库的版本为release-1.8.0。

使用这段代码后，当构建项目时，CMake将尝试下载并集成Google Test库，以便可以在项目中进行单元测试。请注意，实际项目中可能还需要在测试目标中链接Google Test库，并设置测试用例等。

if(NOT googletest_POPULATED)
    FetchContent_Populate(googletest)

    # Prevent GoogleTest from overriding our compiler/linker options
    # when building with Visual Studio
    set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
    # Prevent GoogleTest from using PThreads
    set(gtest_disable_pthreads ON CACHE BOOL "" FORCE)

    # adds the targers: gtest, gtest_main, gmock, gmock_main
    add_subdirectory(
      ${googletest_SOURCE_DIR}
      ${googletest_BINARY_DIR}
    )

    # Silence std::tr1 warning on MSVC
    if(MSVC)
      foreach(_tgt gtest gtest_main gmock gmock_main)
        target_compile_definitions(${_tgt}
          PRIVATE
            "_SILENCE_TR1_NAMESPACE_DEPRECATION_WARNING"
        )
      endforeach()
    endif()
  endif()

  • if(NOT googletest_POPULATED)：检查是否已经获取并集成了Google Test库。如果googletest_POPULATED未定义，则会执行其中的代码块。

  • FetchContent_Populate(googletest)：将下载的Google Test库内容填充到指定的目录，以便后续构建和集成。

  • set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)：在使用Visual Studio构建时，将强制Google Test使用共享运行时（C Runtime）库。可以避免构建时的链接错误。

  • set(gtest_disable_pthreads ON CACHE BOOL "" FORCE)：禁用Google Test对pthreads的使用。这可能在某些环境中是必需的，例如在没有pthreads支持的平台上。

  • add_subdirectory(...)：将Google Test库添加到项目中。它会在指定的源码目录和二进制目录中进行构建。

  • 对于Microsoft Visual Studio（MSVC），在构建Google Test库时，通过target_compile_definitions为gtest、gtest_main、gmock和gmock_main目标添加了宏定义以消除MSVC下的警告。

相关源码

test.cpp

#include "sum_integers.h"
#include "gtest/gtest.h"
#include <vector>

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

TEST(example, sum_zero) {
  auto integers = {1, -1, 2, -2, 3, -3};
  auto result = sum_integers(integers);
  ASSERT_EQ(result, 0);
}

TEST(example, sum_five) {
  auto integers = {1, 2, 3, 4, 5};
  auto result = sum_integers(integers);
  ASSERT_EQ(result, 15);
}

输出

mkdir build
cd build
cmake ..
ctest

Test project /home/jiangli/repo/tutorials/cmake-tutorial/chapter4/03/build
    Start 1: google_test
1/1 Test #1: google_test ......................   Passed    0.00 sec

100% tests passed, 0 tests failed out of 1

Total Test time (real) =   0.01 sec

./cpp_test

[==========] Running 2 tests from 1 test case.
[----------] Global test environment set-up.
[----------] 2 tests from example
[ RUN      ] example.sum_zero
[       OK ] example.sum_zero (0 ms)
[ RUN      ] example.sum_five
[       OK ] example.sum_five (0 ms)
[----------] 2 tests from example (0 ms total)

[----------] Global test environment tear-down
[==========] 2 tests from 1 test case ran. (0 ms total)
[  PASSED  ] 2 tests.

最后祝大家变得更强！！！

jjjstephen
关注
专栏目录
cmake构建googletest的单元测试（外部仓库引入）
qq_32062657的博客
06-20 1750
这段时间看了些cmake构建的一些规则，正巧项目中需要用到单元测试，这里就用cmake构建googletest框架（单元测试）来进行测试。正好也复习一下cmake构建规则。这里进行cmake构建的时候采用的是引入本地第三方库的方式进行构建，一般常规构建大都采用将第三方库源文件fetch到本地项目的third_party目录下进行整体项目的引入构建。我这里采用先将第三方源码编译安装后，引入到本地需要的项目中去的方式构建。首先，这里先下载googletest的源代码，这里采用的是1.10.0版本： ......
CMake项目使用ctest+gtest进行单元测试
witton的专栏
04-15 4454
使用CMake中的ctest进行单元测试
cmake应用：集成gtest进行单元测试
最新发布
nhb687096的博客
07-23 741
编写代码有bug是很正常的，通过编写完备的单元测试，可以及时发现问题，并且在后续的代码改进中持续观测是否引入了新的bug。对于追求质量的，为自己的代码编写全面的单元测试是必备的基础技能，在编写单元测试的时候也能复盘自己的代码设计，是提高代码质量极为有效的手段。在本系列前序的文章中已经介绍了CMake很多内容，本文是针对单元测试的外延。本文主要介绍以下几个方面的内容：1、何为单元测试2、何为gtest3、怎么使用gtest4、怎么运行测试一 单元测试是什么？
CMake I 创建一个简单的单元测试
该用户还没想到好的昵称的博客
01-25 7429
创建一个简单的单元测试。ctest命令、add_test()、enable_testing()。
cmake_test cmake_test cmake_test
04-18
在本项目"cmake_test cmake_test cmake_test"中，我们重点讨论如何利用 CMake 进行测试和配置管理。CMake 并不直接执行编译，而是生成平台特定的构建系统（如 Makefile 或 Visual Studio 工程），然后由这些工具执行...
learning-cmake：学习cmake
01-28
配合Google Test等单元测试库，可以方便地进行自动化测试。 对于多目标项目，CMake提供了`add_executable()`和`add_library()`命令，可以创建多个可执行文件和库。而`target_sources()`、`target_include_...
ament_cmake：支持CMake软件包以使用ament
02-13
3. **ament_add_gtest**：ament_cmake提供了简化添加Google Test单元测试的功能。它自动处理了测试数据的查找和测试目标的创建，使得测试集成更为便捷。 4. **ament_package**：这是ament_cmake中的关键宏，它定义...
cmake工程框架，带gtest单元测试
06-21
本项目提供的"cmake工程框架，带gtest单元测试"，就是一个很好的示例，它展示了如何利用CMake与Google Test（gtest）框架集成，来对C++代码进行单元测试。 首先，`CMake`是一种高级的构建工具，它通过生成特定平台...
集成gtest进行单元测试之cmake应用
OKCRoss的博客
05-25 964
对于追求质量的程序员，为自己的代码编写全面的单元测试是必备的基础技能，在编写单元测试的时候也能复盘自己的代码设计，是提高代码质量极为有效的手段。Google Test是Google开源的一个跨平台的C++单元测试框架，简称gtest，它提供了非常丰富的测试断言、判断宏，极大方便开发者编写测试用例的流程，也是很多开源项目使用的测试框架。这里的单元测试也只是作为示例，在真实的项目中，单元测试的编写往往更加复杂，而且这也还只是提高的软件鲁棒性中的一环，追求极致还需要更多努力。
CMake GoogleTest工程
tangtinghao的博客
03-18 533
CMake GoogleTest工程CMake GoogleTest工程编写被测试函数编写测试用例编写makefile CMake GoogleTest工程 编写被测试函数 class Calc { public: Calc(){} ~Calc(){} template<typename T> T test_fun(T ...
CMakeLists.txt 文件单元测试怎么写
木元心的博客
06-19 369
避免每个文件都去改一次。
如何使用CMake的CTest进行单元测试
目前在做 ROS相关的工作，主要是写ROS相关和C++的学习心得
04-21 5747
CMake是一个跨平台的构建工具，可以自动生成与平台相关的Makefile或Visual Studio项目文件，简化了C++程序的构建过程。而CTest是CMake的测试工具，它可以自动化运行单元测试，收集测试结果并生成报告。
【GTest】使用CMakeLitsts.txt构建Windows和Linux的跨平台GoogleTest项目（非常详细+亲测有效）
测试开发自动化
06-02 2273
如果不知道如何构建对应的项目，参考第一步，历史博客。
一个简单的实操学会使用cmake将googletest组织到C++工程中，进行单元测试并分析结果（附实操源码）
Warren++的博客
05-05 1349
一个简单的实操学会使用cmake将googletest组织到C++工程中，进行单元测试并分析结果（附实操源码）
【CMake】使用ctest配置googletest
beidou111的博客
11-03 2373
以下讨论均为C++我们首先要理解什么是测试。测试就是把程序的某个函数单独拿出来，然后为它单独写一个main函数。运行这个main函数，看看打印结果是不是预期的，那就是测试了。由于测试是软件开发通用流程的一部分，因此当然可以用第三方工具来规范化测试流程。其中GoogleTest就是谷歌家推出的测试框架。它为你定义了一些方便的宏，还提供了好看的测试输出（比如测试失败的时候到底哪里错了？正确值是多少？）。我们要记住，它只是个方便的工具，你完全你可自己手写一个简陋的测试框架，只要写自己的main函数即可。
GoogleTest入门使用（基于CMake）
爱就是是恒久忍耐的专栏
10-02 2844
本文讲述如何使用GoogleTest去测试程序
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值