forked from sywhang/fx
/
spy.go
84 lines (72 loc) · 2.36 KB
/
spy.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
72
73
74
75
76
77
78
79
80
81
82
83
84
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package fxlog
import (
"fmt"
"strings"
"go.uber.org/zap"
)
// Spy is an Fx Printer that captures logged statements. It may be used in
// tests of Fx logs.
type Spy struct {
entries []Entry
}
var _ Logger = &Spy{}
// Log append an Entry.
func (s *Spy) Log(entry Entry) {
s.entries = append(s.entries, entry)
}
// Messages returns a copy of all captured messages.
func (s *Spy) Messages() []Entry {
msgs := make([]Entry, len(s.entries))
copy(msgs, s.entries)
return msgs
}
// String returns all logged messages as a single newline-delimited string.
func (s *Spy) String() string {
if len(s.entries) == 0 {
return ""
}
var msg strings.Builder
for _, m := range s.entries {
fmt.Fprintf(&msg, m.Message)
for _, f := range m.Fields {
// extra space before f.Key to separate out message.
fmt.Fprintf(&msg, "\t%s: %v", f.Key, f.Value)
}
if m.Stack != "" {
fmt.Fprintf(&msg, "\t%q", m.Stack)
}
msg.WriteString("\n")
}
return msg.String()
}
// Fields returns all Fields members of entries.
func (s *Spy) Fields() []zap.Field {
var fields []zap.Field
for _, e := range s.entries {
fields = append(fields, encodeFields(e.Fields, "")...)
}
return fields
}
// Reset clears all messages from the Spy.
func (s *Spy) Reset() {
s.entries = s.entries[:0]
}