forked from celery/celery
/
test_buckets.py
308 lines (243 loc) · 9.66 KB
/
test_buckets.py
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
from __future__ import generators
import sys
import time
import unittest2 as unittest
from itertools import chain, izip
from celery.registry import TaskRegistry
from celery.task.base import Task
from celery.utils import timeutils
from celery.utils import gen_unique_id
from celery.utils.functional import curry
from celery.worker import buckets
from celery.tests.utils import skip_if_environ
skip_if_disabled = curry(skip_if_environ("SKIP_RLIMITS"))
class MockJob(object):
def __init__(self, task_id, task_name, args, kwargs):
self.task_id = task_id
self.task_name = task_name
self.args = args
self.kwargs = kwargs
def __eq__(self, other):
if isinstance(other, self.__class__):
return bool(self.task_id == other.task_id \
and self.task_name == other.task_name \
and self.args == other.args \
and self.kwargs == other.kwargs)
else:
return self == other
def __repr__(self):
return "<MockJob: task:%s id:%s args:%s kwargs:%s" % (
self.task_name, self.task_id, self.args, self.kwargs)
class test_TokenBucketQueue(unittest.TestCase):
@skip_if_disabled
def empty_queue_yields_QueueEmpty(self):
x = buckets.TokenBucketQueue(fill_rate=10)
self.assertRaises(buckets.QueueEmpty, x.get)
@skip_if_disabled
def test_bucket__put_get(self):
x = buckets.TokenBucketQueue(fill_rate=10)
x.put("The quick brown fox")
self.assertEqual(x.get(), "The quick brown fox")
x.put_nowait("The lazy dog")
time.sleep(0.2)
self.assertEqual(x.get_nowait(), "The lazy dog")
@skip_if_disabled
def test_fill_rate(self):
x = buckets.TokenBucketQueue(fill_rate=10)
# 20 items should take at least one second to complete
time_start = time.time()
[x.put(str(i)) for i in xrange(20)]
for i in xrange(20):
sys.stderr.write("x")
x.wait()
self.assertGreater(time.time() - time_start, 1.5)
@skip_if_disabled
def test_can_consume(self):
x = buckets.TokenBucketQueue(fill_rate=1)
x.put("The quick brown fox")
self.assertEqual(x.get(), "The quick brown fox")
time.sleep(0.1)
# Not yet ready for another token
x.put("The lazy dog")
self.assertRaises(x.RateLimitExceeded, x.get)
@skip_if_disabled
def test_expected_time(self):
x = buckets.TokenBucketQueue(fill_rate=1)
x.put_nowait("The quick brown fox")
self.assertEqual(x.get_nowait(), "The quick brown fox")
self.assertTrue(x.expected_time())
@skip_if_disabled
def test_qsize(self):
x = buckets.TokenBucketQueue(fill_rate=1)
x.put("The quick brown fox")
self.assertEqual(x.qsize(), 1)
self.assertEqual(x.get_nowait(), "The quick brown fox")
class test_rate_limit_string(unittest.TestCase):
@skip_if_disabled
def test_conversion(self):
self.assertEqual(timeutils.rate(999), 999)
self.assertEqual(timeutils.rate("1456/s"), 1456)
self.assertEqual(timeutils.rate("100/m"),
100 / 60.0)
self.assertEqual(timeutils.rate("10/h"),
10 / 60.0 / 60.0)
for zero in (0, None, "0", "0/m", "0/h", "0/s"):
self.assertEqual(timeutils.rate(zero), 0)
class TaskA(Task):
rate_limit = 10
class TaskB(Task):
rate_limit = None
class TaskC(Task):
rate_limit = "1/s"
class TaskD(Task):
rate_limit = "1000/m"
class test_TaskBucket(unittest.TestCase):
def setUp(self):
self.registry = TaskRegistry()
self.task_classes = (TaskA, TaskB, TaskC)
for task_cls in self.task_classes:
self.registry.register(task_cls)
@skip_if_disabled
def test_get_nowait(self):
x = buckets.TaskBucket(task_registry=self.registry)
self.assertRaises(buckets.QueueEmpty, x.get_nowait)
@skip_if_disabled
def test_refresh(self):
reg = {}
x = buckets.TaskBucket(task_registry=reg)
reg["foo"] = "something"
x.refresh()
self.assertIn("foo", x.buckets)
self.assertTrue(x.get_bucket_for_type("foo"))
@skip_if_disabled
def test__get_queue_for_type(self):
x = buckets.TaskBucket(task_registry={})
x.buckets["foo"] = buckets.TokenBucketQueue(fill_rate=1)
self.assertIs(x._get_queue_for_type("foo"), x.buckets["foo"].queue)
x.buckets["bar"] = buckets.FastQueue()
self.assertIs(x._get_queue_for_type("bar"), x.buckets["bar"])
@skip_if_disabled
def test_update_bucket_for_type(self):
bucket = buckets.TaskBucket(task_registry=self.registry)
b = bucket._get_queue_for_type(TaskC.name)
self.assertIs(bucket.update_bucket_for_type(TaskC.name).queue, b)
self.assertIs(bucket.buckets[TaskC.name].queue, b)
@skip_if_disabled
def test_auto_add_on_missing_put(self):
reg = {}
b = buckets.TaskBucket(task_registry=reg)
reg["nonexisting.task"] = "foo"
b.put(MockJob(gen_unique_id(), "nonexisting.task", (), {}))
self.assertIn("nonexisting.task", b.buckets)
@skip_if_disabled
def test_auto_add_on_missing(self):
b = buckets.TaskBucket(task_registry=self.registry)
for task_cls in self.task_classes:
self.assertIn(task_cls.name, b.buckets.keys())
self.registry.register(TaskD)
self.assertTrue(b.get_bucket_for_type(TaskD.name))
self.assertIn(TaskD.name, b.buckets.keys())
self.registry.unregister(TaskD)
@skip_if_disabled
def test_has_rate_limits(self):
b = buckets.TaskBucket(task_registry=self.registry)
self.assertEqual(b.buckets[TaskA.name].fill_rate, 10)
self.assertIsInstance(b.buckets[TaskB.name], buckets.Queue)
self.assertEqual(b.buckets[TaskC.name].fill_rate, 1)
self.registry.register(TaskD)
b.init_with_registry()
try:
self.assertEqual(b.buckets[TaskD.name].fill_rate, 1000 / 60.0)
finally:
self.registry.unregister(TaskD)
@skip_if_disabled
def test_on_empty_buckets__get_raises_empty(self):
b = buckets.TaskBucket(task_registry=self.registry)
self.assertRaises(buckets.QueueEmpty, b.get)
self.assertEqual(b.qsize(), 0)
@skip_if_disabled
def test_put__get(self):
b = buckets.TaskBucket(task_registry=self.registry)
job = MockJob(gen_unique_id(), TaskA.name, ["theqbf"], {"foo": "bar"})
b.put(job)
self.assertEqual(b.get(), job)
@skip_if_disabled
def test_fill_rate(self):
b = buckets.TaskBucket(task_registry=self.registry)
cjob = lambda i: MockJob(gen_unique_id(), TaskA.name, [i], {})
jobs = [cjob(i) for i in xrange(20)]
[b.put(job) for job in jobs]
self.assertEqual(b.qsize(), 20)
# 20 items should take at least one second to complete
time_start = time.time()
for i, job in enumerate(jobs):
sys.stderr.write("i")
self.assertEqual(b.get(), job)
self.assertGreater(time.time() - time_start, 1.5)
@skip_if_disabled
def test__very_busy_queue_doesnt_block_others(self):
b = buckets.TaskBucket(task_registry=self.registry)
cjob = lambda i, t: MockJob(gen_unique_id(), t.name, [i], {})
ajobs = [cjob(i, TaskA) for i in xrange(10)]
bjobs = [cjob(i, TaskB) for i in xrange(20)]
jobs = list(chain(*izip(bjobs, ajobs)))
map(b.put, jobs)
got_ajobs = 0
for job in (b.get() for i in xrange(20)):
if job.task_name == TaskA.name:
got_ajobs += 1
self.assertGreater(got_ajobs, 2)
@skip_if_disabled
def test_thorough__multiple_types(self):
self.registry.register(TaskD)
try:
b = buckets.TaskBucket(task_registry=self.registry)
cjob = lambda i, t: MockJob(gen_unique_id(), t.name, [i], {})
ajobs = [cjob(i, TaskA) for i in xrange(10)]
bjobs = [cjob(i, TaskB) for i in xrange(10)]
cjobs = [cjob(i, TaskC) for i in xrange(10)]
djobs = [cjob(i, TaskD) for i in xrange(10)]
# Spread the jobs around.
jobs = list(chain(*izip(ajobs, bjobs, cjobs, djobs)))
[b.put(job) for job in jobs]
for i, job in enumerate(jobs):
sys.stderr.write("0")
self.assertTrue(b.get(), job)
self.assertEqual(i+1, len(jobs))
finally:
self.registry.unregister(TaskD)
@skip_if_disabled
def test_empty(self):
x = buckets.TaskBucket(task_registry=self.registry)
self.assertTrue(x.empty())
x.put(MockJob(gen_unique_id(), TaskC.name, [], {}))
self.assertFalse(x.empty())
x.clear()
self.assertTrue(x.empty())
@skip_if_disabled
def test_items(self):
x = buckets.TaskBucket(task_registry=self.registry)
x.buckets[TaskA.name].put(1)
x.buckets[TaskB.name].put(2)
x.buckets[TaskC.name].put(3)
self.assertItemsEqual(x.items, [1, 2, 3])
class test_FastQueue(unittest.TestCase):
def test_can_consume(self):
x = buckets.FastQueue()
self.assertTrue(x.can_consume())
def test_items(self):
x = buckets.FastQueue()
x.put(10)
x.put(20)
self.assertListEqual([10, 20], list(x.items))
def test_wait(self):
x = buckets.FastQueue()
x.put(10)
self.assertEqual(x.wait(), 10)
def test_clear(self):
x = buckets.FastQueue()
x.put(10)
x.put(20)
self.assertFalse(x.empty())
x.clear()
self.assertTrue(x.empty())