GoogleTest快速入门：使用CMake构建测试项目

GoogleTest快速入门：使用CMake构建测试项目

googletest 由 Google 开发的一款用于 C++ 的单元测试和模拟（mocking）框架 项目地址: https://gitcode.com/gh_mirrors/go/googletest

前言

GoogleTest是Google开发的一个C++测试框架，广泛应用于各种C++项目的单元测试中。本文将详细介绍如何使用CMake构建系统来快速搭建一个基于GoogleTest的测试项目，适合初次接触GoogleTest或需要快速上手的开发者。

准备工作

在开始之前，请确保您的开发环境满足以下要求：

1. 操作系统：支持Linux、macOS或Windows系统
2. 编译器：支持C++17标准的C++编译器（如g++、clang++或MSVC）
3. 构建工具：
   • CMake 3.14或更高版本
   • 配套的构建工具（如Make、Ninja等）

项目初始化

首先创建一个项目目录并初始化CMake配置文件：

mkdir my_project && cd my_project

配置CMakeLists.txt

在项目根目录下创建CMakeLists.txt文件，这是CMake构建系统的核心配置文件。我们将使用CMake的FetchContent模块来获取GoogleTest依赖。

cmake_minimum_required(VERSION 3.14)
project(my_project)

# 设置C++17标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 使用FetchContent获取GoogleTest
include(FetchContent)
FetchContent_Declare(
  googletest
  URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip
)

# Windows平台特殊设置
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(googletest)

关键点说明

1. cmake_minimum_required指定了CMake的最低版本要求
2. CMAKE_CXX_STANDARD设置C++语言标准为C++17
3. FetchContent模块允许我们在配置时下载和管理依赖项
4. URL中的commit hash可以替换为最新的GoogleTest版本

编写测试用例

创建一个简单的测试文件hello_test.cc：

#include <gtest/gtest.h>

// 基本断言演示
TEST(HelloTest, BasicAssertions) {
  // 验证两个字符串不相等
  EXPECT_STRNE("hello", "world");
  // 验证相等性
  EXPECT_EQ(7 * 6, 42);
}

这个测试用例展示了GoogleTest的基本断言功能：

• EXPECT_STRNE用于验证字符串不相等
• EXPECT_EQ用于验证数值相等

配置测试构建

在CMakeLists.txt末尾添加以下内容来配置测试构建：

enable_testing()

# 创建测试可执行文件
add_executable(
  hello_test
  hello_test.cc
)

# 链接GoogleTest库
target_link_libraries(
  hello_test
  GTest::gtest_main
)

# 启用测试发现
include(GoogleTest)
gtest_discover_tests(hello_test)

这段配置完成了以下工作：

1. 启用CMake的测试功能
2. 创建名为hello_test的可执行文件
3. 链接GoogleTest的主库
4. 使用GoogleTest模块自动发现测试用例

构建和运行测试

执行以下命令构建并运行测试：

# 生成构建系统
cmake -S . -B build

# 编译项目
cmake --build build

# 运行测试
cd build && ctest

如果一切顺利，您将看到类似如下的输出：

Test project .../my_project/build
    Start 1: HelloTest.BasicAssertions
1/1 Test #1: HelloTest.BasicAssertions ........   Passed    0.00 sec

100% tests passed, 0 tests failed out of 1

进阶建议

1. 测试组织：随着项目增长，建议将测试文件组织到专门的test目录中
2. Mock功能：GoogleTest还提供了强大的Mock功能，可用于模拟测试依赖
3. 测试夹具：对于需要共享设置的测试组，可以使用测试夹具(Test Fixtures)
4. 参数化测试：GoogleTest支持参数化测试，可以简化相似测试用例的编写

常见问题解决

1. 下载失败：检查网络连接，或尝试更新commit hash到最新版本
2. 编译错误：确认编译器支持C++17标准
3. 链接错误：检查target_link_libraries配置是否正确

通过本教程，您已经掌握了使用CMake构建GoogleTest测试项目的基本方法。接下来可以探索GoogleTest更高级的功能，如测试夹具、参数化测试和Mock对象等，以构建更完善的测试套件。

googletest 由 Google 开发的一款用于 C++ 的单元测试和模拟（mocking）框架 项目地址: https://gitcode.com/gh_mirrors/go/googletest