-
Notifications
You must be signed in to change notification settings - Fork 0
/
soon.go
51 lines (46 loc) · 1.77 KB
/
soon.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
// Copyright 2016 The Cockroach Authors.
//
// 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 testutils
import (
"context"
"runtime/debug"
"testing"
"time"
"github.com/cockroachdb/errors"
"github.com/knz/shakespeare/pkg/crdb/log"
"github.com/knz/shakespeare/pkg/crdb/retry"
"github.com/knz/shakespeare/pkg/crdb/timeutil"
)
// DefaultSucceedsSoonDuration is the maximum amount of time unittests
// will wait for a condition to become true. See SucceedsSoon().
const DefaultSucceedsSoonDuration = 45 * time.Second
// SucceedsSoon fails the test (with t.Fatal) unless the supplied
// function runs without error within a preset maximum duration. The
// function is invoked immediately at first and then successively with
// an exponential backoff starting at 1ns and ending at around 1s.
func SucceedsSoon(t testing.TB, fn func() error) {
t.Helper()
tBegin := timeutil.Now()
wrappedFn := func() error {
err := fn()
if timeutil.Since(tBegin) > 3*time.Second && err != nil {
log.InfoDepth(context.Background(), 3, errors.Wrap(err, "SucceedsSoon"))
}
return err
}
if err := retry.ForDuration(DefaultSucceedsSoonDuration, wrappedFn); err != nil {
t.Fatalf("condition failed to evaluate within %s: %s\n%s",
DefaultSucceedsSoonDuration, err, string(debug.Stack()))
}
}