feat: move MockLogger into a logtest sub-package #5
@@ -38,7 +38,9 @@ handler = logmw.RequestLogger(logger)(handler)
|
||||
In tests:
|
||||
|
||||
```go
|
||||
m := logging.NewMockLogger()
|
||||
import logtest "gitea.unbound.se/shiny/logging/logtest"
|
||||
|
||||
m := logtest.NewMockLogger()
|
||||
// ... exercise code with m.Logger() ...
|
||||
m.Check(t, []string{"level=INFO msg=\"...\""})
|
||||
```
|
||||
@@ -47,16 +49,15 @@ m.Check(t, []string{"level=INFO msg=\"...\""})
|
||||
|
||||
- `SetupLogger(logLevel, logFormat, serviceName, buildVersion string) *slog.Logger`
|
||||
- `ContextWithLogger(ctx, *slog.Logger) context.Context` / `LoggerFromContext(ctx) *slog.Logger`
|
||||
- `Logger` interface; `NewMockLogger() *MockLogger` (+ `MockLogger.Logger()`, `MockLogger.Check(t, want)`).
|
||||
- `logging/logtest.NewMockLogger() *MockLogger` (+ `MockLogger.Logger()`, `MockLogger.Check(t, want)`) — the test helper, in its own sub-package so production code doesn't pull in testify.
|
||||
- `logging/middleware.RequestLogger(logger) func(http.Handler) http.Handler`.
|
||||
|
||||
### Notes
|
||||
|
||||
- `MockLogger` currently lives in the main package, so `testify` is a non-test
|
||||
dependency of the module. Moving it to a `logging/logtest` sub-package is a
|
||||
tracked low-priority follow-up — it's a breaking import change for the ~13
|
||||
services that reference `logging.NewMockLogger`, so it is deferred until a
|
||||
coordinated bump (Ambix 019ecabc).
|
||||
- `MockLogger`/`NewMockLogger` live in the `logging/logtest` sub-package, so the
|
||||
production `logging` package's import graph is free of `testify` — consumers
|
||||
only compile it if they import `logtest`. (`testify` stays in the module's
|
||||
`go.mod` because `logtest` and the library's own tests use it.)
|
||||
|
||||
### Conventions
|
||||
|
||||
|
||||
@@ -23,11 +23,3 @@ func TestContextLogger(t *testing.T) {
|
||||
ctx := ContextWithLogger(context.Background(), custom)
|
||||
assert.Same(t, custom, LoggerFromContext(ctx))
|
||||
}
|
||||
|
||||
func TestMockLogger(t *testing.T) {
|
||||
m := NewMockLogger()
|
||||
m.Logger().Info("hello", "k", "v")
|
||||
m.Check(t, []string{`level=INFO msg=hello k=v`})
|
||||
empty := NewMockLogger()
|
||||
empty.Check(t, nil)
|
||||
}
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
package logging
|
||||
// Package logtest provides test helpers for the logging library. It is kept in
|
||||
// its own package so that importing the production logging package does not pull
|
||||
// in testify (a test-only dependency) — only consumers that import logtest do.
|
||||
package logtest
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
@@ -0,0 +1,11 @@
|
||||
package logtest
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestMockLogger(t *testing.T) {
|
||||
m := NewMockLogger()
|
||||
m.Logger().Info("hello", "k", "v")
|
||||
m.Check(t, []string{`level=INFO msg=hello k=v`})
|
||||
empty := NewMockLogger()
|
||||
empty.Check(t, nil)
|
||||
}
|
||||
Reference in New Issue
Block a user