GoogleTest 使用指南 ｜ 自定义测试事件监听器

GoogleTest 使用指南 ｜ 自定义测试事件监听器

GoogleTest 提供了测试事件监听器（Test Event Listeners），允许开发者在测试执行的不同阶段插入自定义逻辑。这对于扩展测试框架的功能，如生成自定义报告、集成其他工具或进行特定的测试前后处理，非常有用。

测试事件监听器的架构

测试事件监听器基于观察者模式，gTest 在测试执行过程中会触发一系列事件，如测试开始、测试结束、测试成功或失败等。开发者可以通过继承 ::testing::TestEventListener 类，重写相应的方法，来响应这些事件。

实现自定义事件监听器

以下示例展示了如何实现一个自定义测试事件监听器，用于在测试开始和结束时记录日志。

custom_listener.h：

#pragma once

#ifndef CUSTOM_LISTENER_H
#define CUSTOM_LISTENER_H

#include <gtest/gtest.h>

#include <fstream>
#include <string>

class CustomListener : public ::testing::EmptyTestEventListener {
public:
    explicit CustomListener(const std::string& log_file)
        : log_stream_(log_file, std::ios::out | std::ios::trunc) {}

    void OnTestProgramStart(const ::testing::UnitTest& unit_test) override {
        log_stream_ << "测试程序开始\n";
    }

    void OnTestSuiteStart(const ::testing::TestSuite& test_suite) override {
        log_stream_ << "测试套件开始: " << test_suite.name() << "\n";
    }

    void OnTestStart(const ::testing::TestInfo& test_info) override {
        log_stream_ << "测试开始: " << test_info.test_suite_name() << "." << test_info.name() << "\n";
    }

    void OnTestEnd(const ::testing::TestInfo& test_info) override {
        log_stream_ << "测试结束: " << test_info.test_suite_name() << "." << test_info.name()
                    << " - " << (test_info.result()->Passed() ? "通过" : "失败") << "\n";
    }

    void OnTestSuiteEnd(const ::testing::TestSuite& test_suite) override {
        log_stream_ << "测试套件结束: " << test_suite.name() << "\n";
    }

    void OnTestProgramEnd(const ::testing::UnitTest& unit_test) override {
        log_stream_ << "测试程序结束\n";
        log_stream_.flush();
    }

private:
    std::ofstream log_stream_;
};

#endif // CUSTOM_LISTENER_H

main.cpp：

#include <gtest/gtest.h>

#include "custom_listener.h"

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

    ::testing::TestEventListeners& listeners =
        ::testing::UnitTest::GetInstance()->listeners();
    listeners.Append(new CustomListener("test_log.txt"));

    return RUN_ALL_TESTS();
}

验证通过：

cmake -S . -B build
cmake --build build
ctest --test-dir build --output-on-failure

结果：100% tests passed, 0 tests failed out of 15。

监听器日志生成在：build/test_log.txt，里面能看到测试开始、测试结束、通过/失败等事件记录。

运行测试后，test_log.txt 文件将记录测试的开始与结束信息：

自定义测试事件监听器应用场景：

• 自定义报告生成：根据项目需求生成特定格式的测试报告，如 HTML、JSON 等。
• 集成其他工具：在测试事件中调用其他工具，如代码分析器、性能监测器等。
• 增强日志记录：记录更详细的测试执行信息，便于调试和分析。