如何在单元测试中正确捕获 zap 记录器输出

Question

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

我有以下 captureOutput 功能：

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 会破坏目的。捕获该输出的最佳方式是什么？

Answer 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"}
}

如何在单元测试中正确捕获 zap 记录器输出

How to properly capture zap logger output in unit tests

logging

go

go-zap

测试消息是否全部记录

测试最终日志格式