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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
|
import io
import pytest
import warnings
import socket
from case import MagicMock, Mock, patch
from kombu import Connection
from kombu.compression import compress
from kombu.exceptions import ResourceError, ChannelError
from kombu.transport import virtual
from kombu.utils.uuid import uuid
from kombu.five import PY3, monotonic
PRINT_FQDN = 'builtins.print' if PY3 else '__builtin__.print'
def client(**kwargs):
return Connection(transport='kombu.transport.virtual:Transport', **kwargs)
def memory_client():
return Connection(transport='memory')
def test_BrokerState():
s = virtual.BrokerState()
assert hasattr(s, 'exchanges')
t = virtual.BrokerState(exchanges=16)
assert t.exchanges == 16
class test_QoS:
def setup(self):
self.q = virtual.QoS(client().channel(), prefetch_count=10)
def teardown(self):
self.q._on_collect.cancel()
def test_constructor(self):
assert self.q.channel
assert self.q.prefetch_count
assert not self.q._delivered.restored
assert self.q._on_collect
def test_restore_visible__interface(self):
qos = virtual.QoS(client().channel())
qos.restore_visible()
def test_can_consume(self, stdouts):
stderr = io.StringIO()
_restored = []
class RestoreChannel(virtual.Channel):
do_restore = True
def _restore(self, message):
_restored.append(message)
assert self.q.can_consume()
for i in range(self.q.prefetch_count - 1):
self.q.append(i, uuid())
assert self.q.can_consume()
self.q.append(i + 1, uuid())
assert not self.q.can_consume()
tag1 = next(iter(self.q._delivered))
self.q.ack(tag1)
assert self.q.can_consume()
tag2 = uuid()
self.q.append(i + 2, tag2)
assert not self.q.can_consume()
self.q.reject(tag2)
assert self.q.can_consume()
self.q.channel = RestoreChannel(self.q.channel.connection)
tag3 = uuid()
self.q.append(i + 3, tag3)
self.q.reject(tag3, requeue=True)
self.q._flush()
assert self.q._delivered
assert not self.q._delivered.restored
self.q.restore_unacked_once(stderr=stderr)
assert _restored == [11, 9, 8, 7, 6, 5, 4, 3, 2, 1]
assert self.q._delivered.restored
assert not self.q._delivered
self.q.restore_unacked_once(stderr=stderr)
self.q._delivered.restored = False
self.q.restore_unacked_once(stderr=stderr)
assert stderr.getvalue()
assert not stdouts.stdout.getvalue()
self.q.restore_at_shutdown = False
self.q.restore_unacked_once()
def test_get(self):
self.q._delivered['foo'] = 1
assert self.q.get('foo') == 1
class test_Message:
def test_create(self):
c = client().channel()
data = c.prepare_message('the quick brown fox...')
tag = data['properties']['delivery_tag'] = uuid()
message = c.message_to_python(data)
assert isinstance(message, virtual.Message)
assert message is c.message_to_python(message)
if message.errors:
message._reraise_error()
assert message.body == b'the quick brown fox...'
assert message.delivery_tag, tag
def test_create_no_body(self):
virtual.Message(channel=Mock(), payload={
'body': None,
'properties': {'delivery_tag': 1},
})
def test_serializable(self):
c = client().channel()
body, content_type = compress('the quick brown fox...', 'gzip')
data = c.prepare_message(body, headers={'compression': content_type})
tag = data['properties']['delivery_tag'] = uuid()
message = c.message_to_python(data)
dict_ = message.serializable()
assert dict_['body'] == b'the quick brown fox...'
assert dict_['properties']['delivery_tag'] == tag
assert 'compression' not in dict_['headers']
class test_AbstractChannel:
def test_get(self):
with pytest.raises(NotImplementedError):
virtual.AbstractChannel()._get('queue')
def test_put(self):
with pytest.raises(NotImplementedError):
virtual.AbstractChannel()._put('queue', 'm')
def test_size(self):
assert virtual.AbstractChannel()._size('queue') == 0
def test_purge(self):
with pytest.raises(NotImplementedError):
virtual.AbstractChannel()._purge('queue')
def test_delete(self):
with pytest.raises(NotImplementedError):
virtual.AbstractChannel()._delete('queue')
def test_new_queue(self):
assert virtual.AbstractChannel()._new_queue('queue') is None
def test_has_queue(self):
assert virtual.AbstractChannel()._has_queue('queue')
def test_poll(self):
cycle = Mock(name='cycle')
assert virtual.AbstractChannel()._poll(cycle, Mock())
cycle.get.assert_called()
class test_Channel:
def setup(self):
self.channel = client().channel()
def teardown(self):
if self.channel._qos is not None:
self.channel._qos._on_collect.cancel()
def test_exceeds_channel_max(self):
c = client()
t = c.transport
avail = t._avail_channel_ids = Mock(name='_avail_channel_ids')
avail.pop.side_effect = IndexError()
with pytest.raises(ResourceError):
virtual.Channel(t)
def test_exchange_bind_interface(self):
with pytest.raises(NotImplementedError):
self.channel.exchange_bind('dest', 'src', 'key')
def test_exchange_unbind_interface(self):
with pytest.raises(NotImplementedError):
self.channel.exchange_unbind('dest', 'src', 'key')
def test_queue_unbind_interface(self):
self.channel.queue_unbind('dest', 'ex', 'key')
def test_management(self):
m = self.channel.connection.client.get_manager()
assert m
m.get_bindings()
m.close()
def test_exchange_declare(self):
c = self.channel
with pytest.raises(ChannelError):
c.exchange_declare('test_exchange_declare', 'direct',
durable=True, auto_delete=True, passive=True)
c.exchange_declare('test_exchange_declare', 'direct',
durable=True, auto_delete=True)
c.exchange_declare('test_exchange_declare', 'direct',
durable=True, auto_delete=True, passive=True)
assert 'test_exchange_declare' in c.state.exchanges
# can declare again with same values
c.exchange_declare('test_exchange_declare', 'direct',
durable=True, auto_delete=True)
assert 'test_exchange_declare' in c.state.exchanges
# using different values raises NotEquivalentError
with pytest.raises(virtual.NotEquivalentError):
c.exchange_declare('test_exchange_declare', 'direct',
durable=False, auto_delete=True)
def test_exchange_delete(self, ex='test_exchange_delete'):
class PurgeChannel(virtual.Channel):
purged = []
def _purge(self, queue):
self.purged.append(queue)
c = PurgeChannel(self.channel.connection)
c.exchange_declare(ex, 'direct', durable=True, auto_delete=True)
assert ex in c.state.exchanges
assert not c.state.has_binding(ex, ex, ex) # no bindings yet
c.exchange_delete(ex)
assert ex not in c.state.exchanges
c.exchange_declare(ex, 'direct', durable=True, auto_delete=True)
c.queue_declare(ex)
c.queue_bind(ex, ex, ex)
assert c.state.has_binding(ex, ex, ex)
c.exchange_delete(ex)
assert not c.state.has_binding(ex, ex, ex)
assert ex in c.purged
def test_queue_delete__if_empty(self, n='test_queue_delete__if_empty'):
class PurgeChannel(virtual.Channel):
purged = []
size = 30
def _purge(self, queue):
self.purged.append(queue)
def _size(self, queue):
return self.size
c = PurgeChannel(self.channel.connection)
c.exchange_declare(n)
c.queue_declare(n)
c.queue_bind(n, n, n)
# tests code path that returns if queue already bound.
c.queue_bind(n, n, n)
c.queue_delete(n, if_empty=True)
assert c.state.has_binding(n, n, n)
c.size = 0
c.queue_delete(n, if_empty=True)
assert not c.state.has_binding(n, n, n)
assert n in c.purged
def test_queue_purge(self, n='test_queue_purge'):
class PurgeChannel(virtual.Channel):
purged = []
def _purge(self, queue):
self.purged.append(queue)
c = PurgeChannel(self.channel.connection)
c.exchange_declare(n)
c.queue_declare(n)
c.queue_bind(n, n, n)
c.queue_purge(n)
assert n in c.purged
def test_basic_publish__anon_exchange(self):
c = memory_client().channel()
msg = MagicMock(name='msg')
c.encode_body = Mock(name='c.encode_body')
c.encode_body.return_value = (1, 2)
c._put = Mock(name='c._put')
c.basic_publish(msg, None, 'rkey', kw=1)
c._put.assert_called_with('rkey', msg, kw=1)
def test_basic_publish_unique_delivery_tags(self, n='test_uniq_tag'):
c1 = memory_client().channel()
c2 = memory_client().channel()
for c in (c1, c2):
c.exchange_declare(n)
c.queue_declare(n)
c.queue_bind(n, n, n)
m1 = c1.prepare_message('George Costanza')
m2 = c2.prepare_message('Elaine Marie Benes')
c1.basic_publish(m1, n, n)
c2.basic_publish(m2, n, n)
r1 = c1.message_to_python(c1.basic_get(n))
r2 = c2.message_to_python(c2.basic_get(n))
assert r1.delivery_tag != r2.delivery_tag
with pytest.raises(ValueError):
int(r1.delivery_tag)
with pytest.raises(ValueError):
int(r2.delivery_tag)
def test_basic_publish__get__consume__restore(self,
n='test_basic_publish'):
c = memory_client().channel()
c.exchange_declare(n)
c.queue_declare(n)
c.queue_bind(n, n, n)
c.queue_declare(n + '2')
c.queue_bind(n + '2', n, n)
messages = []
c.connection._deliver = Mock(name='_deliver')
def on_deliver(message, queue):
messages.append(message)
c.connection._deliver.side_effect = on_deliver
m = c.prepare_message('nthex quick brown fox...')
c.basic_publish(m, n, n)
r1 = c.message_to_python(c.basic_get(n))
assert r1
assert r1.body == b'nthex quick brown fox...'
assert c.basic_get(n) is None
consumer_tag = uuid()
c.basic_consume(n + '2', False,
consumer_tag=consumer_tag, callback=lambda *a: None)
assert n + '2' in c._active_queues
c.drain_events()
r2 = c.message_to_python(messages[-1])
assert r2.body == b'nthex quick brown fox...'
assert r2.delivery_info['exchange'] == n
assert r2.delivery_info['routing_key'] == n
with pytest.raises(virtual.Empty):
c.drain_events()
c.basic_cancel(consumer_tag)
c._restore(r2)
r3 = c.message_to_python(c.basic_get(n))
assert r3
assert r3.body == b'nthex quick brown fox...'
assert c.basic_get(n) is None
def test_basic_ack(self):
class MockQoS(virtual.QoS):
was_acked = False
def ack(self, delivery_tag):
self.was_acked = True
self.channel._qos = MockQoS(self.channel)
self.channel.basic_ack('foo')
assert self.channel._qos.was_acked
def test_basic_recover__requeue(self):
class MockQoS(virtual.QoS):
was_restored = False
def restore_unacked(self):
self.was_restored = True
self.channel._qos = MockQoS(self.channel)
self.channel.basic_recover(requeue=True)
assert self.channel._qos.was_restored
def test_restore_unacked_raises_BaseException(self):
q = self.channel.qos
q._flush = Mock()
q._delivered = {1: 1}
q.channel._restore = Mock()
q.channel._restore.side_effect = SystemExit
errors = q.restore_unacked()
assert isinstance(errors[0][0], SystemExit)
assert errors[0][1] == 1
assert not q._delivered
@patch('kombu.transport.virtual.base.emergency_dump_state')
@patch(PRINT_FQDN)
def test_restore_unacked_once_when_unrestored(self, print_,
emergency_dump_state):
q = self.channel.qos
q._flush = Mock()
class State(dict):
restored = False
q._delivered = State({1: 1})
ru = q.restore_unacked = Mock()
exc = None
try:
raise KeyError()
except KeyError as exc_:
exc = exc_
ru.return_value = [(exc, 1)]
self.channel.do_restore = True
q.restore_unacked_once()
print_.assert_called()
emergency_dump_state.assert_called()
def test_basic_recover(self):
with pytest.raises(NotImplementedError):
self.channel.basic_recover(requeue=False)
def test_basic_reject(self):
class MockQoS(virtual.QoS):
was_rejected = False
def reject(self, delivery_tag, requeue=False):
self.was_rejected = True
self.channel._qos = MockQoS(self.channel)
self.channel.basic_reject('foo')
assert self.channel._qos.was_rejected
def test_basic_qos(self):
self.channel.basic_qos(prefetch_count=128)
assert self.channel._qos.prefetch_count == 128
def test_lookup__undeliverable(self, n='test_lookup__undeliverable'):
warnings.resetwarnings()
with warnings.catch_warnings(record=True) as log:
assert self.channel._lookup(n, n, 'ae.undeliver') == [
'ae.undeliver',
]
assert log
assert 'could not be delivered' in log[0].message.args[0]
def test_context(self):
x = self.channel.__enter__()
assert x is self.channel
x.__exit__()
assert x.closed
def test_cycle_property(self):
assert self.channel.cycle
def test_flow(self):
with pytest.raises(NotImplementedError):
self.channel.flow(False)
def test_close_when_no_connection(self):
self.channel.connection = None
self.channel.close()
assert self.channel.closed
def test_drain_events_has_get_many(self):
c = self.channel
c._get_many = Mock()
c._poll = Mock()
c._consumers = [1]
c._qos = Mock()
c._qos.can_consume.return_value = True
c.drain_events(timeout=10.0)
c._get_many.assert_called_with(c._active_queues, timeout=10.0)
def test_get_exchanges(self):
self.channel.exchange_declare(exchange='unique_name')
assert self.channel.get_exchanges()
def test_basic_cancel_not_in_active_queues(self):
c = self.channel
c._consumers.add('x')
c._tag_to_queue['x'] = 'foo'
c._active_queues = Mock()
c._active_queues.remove.side_effect = ValueError()
c.basic_cancel('x')
c._active_queues.remove.assert_called_with('foo')
def test_basic_cancel_unknown_ctag(self):
assert self.channel.basic_cancel('unknown-tag') is None
def test_list_bindings(self):
c = self.channel
c.exchange_declare(exchange='unique_name')
c.queue_declare(queue='q')
c.queue_bind(queue='q', exchange='unique_name', routing_key='rk')
assert ('q', 'unique_name', 'rk') in list(c.list_bindings())
def test_after_reply_message_received(self):
c = self.channel
c.queue_delete = Mock()
c.after_reply_message_received('foo')
c.queue_delete.assert_called_with('foo')
def test_queue_delete_unknown_queue(self):
assert self.channel.queue_delete('xiwjqjwel') is None
def test_queue_declare_passive(self):
has_queue = self.channel._has_queue = Mock()
has_queue.return_value = False
with pytest.raises(ChannelError):
self.channel.queue_declare(queue='21wisdjwqe', passive=True)
def test_get_message_priority(self):
def _message(priority):
return self.channel.prepare_message(
'the message with priority', priority=priority,
)
assert self.channel._get_message_priority(_message(5)) == 5
assert self.channel._get_message_priority(
_message(self.channel.min_priority - 10)
) == self.channel.min_priority
assert self.channel._get_message_priority(
_message(self.channel.max_priority + 10),
) == self.channel.max_priority
assert self.channel._get_message_priority(
_message('foobar'),
) == self.channel.default_priority
assert self.channel._get_message_priority(
_message(2), reverse=True,
) == self.channel.max_priority - 2
class test_Transport:
def setup(self):
self.transport = client().transport
def test_custom_polling_interval(self):
x = client(transport_options={'polling_interval': 32.3})
assert x.transport.polling_interval == 32.3
def test_timeout_over_polling_interval(self):
x = client(transport_options=dict(polling_interval=60))
start = monotonic()
with pytest.raises(socket.timeout):
x.transport.drain_events(x, timeout=.5)
assert monotonic() - start < 60
def test_close_connection(self):
c1 = self.transport.create_channel(self.transport)
c2 = self.transport.create_channel(self.transport)
assert len(self.transport.channels) == 2
self.transport.close_connection(self.transport)
assert not self.transport.channels
del(c1) # so pyflakes doesn't complain
del(c2)
def test_drain_channel(self):
channel = self.transport.create_channel(self.transport)
with pytest.raises(virtual.Empty):
self.transport._drain_channel(channel, Mock())
def test__deliver__no_queue(self):
with pytest.raises(KeyError):
self.transport._deliver(Mock(name='msg'), queue=None)
def test__reject_inbound_message(self):
channel = Mock(name='channel')
self.transport.channels = [None, channel]
self.transport._reject_inbound_message({'foo': 'bar'})
channel.Message.assert_called_with({'foo': 'bar'}, channel=channel)
channel.qos.append.assert_called_with(
channel.Message(), channel.Message().delivery_tag,
)
channel.basic_reject.assert_called_with(
channel.Message().delivery_tag, requeue=True,
)
def test_on_message_ready(self):
channel = Mock(name='channel')
msg = Mock(name='msg')
callback = Mock(name='callback')
self.transport._callbacks = {'q1': callback}
self.transport.on_message_ready(channel, msg, queue='q1')
callback.assert_called_with(msg)
def test_on_message_ready__no_queue(self):
with pytest.raises(KeyError):
self.transport.on_message_ready(
Mock(name='channel'), Mock(name='msg'), queue=None)
def test_on_message_ready__no_callback(self):
self.transport._callbacks = {}
with pytest.raises(KeyError):
self.transport.on_message_ready(
Mock(name='channel'), Mock(name='msg'), queue='q1')
|