open-consul/sdk/testutil/retry/retry_test.go

144 lines
3.0 KiB
Go

package retry
import (
"fmt"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// delta defines the time band a test run should complete in.
var delta = 25 * time.Millisecond
func TestRetryer(t *testing.T) {
tests := []struct {
desc string
r Retryer
}{
{"counter", &Counter{Count: 3, Wait: 100 * time.Millisecond}},
{"timer", &Timer{Timeout: 200 * time.Millisecond, Wait: 100 * time.Millisecond}},
}
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
var iters int
start := time.Now()
for tt.r.Continue() {
iters++
}
dur := time.Since(start)
if got, want := iters, 3; got != want {
t.Fatalf("got %d retries want %d", got, want)
}
// since the first iteration happens immediately
// the retryer waits only twice for three iterations.
// order of events: (true, (wait) true, (wait) true, false)
if got, want := dur, 200*time.Millisecond; got < (want-delta) || got > (want+delta) {
t.Fatalf("loop took %v want %v (+/- %v)", got, want, delta)
}
})
}
}
func TestBasics(t *testing.T) {
t.Run("Error allows retry", func(t *testing.T) {
i := 0
Run(t, func(r *R) {
i++
t.Logf("i: %d; r: %#v", i, r)
if i == 1 {
r.Errorf("Errorf, i: %d", i)
return
}
})
assert.Equal(t, i, 2)
})
t.Run("Fatal returns from func, but does not fail test", func(t *testing.T) {
i := 0
gotHere := false
ft := &fakeT{}
Run(ft, func(r *R) {
i++
t.Logf("i: %d; r: %#v", i, r)
if i == 1 {
r.Fatalf("Fatalf, i: %d", i)
gotHere = true
}
})
assert.False(t, gotHere)
assert.Equal(t, i, 2)
// surprisingly, r.FailNow() *does not* trigger ft.FailNow()!
assert.Equal(t, ft.fails, 0)
})
t.Run("Func being run can panic with struct{}{}", func(t *testing.T) {
gotPanic := false
func() {
defer func() {
if p := recover(); p != nil {
gotPanic = true
}
}()
Run(t, func(r *R) {
panic(struct{}{})
})
}()
assert.True(t, gotPanic)
})
}
func TestRunWith(t *testing.T) {
t.Run("calls FailNow after exceeding retries", func(t *testing.T) {
ft := &fakeT{}
iter := 0
RunWith(&Counter{Count: 3, Wait: time.Millisecond}, ft, func(r *R) {
iter++
r.FailNow()
})
require.Equal(t, 3, iter)
require.Equal(t, 1, ft.fails)
})
t.Run("Stop ends the retrying", func(t *testing.T) {
ft := &fakeT{}
iter := 0
RunWith(&Counter{Count: 5, Wait: time.Millisecond}, ft, func(r *R) {
iter++
if iter == 2 {
r.Stop(fmt.Errorf("do not proceed"))
}
r.Fatalf("not yet")
})
// TODO: these should all be assert
require.Equal(t, 2, iter)
require.Equal(t, 1, ft.fails)
require.Len(t, ft.out, 1)
require.Contains(t, ft.out[0], "not yet\n")
require.Contains(t, ft.out[0], "do not proceed\n")
})
}
type fakeT struct {
fails int
out []string
}
func (f *fakeT) Helper() {}
func (f *fakeT) Log(args ...interface{}) {
f.out = append(f.out, fmt.Sprint(args...))
}
func (f *fakeT) FailNow() {
f.fails++
}
var _ Failer = &fakeT{}