Skip to content
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
60 changes: 60 additions & 0 deletions logadapter/logadapter.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// Package logadapter bridges a zerolog.Logger into the ad hoc Write,
// Printf/Println, and Errorf interfaces that third-party libraries expect
// from a logger (io.Writer, go-smtp's Logger, go-socks5's Logger,
// tcpproxy's Logger, and the standard library's *log.Logger).
//
// Construct an Adapter from a logger that already carries any fixed
// context (component, module, tunnel ID, etc.) via zerolog's With(); the
// Adapter itself adds no context beyond the level at which it logs.
package logadapter

import (
"fmt"
"strings"

"github.com/rs/zerolog"
)

// Adapter adapts a zerolog.Logger to the logging interfaces expected by
// third-party libraries. A single Adapter value satisfies io.Writer, the
// Printf/Println-style Logger interface used by go-smtp and tcpproxy, and
// the Errorf-style Logger interface used by go-socks5 — pick whichever
// method(s) the target interface requires.
//
// All methods log a single event at Level, with any trailing newline
// trimmed since callers typically pass pre-formatted lines.
type Adapter struct {
Logger zerolog.Logger
Level zerolog.Level
}

// New returns an Adapter that logs to logger at level.
func New(logger zerolog.Logger, level zerolog.Level) Adapter {
return Adapter{Logger: logger, Level: level}
}

func (a Adapter) log(msg string) {
a.Logger.WithLevel(a.Level).Msg(strings.TrimRight(msg, "\n"))
}

// Write implements io.Writer.
func (a Adapter) Write(p []byte) (int, error) {
a.log(string(p))
return len(p), nil
}

// Printf implements the Printf half of the Logger interfaces used by
// go-smtp and tcpproxy.
func (a Adapter) Printf(format string, v ...any) {
a.log(fmt.Sprintf(format, v...))
}

// Println implements the Println half of go-smtp's Logger interface.
func (a Adapter) Println(v ...any) {
a.log(fmt.Sprintln(v...))
}

// Errorf implements go-socks5's Logger interface.
func (a Adapter) Errorf(format string, v ...any) {
a.log(fmt.Sprintf(format, v...))
}
63 changes: 63 additions & 0 deletions logadapter/logadapter_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package logadapter_test

import (
"bytes"
"testing"

"github.com/rs/zerolog"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/dioad/cli/logadapter"
)

func newAdapter(t *testing.T, level zerolog.Level) (logadapter.Adapter, *bytes.Buffer) {
t.Helper()
buf := &bytes.Buffer{}
logger := zerolog.New(buf)
return logadapter.New(logger, level), buf
}

func TestAdapter_Write(t *testing.T) {
t.Parallel()

a, buf := newAdapter(t, zerolog.DebugLevel)

n, err := a.Write([]byte("dial failed\n"))

require.NoError(t, err)
assert.Equal(t, len("dial failed\n"), n)
assert.Contains(t, buf.String(), `"message":"dial failed"`)
assert.Contains(t, buf.String(), `"level":"debug"`)
}

func TestAdapter_Printf(t *testing.T) {
t.Parallel()

a, buf := newAdapter(t, zerolog.ErrorLevel)

a.Printf("no route matched %q", "example.com")

assert.Contains(t, buf.String(), `"message":"no route matched \"example.com\""`)
assert.Contains(t, buf.String(), `"level":"error"`)
}

func TestAdapter_Println(t *testing.T) {
t.Parallel()

a, buf := newAdapter(t, zerolog.ErrorLevel)

a.Println("dial error:", "connection refused")

assert.Contains(t, buf.String(), `"message":"dial error: connection refused"`)
}

func TestAdapter_Errorf(t *testing.T) {
t.Parallel()

a, buf := newAdapter(t, zerolog.ErrorLevel)

a.Errorf("socks command %s failed", "connect")

assert.Contains(t, buf.String(), `"message":"socks command connect failed"`)
}
Loading