Help us understand the problem. What is going on with this article?

GoのzapでLogが吐かれたかどうかをテストする

参考コード

  • 同僚が激推してたのでメモ
    • 別UIでいちいちログが吐かれているか確認せずにテストコードで確認できるのでとても良い
zap.go
package test

import "go.uber.org/zap"

type S struct {
    logger *zap.Logger
}

func Main() {
    s := S{}
    s.FooBar()
}

func (s *S) FooBar() {
    s.logger.Warn("warning")
}
zap_test.go
package test

import (
    "testing"

    "go.uber.org/zap"
    zapobserver "go.uber.org/zap/zaptest/observer"
)

func TestS_FooBar(t *testing.T) {
    core, obs := zapobserver.New(zap.InfoLevel)
    // core, obs := zapobserver.New(zap.FatalLevel) // the test will be failed

    logger := zap.New(core)
    s := S{
        logger: logger,
    }

    s.FooBar()

    if obs.Len() != 1 {
        t.Fatal("the log should be emitted")
    }
}
  • zapobserver.Newzap.corezapobserver.ObservedLogsを生成してくれるので、そいつでLoggerを作ってあげればよい
    • 引数によって対象にするLogのレベルも変更できるので、コード内にも表したようにこのコードに対してzap.FatalLevelを設定するとテストは通らない

References

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away