-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
788 additions
and
482 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
package log | ||
|
||
import ( | ||
"fmt" | ||
"os" | ||
"sync/atomic" | ||
"time" | ||
|
||
"github.com/efritz/glock" | ||
) | ||
|
||
type baseLogger interface { | ||
Log(timestamp time.Time, level LogLevel, fields LogFields, msg string) error | ||
} | ||
|
||
type baseWrapper struct { | ||
logger baseLogger | ||
level LogLevel | ||
clock glock.Clock | ||
exiter func() | ||
sequence uint64 | ||
} | ||
|
||
type baseShim struct { | ||
wrapper *baseWrapper | ||
fields LogFields | ||
} | ||
|
||
// | ||
// Shim | ||
|
||
func newBaseShim(logger baseLogger, level LogLevel, initialFields LogFields) Logger { | ||
wrapper := &baseWrapper{ | ||
logger, | ||
level, | ||
glock.NewRealClock(), | ||
func() { os.Exit(1) }, | ||
0, | ||
} | ||
|
||
return adaptShim(&baseShim{wrapper, initialFields}) | ||
} | ||
|
||
func newTestShim(logger baseLogger, level LogLevel, initialFields LogFields, clock glock.Clock, exiter func()) Logger { | ||
wrapper := &baseWrapper{ | ||
logger, | ||
level, | ||
clock, | ||
exiter, | ||
0, | ||
} | ||
|
||
return adaptShim(&baseShim{wrapper, initialFields}) | ||
} | ||
|
||
func (s *baseShim) WithFields(fields LogFields) logShim { | ||
if len(fields) == 0 { | ||
return s | ||
} | ||
|
||
return &baseShim{s.wrapper, s.fields.concat(fields)} | ||
} | ||
|
||
func (s *baseShim) LogWithFields(level LogLevel, fields LogFields, format string, args ...interface{}) { | ||
if level > s.wrapper.level { | ||
return | ||
} | ||
|
||
seq := atomic.AddUint64(&s.wrapper.sequence, 1) | ||
fields = addCaller(fields).normalizeTimeValues() | ||
fields["sequenceNumber"] = seq | ||
|
||
s.wrapper.logger.Log( | ||
s.wrapper.clock.Now().UTC(), | ||
level, | ||
s.fields.concat(fields), | ||
fmt.Sprintf(format, args...), | ||
) | ||
|
||
if level == LevelFatal { | ||
s.wrapper.exiter() | ||
} | ||
} | ||
|
||
func (s *baseShim) Sync() error { | ||
return nil | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
package log | ||
|
||
//go:generate go-mockgen -f github.com/go-nacelle/log -i baseLogger -o base_logger_mock_test.go | ||
|
||
import ( | ||
"github.com/aphistic/sweet" | ||
"github.com/efritz/glock" | ||
. "github.com/efritz/go-mockgen/matchers" | ||
. "github.com/onsi/gomega" | ||
) | ||
|
||
type BaseLoggerSuite struct{} | ||
|
||
func (s *BaseLoggerSuite) TestLogFormat(t sweet.T) { | ||
base := NewMockBaseLogger() | ||
clock := glock.NewMockClock() | ||
logger := newTestShim(base, LevelDebug, nil, clock, func() {}) | ||
logger.LogWithFields(LevelInfo, nil, "test %d %d %d", 1, 2, 3) | ||
|
||
Expect(base.LogFunc).To(BeCalledOnceWith( | ||
clock.Now().UTC(), | ||
LevelInfo, | ||
LogFields{ | ||
// Note: this value refers to the line number containing `LogWithFields` in | ||
// the test setup above. If code is added before that line, this value must | ||
// be updated. | ||
"caller": "log/base_logger_test.go:18", | ||
"sequenceNumber": uint64(1), | ||
}, | ||
"test 1 2 3", | ||
)) | ||
} | ||
|
||
func (s *BaseLoggerSuite) TestWrappedLoggers(t sweet.T) { | ||
base := NewMockBaseLogger() | ||
clock := glock.NewMockClock() | ||
logger := newTestShim(base, LevelDebug, LogFields{"init": "foo"}, clock, func() {}) | ||
wrappedLogger := logger.WithFields(LogFields{"wrapped": "bar"}) | ||
wrappedLogger.LogWithFields(LevelDebug, LogFields{"extra": "baz"}, "test %d %d %d", 1, 2, 3) | ||
logger.LogWithFields(LevelDebug, LogFields{"extra": "bonk"}, "test %d %d %d", 1, 2, 3) | ||
|
||
Expect(base.LogFunc).To(BeCalledOnceWith( | ||
clock.Now().UTC(), | ||
LevelDebug, | ||
LogFields{ | ||
"init": "foo", | ||
"wrapped": "bar", | ||
"extra": "baz", | ||
// Note: this value refers to the line number containing `LogWithFields` in | ||
// the test setup above. If code is added before that line, this value must | ||
// be updated. | ||
"caller": "log/base_logger_test.go:39", | ||
"sequenceNumber": uint64(1), | ||
}, | ||
"test 1 2 3", | ||
)) | ||
|
||
Expect(base.LogFunc).To(BeCalledOnceWith( | ||
clock.Now().UTC(), | ||
LevelDebug, | ||
LogFields{ | ||
"init": "foo", | ||
"extra": "bonk", | ||
// Note: this value refers to the line number containing `LogWithFields` in | ||
// the test setup above. If code is added before that line, this value must | ||
// be updated. | ||
"caller": "log/base_logger_test.go:40", | ||
"sequenceNumber": uint64(2), | ||
}, | ||
"test 1 2 3", | ||
)) | ||
} | ||
|
||
func (s *BaseLoggerSuite) TestLogLevelFilter(t sweet.T) { | ||
base := NewMockBaseLogger() | ||
clock := glock.NewMockClock() | ||
logger := newTestShim(base, LevelInfo, nil, clock, func() {}) | ||
logger.LogWithFields(LevelDebug, nil, "test %d %d %d", 1, 2, 3) | ||
Expect(base.LogFunc).NotTo(BeCalled()) | ||
} | ||
|
||
func (s *BaseLoggerSuite) TestLogFatal(t sweet.T) { | ||
base := NewMockBaseLogger() | ||
clock := glock.NewMockClock() | ||
called := false | ||
logger := newTestShim(base, LevelInfo, nil, clock, func() { called = true }) | ||
logger.LogWithFields(LevelFatal, nil, "test %d %d %d", 1, 2, 3) | ||
Expect(called).To(BeTrue()) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.