GoogleTest 使用指南｜事件机制

原创于 2026-05-25 14:49:26 发布 · 534 阅读

13 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

标签

#单元测试 #C++ #GoogleTest

GoogleTest 使用指南｜事件机制

GoogleTest 使用指南｜事件机制

GoogleTest 使用指南｜事件机制

GoogleTest 提供了一个强大的事件监听系统，允许你在测试执行的各个阶段插入自定义代码。这对于生成自定义报告、性能分析、资源监控等场景非常有用。

事件机制架构：

GoogleTest 的事件一共有 3 种：

全局的，所有案例执行前后。
TestSuite 级别的，在某一批案例中第一个案例前，最后一个案例执行后。
TestCase 级别的，每个 TestCase 前后。

全局事件

要实现全局事件，必须写一个类，继承 testing::Environment 类，实现里面的 SetUp 和 TearDown 方法。

SetUp() 方法在所有案例执行前执行
TearDown() 方法在所有案例执行后执行

environment.h：

#pragma once

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

class GlobalTestEnvironment : public ::testing::Environment
{
public:
    // 在所有测试开始前执行一次
    void SetUp() override
    {
        std::cout << "Global Test Environment SetUp" << std::endl;
    }

    // 在所有测试结束后执行一次
    void TearDown() override
    {
       std::cout << "Global Test Environment TearDown" << std::endl;
    }
};

当然，这样还不够，我们还需要告诉 gtest 添加这个全局事件，我们需要在 main 函数中通过 testing::AddGlobalTestEnvironment 方法将事件挂进来。我们可以写很多个这样的类，然后将他们的事件都挂上去。

test_global_environment.cpp：

#include "environment.h"
#include "max.h"
#include "min.h"

TEST(MaxTest, NegativeNumbers) {
    EXPECT_EQ(max(-3, -5), -3);
    EXPECT_EQ(max(-10, -2), -2);
}

TEST(MaxTest, MixedNumbers) {
    EXPECT_EQ(max(-5, 5), 5);
    EXPECT_EQ(max(0, -10), 0);
}

// Min 函数测试
TEST(MinTest, PositiveNumbers) {
    EXPECT_EQ(min(3, 5), 3);
    EXPECT_EQ(min(10, 2), 2);
}

TEST(MinTest, NegativeNumbers) {
    EXPECT_EQ(min(-3, -5), -5);
    EXPECT_EQ(min(-10, -2), -10);
}

int main(int argc, char* argv[])
{
    // 注册全局环境
    ::testing::InitGoogleTest(&argc, argv);

    ::testing::AddGlobalTestEnvironment(new GlobalTestEnvironment);

    return RUN_ALL_TESTS();
}

CMakeLists.txt：

add_executable(test_global_environment test_environment.cpp max.cpp)
# 注意：用 gtest 而不是 gtest_main，因为我们有自定义 main
target_link_libraries(test_environment gtest)
add_test(NAME test_environment COMMAND test_environment)

测试输出：

"/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_environment"
➜  Clang 17.0.0 arm64-apple-darwin24.6.0 "/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_environment"
[==========] Running 4 tests from 2 test suites.
[----------] Global test environment set-up.
Global Test Environment SetUp
[----------] 2 tests from MaxTest
[ RUN      ] MaxTest.NegativeNumbers
[       OK ] MaxTest.NegativeNumbers (0 ms)
[ RUN      ] MaxTest.MixedNumbers
[       OK ] MaxTest.MixedNumbers (0 ms)
[----------] 2 tests from MaxTest (0 ms total)

[----------] 2 tests from MinTest
[ RUN      ] MinTest.PositiveNumbers
[       OK ] MinTest.PositiveNumbers (0 ms)
[ RUN      ] MinTest.NegativeNumbers
[       OK ] MinTest.NegativeNumbers (0 ms)
[----------] 2 tests from MinTest (0 ms total)

[----------] Global test environment tear-down
Global Test Environment TearDown
[==========] 4 tests from 2 test suites ran. (0 ms total)
[  PASSED  ] 4 tests.

注意 Global Test Environment SetUp 和 Global Test Environment TearDown 两个语句的位置。

TestProgram、TestIterator 事件

TestProgram 和 TestIteration 是 GoogleTest 事件机制里比较外层的两个生命周期阶段。

TestProgram 表示整个测试程序的一次完整运行。对应两个事件：

void OnTestProgramStart(const ::testing::UnitTest& unit_test) override;
void OnTestProgramEnd(const ::testing::UnitTest& unit_test) override;

它们只在整个测试进程开始和结束时触发一次。

适合做：

打开/关闭总日志文件
输出测试总数
记录整个测试程序最终是否通过
生成测试运行摘要

TestIteration 表示“一轮测试执行”。默认情况下只执行一轮，所以你可能感觉它和 TestProgram 差不多。但如果使用：

--gtest_repeat=2

测试会执行两轮，这时 TestIteration 会触发两次。

对应事件：

void OnTestIterationStart(const ::testing::UnitTest& unit_test, int iteration) override;
void OnTestIterationEnd(const ::testing::UnitTest& unit_test, int iteration) override;

事件顺序大致是：

  OnTestProgramStart

  OnTestIterationStart iteration=0
    运行所有测试
  OnTestIterationEnd iteration=0

  OnTestIterationStart iteration=1
    再运行所有测试
  OnTestIterationEnd iteration=1

  OnTestProgramEnd

下面是一个例子。

test_program_interaiton.cpp：

#include "gtest/gtest.h"

#include <fstream>

namespace {

class ProgramIterationListener : public ::testing::EmptyTestEventListener {
public:
    explicit ProgramIterationListener(const char* log_file)
        : log_stream_(log_file, std::ios::out | std::ios::trunc) {}

    void OnTestProgramStart(const ::testing::UnitTest& unit_test) override {
        log_stream_ << "ProgramStart: total_test_count="
                    << unit_test.total_test_count() << "\n";
    }

    void OnTestIterationStart(const ::testing::UnitTest& unit_test, int iteration) override {
        log_stream_ << "IterationStart: iteration=" << iteration
                    << ", total_test_count=" << unit_test.total_test_count() << "\n";
    }

    void OnTestIterationEnd(const ::testing::UnitTest& unit_test, int iteration) override {
        log_stream_ << "IterationEnd: iteration=" << iteration
                    << ", successful_test_count=" << unit_test.successful_test_count()
                    << ", failed_test_count=" << unit_test.failed_test_count() << "\n";
    }

    void OnTestProgramEnd(const ::testing::UnitTest& unit_test) override {
        log_stream_ << "ProgramEnd: passed="
                    << (unit_test.Passed() ? "true" : "false") << "\n";
        log_stream_.flush();
    }

private:
    std::ofstream log_stream_;
};

TEST(ProgramIterationListenerTest, RunsInEachIteration) {
    SUCCEED();
}

} // namespace

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

    ::testing::UnitTest::GetInstance()->listeners().Append(
        new ProgramIterationListener("program_iteration_log.txt"));

    return RUN_ALL_TESTS();
}

CMakeLists.txt 中我们设置这个测试执行两轮：

在这里插入图片描述

测试结果：

在这里插入图片描述

可以看出 Program 事件有 1 次，Iteration 事件有 2 次。

TestSuite 事件

TestSuite（测试套件）事件是在一组相关测试执行前后运行的设置和清理代码。与全局环境不同，TestSuite 事件是针对特定测试套件的。

我们需要写一个类，继承 ::testing::Test，然后实现两个静态方法：

SetUpTestCase() 方法在第一个 TestCase 之前执行
TearDownTestCase() 方法在最后一个 TestCase 之后执行

class FooTest : public ::testing::Test
{
protected:
  static void SetUpTestCase() {
    std::cout << "TestSuite SetUp" << std::endl;
  }

  static void TearDownTestCase() {
    std::cout << "TestSuite TearDown" << std::endl;
  }
};

在编写测试案例时，我们需要使用 TEST_F 这个宏，第一个参数必须是我们上面类的名字，代表一个 TestSuite。

TEST_F(FooTest, Test1)
{
    std::cout << "Test 1" << std::endl;
}

TEST_F(FooTest, Test2)
{
    std::cout << "Test 2" << std::endl;
}

测试输出：

"/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_suite"
➜  Clang 17.0.0 arm64-apple-darwin24.6.0 "/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_suite"
Running main() from /Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/_deps/googletest-src/googletest/src/gtest_main.cc
[==========] Running 2 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 2 tests from FooTest
TestSuite SetUp
[ RUN      ] FooTest.Test1
Test 1
[       OK ] FooTest.Test1 (0 ms)
[ RUN      ] FooTest.Test2
Test 2
[       OK ] FooTest.Test2 (0 ms)
TestSuite TearDown
[----------] 2 tests from FooTest (0 ms total)

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

TestCase 事件

TestCase 事件是挂在每个案例执行前后的，实现方式和上面的几乎一样，不过需要实现的是 SetUp 和 TearDown 方法：

SetUp() 方法在每个 TestCase 之前执行
TearDown() 方法在每个 TestCase 之后执行

class FooTest : public ::testing::Test
{
protected:
  static void SetUpTestCase() {
    std::cout << "TestSuite SetUp" << std::endl;
  }

  static void TearDownTestCase() {
    std::cout << "TestSuite TearDown" << std::endl;
  }

  void SetUp() override {
        std::cout << "TestCase SetUp" << std::endl;
    }

    void TearDown() override {
        std::cout << "TestCase TearDown" << std::endl;
    }
};

测试输出：

"/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_suite"
➜  Clang 17.0.0 arm64-apple-darwin24.6.0 "/Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/test_suite"
Running main() from /Users/xiye/CppProjects/unit-test-example/out/build/Clang 17.0.0 arm64-apple-darwin24.6.0/_deps/googletest-src/googletest/src/gtest_main.cc
[==========] Running 2 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 2 tests from FooTest
TestSuite SetUp
[ RUN      ] FooTest.Test1
TestCase SetUp
Test 1
TestCase TearDown
[       OK ] FooTest.Test1 (0 ms)
[ RUN      ] FooTest.Test2
TestCase SetUp
Test 2
TestCase TearDown
[       OK ] FooTest.Test2 (0 ms)
TestSuite TearDown
[----------] 2 tests from FooTest (0 ms total)

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