如何在GoogleTest中捕获spdlog输出完成日志测试断言
问题根因
spdlog内置的stdout_color_mt、stderr_color_mt日志器,底层是直接通过操作系统接口向标准输出、标准错误的底层文件句柄写入内容(类Unix系统对应STDOUT_FILENO/STDERR_FILENO,Windows系统对应控制台标准句柄),完全不经过std::cout对应的标准流缓冲区输出链路。你之前通过重定向std::cout流缓冲区的捕获逻辑,从底层就拦不到spdlog的输出,哪怕是修复了#1147号issue的最新提交版本,这个输出路径的设计也没有改变。
可落地的解决方案
方案1:测试场景下替换为自定义捕获sink(推荐)
这是最稳定、无系统副作用的单元测试适配方案,不需要操作操作系统级的文件重定向,直接让spdlog把日志内容写入测试用的缓冲区即可。
具体实现逻辑:
- 编写一个继承自spdlog
base_sink的自定义sink,收到日志内容后直接同步写入测试用的stringstream缓冲区 - 测试初始化时,把全局注册的同名console/stderr日志器替换为绑定了自定义sink的实例,保证业务代码里通过
spdlog::get("console")获取到的是测试环境的版本 - 保留原有的
std::cout流缓冲区重定向逻辑,兼容业务代码里直接调用std::cout输出的旧逻辑
改造后的测试夹具参考实现:
#include "spdlog/sinks/base_sink.h" // 自定义sink:直接把格式化后的日志内容写入指定的捕获缓冲区 class test_capture_sink : public spdlog::sinks::base_sink<std::mutex> { public: explicit test_capture_sink(std::stringstream& capture_buf) : capture_buf_(capture_buf) {} protected: void sink_it_(const spdlog::details::log_msg& msg) override { spdlog::memory_buf_t formatted; spdlog::sinks::base_sink<std::mutex>::formatter_->format(msg, formatted); capture_buf_.write(formatted.data(), formatted.size()); } void flush_() override { capture_buf_.flush(); } private: std::stringstream& capture_buf_; }; class MyTest : public testing::Test { protected: void SetUp() override { // 保留原有std::cout重定向,兼容旧的cout输出逻辑 sbuf = std::cout.rdbuf(); std::cout.rdbuf(buffer.rdbuf()); // 构造绑定测试缓冲区的自定义sink,替换默认的stdout日志器 auto console_sink = std::make_shared<test_capture_sink>(buffer); auto console_logger = std::make_shared<spdlog::logger>("console", console_sink); // 同步生产环境的日志格式,避免测试和线上输出不一致 console_logger->set_pattern("[%^%l%$] %v"); // 调试测试时记得把日志级别调到debug,否则默认info级别会过滤掉debug日志 console_logger->set_level(spdlog::level::debug); // 替换全局注册的同名logger,保证业务代码能取到测试版本 spdlog::drop("console"); spdlog::register_logger(console_logger); // stderr日志器同理配置独立的捕获缓冲区 auto err_sink = std::make_shared<test_capture_sink>(err_buffer); auto err_logger = std::make_shared<spdlog::logger>("stderr", err_sink); err_logger->set_level(spdlog::level::debug); spdlog::drop("stderr"); spdlog::register_logger(err_logger); } void TearDown() override { std::cout.rdbuf(sbuf); // 测试结束后清理自定义注册的logger,避免污染其他测试用例 spdlog::drop("console"); spdlog::drop("stderr"); } std::stringstream buffer; std::stringstream err_buffer; std::streambuf* sbuf; };
方案2:重定向进程级底层stdout文件描述符
如果不想替换日志器实例,就需要绕过std::cout的流缓冲区,直接重定向操作系统层的标准输出句柄,才能捕获到spdlog的输出。
大致流程为:
- 测试启动时创建匿名管道,备份原有的标准输出文件句柄
- 将进程的标准输出句柄重定向到管道的写入端
- 业务逻辑执行完成后,从管道读取所有写入的内容做校验
- 测试结束后恢复原有的标准输出句柄
注意:这个方案有明显局限性:
- 需要针对类Unix、Windows系统编写两套不同的重定向逻辑,跨平台适配成本高
- 系统管道默认缓冲区大小有限,多线程、高并发写入时容易出现阻塞
- spdlog异步日志模式下,写入和读取的时序很难匹配,容易出现内容漏读的问题,不推荐作为单元测试的通用方案。
内容的提问来源于stack exchange,提问作者mike
相关产品推荐
相关产品推荐

