如何在单元测试中正确捕获 zap logger 输出

Posted 2023-02-18

【中文标题】如何在单元测试中正确捕获 zap logger 输出

【英文标题】：How to properly capture zap logger output in unit tests

【发布时间】：2022-01-20 19:23:00

【问题描述】：

根据zap.NewDevelopmentConfig() 和zap.NewProductionConfig() 的配置，我假设zap 将日志写入stderr。但是，我似乎无法在单元测试中捕获输出。

我有以下captureOutput func:

func captureOutput(f func()) string 
    r, w, err := os.Pipe()
    if err != nil 
        panic(err)
    

    stdout := os.Stdout
    os.Stdout = w
    defer func() 
        os.Stdout = stdout
    ()

    stderr := os.Stderr
    os.Stderr = w
    defer func() 
        os.Stderr = stderr
    ()

    f()
    w.Close()

    var buf bytes.Buffer
    io.Copy(&buf, r)

    return buf.String()

它无法捕获 zap 输出，但确实设法从 fmt.Println(...) 获取输出：

func TestZapCapture(t *testing.T) 
    auditor, _ := zap.NewProduction()
    output := captureOutput(func() 
        auditor.Info("hi")
    )

    assert.NotEmpty(t, output)
    //fails to captures output


func TestFmtCapture(t *testing.T) 
    output := captureOutput(func() 
        fmt.Println("hi")
    )

    assert.NotEmpty(t, output)
    //successfully captures output

我知道在这种情况下使用 zap 观察器，但我的实际用例是测试高度修改的 zap 记录器，因此测试新的 zap.Core 会破坏目的。捕获该输出的最佳方法是什么？

【问题讨论】：

相关（虽然不是你想要的）***.com/questions/52734529/…

您好，您的回答是否有意义？有什么反馈吗？

您下面的答案肯定会起作用，但需要修改现有的核心。虽然类似，但我决定从我的构造函数中提取配置，以便利用内存中的 zap sink（来自您发布的链接）：***.com/a/52737940/5042150

请注意，只有第二种解决方案需要修改现有核心。这取决于您要测试的内容。使用自定义接收器也是一个不错的选择

【参考方案1】：

测试消息是否被记录

使用zapcore.NewTee。在您的单元测试中，您实例化一个记录器，其核心由您自己的高度修改的核心和观察到的核心组成。观察到的核心将收到日志entries，因此您可以断言单个字段是您所期望的（级别、消息、字段等）

func main() 
    // some arbitrary custom core logger
    mycore := zapcore.NewCore(
        zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
        os.Stderr,
        zapcore.InfoLevel,
    )
    // test core
    observed, logs := observer.New(zapcore.InfoLevel)
    
    // new logger with the two cores tee'd together
    logger := zap.New(zapcore.NewTee(mycore, observed))

    logger.Error("foo")

    entry := logs.All()[0]
    fmt.Println(entry.Message == "foo")            // true
    fmt.Println(entry.Level == zapcore.ErrorLevel) // true

测试最终的日志格式

在这种情况下，您希望将记录器输出通过管道传输到任意写入器。您可以使用zap.CombineWriteSyncers 实现此目的，并将其作为自定义核心的依赖项注入。

// this would be placed in your main code
func NewCustomLogger(pipeTo io.Writer) zapcore.Core 
    return zapcore.NewCore(
        zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
        zap.CombineWriteSyncers(os.Stderr, zapcore.AddSync(pipeTo)),
        zapcore.InfoLevel,
    )


func TestLogger(t *testing.T) 
    b := &bytes.Buffer
    // call the constructor from your test code with the arbitrary writer
    mycore := NewCustomLogger(b)

    logger := zap.New(mycore)
    logger.Error("foo")

    fmt.Println(b.String()) // "level":"error","ts":1639813360.853494,"msg":"foo"