c++怎么用Google Test(gtest)进行单元测试_c++单元测试框架gtest使用指南

首先安装配置gtest,再编写测试用例并使用TEST宏定义测试,通过EXPECT_EQ等断言验证结果,最后结合CMake编译运行,实现对C++代码的单元测试覆盖。

在C++项目中使用Google Test(简称gtest)进行单元测试,是提升代码质量、确保模块正确性的有效方式。gtest是一个由Google开发的开源C++测试框架,功能强大、易于上手,支持断言、参数化测试、死亡测试等多种测试类型。

1. 安装与配置gtest

要使用gtest,首先需要将其集成到你的项目中。常见方法有通过包管理器安装或从源码编译:

  • Linux(以Ubuntu为例): 使用apt安装:
    sudo apt-get install libgtest-dev cmake
    然后进入目录编译gtest源码(因为libgtest-dev不直接提供库文件)。
  • macOS: 使用Homebrew:
    brew install googletest
  • Windows + vcpkg:
    vcpkg install gtest
  • 源码编译(通用方法):
    从GitHub克隆并构建:
    git clone https://github.com/google/googletest.git
    cd googletest
    mkdir build && cd build
    cmake ..
    make -j
    sudo make install
        

2. 编写第一个测试用例

假设你有一个简单的加法函数,想对它进行测试。

示例代码(add.h):

#ifndef ADD_H
#define ADD_H
int add(int a, int b);
#endif

add.cpp:

#include "add.h"
int add(int a, int b) {
    return a + b;
}

test_add.cpp(测试文件):

#include 
#include "add.h"

// 测试用例:测试add函数 TEST(TestAdd, HandlesPositiveNumbers) { EXPECT_EQ(add(2, 3), 5); }

TEST(TestAdd, HandlesNegativeNumbers) { EXPECT_EQ(add(-1, -1), -2); }

TEST(TestAdd, HandlesZero) { EXPECT_EQ(add(0, 0), 0); }

// 主函数,运行所有测试 int main(int argc, char **argv) { ::testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); }

这里使用了TEST宏定义测试用例,格式为 TEST(测试套件名, 测试名)。EXPECT_EQ用于判断两个值是否相等。

3. 编译和运行测试

将源文件和测试文件一起编译,链接gtest和pthread库。

例如使用g++编译:

g++ -std=c++11 add.cpp test_add.cpp -lgtest -lgtest_main -lpthread -o test_add
运行:
./test_add
输出类似:
[==========] Running 3 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 3 tests from TestAdd
[ RUN      ] TestAdd.HandlesPositiveNumbers
[       OK ] TestAdd.HandlesPositiveNumbers (0 ms)
[ RUN      ] TestAdd.HandlesNegativeNumbers
[       OK ] TestAdd.HandlesNegativeNumbers (0 ms)
[ RUN      ] TestAdd.HandlesZero
[       OK ] TestAdd.HandlesZero (0 ms)
[----------] 3 tests from TestAdd (0 ms total)
[==========] 3 tests passed.

4. 常用断言与高级特性

gtest提供了丰富的断言宏,帮助你验证各种条件。

常用断言:

  • EXPECT_EQ(a, b) / ASSERT_EQ(a, b):判断相等(EXPECT失败继续执行,ASSERT则中断当前测试)
  • EXPECT_TRUE(condition):判断条件为真
  • EXPECT_NE(a, b):不相等
  • EXPECT_LT(a, b):a 小于 b
  • EXPECT_STRNE(str1, str2):字符串不相等

参数化测试(Parametrized Tests): 当你想用多组数据测试同一逻辑时,可以使用参数化测试。

示例:

class AddTest : public ::testing::TestWithParam> {};

TEST_P(AddTest, TestAdd) { auto [a, b, expected] = GetParam(); EXPECT_EQ(add(a, b), expected); }

INSTANTIATE_TEST_SUITE_P( PositiveAndNegative, AddTest, ::testing::Values( std::make_tuple(2, 3, 5), std::make_tuple(-1, -1, -2), std::make_tuple(0, 0, 0) ) );

这样会为每组参数生成一个测试实例,提高覆盖率。

5. 与CMake集成(推荐)

现代C++项目通常使用CMake管理构建,集成gtest更方便。

CMakeLists.txt 示例:

cmake_minimum_required(VERSION 3.14)
project(MyProject)

set(CMAKE_CXX_STANDARD 11)

添加源文件

add_library(mylib add.cpp)

查找gtest

find_package(GTest REQUIRED)

添加测试可执行文件

add_executable(test_add test_add.cpp) target_link_libraries(test_add mylib GTest::GTest GTest::Main)

启用测试

enable_testing() add_test(NAME run_test_add COMMAND test_add)

然后执行:
mkdir build && cd build
cmake .. && make
ctest

基本上就这些。掌握这些内容后,你已经可以在C++项目中高效使用gtest进行单元测试了。关键是坚持“先写测试,再写实现”的TDD思路,逐步提升代码健壮性。