File: timer_test.go

package info (click to toggle)
golang-github-juju-utils 0.0~git20171220.f38c0b0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,748 kB
  • sloc: makefile: 20
file content (189 lines) | stat: -rw-r--r-- 4,670 bytes parent folder | download | duplicates (2)
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
// Copyright 2015 Canonical Ltd.
// Copyright 2015 Cloudbase Solutions SRL
// Licensed under the LGPLv3, see LICENCE file for details.

package utils_test

import (
	"math"
	"time"

	gc "gopkg.in/check.v1"

	"github.com/juju/testing"
	jc "github.com/juju/testing/checkers"
	"github.com/juju/utils"
	"github.com/juju/utils/clock"
)

type TestStdTimer struct {
	stdStub *testing.Stub
}

func (t *TestStdTimer) Stop() bool {
	t.stdStub.AddCall("Stop")
	return true
}

func (t *TestStdTimer) Reset(d time.Duration) bool {
	t.stdStub.AddCall("Reset", d)
	return true
}

func (t *TestStdTimer) Chan() <-chan time.Time {
	panic("should not be called")
}

type timerSuite struct {
	baseSuite        testing.CleanupSuite
	timer            *utils.BackoffTimer
	afterFuncCalls   int64
	properFuncCalled bool
	stub             *testing.Stub

	min    time.Duration
	max    time.Duration
	factor int64
}

var _ = gc.Suite(&timerSuite{})

type mockClock struct {
	stub             *testing.Stub
	c                *gc.C
	afterFuncCalls   *int64
	properFuncCalled bool
}

// These 2 methods are not used here but are needed to satisfy the intergface
func (c *mockClock) Now() time.Time                         { return time.Now() }
func (c *mockClock) After(d time.Duration) <-chan time.Time { return time.After(d) }
func (c *mockClock) NewTimer(d time.Duration) clock.Timer {
	panic("should not be called")
}

func (c *mockClock) AfterFunc(d time.Duration, f func()) clock.Timer {
	*c.afterFuncCalls++
	f()
	c.c.Assert(c.properFuncCalled, jc.IsTrue)
	c.properFuncCalled = false
	return &TestStdTimer{c.stub}
}

func (s *timerSuite) SetUpTest(c *gc.C) {
	s.baseSuite.SetUpTest(c)
	s.afterFuncCalls = 0
	s.stub = &testing.Stub{}

	// This along with the checks in afterFuncMock below assert
	// that mockFunc is indeed passed as the argument to afterFuncMock
	// to be executed.
	mockFunc := func() { s.properFuncCalled = true }
	mockClock := &mockClock{
		stub:             s.stub,
		c:                c,
		afterFuncCalls:   &s.afterFuncCalls,
		properFuncCalled: s.properFuncCalled,
	}

	s.min = 2 * time.Second
	s.max = 16 * time.Second
	s.factor = 2
	s.timer = utils.NewBackoffTimer(
		utils.BackoffTimerConfig{
			Min:    s.min,
			Max:    s.max,
			Jitter: false,
			Factor: s.factor,
			Func:   mockFunc,
			Clock:  mockClock,
		},
	)
}

func (s *timerSuite) TestStart(c *gc.C) {
	s.timer.Start()
	s.testStart(c, 1, 1)
}

func (s *timerSuite) TestMultipleStarts(c *gc.C) {
	s.timer.Start()
	s.testStart(c, 1, 1)

	s.timer.Start()
	s.checkStopCalls(c, 1)
	s.testStart(c, 2, 2)

	s.timer.Start()
	s.checkStopCalls(c, 2)
	s.testStart(c, 3, 3)
}

func (s *timerSuite) TestResetNoStart(c *gc.C) {
	s.timer.Reset()
	currentDuration := utils.ExposeBackoffTimerDuration(s.timer)
	c.Assert(currentDuration, gc.Equals, s.min)
}

func (s *timerSuite) TestResetAndStart(c *gc.C) {
	s.timer.Reset()
	currentDuration := utils.ExposeBackoffTimerDuration(s.timer)
	c.Assert(currentDuration, gc.Equals, s.min)

	// These variables are used to track the number
	// of afterFuncCalls(signalCallsNo) and the number
	// of Stop calls(resetStopCallsNo + signalCallsNo)
	resetStopCallsNo := 0
	signalCallsNo := 0

	signalCallsNo++
	s.timer.Start()
	s.testStart(c, 1, 1)

	resetStopCallsNo++
	s.timer.Reset()
	s.checkStopCalls(c, resetStopCallsNo+signalCallsNo-1)
	currentDuration = utils.ExposeBackoffTimerDuration(s.timer)
	c.Assert(currentDuration, gc.Equals, s.min)

	for i := 1; i < 200; i++ {
		signalCallsNo++
		s.timer.Start()
		s.testStart(c, int64(signalCallsNo), int64(i))
		s.checkStopCalls(c, resetStopCallsNo+signalCallsNo-1)
	}

	resetStopCallsNo++
	s.timer.Reset()
	s.checkStopCalls(c, signalCallsNo+resetStopCallsNo-1)

	for i := 1; i < 100; i++ {
		signalCallsNo++
		s.timer.Start()
		s.testStart(c, int64(signalCallsNo), int64(i))
		s.checkStopCalls(c, resetStopCallsNo+signalCallsNo-1)
	}

	resetStopCallsNo++
	s.timer.Reset()
	s.checkStopCalls(c, signalCallsNo+resetStopCallsNo-1)
}

func (s *timerSuite) testStart(c *gc.C, afterFuncCalls int64, durationFactor int64) {
	c.Assert(s.afterFuncCalls, gc.Equals, afterFuncCalls)
	c.Logf("iteration %d", afterFuncCalls)
	expectedDuration := time.Duration(math.Pow(float64(s.factor), float64(durationFactor))) * s.min
	if expectedDuration > s.max || expectedDuration <= 0 {
		expectedDuration = s.max
	}
	currentDuration := utils.ExposeBackoffTimerDuration(s.timer)
	c.Assert(currentDuration, gc.Equals, expectedDuration)
}

func (s *timerSuite) checkStopCalls(c *gc.C, number int) {
	calls := make([]testing.StubCall, number)
	for i := 0; i < number; i++ {
		calls[i] = testing.StubCall{FuncName: "Stop"}
	}
	s.stub.CheckCalls(c, calls)
}