forked from mirror/logrus
105 lines
2.2 KiB
Go
105 lines
2.2 KiB
Go
// The Test package is used for testing logrus. It is here for backwards
|
|
// compatibility from when logrus' organization was upper-case. Please use
|
|
// lower-case logrus and the `null` package instead of this one.
|
|
package test
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"sync"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// Hook is a hook designed for dealing with logs in test scenarios.
|
|
type Hook struct {
|
|
// Entries is an array of all entries that have been received by this hook.
|
|
// For safe access, use the AllEntries() method, rather than reading this
|
|
// value directly.
|
|
Entries []logrus.Entry
|
|
mu sync.RWMutex
|
|
}
|
|
|
|
// NewGlobal installs a test hook for the global logger.
|
|
func NewGlobal() *Hook {
|
|
|
|
hook := new(Hook)
|
|
logrus.AddHook(hook)
|
|
|
|
return hook
|
|
|
|
}
|
|
|
|
// NewLocal installs a test hook for a given local logger.
|
|
func NewLocal(logger *logrus.Logger) *Hook {
|
|
|
|
hook := new(Hook)
|
|
logger.Hooks.Add(hook)
|
|
|
|
return hook
|
|
|
|
}
|
|
|
|
type TestOption func(logger *logrus.Logger)
|
|
|
|
func FatalPanics(logger *logrus.Logger) {
|
|
logger.Exit = func(code int) {
|
|
panic(code)
|
|
}
|
|
}
|
|
|
|
// NewNullLogger creates a discarding logger and installs the test hook.
|
|
func NewNullLogger(options ...TestOption) (*logrus.Logger, *Hook) {
|
|
|
|
logger := logrus.New()
|
|
logger.Out = ioutil.Discard
|
|
|
|
for _, option := range options {
|
|
option(logger)
|
|
}
|
|
|
|
return logger, NewLocal(logger)
|
|
|
|
}
|
|
|
|
func (t *Hook) Fire(e *logrus.Entry) error {
|
|
t.mu.Lock()
|
|
defer t.mu.Unlock()
|
|
t.Entries = append(t.Entries, *e)
|
|
return nil
|
|
}
|
|
|
|
func (t *Hook) Levels() []logrus.Level {
|
|
return logrus.AllLevels
|
|
}
|
|
|
|
// LastEntry returns the last entry that was logged or nil.
|
|
func (t *Hook) LastEntry() *logrus.Entry {
|
|
t.mu.RLock()
|
|
defer t.mu.RUnlock()
|
|
i := len(t.Entries) - 1
|
|
if i < 0 {
|
|
return nil
|
|
}
|
|
return &t.Entries[i]
|
|
}
|
|
|
|
// AllEntries returns all entries that were logged.
|
|
func (t *Hook) AllEntries() []*logrus.Entry {
|
|
t.mu.RLock()
|
|
defer t.mu.RUnlock()
|
|
// Make a copy so the returned value won't race with future log requests
|
|
entries := make([]*logrus.Entry, len(t.Entries))
|
|
for i := 0; i < len(t.Entries); i++ {
|
|
// Make a copy, for safety
|
|
entries[i] = &t.Entries[i]
|
|
}
|
|
return entries
|
|
}
|
|
|
|
// Reset removes all Entries from this test hook.
|
|
func (t *Hook) Reset() {
|
|
t.mu.Lock()
|
|
defer t.mu.Unlock()
|
|
t.Entries = make([]logrus.Entry, 0)
|
|
}
|