-
Notifications
You must be signed in to change notification settings - Fork 367
/
consumer.py
388 lines (298 loc) · 12.6 KB
/
consumer.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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
import datetime
import logging
import threading
import time
import unittest
from huey import queue_command, Invoker, BaseConfiguration
from huey.backends.dummy import DummyQueue, DummyDataStore
from huey.exceptions import QueueException
from huey.queue import QueueCommand, PeriodicQueueCommand
from huey.registry import registry
from huey.utils import local_to_utc
from huey.bin.huey_consumer import load_config, Consumer, IterableQueue
# store some global state
state = {}
# create a queue, result store and invoker for testing
test_queue = DummyQueue('test-queue')
test_result_store = DummyDataStore('test-queue')
test_task_store = DummyDataStore('test-tasks')
test_invoker = Invoker(test_queue, test_result_store, test_task_store)
# create a dummy config for passing to the consumer
class DummyConfiguration(BaseConfiguration):
QUEUE = test_queue
RESULT_STORE = test_result_store
TASK_STORE = test_result_store
THREADS = 2
@queue_command(test_invoker)
def modify_state(k, v):
state[k] = v
return v
@queue_command(test_invoker)
def blow_up():
raise Exception('blowed up')
@queue_command(test_invoker, retries=3)
def retry_command(k, always_fail=True):
if k not in state:
if not always_fail:
state[k] = 'fixed'
raise Exception('fappsk')
return state[k]
@queue_command(test_invoker, retries=3, retry_delay=10)
def retry_command_slow(k, always_fail=True):
if k not in state:
if not always_fail:
state[k] = 'fixed'
raise Exception('fappsk')
return state[k]
# create a log handler that will track messages generated by the consumer
class TestLogHandler(logging.Handler):
def __init__(self, *args, **kwargs):
self.messages = []
logging.Handler.__init__(self, *args, **kwargs)
def emit(self, record):
self.messages.append(record.getMessage())
class SkewConsumerTestCase(unittest.TestCase):
def setUp(self):
global state
state = {}
self.orig_sleep = time.sleep
time.sleep = lambda x: None
self.consumer = Consumer(test_invoker, DummyConfiguration)
self.handler = TestLogHandler()
self.consumer.logger.addHandler(self.handler)
def tearDown(self):
self.consumer.shutdown()
self.consumer.logger.removeHandler(self.handler)
time.sleep = self.orig_sleep
def test_consumer_loader(self):
config = load_config('huey.tests.config.Config')
self.assertTrue(isinstance(config.QUEUE, DummyQueue))
self.assertEqual(config.QUEUE.name, 'test-queue')
def spawn(self, func, *args, **kwargs):
t = threading.Thread(target=func, args=args, kwargs=kwargs)
t.start()
return t
def test_iterable_queue(self):
store = []
q = IterableQueue()
def do_queue(queue, result):
for message in queue:
result.append(message)
t = self.spawn(do_queue, q, store)
q.put(1)
q.put(2)
q.put(StopIteration)
t.join()
self.assertFalse(t.is_alive())
self.assertEqual(store, [1, 2])
def test_message_processing(self):
self.consumer.start_message_receiver()
self.consumer.start_worker_pool()
self.assertFalse('k' in state)
res = modify_state('k', 'v')
res.get(blocking=True)
self.assertTrue('k' in state)
self.assertEqual(res.get(), 'v')
def test_worker(self):
res = modify_state('x', 'y')
cmd = test_invoker.dequeue()
self.assertEqual(res.get(), None)
# we will be calling release() after finishing work
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertTrue('x' in state)
self.assertEqual(res.get(), 'y')
def test_worker_exception(self):
res = blow_up()
cmd = test_invoker.dequeue()
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages, [
'unhandled exception in worker thread',
])
def test_retries_and_logging(self):
# this will continually fail
res = retry_command('blampf')
cmd = test_invoker.dequeue()
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages, [
'unhandled exception in worker thread',
're-enqueueing task %s, 2 tries left' % cmd.task_id,
])
cmd = test_invoker.dequeue()
self.assertEqual(cmd.retries, 2)
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages[-2:], [
'unhandled exception in worker thread',
're-enqueueing task %s, 1 tries left' % cmd.task_id,
])
cmd = test_invoker.dequeue()
self.assertEqual(cmd.retries, 1)
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages[-2:], [
'unhandled exception in worker thread',
're-enqueueing task %s, 0 tries left' % cmd.task_id,
])
cmd = test_invoker.dequeue()
self.assertEqual(cmd.retries, 0)
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(len(self.handler.messages), 7)
self.assertEqual(self.handler.messages[-1:], [
'unhandled exception in worker thread',
])
self.assertEqual(test_invoker.dequeue(), None)
def test_retries_with_success(self):
# this will fail once, then succeed
res = retry_command('blampf', False)
self.assertFalse('blampf' in state)
cmd = test_invoker.dequeue()
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages, [
'unhandled exception in worker thread',
're-enqueueing task %s, 2 tries left' % cmd.task_id,
])
cmd = test_invoker.dequeue()
self.assertEqual(cmd.retries, 2)
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(state['blampf'], 'fixed')
self.assertEqual(test_invoker.dequeue(), None)
def test_pooling(self):
# simulate acquiring two worker threads
self.consumer._pool.acquire()
self.consumer._pool.acquire()
res = modify_state('x', 'y')
# dequeue a *single* message
pt = self.spawn(self.consumer.check_message)
# work on any messages generated by the processor thread
st = self.spawn(self.consumer.worker_pool)
# our result is not available since all workers are blocked
self.assertEqual(res.get(), None)
self.assertFalse(self.consumer._pool.acquire(blocking=False))
# our processor is waiting
self.assertTrue(pt.is_alive())
self.assertEqual(self.consumer._queue.qsize(), 0)
# release a worker
self.consumer._pool.release()
# we can get and block now, but will set a timeout of 3 to indicate that
# something is wrong
self.assertEqual(res.get(blocking=True, timeout=3), 'y')
# this is done
pt.join()
def test_scheduling(self):
dt = datetime.datetime(2011, 1, 1, 0, 0)
dt2 = datetime.datetime(2037, 1, 1, 0, 0)
r1 = modify_state.schedule(args=('k', 'v'), eta=dt, convert_utc=False)
r2 = modify_state.schedule(args=('k2', 'v2'), eta=dt2, convert_utc=False)
# dequeue a *single* message
pt = self.spawn(self.consumer.check_message)
# work on any messages generated by the processor thread
st = self.spawn(self.consumer.worker_pool)
pt.join()
self.assertTrue('k' in state)
self.assertEqual(self.consumer.schedule._schedule, {})
# dequeue a *single* message
pt = self.spawn(self.consumer.check_message)
pt.join()
# it got stored in the schedule instead of executing
self.assertFalse('k2' in state)
self.assertTrue(r2.task_id in self.consumer.schedule._schedule)
# run through an iteration of the scheduler
self.consumer.check_schedule(dt)
# our command was not enqueued
self.assertEqual(len(self.consumer.invoker.queue), 0)
# try running the scheduler with the time the command should run
self.consumer.check_schedule(dt2)
# it was enqueued
self.assertEqual(len(self.consumer.invoker.queue), 1)
self.assertEqual(self.consumer.schedule._schedule, {})
# dequeue and inspect -- it won't be executed because the scheduler will
# see that it is scheduled to run in the future and plop it back into the
# schedule
command = self.consumer.invoker.dequeue()
self.assertEqual(command.task_id, r2.task_id)
self.assertEqual(command.execute_time, dt2)
def test_retry_scheduling(self):
# this will continually fail
res = retry_command_slow('blampf')
self.assertEqual(self.consumer.schedule._schedule, {})
cur_time = datetime.datetime.utcnow()
cmd = test_invoker.dequeue()
self.consumer._pool.acquire()
self.consumer.worker(cmd)
self.assertEqual(self.handler.messages, [
'unhandled exception in worker thread',
're-enqueueing task %s, 2 tries left' % cmd.task_id,
])
self.assertEqual(self.consumer.schedule._schedule, {
cmd.task_id: cmd,
})
cmd_from_sched = self.consumer.schedule._schedule[cmd.task_id]
self.assertEqual(cmd_from_sched.retries, 2)
exec_time = cmd.execute_time
self.assertEqual((exec_time - cur_time).seconds, 10)
def test_schedule_local_utc(self):
dt = datetime.datetime(2011, 1, 1, 0, 0)
dt2 = datetime.datetime(2037, 1, 1, 0, 0)
r1 = modify_state.schedule(args=('k', 'v'), eta=dt)
r2 = modify_state.schedule(args=('k2', 'v2'), eta=dt2)
# dequeue a *single* message
pt = self.spawn(self.consumer.check_message)
# work on any messages generated by the processor thread
st = self.spawn(self.consumer.worker_pool)
pt.join()
self.assertTrue('k' in state)
self.assertEqual(self.consumer.schedule._schedule, {})
# dequeue a *single* message
pt = self.spawn(self.consumer.check_message)
pt.join()
# it got stored in the schedule instead of executing
self.assertFalse('k2' in state)
self.assertTrue(r2.task_id in self.consumer.schedule._schedule)
# run through an iteration of the scheduler
self.consumer.check_schedule(dt)
# our command was not enqueued
self.assertEqual(len(self.consumer.invoker.queue), 0)
# try running the scheduler with the time the command should run
self.consumer.check_schedule(local_to_utc(dt2))
# it was enqueued
self.assertEqual(len(self.consumer.invoker.queue), 1)
self.assertEqual(self.consumer.schedule._schedule, {})
# dequeue and inspect -- it won't be executed because the scheduler will
# see that it is scheduled to run in the future and plop it back into the
# schedule
command = self.consumer.invoker.dequeue()
self.assertEqual(command.task_id, r2.task_id)
self.assertEqual(command.execute_time, local_to_utc(dt2))
def test_schedule_persistence(self):
dt = datetime.datetime(2037, 1, 1, 0, 0)
dt2 = datetime.datetime(2037, 1, 1, 0, 1)
r = modify_state.schedule(args=('k', 'v'), eta=dt, convert_utc=False)
r2 = modify_state.schedule(args=('k2', 'v2'), eta=dt2, convert_utc=False)
# two messages in the queue
self.assertEqual(len(self.consumer.invoker.queue), 2)
# pull 'em down
self.consumer.check_message()
self.consumer.check_message()
self.consumer.save_schedule()
self.consumer.schedule._schedule = {}
self.consumer.load_schedule()
self.assertTrue(r.task_id in self.consumer.schedule._schedule)
self.assertTrue(r2.task_id in self.consumer.schedule._schedule)
cmd1 = self.consumer.schedule._schedule[r.task_id]
cmd2 = self.consumer.schedule._schedule[r2.task_id]
self.assertEqual(cmd1.execute_time, dt)
self.assertEqual(cmd2.execute_time, dt2)
# check w/conversion
r3 = modify_state.schedule(args=('k3', 'v3'), eta=dt)
self.consumer.check_message()
self.consumer.save_schedule()
self.consumer.schedule._schedule = {}
self.consumer.load_schedule()
cmd3 = self.consumer.schedule._schedule[r3.task_id]
self.assertEqual(cmd3.execute_time, local_to_utc(dt))