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
|
import socket
from unittest.mock import Mock, call
import pytest
from celery.events import Event
from celery.events.receiver import CLIENT_CLOCK_SKEW
class MockProducer:
raise_on_publish = False
def __init__(self, *args, **kwargs):
self.sent = []
def publish(self, msg, *args, **kwargs):
if self.raise_on_publish:
raise KeyError()
self.sent.append(msg)
def close(self):
pass
def has_event(self, kind):
for event in self.sent:
if event['type'] == kind:
return event
return False
def test_Event():
event = Event('world war II')
assert event['type'] == 'world war II'
assert event['timestamp']
class test_EventDispatcher:
def test_redis_uses_fanout_exchange(self):
self.app.connection = Mock()
conn = self.app.connection.return_value = Mock()
conn.transport.driver_type = 'redis'
dispatcher = self.app.events.Dispatcher(conn, enabled=False)
assert dispatcher.exchange.type == 'fanout'
def test_others_use_topic_exchange(self):
self.app.connection = Mock()
conn = self.app.connection.return_value = Mock()
conn.transport.driver_type = 'amqp'
dispatcher = self.app.events.Dispatcher(conn, enabled=False)
assert dispatcher.exchange.type == 'topic'
def test_takes_channel_connection(self):
x = self.app.events.Dispatcher(channel=Mock())
assert x.connection is x.channel.connection.client
def test_sql_transports_disabled(self):
conn = Mock()
conn.transport.driver_type = 'sql'
x = self.app.events.Dispatcher(connection=conn)
assert not x.enabled
def test_send(self):
producer = MockProducer()
producer.connection = self.app.connection_for_write()
connection = Mock()
connection.transport.driver_type = 'amqp'
eventer = self.app.events.Dispatcher(connection, enabled=False,
buffer_while_offline=False)
eventer.producer = producer
eventer.enabled = True
eventer.send('World War II', ended=True)
assert producer.has_event('World War II')
eventer.enabled = False
eventer.send('World War III')
assert not producer.has_event('World War III')
evs = ('Event 1', 'Event 2', 'Event 3')
eventer.enabled = True
eventer.producer.raise_on_publish = True
eventer.buffer_while_offline = False
with pytest.raises(KeyError):
eventer.send('Event X')
eventer.buffer_while_offline = True
for ev in evs:
eventer.send(ev)
eventer.producer.raise_on_publish = False
eventer.flush()
for ev in evs:
assert producer.has_event(ev)
eventer.flush()
def test_send_buffer_group(self):
buf_received = [None]
producer = MockProducer()
producer.connection = self.app.connection_for_write()
connection = Mock()
connection.transport.driver_type = 'amqp'
eventer = self.app.events.Dispatcher(
connection, enabled=False,
buffer_group={'task'}, buffer_limit=2,
)
eventer.producer = producer
eventer.enabled = True
eventer._publish = Mock(name='_publish')
def on_eventer_publish(events, *args, **kwargs):
buf_received[0] = list(events)
eventer._publish.side_effect = on_eventer_publish
assert not eventer._group_buffer['task']
eventer.on_send_buffered = Mock(name='on_send_buffered')
eventer.send('task-received', uuid=1)
prev_buffer = eventer._group_buffer['task']
assert eventer._group_buffer['task']
eventer.on_send_buffered.assert_called_with()
eventer.send('task-received', uuid=1)
assert not eventer._group_buffer['task']
eventer._publish.assert_has_calls([
call([], eventer.producer, 'task.multi'),
])
# clear in place
assert eventer._group_buffer['task'] is prev_buffer
assert len(buf_received[0]) == 2
eventer.on_send_buffered = None
eventer.send('task-received', uuid=1)
def test_flush_no_groups_no_errors(self):
eventer = self.app.events.Dispatcher(Mock())
eventer.flush(errors=False, groups=False)
def test_enter_exit(self):
with self.app.connection_for_write() as conn:
d = self.app.events.Dispatcher(conn)
d.close = Mock()
with d as _d:
assert _d
d.close.assert_called_with()
def test_enable_disable_callbacks(self):
on_enable = Mock()
on_disable = Mock()
with self.app.connection_for_write() as conn:
with self.app.events.Dispatcher(conn, enabled=False) as d:
d.on_enabled.add(on_enable)
d.on_disabled.add(on_disable)
d.enable()
on_enable.assert_called_with()
d.disable()
on_disable.assert_called_with()
def test_enabled_disable(self):
connection = self.app.connection_for_write()
channel = connection.channel()
try:
dispatcher = self.app.events.Dispatcher(connection,
enabled=True)
dispatcher2 = self.app.events.Dispatcher(connection,
enabled=True,
channel=channel)
assert dispatcher.enabled
assert dispatcher.producer.channel
assert (dispatcher.producer.serializer ==
self.app.conf.event_serializer)
created_channel = dispatcher.producer.channel
dispatcher.disable()
dispatcher.disable() # Disable with no active producer
dispatcher2.disable()
assert not dispatcher.enabled
assert dispatcher.producer is None
# does not close manually provided channel
assert not dispatcher2.channel.closed
dispatcher.enable()
assert dispatcher.enabled
assert dispatcher.producer
# XXX test compat attribute
assert dispatcher.publisher is dispatcher.producer
prev, dispatcher.publisher = dispatcher.producer, 42
try:
assert dispatcher.producer == 42
finally:
dispatcher.producer = prev
finally:
channel.close()
connection.close()
assert created_channel.closed
class test_EventReceiver:
def test_process(self):
message = {'type': 'world-war'}
got_event = [False]
def my_handler(event):
got_event[0] = True
connection = Mock()
connection.transport_cls = 'memory'
r = self.app.events.Receiver(
connection,
handlers={'world-war': my_handler},
node_id='celery.tests',
)
r._receive(message, object())
assert got_event[0]
def test_accept_argument(self):
r = self.app.events.Receiver(Mock(), accept={'app/foo'})
assert r.accept == {'app/foo'}
def test_event_queue_prefix__default(self):
r = self.app.events.Receiver(Mock())
assert r.queue.name.startswith('celeryev.')
def test_event_queue_prefix__setting(self):
self.app.conf.event_queue_prefix = 'eventq'
r = self.app.events.Receiver(Mock())
assert r.queue.name.startswith('eventq.')
def test_event_queue_prefix__argument(self):
r = self.app.events.Receiver(Mock(), queue_prefix='fooq')
assert r.queue.name.startswith('fooq.')
def test_event_exchange__default(self):
r = self.app.events.Receiver(Mock())
assert r.exchange.name == 'celeryev'
def test_event_exchange__setting(self):
self.app.conf.event_exchange = 'exchange_ev'
r = self.app.events.Receiver(Mock())
assert r.exchange.name == 'exchange_ev'
def test_catch_all_event(self):
message = {'type': 'world-war'}
got_event = [False]
def my_handler(event):
got_event[0] = True
connection = Mock()
connection.transport_cls = 'memory'
r = self.app.events.Receiver(connection, node_id='celery.tests')
r.handlers['*'] = my_handler
r._receive(message, object())
assert got_event[0]
def test_itercapture(self):
connection = self.app.connection_for_write()
try:
r = self.app.events.Receiver(connection, node_id='celery.tests')
it = r.itercapture(timeout=0.0001, wakeup=False)
with pytest.raises(socket.timeout):
next(it)
with pytest.raises(socket.timeout):
r.capture(timeout=0.00001)
finally:
connection.close()
def test_event_from_message_localize_disabled(self):
r = self.app.events.Receiver(Mock(), node_id='celery.tests')
r.adjust_clock = Mock()
ts_adjust = Mock()
r.event_from_message(
{'type': 'worker-online', 'clock': 313},
localize=False,
adjust_timestamp=ts_adjust,
)
ts_adjust.assert_not_called()
r.adjust_clock.assert_called_with(313)
def test_event_from_message_clock_from_client(self):
r = self.app.events.Receiver(Mock(), node_id='celery.tests')
r.clock.value = 302
r.adjust_clock = Mock()
body = {'type': 'task-sent'}
r.event_from_message(
body, localize=False, adjust_timestamp=Mock(),
)
assert body['clock'] == r.clock.value + CLIENT_CLOCK_SKEW
def test_receive_multi(self):
r = self.app.events.Receiver(Mock(name='connection'))
r.process = Mock(name='process')
efm = r.event_from_message = Mock(name='event_from_message')
def on_efm(*args):
return args
efm.side_effect = on_efm
r._receive([1, 2, 3], Mock())
r.process.assert_has_calls([call(1), call(2), call(3)])
def test_itercapture_limit(self):
connection = self.app.connection_for_write()
channel = connection.channel()
try:
events_received = [0]
def handler(event):
events_received[0] += 1
producer = self.app.events.Dispatcher(
connection, enabled=True, channel=channel,
)
r = self.app.events.Receiver(
connection,
handlers={'*': handler},
node_id='celery.tests',
)
evs = ['ev1', 'ev2', 'ev3', 'ev4', 'ev5']
for ev in evs:
producer.send(ev)
it = r.itercapture(limit=4, wakeup=True)
next(it) # skip consumer (see itercapture)
list(it)
assert events_received[0] == 4
finally:
channel.close()
connection.close()
def test_State(app):
state = app.events.State()
assert dict(state.workers) == {}
def test_default_dispatcher(app):
with app.events.default_dispatcher() as d:
assert d
assert d.connection
class DummyConn:
class transport:
driver_type = 'amqp'
def test_get_exchange_default_type():
from celery.events import event
conn = DummyConn()
ex = event.get_exchange(conn)
assert ex.type == 'topic'
assert ex.name == event.EVENT_EXCHANGE_NAME
def test_get_exchange_redis_type():
from celery.events import event
class RedisConn:
class transport:
driver_type = 'redis'
conn = RedisConn()
ex = event.get_exchange(conn)
assert ex.type == 'fanout'
assert ex.name == event.EVENT_EXCHANGE_NAME
def test_get_exchange_custom_name():
from celery.events import event
conn = DummyConn()
ex = event.get_exchange(conn, name='custom')
assert ex.name == 'custom'
def test_group_from():
from celery.events import event
print("event.py loaded from:", event.__file__)
assert event.group_from('task-sent') == 'task'
assert event.group_from('custom-my-event') == 'custom'
assert event.group_from('foo') == 'foo'
|