/
capture.go
71 lines (62 loc) · 1.86 KB
/
capture.go
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
68
69
70
71
// Copyright © 2020 Attestant Limited.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package logger
import (
"fmt"
"strings"
"sync"
"testing"
"github.com/rs/zerolog"
zerologger "github.com/rs/zerolog/log"
"github.com/stretchr/testify/assert"
)
// LogCapture allows testing code to query log output.
type LogCapture struct {
mu sync.Mutex
entries []string
}
// NewLogCapture captures logs for querying.
func NewLogCapture() *LogCapture {
c := &LogCapture{
// entries: make([]*LogEntry, 0),
entries: make([]string, 0),
}
zerologger.Logger = zerologger.Logger.Hook(c)
return c
}
// Run is the hook to capture log entries. It also stops the entry from being printed.
func (c *LogCapture) Run(e *zerolog.Event, _ zerolog.Level, msg string) {
c.mu.Lock()
defer c.mu.Unlock()
c.entries = append(c.entries, msg)
e.Discard()
}
// AssertHasEntry checks if there is a log entry with the given string.
func (c *LogCapture) AssertHasEntry(t *testing.T, msg string) {
c.mu.Lock()
defer c.mu.Unlock()
for i := range c.entries {
if c.entries[i] == msg {
return
}
}
assert.Fail(t, fmt.Sprintf("Missing log message %q", msg), strings.Join(c.entries, "\n"))
}
// Entries returns all log entries.
func (c *LogCapture) Entries() []string {
return c.entries
}
// ClearEntries removes all log entries.
func (c *LogCapture) ClearEntries() {
c.entries = make([]string, 0)
}