Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add zerolog level methods #30

Merged
merged 1 commit into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions adapters/zerolog/zerolog.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ import (
"runtime/debug"
"strings"

"github.com/rs/zerolog"

"github.com/danteay/golog/fields"
"github.com/danteay/golog/levels"
"github.com/rs/zerolog"
)

// Adapter is a zerolog adapter implementation
Expand Down Expand Up @@ -51,6 +50,18 @@ func (a *Adapter) Writer() io.Writer {
// SetWriter sets the writer for the adapter
func (a *Adapter) SetWriter(w io.Writer) {
a.writer = w
a.logger = a.logger.Output(w)
}

// Level returns the level for the adapter
func (a *Adapter) Level() levels.Level {
return a.level
}

// SetLevel sets the level for the adapter
func (a *Adapter) SetLevel(level levels.Level) {
a.level = level
a.logger = a.logger.Level(getLevels(level))
}

// Logger returns the zerolog logger instance
Expand All @@ -60,6 +71,10 @@ func (a *Adapter) Logger() zerolog.Logger {

// Log logs a message with the given level, error, fields, and message
func (a *Adapter) Log(level levels.Level, err error, logFields *fields.Fields, msg string, args ...any) {
if level <= levels.Disabled {
return
}

log := a.getLog(level)

addErrFields(level, err, log, a.withTrace)
Expand All @@ -75,12 +90,13 @@ func (a *Adapter) Log(level levels.Level, err error, logFields *fields.Fields, m

func (a *Adapter) getLog(level levels.Level) *zerolog.Event {
events := map[levels.Level]func() *zerolog.Event{
levels.Debug: a.logger.Debug,
levels.Info: a.logger.Info,
levels.Warn: a.logger.Warn,
levels.Error: a.logger.Error,
levels.Fatal: a.logger.Fatal,
levels.Panic: a.logger.Panic,
levels.TraceLevel: a.logger.Trace,
levels.Debug: a.logger.Debug,
levels.Info: a.logger.Info,
levels.Warn: a.logger.Warn,
levels.Error: a.logger.Error,
levels.Fatal: a.logger.Fatal,
levels.Panic: a.logger.Panic,
}

event, exists := events[level]
Expand Down
70 changes: 65 additions & 5 deletions adapters/zerolog/zerolog_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ import (
)

type testMsg struct {
Level string `json:"level"`
Message string `json:"message"`
Error string `json:"error"`
Key1 string `json:"key1"`
Key2 int `json:"key2"`
Level string `json:"level"`
Message string `json:"message"`
Error string `json:"error"`
Key1 string `json:"key1"`
Key2 int `json:"key2"`
Stack []string `json:"stack"`
}

func TestAdapter_Log(t *testing.T) {
Expand Down Expand Up @@ -135,6 +136,65 @@ func TestAdapter_Log(t *testing.T) {

assert.Equal(t, "", logOutput.String())
})

t.Run("should log message with error and stack trace", func(t *testing.T) {
var logOutput bytes.Buffer

logger := New(WithLevel(levels.TraceLevel), WithWriter(&logOutput))

msg := "Test message"
err := errors.New("test error")

logger.Log(levels.TraceLevel, err, nil, msg)

res := testMsg{}

if errUnmarshall := json.Unmarshal(logOutput.Bytes(), &res); errUnmarshall != nil {
t.Fatal(errUnmarshall)
}

assert.Equal(t, levels.TraceLevel.String(), res.Level)
assert.Equal(t, msg, res.Message)
assert.Equal(t, err.Error(), res.Error)
assert.NotEmpty(t, res.Stack)
})

t.Run("should change level", func(t *testing.T) {
var logOutput bytes.Buffer

logger := New(WithLevel(levels.Info), WithWriter(&logOutput))

logger.Log(levels.Debug, nil, nil, "Test message")

assert.Equal(t, "", logOutput.String())

logger.SetLevel(levels.Debug)

logger.Log(levels.Debug, nil, nil, "Test message")

assert.NotEqual(t, "", logOutput.String())
})

t.Run("should change writer", func(t *testing.T) {
var logOutput bytes.Buffer

logger := New(WithLevel(levels.Debug), WithWriter(&logOutput))

logger.Log(levels.Debug, nil, nil, "Test message")

assert.NotEqual(t, "", logOutput.String())

logOutput.Reset()

var newOutput bytes.Buffer

logger.SetWriter(&newOutput)

logger.Log(levels.Debug, nil, nil, "Test message")

assert.NotEqual(t, "", newOutput.String())
assert.Equal(t, "", logOutput.String())
})
}

func TestGetLevels(t *testing.T) {
Expand Down