forked from vulcand/oxy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbucketset_test.go
253 lines (192 loc) · 6.36 KB
/
bucketset_test.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
package ratelimit
import (
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/vulcand/oxy/internal/holsterv4/clock"
"github.com/vulcand/oxy/testutils"
)
// A value returned by `MaxPeriod` corresponds to the longest bucket time period.
func TestLongestPeriod(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 20))
require.NoError(t, rates.Add(7*clock.Second, 10, 20))
require.NoError(t, rates.Add(5*clock.Second, 11, 21))
done := testutils.FreezeTime()
defer done()
// When
tbs := NewTokenBucketSet(rates)
// Then
assert.Equal(t, 7*clock.Second, tbs.maxPeriod)
}
// Successful token consumption updates state of all buckets in the set.
func TestConsume(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 20))
require.NoError(t, rates.Add(10*clock.Second, 20, 50))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
// When
delay, err := tbs.Consume(15)
require.NoError(t, err)
// Then
assert.Equal(t, time.Duration(0), delay)
assert.Equal(t, "{1s: 5}, {10s: 35}", tbs.debugState())
}
// As time goes by all set buckets are refilled with appropriate rates.
func TestConsumeRefill(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 10, 20))
require.NoError(t, rates.Add(100*clock.Second, 20, 50))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(15)
require.NoError(t, err)
assert.Equal(t, "{10s: 5}, {1m40s: 35}", tbs.debugState())
// When
clock.Advance(10 * clock.Second)
delay, err := tbs.Consume(0) // Consumes nothing but forces an internal state update.
require.NoError(t, err)
// Then
assert.Equal(t, time.Duration(0), delay)
assert.Equal(t, "{10s: 15}, {1m40s: 37}", tbs.debugState())
}
// If the first bucket in the set has no enough tokens to allow desired
// consumption then an appropriate delay is returned.
func TestConsumeLimitedBy1st(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 10, 10))
require.NoError(t, rates.Add(100*clock.Second, 20, 20))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(5)
require.NoError(t, err)
assert.Equal(t, "{10s: 5}, {1m40s: 15}", tbs.debugState())
// When
delay, err := tbs.Consume(10)
require.NoError(t, err)
// Then
assert.Equal(t, 5*clock.Second, delay)
assert.Equal(t, "{10s: 5}, {1m40s: 15}", tbs.debugState())
}
// If the second bucket in the set has no enough tokens to allow desired
// consumption then an appropriate delay is returned.
func TestConsumeLimitedBy2st(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 10, 10))
require.NoError(t, rates.Add(100*clock.Second, 20, 20))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(10)
require.NoError(t, err)
clock.Advance(10 * clock.Second)
_, err = tbs.Consume(10)
require.NoError(t, err)
clock.Advance(5 * clock.Second)
_, err = tbs.Consume(0)
require.NoError(t, err)
assert.Equal(t, "{10s: 5}, {1m40s: 3}", tbs.debugState())
// When
delay, err := tbs.Consume(10)
require.NoError(t, err)
// Then
assert.Equal(t, 7*(5*clock.Second), delay)
assert.Equal(t, "{10s: 5}, {1m40s: 3}", tbs.debugState())
}
// An attempt to consume more tokens then the smallest bucket capacity results
// in error.
func TestConsumeMoreThenBurst(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 20))
require.NoError(t, rates.Add(10*clock.Second, 50, 100))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(5)
require.NoError(t, err)
assert.Equal(t, "{1s: 15}, {10s: 95}", tbs.debugState())
// When
_, err = tbs.Consume(21)
require.Error(t, err)
// Then
assert.Equal(t, "{1s: 15}, {10s: 95}", tbs.debugState())
}
// Update operation can add buckets.
func TestUpdateMore(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 20))
require.NoError(t, rates.Add(10*clock.Second, 20, 50))
require.NoError(t, rates.Add(20*clock.Second, 45, 90))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(5)
require.NoError(t, err)
assert.Equal(t, "{1s: 15}, {10s: 45}, {20s: 85}", tbs.debugState())
rates = NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 30, 40))
require.NoError(t, rates.Add(11*clock.Second, 30, 40))
require.NoError(t, rates.Add(12*clock.Second, 30, 40))
require.NoError(t, rates.Add(13*clock.Second, 30, 40))
// When
tbs.Update(rates)
// Then
assert.Equal(t, "{10s: 40}, {11s: 40}, {12s: 40}, {13s: 40}", tbs.debugState())
assert.Equal(t, 13*clock.Second, tbs.maxPeriod)
}
// Update operation can remove buckets.
func TestUpdateLess(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 20))
require.NoError(t, rates.Add(10*clock.Second, 20, 50))
require.NoError(t, rates.Add(20*clock.Second, 45, 90))
require.NoError(t, rates.Add(30*clock.Second, 50, 100))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(5)
require.NoError(t, err)
assert.Equal(t, "{1s: 15}, {10s: 45}, {20s: 85}, {30s: 95}", tbs.debugState())
rates = NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 25, 20))
require.NoError(t, rates.Add(20*clock.Second, 30, 21))
// When
tbs.Update(rates)
// Then
assert.Equal(t, "{10s: 20}, {20s: 21}", tbs.debugState())
assert.Equal(t, 20*clock.Second, tbs.maxPeriod)
}
// Update operation can remove buckets.
func TestUpdateAllDifferent(t *testing.T) {
// Given
rates := NewRateSet()
require.NoError(t, rates.Add(10*clock.Second, 20, 50))
require.NoError(t, rates.Add(30*clock.Second, 50, 100))
done := testutils.FreezeTime()
defer done()
tbs := NewTokenBucketSet(rates)
_, err := tbs.Consume(5)
require.NoError(t, err)
assert.Equal(t, "{10s: 45}, {30s: 95}", tbs.debugState())
rates = NewRateSet()
require.NoError(t, rates.Add(1*clock.Second, 10, 40))
require.NoError(t, rates.Add(60*clock.Second, 100, 150))
// When
tbs.Update(rates)
// Then
assert.Equal(t, "{1s: 40}, {1m0s: 150}", tbs.debugState())
assert.Equal(t, 60*clock.Second, tbs.maxPeriod)
}