vendor/github.com/Sirupsen/logrus/hooks/test/test.go

   1 package test
   2
   3 import (
   4         "io/ioutil"
   5
   6         "github.com/Sirupsen/logrus"
   7 )
   8
   9 // test.Hook is a hook designed for dealing with logs in test scenarios.
  10 type Hook struct {
  11         Entries []*logrus.Entry
  12 }
  13
  14 // Installs a test hook for the global logger.
  15 func NewGlobal() *Hook {
  16
  17         hook := new(Hook)
  18         logrus.AddHook(hook)
  19
  20         return hook
  21
  22 }
  23
  24 // Installs a test hook for a given local logger.
  25 func NewLocal(logger *logrus.Logger) *Hook {
  26
  27         hook := new(Hook)
  28         logger.Hooks.Add(hook)
  29
  30         return hook
  31
  32 }
  33
  34 // Creates a discarding logger and installs the test hook.
  35 func NewNullLogger() (*logrus.Logger, *Hook) {
  36
  37         logger := logrus.New()
  38         logger.Out = ioutil.Discard
  39
  40         return logger, NewLocal(logger)
  41
  42 }
  43
  44 func (t *Hook) Fire(e *logrus.Entry) error {
  45         t.Entries = append(t.Entries, e)
  46         return nil
  47 }
  48
  49 func (t *Hook) Levels() []logrus.Level {
  50         return logrus.AllLevels
  51 }
  52
  53 // LastEntry returns the last entry that was logged or nil.
  54 func (t *Hook) LastEntry() (l *logrus.Entry) {
  55
  56         if i := len(t.Entries) - 1; i < 0 {
  57                 return nil
  58         } else {
  59                 return t.Entries[i]
  60         }
  61
  62 }
  63
  64 // Reset removes all Entries from this test hook.
  65 func (t *Hook) Reset() {
  66         t.Entries = make([]*logrus.Entry, 0)
  67 }