如何在单元测试断言失败时使用自定义上下文日志（如zap）输出

问题场景 #

你希望将Go单元测试中（基于testify Suite框架）的断言失败信息，导入到自定义日志器（如Zap）中，输出结构化的JSON格式日志，替代默认的测试输出样式。

现有测试代码 #

func (s *TempSuite) Test() {
    s.Run("Test", func() {
        s.Assertions.True(false, "Failure here")
    })
}

当前默认输出 #

Error:          Should be true
                Test:           TestTempSuite/Test/Test
                Messages:       Failure here
--- FAIL: TestTempSuite (0.00s)
    --- FAIL: TestTempSuite/Test (0.00s)
        --- FAIL: TestTempSuite/Test/Test (0.00s)

期望输出格式 #

{"timestamp":"xxxxxx", "message":"Error:          Should be true

Test:           TestTempSuite/Test/Test

Messages:       Failure here

--- FAIL: TestTempSuite (0.00s)

--- FAIL: TestTempSuite/Test (0.00s)

--- FAIL: TestTempSuite/Test/Test (0.00s)",  "testsuite":"xxxxx", "myTag": "xxxxxxx"}

解决方案 #

有三种可行的方式实现需求，可根据实际场景选择：

1. 自定义Testify断言失败处理器 #

Testify的Assertions支持自定义FailureHandler接口，实现该接口后，可在断言触发失败时直接调用Zap输出结构化日志。

实现自定义Handler

import (
    "fmt"
    "go.uber.org/zap"
    "github.com/stretchr/testify/assert"
)

type ZapFailureHandler struct {
    logger *zap.Logger
}

// HandleFailure 实现assert.FailureHandler接口
func (h *ZapFailureHandler) HandleFailure(failure assert.Failure) {
    // 拼接断言失败的核心信息
    logContent := fmt.Sprintf("Error:          %s\nTest:           %s\nMessages:       %s",
        failure.Message, failure.TestName, failure.Messages)
    
    // 用Zap输出结构化日志，可自定义添加业务字段
    h.logger.Error("断言失败",
        zap.String("testsuite", "TempSuite"),
        zap.String("myTag", "custom-tag"),
        zap.String("message", logContent),
    )

    // 可选：保留默认测试失败输出，若不需要可注释此行
    assert.DefaultFailureHandler.HandleFailure(failure)
}

在Suite中配置Handler

在Suite的SetupTest方法中替换默认的失败处理器：

func (s *TempSuite) SetupTest() {
    // 初始化Zap日志实例（根据实际需求配置）
    logger, _ := zap.NewProduction()
    // 创建自定义断言实例并绑定处理器
    s.Assertions = assert.New(s.T())
    s.Assertions.SetFailureHandler(&ZapFailureHandler{logger: logger})
}

2. 重定向测试输出到Zap #

如果需要捕获包含--- FAIL:栈信息在内的完整测试输出，可以重定向os.Stderr到自定义Writer，再将内容转发给Zap。

实现自定义Writer

import (
    "bytes"
    "os"
    "go.uber.org/zap"
)

type TestLogWriter struct {
    logger *zap.Logger
    buffer *bytes.Buffer
}

func (w *TestLogWriter) Write(p []byte) (n int, err error) {
    w.buffer.Write(p)
    // 检测到测试失败标记时，输出结构化日志
    if bytes.Contains(p, []byte("--- FAIL:")) {
        w.logger.Error("测试失败",
            zap.String("testsuite", "TempSuite"),
            zap.String("myTag", "custom-tag"),
            zap.String("message", w.buffer.String()),
        )
        w.buffer.Reset()
    }
    return len(p), nil
}

替换标准错误输出

在测试包的init函数中替换os.Stderr：

func init() {
    logger, _ := zap.NewProduction()
    writer := &TestLogWriter{
        logger: logger,
        buffer: &bytes.Buffer{},
    }
    os.Stderr = writer
}

3. 封装自定义断言方法 #

直接封装业务专属的断言函数，完全控制断言失败时的日志输出逻辑，同时触发测试失败。

封装断言方法

import (
    "fmt"
    "go.uber.org/zap"
)

func (s *TempSuite) AssertTrue(condition bool, msg string, args ...interface{}) {
    if !condition {
        logger, _ := zap.NewProduction()
        fullMsg := fmt.Sprintf(msg, args...)
        // 拼接符合需求的失败信息
        logContent := fmt.Sprintf("Error: Should be true\nTest: %s\nMessages: %s",
            s.T().Name(), fullMsg)
        
        logger.Error("断言失败",
            zap.String("testsuite", "TempSuite"),
            zap.String("myTag", "custom-tag"),
            zap.String("message", logContent),
        )
        // 触发测试失败
        s.T().Fatalf(fullMsg)
    }
}

使用自定义断言

func (s *TempSuite) Test() {
    s.Run("Test", func() {
        s.AssertTrue(false, "Failure here")
    })
}

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