如何mock sigs.k8s.io/controller-runtime的zap logger并将测试日志输出到buffer

核心逻辑：sigs.k8s.io/controller-runtime 封装的 zap logger 支持通过 zap.Options 的 Writer 字段指定输出目的地，你只需要将测试用的 buf 设置到该字段即可，同时要注意全局 logger 的初始化顺序。

方案1：修改公共 SetLogger 方法（推荐，兼容生产/测试场景，无侵入） #

步骤1：调整 SetLogger 签名，增加可选自定义输出参数 #

修改后的 SetLogger 代码如下，生产环境调用逻辑完全不变：

import "io"

func SetLogger(customWriters ...io.Writer) {
    opts := zap.Options{
        Development:     developmentFlag,
        StacktraceLevel: stacktraceLevel,
        Level:           isLevelEnabler,
        Encoder:         logFmtEncoder,
    }
    // 测试场景传入buf时替换输出源，生产场景无传参则使用默认stderr输出
    if len(customWriters) > 0 {
        opts.Writer = io.MultiWriter(customWriters...)
    }
    ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
}

步骤2：调整测试代码 #

注意要先初始化 logger 再获取实例，且结构化日志默认携带元字段，不要直接做全等断言：

var _ = Describe("Logger", func() {
    It("Test Default Log Level", func() {
        buf := &bytes.Buffer{}
        // 先传入buf初始化全局logger
        SetLogger(buf)
        // 再获取logger实例，此时拿到的才是输出到buf的logger
        testLog := ctrl.Log.WithName("setup")
        
        testLog.Info("This is a test")
        // 结构化日志默认带级别、logger名、时间戳等字段，使用包含匹配即可
        Expect(buf.String()).To(ContainSubstring("This is a test"))
        Expect(buf.String()).To(ContainSubstring(`"logger":"setup"`))
        Expect(buf.String()).To(ContainSubstring(`"level":"info"`))
    })
})

方案2：不修改原有 SetLogger，测试侧单独构造 logger #

如果不想改动生产代码，可以在测试用例内直接复用原有配置，仅替换 Writer 字段：

var _ = Describe("Logger", func() {
    It("Test Default Log Level", func() {
        buf := &bytes.Buffer{}
        // 复用生产配置，仅替换输出源为buf
        opts := zap.Options{
            Development:     developmentFlag,
            StacktraceLevel: stacktraceLevel,
            Level:           isLevelEnabler,
            Encoder:         logFmtEncoder,
            Writer:          buf,
        }
        ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
        testLog := ctrl.Log.WithName("setup")
        
        testLog.Info("This is a test")
        Expect(buf.String()).To(ContainSubstring("This is a test"))
    })
})

注意事项 #

• 单测结束后建议重置全局 logger，避免影响其他测试用例
• 日志断言不要直接匹配完整字符串，结构化日志默认会附加多个元字段，使用子串匹配即可

内容的提问来源于stack exchange，提问作者user1365697