-
Notifications
You must be signed in to change notification settings - Fork 0
/
matchers.go
348 lines (326 loc) · 8.97 KB
/
matchers.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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
package logcap
import (
"fmt"
"sync"
"time"
"github.com/sirupsen/logrus"
"github.com/onsi/gomega/matchers"
"github.com/onsi/gomega/types"
)
var logMut sync.Mutex
// Repeater allows for easy repeating of log matches. If you have something that's going to log
// 30 times, just use a repeater:
//
// Ω(logHook).Should(HaveLogs(Repeater{MatchRegexp(`Log entry \d+`), 30}))
//
type Repeater struct {
M interface{}
N int
}
type markedEntry struct {
*logrus.Entry
matched bool
}
type logsMatch struct {
Expected types.GomegaMatcher
matched bool
Fields *logrus.Fields
Entry *markedEntry
}
type logsMatcher struct {
Matchers []*logsMatch
NonMatching *markedEntry
timeout time.Duration
}
type noLogsMatcher struct {
matchers.EqualMatcher
level *logrus.Level
found int
}
// HaveLogs takes a number of strings, Gomega matchers and/or
// logrus.Fields as arguments. It attempts to match logs based on the
// strings/matchers given. If a logrus.Fields{} argument is given, it
// is applied to all strings/matchers that precede it up until the
// previous logrus.Fields{} argument. To succeed, all
// strings/matchers must match along with their associated
// logrus.Fields{} argument.
//
// This matches three distinct log entries, each with a {"task":
// "exiting"} field set:
//
// HaveLogs("culler", "tallier", "summer", logrus.Fields{"task": "exiting"})
//
// This matches two log entries with empty field sets, and one
// without:
//
// HaveLogs("alpha", "beta", logrus.Fields{}, "gamma", logrus.Fields{"big": "whoop"})
//
// An optional time.Duration added to the arguments will set the
// timeout for HaveLogs giving up on waiting for a match.
//
// HaveLogs("summation", time.Seconds*100)
//
// The default timeout is two seconds.
func HaveLogs(args ...interface{}) types.GomegaMatcher {
m := &logsMatcher{timeout: time.Second * 2}
parseMatchArgs(args, m)
return m
}
// HaveNoLogs is the inverse of HaveLogs(). It makes sure that there
// are no logs that haven't been matched already.
//
// If given a level, it'll only make sure no logs of that level have
// been seen. E.g.:
//
// Ω(logHook).Should(HaveNoLogs(logrus.ErrorLevel))
func HaveNoLogs(level ...logrus.Level) types.GomegaMatcher {
m := &noLogsMatcher{
EqualMatcher: matchers.EqualMatcher{Expected: 0},
}
if len(level) > 0 {
m.level = &level[0]
}
return m
}
// matcherOrEqual if given a matcher will use it. Otherwise it'll use
// the stock EqualMatcher.
func matcherOrEqual(arg interface{}) *logsMatch {
switch arg := arg.(type) {
case types.GomegaMatcher:
return &logsMatch{Expected: arg}
default:
return &logsMatch{Expected: &matchers.EqualMatcher{Expected: arg}}
}
}
func parseMatchArgs(args []interface{}, m *logsMatcher) {
for _, arg := range args {
switch arg := arg.(type) {
case logrus.Fields: // Go backwards through matches and add this to its fields arg.
for i := len(m.Matchers) - 1; i >= 0; i-- {
if m.Matchers[i].Fields != nil { // Only if they don't have one already.
break
}
m.Matchers[i].Fields = &arg
}
case Repeater:
for i := 0; i < arg.N; i++ {
m.Matchers = append(m.Matchers, matcherOrEqual(arg.M))
}
case time.Duration:
m.timeout = arg
default:
m.Matchers = append(m.Matchers, matcherOrEqual(arg))
}
}
}
func (m *logsMatcher) numMatchersLeft() (count int) {
for _, match := range m.Matchers {
if !match.matched {
count++
}
}
return
}
func (m *logsMatcher) Match(actual interface{}) (success bool, err error) {
// Reset match indicators
for _, match := range m.Matchers {
match.matched = false
}
hook := actual.(*LogCap)
hook.cacheMut.Lock()
defer hook.cacheMut.Unlock()
var entry *markedEntry
cacheTop := 0
MainLoop:
// Loop until all matched or timeout.
for m.numMatchersLeft() > 0 {
if cacheTop < len(hook.cache) { // Look at old logs first.
entry = hook.cache[cacheTop]
} else {
select {
case e := <-hook.entries:
entry = &markedEntry{e, false}
case <-time.After(m.timeout):
return false, nil
}
hook.cache = append(hook.cache, entry)
// fmt.Printf("I see %s [%d] with %+v [%d]\n", entry.Message, len(hook.entries), entry.Data, m.numMatchersLeft())
}
cacheTop++
if entry.matched { // We've already matched this one.
continue MainLoop
}
MatchLoop:
// Find a matcher for this entry
for _, matchItem := range m.Matchers {
if matchItem.matched { // Already matched it.
continue MatchLoop
}
doesMatch, err := matchItem.Expected.Match(entry.Message)
if err != nil {
return false, err
}
if !doesMatch { // Nope, try the next one.
continue MatchLoop
}
if matchItem.Fields != nil {
logMut.Lock()
data := entry.Data
for key, value := range *matchItem.Fields {
var matcher types.GomegaMatcher
switch value := value.(type) {
case types.GomegaMatcher:
matcher = value
default:
matcher = &matchers.EqualMatcher{Expected: value}
}
if _, ok := data[key]; !ok {
logMut.Unlock()
continue MatchLoop // Not there, no match.
}
matched, err := matcher.Match(data[key])
if err != nil {
logMut.Unlock()
return false, err
}
if !matched {
logMut.Unlock()
continue MatchLoop
}
}
logMut.Unlock()
}
matchItem.matched = true
entry.matched = true
matchItem.Entry = entry
continue MainLoop
}
m.NonMatching = entry
}
return true, nil
}
func (m *logsMatcher) baseMessage(matched bool) (message string) {
for _, matchEntry := range m.Matchers {
if m.NonMatching != nil {
if matchEntry.matched { // Don't report on things I know about
continue
}
moMessage := m.NonMatching.Message
moMessage += fmt.Sprintf("\n logged at %s:%d\n", m.NonMatching.Data["file"], m.NonMatching.Data["line"])
if len(m.NonMatching.Data) > 2 {
data := logrus.Fields{}
for k, v := range m.NonMatching.Data {
if k == "file" || k == "line" {
continue
}
data[k] = v
}
moMessage += fmt.Sprintf(" with %#v", data)
}
message += matchEntry.Expected.FailureMessage(moMessage) + "\n"
if matchEntry.Fields != nil {
message += fmt.Sprintf(" with %#v\n", matchEntry.Fields)
}
return
}
if matchEntry.matched == matched {
if matched {
message += matchEntry.Expected.NegatedFailureMessage(matchEntry.Entry.Message) + "\n"
message += fmt.Sprintf("logged at %s:%d\n", matchEntry.Entry.Data["file"], matchEntry.Entry.Data["line"])
} else {
message += matchEntry.Expected.FailureMessage(nil) + "\n"
}
if matchEntry.Fields != nil {
message += fmt.Sprintf("with %#v\n", matchEntry.Fields)
}
}
}
if m.NonMatching != nil {
message += "Nonmatching log:\n"
message += " " + m.NonMatching.Message + "\n"
message += fmt.Sprintf(" logged at %s:%d\n", m.NonMatching.Data["file"], m.NonMatching.Data["line"])
if len(m.NonMatching.Data) > 2 {
data := logrus.Fields{}
for k, v := range m.NonMatching.Data {
if k == "file" || k == "line" {
continue
}
data[k] = v
}
message += fmt.Sprintf(" with %#v\n", data)
}
}
return
}
func (m *logsMatcher) FailureMessage(actual interface{}) (message string) {
return m.baseMessage(false)
}
func (m *logsMatcher) NegatedFailureMessage(actual interface{}) (message string) {
return m.baseMessage(true)
}
func (m *noLogsMatcher) Match(actual interface{}) (success bool, err error) {
hook := actual.(*LogCap)
hook.cacheMut.Lock()
defer hook.cacheMut.Unlock()
l := len(hook.entries) + len(hook.cache)
var entry *markedEntry
cacheTop := 0
for i := 0; i < l; i++ {
if cacheTop < len(hook.cache) {
entry = hook.cache[cacheTop]
} else {
e := <-hook.entries
entry = &markedEntry{e, false}
hook.cache = append(hook.cache, entry)
}
cacheTop++
if m.level != nil && entry.Level != *m.level {
continue
}
if !entry.matched { // Count non-matched entries
m.found++
}
}
return m.EqualMatcher.Match(m.found)
}
func (m *noLogsMatcher) FailureMessage(actual interface{}) (message string) {
hook := actual.(*LogCap)
message = fmt.Sprintf("Expected no logs. Instead, got %d:", m.found)
for _, entry := range hook.cache {
if m.level != nil && entry.Level != *m.level {
continue
}
if entry.matched {
continue
}
extra := ""
if len(entry.Data) > 2 {
data := logrus.Fields{}
for k, v := range entry.Data {
if k == "file" || k == "line" {
continue
}
data[k] = v
}
extra = fmt.Sprintf(" (%v)", data)
}
message = message + fmt.Sprintf("\n %s%s\n logged at %s:%d", entry.Message, extra, entry.Data["file"], entry.Data["line"])
}
return
}
func (m *noLogsMatcher) NegatedFailureMessage(actual interface{}) (message string) {
hook := actual.(*LogCap)
hook.cacheMut.Lock()
defer hook.cacheMut.Unlock()
message = fmt.Sprintf("Did not expect 0 logs\n")
for _, entry := range hook.cache {
if m.level != nil && entry.Level != *m.level {
continue
}
if entry.matched {
continue
}
message = message + fmt.Sprintf("\n%s\n logged at %s:%d", entry.Message, entry.Data["file"], entry.Data["line"])
}
return
}