正确捕获 zap 记录器输出的单元测试方法
来源:stackoverflow
时间:2024-03-03 23:24:27 470浏览 收藏
来到golang学习网的大家,相信都是编程学习爱好者,希望在这里学习Golang相关编程知识。下面本篇文章就来带大家聊聊《正确捕获 zap 记录器输出的单元测试方法》,介绍一下,希望对大家的知识积累有所帮助,助力实战开发!
问题内容
根据 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
会达不到目的。捕获该输出的最佳方法是什么?
正确答案
测试消息是否被记录
使用 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 记录器输出的单元测试方法》的内容就介绍到这里了,是不是学起来一目了然!想要了解更多关于的内容请关注golang学习网公众号!
声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
-
502 收藏
-
502 收藏
-
501 收藏
-
501 收藏
-
501 收藏
最新阅读
更多>
-
139 收藏
-
204 收藏
-
325 收藏
-
477 收藏
-
486 收藏
-
439 收藏
-
357 收藏
-
352 收藏
-
101 收藏
-
440 收藏
-
212 收藏
-
143 收藏
课程推荐
更多>
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 508次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习