Тестирование zap logging для Logger, созданного из пользовательского Config - PullRequest
Новая
       38

Тестирование zap logging для Logger, созданного из пользовательского Config

0 голосов
/ 10 октября 2018

У меня есть Zap logger, сгенерированный из пользовательского Config (то есть config.Build ()).Я хотел бы протестировать регистратор, вызвав, например, logger.Info () в методе test и утвердить результат, чтобы увидеть, соответствует ли он установленному config.Как я могу добиться этого?

РЕДАКТИРОВАТЬ: Добавление примера кода в следующем 

func GetLogger() *zap.Logger{
 config := &zap.Config{
  Encoding: "json",
  Level: zap.NewAtomicLevelAt(zapcore.InfoLevel),
  OutputPaths: []string{"stdout"},
  ErrorOutputPaths: []string{"stdout"},
  EncoderConfig: zapcore.EncoderConfig{
   MessageKey: "@m",
   LevelKey:    "@l",
   EncodeLevel: zapcore.CapitalLevelEncoder,
   TimeKey:    "@t",
   EncodeTime: zapcore.EpochMillisTimeEncoder,
   CallerKey:     "@c",
   EncodeCaller:  zapcore.ShortCallerEncoder,
   StacktraceKey: "@x",
  },
 }
 return config.Build()
}

1 Ответ

0 голосов
/ 10 октября 2018

Zap имеет концепцию раковин , адресатов для сообщений журнала.Для тестирования реализуйте приемник, который просто запоминает сообщения (например, в байтах. Буфер): 

package main

import (
    "bytes"
    "net/url"
    "strings"
    "testing"
    "time"

    "go.uber.org/zap"
)

// MemorySink implements zap.Sink by writing all messages to a buffer.
type MemorySink struct {
    *bytes.Buffer
}

// Implement Close and Sync as no-ops to satisfy the interface. The Write 
// method is provided by the embedded buffer.

func (s *MemorySink) Close() error { return nil }
func (s *MemorySink) Sync() error  { return nil }


func TestLogger(t *testing.T) {
    // Create a sink instance, and register it with zap for the "memory" 
    // protocol.
    sink := &MemorySink{new(bytes.Buffer)}
    zap.RegisterSink("memory", func(*url.URL) (zap.Sink, error) {
        return sink, nil
    })

    conf := zap.NewProductionConfig() // TODO: replace with real config

    // Redirect all messages to the MemorySink.    
    conf.OutputPaths = []string{"memory://"}

    l, err := conf.Build()
    if err != nil {
        t.Fatal(err)
    }

    l.Info("failed to fetch URL",
        zap.String("url", "http://example.com"),
        zap.Int("attempt", 3),
        zap.Duration("backoff", time.Second),
    )

    // Assert sink contents

    output := sink.String()
    t.Logf("output = %s", output)

    if !strings.Contains(output, `"url":"http://example.com"`) {
        t.Error("output missing: url=http://example.com")
    }
}
...