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

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

googletest GoogleTest - Google Testing and Mocking Framework 项目地址: https://gitcode.com/gh_mirrors/googl/googletest

前言

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

环境准备

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

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

项目初始化

首先创建一个项目目录并初始化CMake项目结构：

mkdir my_project && cd my_project

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

配置CMakeLists.txt

以下是完整的CMakeLists.txt文件内容，我们将分段解释关键部分：

cmake_minimum_required(VERSION 3.14)
project(my_project)

# 设置C++标准要求
set(CMAKE_CXX_STANDARD 14)
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最低版本要求为3.14
2. 设置了C++14标准为必需
3. 通过URL直接下载特定版本的GoogleTest（示例中的commit hash可替换为最新版本）
4. Windows平台需要特殊设置以确保CRT库的一致性

编写测试用例

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

#include <gtest/gtest.h>

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

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

• TEST()宏定义了一个测试用例
• 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. 版本控制：定期更新GoogleTest的commit hash以获取最新版本
2. 测试组织：随着项目增长，合理组织测试文件和目录结构
3. 高级特性：探索GoogleTest提供的更多断言类型和测试功能
4. 持续集成：考虑将测试流程集成到CI/CD系统中

结语

通过本文，您已经学会了如何使用CMake快速搭建一个基于GoogleTest的测试项目。GoogleTest提供了丰富的测试功能，能够满足从简单到复杂的各种测试需求。建议下一步阅读GoogleTest的官方文档，深入了解其更多高级特性和最佳实践。

googletest GoogleTest - Google Testing and Mocking Framework 项目地址: https://gitcode.com/gh_mirrors/googl/googletest