summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/Sirupsen/logrus/hooks/test/test.go
blob: 068812535d51a54eb4b3a9ee9eadfaa0c140e97b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package test

import (
	"io/ioutil"

	"github.com/Sirupsen/logrus"
)

// test.Hook is a hook designed for dealing with logs in test scenarios.
type Hook struct {
	Entries []*logrus.Entry
}

// Installs a test hook for the global logger.
func NewGlobal() *Hook {

	hook := new(Hook)
	logrus.AddHook(hook)

	return hook

}

// Installs a test hook for a given local logger.
func NewLocal(logger *logrus.Logger) *Hook {

	hook := new(Hook)
	logger.Hooks.Add(hook)

	return hook

}

// Creates a discarding logger and installs the test hook.
func NewNullLogger() (*logrus.Logger, *Hook) {

	logger := logrus.New()
	logger.Out = ioutil.Discard

	return logger, NewLocal(logger)

}

func (t *Hook) Fire(e *logrus.Entry) error {
	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() (l *logrus.Entry) {

	if i := len(t.Entries) - 1; i < 0 {
		return nil
	} else {
		return t.Entries[i]
	}

}

// Reset removes all Entries from this test hook.
func (t *Hook) Reset() {
	t.Entries = make([]*logrus.Entry, 0)
}