/
asserts.go
526 lines (452 loc) · 14.5 KB
/
asserts.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
// Tideland Go Library - Audit
//
// Copyright (C) 2012-2017 Frank Mueller / Tideland / Oldenburg / Germany
//
// All rights reserved. Use of this source code is governed
// by the new BSD license.
package audit
//--------------------
// IMPORTS
//--------------------
import (
"fmt"
"strings"
"time"
)
//--------------------
// TEST
//--------------------
// Test represents the test inside an assert.
type Test uint
// Tests provided by the assertion.
const (
Invalid Test = iota + 1
True
False
Nil
NotNil
Equal
Different
Contents
About
Range
Substring
Case
Match
ErrorMatch
Implementor
Assignable
Unassignable
Empty
NotEmpty
Length
Panics
PathExists
Wait
WaitTested
Retry
Fail
)
//--------------------
// ASSERTION
//--------------------
// MakeSigChan is a simple one-liner to create the buffered signal channel
// for the wait assertion.
func MakeSigChan() chan interface{} {
return make(chan interface{}, 1)
}
// Assertion defines the available test methods.
type Assertion interface {
// SetFailable allows to change the failable possibly used inside
// a failer. This way a testing.T of a sub-test can be injected. A
// restore function is returned.
//
// t.Run(name, func(t *testing.T)) {
// defer assert.SetFailable(t)()
// ...
// })
//
// This way the returned restorer function will be called when
// leaving the sub-test.
SetFailable(f Failable) func()
// IncrCallstackOffset allows test libraries using the audit
// package internally to adjust the callstack offset. This
// way test output shows the correct location. Deferring
// the returned function restores the former offset.
IncrCallstackOffset() func()
// Logf can be used to display useful information during testing.
Logf(format string, args ...interface{})
// True tests if obtained is true.
True(obtained bool, msgs ...string) bool
// False tests if obtained is false.
False(obtained bool, msgs ...string) bool
// Nil tests if obtained is nil.
Nil(obtained interface{}, msgs ...string) bool
// NotNil tests if obtained is not nil.
NotNil(obtained interface{}, msgs ...string) bool
// Equal tests if obtained and expected are equal.
Equal(obtained, expected interface{}, msgs ...string) bool
// Different tests if obtained and expected are different.
Different(obtained, expected interface{}, msgs ...string) bool
// Contents tests if the obtained data is part of the expected
// string, array, or slice.
Contents(obtained, full interface{}, msgs ...string) bool
// About tests if obtained and expected are near to each other
// (within the given extent).
About(obtained, expected, extent float64, msgs ...string) bool
// Range tests if obtained is larger or equal low and lower or
// equal high. Allowed are byte, int and float64 for numbers, runes,
// strings, times, and duration. In case of obtained arrays,
// slices, and maps low and high have to be ints for testing
// the length.
Range(obtained, low, high interface{}, msgs ...string) bool
// Substring tests if obtained is a substring of the full string.
Substring(obtained, full string, msgs ...string) bool
// Case tests if obtained string is uppercase or lowercase.
Case(obtained string, upperCase bool, msgs ...string) bool
// Match tests if the obtained string matches a regular expression.
Match(obtained, regex string, msgs ...string) bool
// ErrorMatch tests if the obtained error as string matches a
// regular expression.
ErrorMatch(obtained error, regex string, msgs ...string) bool
// Implementor tests if obtained implements the expected
// interface variable pointer.
Implementor(obtained, expected interface{}, msgs ...string) bool
// Assignable tests if the types of expected and obtained are assignable.
Assignable(obtained, expected interface{}, msgs ...string) bool
// Unassignable tests if the types of expected and obtained are
// not assignable.
Unassignable(obtained, expected interface{}, msgs ...string) bool
// Empty tests if the len of the obtained string, array, slice
// map, or channel is 0.
Empty(obtained interface{}, msgs ...string) bool
// NotEmpty tests if the len of the obtained string, array, slice
// map, or channel is greater than 0.
NotEmpty(obtained interface{}, msgs ...string) bool
// Length tests if the len of the obtained string, array, slice
// map, or channel is equal to the expected one.
Length(obtained interface{}, expected int, msgs ...string) bool
// Panics checks if the passed function panics.
Panics(pf func(), msgs ...string) bool
// PathExists checks if the passed path or file exists.
PathExists(path string, msgs ...string) bool
// Wait until a received signal or a timeout. The signal has
// to be the expected value.
Wait(sigc <-chan interface{}, expected interface{}, timeout time.Duration, msgs ...string) bool
// WaitTested wait until a received signal or a timeout. The signal then
// is tested by the passed function which has to return nil for a successful
// assert.
WaitTested(sigc <-chan interface{}, tester func(interface{}) error, timeout time.Duration, msgs ...string) bool
// Retry calls the passed function and expects it to return true. Otherwise
// it pauses for the given duration and retries the call the defined number.
Retry(rf func() bool, retries int, pause time.Duration, msgs ...string) bool
// Fail always fails.
Fail(msgs ...string) bool
}
// NewAssertion creates a new Assertion instance.
func NewAssertion(f Failer) Assertion {
return &assertion{
failer: f,
}
}
// assertion implements Assertion.
type assertion struct {
Tester
failer Failer
}
// SetFailable implements Assertion.
func (a *assertion) SetFailable(f Failable) func() {
tf, ok := a.failer.(*testingFailer)
if !ok {
// Nothing to do.
return func() {}
}
// It's a test assertion.
old := tf.failable
tf.failable = f
return func() {
tf.failable = old
}
}
// Logf implements Assertion.
func (a *assertion) IncrCallstackOffset() func() {
return a.failer.IncrCallstackOffset()
}
// Logf implements Assertion.
func (a *assertion) Logf(format string, args ...interface{}) {
a.failer.Logf(format, args...)
}
// True implements Assertion.
func (a *assertion) True(obtained bool, msgs ...string) bool {
if !a.IsTrue(obtained) {
return a.failer.Fail(True, obtained, true, msgs...)
}
return true
}
// False implements Assertion.
func (a *assertion) False(obtained bool, msgs ...string) bool {
if a.IsTrue(obtained) {
return a.failer.Fail(False, obtained, false, msgs...)
}
return true
}
// Nil implements Assertion.
func (a *assertion) Nil(obtained interface{}, msgs ...string) bool {
if !a.IsNil(obtained) {
return a.failer.Fail(Nil, obtained, nil, msgs...)
}
return true
}
// NotNil implements Assertion.
func (a *assertion) NotNil(obtained interface{}, msgs ...string) bool {
if a.IsNil(obtained) {
return a.failer.Fail(NotNil, obtained, nil, msgs...)
}
return true
}
// Equal implements Assertion.
func (a *assertion) Equal(obtained, expected interface{}, msgs ...string) bool {
if !a.IsEqual(obtained, expected) {
return a.failer.Fail(Equal, obtained, expected, msgs...)
}
return true
}
// Different implements Assertion.
func (a *assertion) Different(obtained, expected interface{}, msgs ...string) bool {
if a.IsEqual(obtained, expected) {
return a.failer.Fail(Different, obtained, expected, msgs...)
}
return true
}
// Contents implements Assertion.
func (a *assertion) Contents(part, full interface{}, msgs ...string) bool {
contains, err := a.Contains(part, full)
if err != nil {
return a.failer.Fail(Contents, part, full, "type missmatch: "+err.Error())
}
if !contains {
return a.failer.Fail(Contents, part, full, msgs...)
}
return true
}
// About implements Assertion.
func (a *assertion) About(obtained, expected, extent float64, msgs ...string) bool {
if !a.IsAbout(obtained, expected, extent) {
return a.failer.Fail(About, obtained, expected, msgs...)
}
return true
}
// Range implements Assertion.
func (a *assertion) Range(obtained, low, high interface{}, msgs ...string) bool {
expected := &lowHigh{low, high}
inRange, err := a.IsInRange(obtained, low, high)
if err != nil {
return a.failer.Fail(Range, obtained, expected, "type missmatch: "+err.Error())
}
if !inRange {
return a.failer.Fail(Range, obtained, expected, msgs...)
}
return true
}
// Substring implements Assertion.
func (a *assertion) Substring(obtained, full string, msgs ...string) bool {
if !a.IsSubstring(obtained, full) {
return a.failer.Fail(Substring, obtained, full, msgs...)
}
return true
}
// Case implements Assertion.
func (a *assertion) Case(obtained string, upperCase bool, msgs ...string) bool {
if !a.IsCase(obtained, upperCase) {
if upperCase {
return a.failer.Fail(Case, obtained, strings.ToUpper(obtained), msgs...)
}
return a.failer.Fail(Case, obtained, strings.ToLower(obtained), msgs...)
}
return true
}
// Match implements Assertion.
func (a *assertion) Match(obtained, regex string, msgs ...string) bool {
matches, err := a.IsMatching(obtained, regex)
if err != nil {
return a.failer.Fail(Match, obtained, regex, "can't compile regex: "+err.Error())
}
if !matches {
return a.failer.Fail(Match, obtained, regex, msgs...)
}
return true
}
// ErrorMatch implements Assertion.
func (a *assertion) ErrorMatch(obtained error, regex string, msgs ...string) bool {
if obtained == nil {
return a.failer.Fail(ErrorMatch, nil, regex, "error is nil")
}
matches, err := a.IsMatching(obtained.Error(), regex)
if err != nil {
return a.failer.Fail(ErrorMatch, obtained, regex, "can't compile regex: "+err.Error())
}
if !matches {
return a.failer.Fail(ErrorMatch, obtained, regex, msgs...)
}
return true
}
// Implementor implements Assertion.
func (a *assertion) Implementor(obtained, expected interface{}, msgs ...string) bool {
implements, err := a.IsImplementor(obtained, expected)
if err != nil {
return a.failer.Fail(Implementor, obtained, expected, err.Error())
}
if !implements {
return a.failer.Fail(Implementor, obtained, expected, msgs...)
}
return implements
}
// Assignable implements Assertion.
func (a *assertion) Assignable(obtained, expected interface{}, msgs ...string) bool {
if !a.IsAssignable(obtained, expected) {
return a.failer.Fail(Assignable, obtained, expected, msgs...)
}
return true
}
// Unassignable implements Assertion.
func (a *assertion) Unassignable(obtained, expected interface{}, msgs ...string) bool {
if a.IsAssignable(obtained, expected) {
return a.failer.Fail(Unassignable, obtained, expected, msgs...)
}
return true
}
// Empty implements Assertion.
func (a *assertion) Empty(obtained interface{}, msgs ...string) bool {
length, err := a.Len(obtained)
if err != nil {
return a.failer.Fail(Empty, ValueDescription(obtained), 0, err.Error())
}
if length > 0 {
return a.failer.Fail(Empty, length, 0, msgs...)
}
return true
}
// NotEmpty implements Assertion.
func (a *assertion) NotEmpty(obtained interface{}, msgs ...string) bool {
length, err := a.Len(obtained)
if err != nil {
return a.failer.Fail(NotEmpty, ValueDescription(obtained), 0, err.Error())
}
if length == 0 {
return a.failer.Fail(NotEmpty, length, 0, msgs...)
}
return true
}
// Length implements Assertion.
func (a *assertion) Length(obtained interface{}, expected int, msgs ...string) bool {
length, err := a.Len(obtained)
if err != nil {
return a.failer.Fail(Length, ValueDescription(obtained), expected, err.Error())
}
if length != expected {
return a.failer.Fail(Length, length, expected, msgs...)
}
return true
}
// Panics implements Assertion.
func (a *assertion) Panics(pf func(), msgs ...string) bool {
if !a.HasPanic(pf) {
return a.failer.Fail(Panics, ValueDescription(pf), nil, msgs...)
}
return true
}
// PathExists implements Assertion.
func (a *assertion) PathExists(obtained string, msgs ...string) bool {
valid, err := a.IsValidPath(obtained)
if err != nil {
return a.failer.Fail(PathExists, obtained, true, err.Error())
}
if !valid {
return a.failer.Fail(PathExists, obtained, true, msgs...)
}
return true
}
// Wait implements Assertion.
func (a *assertion) Wait(sigc <-chan interface{}, expected interface{}, timeout time.Duration, msgs ...string) bool {
select {
case obtained := <-sigc:
if !a.IsEqual(obtained, expected) {
return a.failer.Fail(Wait, obtained, expected, msgs...)
}
return true
case <-time.After(timeout):
return a.failer.Fail(Wait, "timeout "+timeout.String(), "signal true", msgs...)
}
}
// WaitTested implements Assertion.
func (a *assertion) WaitTested(sigc <-chan interface{}, tester func(interface{}) error, timeout time.Duration, msgs ...string) bool {
select {
case obtained := <-sigc:
err := tester(obtained)
return a.Nil(err, msgs...)
case <-time.After(timeout):
return a.failer.Fail(Wait, "timeout "+timeout.String(), "signal true", msgs...)
}
}
// Retry implements Assertion.
func (a *assertion) Retry(rf func() bool, retries int, pause time.Duration, msgs ...string) bool {
start := time.Now()
for r := 0; r < retries; r++ {
if rf() {
return true
}
time.Sleep(pause)
}
needed := time.Now().Sub(start)
info := fmt.Sprintf("timeout after %v and %d retries", needed, retries)
return a.failer.Fail(Retry, info, "successful call", msgs...)
}
// Fail implements Assertion.
func (a *assertion) Fail(msgs ...string) bool {
return a.failer.Fail(Fail, nil, nil, msgs...)
}
//--------------------
// HELPER
//--------------------
// lowHigh transports the expected borders of a range test.
type lowHigh struct {
low interface{}
high interface{}
}
// lenable is an interface for the Len() mehod.
type lenable interface {
Len() int
}
// obexString constructs a descriptive sting matching
// to test, obtained, and expected value.
func obexString(test Test, obtained, expected interface{}) string {
switch test {
case True, False, Nil, NotNil, Empty, NotEmpty:
return fmt.Sprintf("'%v'", obtained)
case Implementor, Assignable, Unassignable:
return fmt.Sprintf("'%v' <> '%v'", ValueDescription(obtained), ValueDescription(expected))
case Range:
lh := expected.(*lowHigh)
return fmt.Sprintf("not '%v' <= '%v' <= '%v'", lh.low, obtained, lh.high)
case Fail:
return "fail intended"
default:
return fmt.Sprintf("'%v' <> '%v'", obtained, expected)
}
}
// failString constructs a fail string for panics or
// validition errors.
func failString(test Test, obex string, msgs ...string) string {
var out string
if test == Fail {
out = fmt.Sprintf("assert failed: %s", obex)
} else {
out = fmt.Sprintf("assert '%s' failed: %s", test, obex)
}
jmsgs := strings.Join(msgs, " ")
if len(jmsgs) > 0 {
out += " (" + jmsgs + ")"
}
return out
}
// EOF