-
Notifications
You must be signed in to change notification settings - Fork 175
/
unittest.go
380 lines (329 loc) · 10.7 KB
/
unittest.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
package unittest
import (
"encoding/json"
"io/ioutil"
"math"
"os"
"regexp"
"strings"
"sync"
"testing"
"time"
"github.com/onflow/flow-go/model/flow"
"github.com/dgraph-io/badger/v2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/onflow/flow-go/module"
"github.com/onflow/flow-go/module/util"
)
type SkipReason int
const (
TEST_FLAKY SkipReason = iota + 1 // flaky
TEST_TODO // not fully implemented or broken and needs to be fixed
TEST_REQUIRES_GCP_ACCESS // requires the environment to be configured with GCP credentials
TEST_DEPRECATED // uses code that has been deprecated / disabled
TEST_LONG_RUNNING // long running
TEST_RESOURCE_INTENSIVE // resource intensive test
)
func (s SkipReason) String() string {
switch s {
case TEST_FLAKY:
return "TEST_FLAKY"
case TEST_TODO:
return "TEST_TODO"
case TEST_REQUIRES_GCP_ACCESS:
return "TEST_REQUIRES_GCP_ACCESS"
case TEST_DEPRECATED:
return "TEST_DEPRECATED"
case TEST_LONG_RUNNING:
return "TEST_LONG_RUNNING"
case TEST_RESOURCE_INTENSIVE:
return "TEST_RESOURCE_INTENSIVE"
}
return "UNKNOWN"
}
func (s SkipReason) MarshalJSON() ([]byte, error) {
return json.Marshal(s.String())
}
func parseSkipReason(reason string) SkipReason {
switch reason {
case "TEST_FLAKY":
return TEST_FLAKY
case "TEST_TODO":
return TEST_TODO
case "TEST_REQUIRES_GCP_ACCESS":
return TEST_REQUIRES_GCP_ACCESS
case "TEST_DEPRECATED":
return TEST_DEPRECATED
case "TEST_LONG_RUNNING":
return TEST_LONG_RUNNING
case "TEST_RESOURCE_INTENSIVE":
return TEST_RESOURCE_INTENSIVE
default:
return 0
}
}
func ParseSkipReason(output string) (SkipReason, bool) {
// match output like:
// " test_file.go:123: SKIP [TEST_REASON]: message\n"
r := regexp.MustCompile(`(?s)^\s+[a-zA-Z0-9_\-]+\.go:[0-9]+: SKIP \[([A-Z_]+)]: .*$`)
matches := r.FindStringSubmatch(output)
if len(matches) == 2 {
skipReason := parseSkipReason(matches[1])
if skipReason != 0 {
return skipReason, true
}
}
return 0, false
}
func SkipUnless(t *testing.T, reason SkipReason, message string) {
t.Helper()
if os.Getenv(reason.String()) == "" {
t.Skipf("SKIP [%s]: %s", reason.String(), message)
}
}
type SkipBenchmarkReason int
const (
BENCHMARK_EXPERIMENT SkipBenchmarkReason = iota + 1
)
func (s SkipBenchmarkReason) String() string {
switch s {
case BENCHMARK_EXPERIMENT:
return "BENCHMARK_EXPERIMENT"
}
return "UNKNOWN"
}
func SkipBenchmarkUnless(b *testing.B, reason SkipBenchmarkReason, message string) {
b.Helper()
if os.Getenv(reason.String()) == "" {
b.Skip(message)
}
}
func ExpectPanic(expectedMsg string, t *testing.T) {
if r := recover(); r != nil {
err := r.(error)
if err.Error() != expectedMsg {
t.Errorf("expected %v to be %v", err, expectedMsg)
}
return
}
t.Errorf("Expected to panic with `%s`, but did not panic", expectedMsg)
}
// AssertReturnsBefore asserts that the given function returns before the
// duration expires.
func AssertReturnsBefore(t *testing.T, f func(), duration time.Duration, msgAndArgs ...interface{}) {
done := make(chan struct{})
go func() {
f()
close(done)
}()
select {
case <-time.After(duration):
t.Log("function did not return in time")
assert.Fail(t, "function did not close in time", msgAndArgs...)
case <-done:
return
}
}
// AssertClosesBefore asserts that the given channel closes before the
// duration expires.
func AssertClosesBefore(t assert.TestingT, done <-chan struct{}, duration time.Duration, msgAndArgs ...interface{}) {
select {
case <-time.After(duration):
assert.Fail(t, "channel did not return in time", msgAndArgs...)
case <-done:
return
}
}
func AssertFloatEqual(t *testing.T, expected, actual float64, message string) {
tolerance := .00001
if !(math.Abs(expected-actual) < tolerance) {
assert.Equal(t, expected, actual, message)
}
}
// AssertNotClosesBefore asserts that the given channel does not close before the duration expires.
func AssertNotClosesBefore(t assert.TestingT, done <-chan struct{}, duration time.Duration, msgAndArgs ...interface{}) {
select {
case <-time.After(duration):
return
case <-done:
assert.Fail(t, "channel closed before timeout", msgAndArgs...)
}
}
// RequireReturnBefore requires that the given function returns before the
// duration expires.
func RequireReturnsBefore(t testing.TB, f func(), duration time.Duration, message string) {
done := make(chan struct{})
go func() {
f()
close(done)
}()
RequireCloseBefore(t, done, duration, message+": function did not return on time")
}
// RequireComponentsDoneBefore invokes the done method of each of the input components concurrently, and
// fails the test if any components shutdown takes longer than the specified duration.
func RequireComponentsDoneBefore(t testing.TB, duration time.Duration, components ...module.ReadyDoneAware) {
done := util.AllDone(components...)
RequireCloseBefore(t, done, duration, "failed to shutdown all components on time")
}
// RequireComponentsReadyBefore invokes the ready method of each of the input components concurrently, and
// fails the test if any components startup takes longer than the specified duration.
func RequireComponentsReadyBefore(t testing.TB, duration time.Duration, components ...module.ReadyDoneAware) {
ready := util.AllReady(components...)
RequireCloseBefore(t, ready, duration, "failed to start all components on time")
}
// RequireCloseBefore requires that the given channel returns before the
// duration expires.
func RequireCloseBefore(t testing.TB, c <-chan struct{}, duration time.Duration, message string) {
select {
case <-time.After(duration):
require.Fail(t, "could not close done channel on time: "+message)
case <-c:
return
}
}
// RequireClosed is a test helper function that fails the test if channel `ch` is not closed.
func RequireClosed(t *testing.T, ch <-chan struct{}, message string) {
select {
case <-ch:
default:
require.Fail(t, "channel is not closed: "+message)
}
}
// RequireConcurrentCallsReturnBefore is a test helper that runs function `f` count-many times concurrently,
// and requires all invocations to return within duration.
func RequireConcurrentCallsReturnBefore(t *testing.T, f func(), count int, duration time.Duration, message string) {
wg := &sync.WaitGroup{}
for i := 0; i < count; i++ {
wg.Add(1)
go func() {
f()
wg.Done()
}()
}
RequireReturnsBefore(t, wg.Wait, duration, message)
}
// RequireNeverReturnBefore is a test helper that tries invoking function `f` and fails the test if either:
// - function `f` is not invoked within 1 second.
// - function `f` returns before specified `duration`.
//
// It also returns a channel that is closed once the function `f` returns and hence its openness can evaluate
// return status of function `f` for intervals longer than duration.
func RequireNeverReturnBefore(t *testing.T, f func(), duration time.Duration, message string) <-chan struct{} {
ch := make(chan struct{})
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
wg.Done()
f()
close(ch)
}()
// requires function invoked within next 1 second
RequireReturnsBefore(t, wg.Wait, 1*time.Second, "could not invoke the function: "+message)
// requires function never returns within duration
RequireNeverClosedWithin(t, ch, duration, "unexpected return: "+message)
return ch
}
// RequireNeverClosedWithin is a test helper function that fails the test if channel `ch` is closed before the
// determined duration.
func RequireNeverClosedWithin(t *testing.T, ch <-chan struct{}, duration time.Duration, message string) {
select {
case <-time.After(duration):
case <-ch:
require.Fail(t, "channel closed before timeout: "+message)
}
}
// RequireNotClosed is a test helper function that fails the test if channel `ch` is closed.
func RequireNotClosed(t *testing.T, ch <-chan struct{}, message string) {
select {
case <-ch:
require.Fail(t, "channel is closed: "+message)
default:
}
}
// AssertErrSubstringMatch asserts that two errors match with substring
// checking on the Error method (`expected` must be a substring of `actual`, to
// account for the actual error being wrapped). Fails the test if either error
// is nil.
//
// NOTE: This should only be used in cases where `errors.Is` cannot be, like
// when errors are transmitted over the network without type information.
func AssertErrSubstringMatch(t testing.TB, expected, actual error) {
require.NotNil(t, expected)
require.NotNil(t, actual)
assert.True(
t,
strings.Contains(actual.Error(), expected.Error()) || strings.Contains(expected.Error(), actual.Error()),
"expected error: '%s', got: '%s'", expected.Error(), actual.Error(),
)
}
func TempDir(t testing.TB) string {
dir, err := ioutil.TempDir("", "flow-testing-temp-")
require.NoError(t, err)
return dir
}
func RunWithTempDir(t testing.TB, f func(string)) {
dbDir := TempDir(t)
defer func() {
require.NoError(t, os.RemoveAll(dbDir))
}()
f(dbDir)
}
func badgerDB(t testing.TB, dir string, create func(badger.Options) (*badger.DB, error)) *badger.DB {
opts := badger.
DefaultOptions(dir).
WithKeepL0InMemory(true).
WithLogger(nil)
db, err := create(opts)
require.NoError(t, err)
return db
}
func BadgerDB(t testing.TB, dir string) *badger.DB {
return badgerDB(t, dir, badger.Open)
}
func TypedBadgerDB(t testing.TB, dir string, create func(badger.Options) (*badger.DB, error)) *badger.DB {
return badgerDB(t, dir, create)
}
func RunWithBadgerDB(t testing.TB, f func(*badger.DB)) {
RunWithTempDir(t, func(dir string) {
db := BadgerDB(t, dir)
defer func() {
assert.NoError(t, db.Close())
}()
f(db)
})
}
// RunWithTypedBadgerDB creates a Badger DB that is passed to f and closed
// after f returns. The extra create parameter allows passing in a database
// constructor function which instantiates a database with a particular type
// marker, for testing storage modules which require a backed with a particular
// type.
func RunWithTypedBadgerDB(t testing.TB, create func(badger.Options) (*badger.DB, error), f func(*badger.DB)) {
RunWithTempDir(t, func(dir string) {
db := badgerDB(t, dir, create)
defer func() {
assert.NoError(t, db.Close())
}()
f(db)
})
}
func TempBadgerDB(t testing.TB) (*badger.DB, string) {
dir := TempDir(t)
db := BadgerDB(t, dir)
return db, dir
}
func Concurrently(n int, f func(int)) {
var wg sync.WaitGroup
for i := 0; i < n; i++ {
wg.Add(1)
go func(i int) {
f(i)
wg.Done()
}(i)
}
wg.Wait()
}
// AssertEqualBlocksLenAndOrder asserts that both a segment of blocks have the same len and blocks are in the same order
func AssertEqualBlocksLenAndOrder(t *testing.T, expectedBlocks, actualSegmentBlocks []*flow.Block) {
assert.Equal(t, flow.GetIDs(expectedBlocks), flow.GetIDs(actualSegmentBlocks))
}