/
test_redis.py
1025 lines (853 loc) · 37.6 KB
/
test_redis.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
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import json
import random
import ssl
from contextlib import contextmanager
from datetime import timedelta
from pickle import dumps, loads
from unittest.mock import ANY, Mock, call, patch
import pytest
from case import ContextMock, mock
from celery import signature, states, uuid
from celery.canvas import Signature
from celery.exceptions import (ChordError, ImproperlyConfigured)
from celery.utils.collections import AttributeDict
def raise_on_second_call(mock, exc, *retval):
def on_first_call(*args, **kwargs):
mock.side_effect = exc
return mock.return_value
mock.side_effect = on_first_call
if retval:
mock.return_value, = retval
class ConnectionError(Exception):
pass
class Connection:
connected = True
def disconnect(self):
self.connected = False
class Pipeline:
def __init__(self, client):
self.client = client
self.steps = []
def __getattr__(self, attr):
def add_step(*args, **kwargs):
self.steps.append((getattr(self.client, attr), args, kwargs))
return self
return add_step
def __enter__(self):
return self
def __exit__(self, type, value, traceback):
pass
def execute(self):
return [step(*a, **kw) for step, a, kw in self.steps]
class PubSub(mock.MockCallbacks):
def __init__(self, ignore_subscribe_messages=False):
self._subscribed_to = set()
def close(self):
self._subscribed_to = set()
def subscribe(self, *args):
self._subscribed_to.update(args)
def unsubscribe(self, *args):
self._subscribed_to.difference_update(args)
def get_message(self, timeout=None):
pass
class Redis(mock.MockCallbacks):
Connection = Connection
Pipeline = Pipeline
pubsub = PubSub
def __init__(self, host=None, port=None, db=None, password=None, **kw):
self.host = host
self.port = port
self.db = db
self.password = password
self.keyspace = {}
self.expiry = {}
self.connection = self.Connection()
def get(self, key):
return self.keyspace.get(key)
def mget(self, keys):
return [self.get(key) for key in keys]
def setex(self, key, expires, value):
self.set(key, value)
self.expire(key, expires)
def set(self, key, value):
self.keyspace[key] = value
def expire(self, key, expires):
self.expiry[key] = expires
return expires
def delete(self, key):
return bool(self.keyspace.pop(key, None))
def pipeline(self):
return self.Pipeline(self)
def _get_unsorted_list(self, key):
# We simply store the values in append (rpush) order
return self.keyspace.setdefault(key, list())
def rpush(self, key, value):
self._get_unsorted_list(key).append(value)
def lrange(self, key, start, stop):
return self._get_unsorted_list(key)[start:stop]
def llen(self, key):
return len(self._get_unsorted_list(key))
def _get_sorted_set(self, key):
# We store 2-tuples of (score, value) and sort after each append (zadd)
return self.keyspace.setdefault(key, list())
def zadd(self, key, mapping):
# Store elements as 2-tuples with the score first so we can sort it
# once the new items have been inserted
fake_sorted_set = self._get_sorted_set(key)
fake_sorted_set.extend(
(score, value) for value, score in mapping.items()
)
fake_sorted_set.sort()
def zrange(self, key, start, stop):
# `stop` is inclusive in Redis so we use `stop + 1` unless that would
# cause us to move from negative (right-most) indicies to positive
stop = stop + 1 if stop != -1 else None
return [e[1] for e in self._get_sorted_set(key)[start:stop]]
def zrangebyscore(self, key, min_, max_):
return [
e[1] for e in self._get_sorted_set(key)
if (min_ == "-inf" or e[0] >= min_) and
(max_ == "+inf" or e[1] <= max_)
]
def zcount(self, key, min_, max_):
return len(self.zrangebyscore(key, min_, max_))
class Sentinel(mock.MockCallbacks):
def __init__(self, sentinels, min_other_sentinels=0, sentinel_kwargs=None,
**connection_kwargs):
self.sentinel_kwargs = sentinel_kwargs
self.sentinels = [Redis(hostname, port, **self.sentinel_kwargs)
for hostname, port in sentinels]
self.min_other_sentinels = min_other_sentinels
self.connection_kwargs = connection_kwargs
def master_for(self, service_name, redis_class):
return random.choice(self.sentinels)
class redis:
StrictRedis = Redis
class ConnectionPool:
def __init__(self, **kwargs):
pass
class UnixDomainSocketConnection:
def __init__(self, **kwargs):
pass
class sentinel:
Sentinel = Sentinel
class test_RedisResultConsumer:
def get_backend(self):
from celery.backends.redis import RedisBackend
class _RedisBackend(RedisBackend):
redis = redis
return _RedisBackend(app=self.app)
def get_consumer(self):
consumer = self.get_backend().result_consumer
consumer._connection_errors = (ConnectionError,)
return consumer
@patch('celery.backends.asynchronous.BaseResultConsumer.on_after_fork')
def test_on_after_fork(self, parent_method):
consumer = self.get_consumer()
consumer.start('none')
consumer.on_after_fork()
parent_method.assert_called_once()
consumer.backend.client.connection_pool.reset.assert_called_once()
consumer._pubsub.close.assert_called_once()
# PubSub instance not initialized - exception would be raised
# when calling .close()
consumer._pubsub = None
parent_method.reset_mock()
consumer.backend.client.connection_pool.reset.reset_mock()
consumer.on_after_fork()
parent_method.assert_called_once()
consumer.backend.client.connection_pool.reset.assert_called_once()
# Continues on KeyError
consumer._pubsub = Mock()
consumer._pubsub.close = Mock(side_effect=KeyError)
parent_method.reset_mock()
consumer.backend.client.connection_pool.reset.reset_mock()
consumer.on_after_fork()
parent_method.assert_called_once()
@patch('celery.backends.redis.ResultConsumer.cancel_for')
@patch('celery.backends.asynchronous.BaseResultConsumer.on_state_change')
def test_on_state_change(self, parent_method, cancel_for):
consumer = self.get_consumer()
meta = {'task_id': 'testing', 'status': states.SUCCESS}
message = 'hello'
consumer.on_state_change(meta, message)
parent_method.assert_called_once_with(meta, message)
cancel_for.assert_called_once_with(meta['task_id'])
# Does not call cancel_for for other states
meta = {'task_id': 'testing2', 'status': states.PENDING}
parent_method.reset_mock()
cancel_for.reset_mock()
consumer.on_state_change(meta, message)
parent_method.assert_called_once_with(meta, message)
cancel_for.assert_not_called()
def test_drain_events_before_start(self):
consumer = self.get_consumer()
# drain_events shouldn't crash when called before start
consumer.drain_events(0.001)
def test_consume_from_connection_error(self):
consumer = self.get_consumer()
consumer.start('initial')
consumer._pubsub.subscribe.side_effect = (ConnectionError(), None)
consumer.consume_from('some-task')
assert consumer._pubsub._subscribed_to == {b'celery-task-meta-initial', b'celery-task-meta-some-task'}
def test_cancel_for_connection_error(self):
consumer = self.get_consumer()
consumer.start('initial')
consumer._pubsub.unsubscribe.side_effect = ConnectionError()
consumer.consume_from('some-task')
consumer.cancel_for('some-task')
assert consumer._pubsub._subscribed_to == {b'celery-task-meta-initial'}
@patch('celery.backends.redis.ResultConsumer.cancel_for')
@patch('celery.backends.asynchronous.BaseResultConsumer.on_state_change')
def test_drain_events_connection_error(self, parent_on_state_change, cancel_for):
meta = {'task_id': 'initial', 'status': states.SUCCESS}
consumer = self.get_consumer()
consumer.start('initial')
consumer.backend._set_with_state(b'celery-task-meta-initial', json.dumps(meta), states.SUCCESS)
consumer._pubsub.get_message.side_effect = ConnectionError()
consumer.drain_events()
parent_on_state_change.assert_called_with(meta, None)
assert consumer._pubsub._subscribed_to == {b'celery-task-meta-initial'}
class test_RedisBackend:
def get_backend(self):
from celery.backends.redis import RedisBackend
class _RedisBackend(RedisBackend):
redis = redis
return _RedisBackend
def get_E_LOST(self):
from celery.backends.redis import E_LOST
return E_LOST
def setup(self):
self.Backend = self.get_backend()
self.E_LOST = self.get_E_LOST()
self.b = self.Backend(app=self.app)
@pytest.mark.usefixtures('depends_on_current_app')
def test_reduce(self):
pytest.importorskip('redis')
from celery.backends.redis import RedisBackend
x = RedisBackend(app=self.app)
assert loads(dumps(x))
def test_no_redis(self):
self.Backend.redis = None
with pytest.raises(ImproperlyConfigured):
self.Backend(app=self.app)
def test_url(self):
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'redis://:bosco@vandelay.com:123//1', app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['socket_timeout'] == 30.0
assert x.connparams['socket_connect_timeout'] == 100.0
def test_timeouts_in_url_coerced(self):
pytest.importorskip('redis')
x = self.Backend(
('redis://:bosco@vandelay.com:123//1?'
'socket_timeout=30&socket_connect_timeout=100'),
app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['socket_timeout'] == 30
assert x.connparams['socket_connect_timeout'] == 100
def test_socket_url(self):
pytest.importorskip('redis')
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'socket:///tmp/redis.sock?virtual_host=/3', app=self.app,
)
assert x.connparams
assert x.connparams['path'] == '/tmp/redis.sock'
assert (x.connparams['connection_class'] is
redis.UnixDomainSocketConnection)
assert 'host' not in x.connparams
assert 'port' not in x.connparams
assert x.connparams['socket_timeout'] == 30.0
assert 'socket_connect_timeout' not in x.connparams
assert 'socket_keepalive' not in x.connparams
assert x.connparams['db'] == 3
def test_backend_ssl(self):
pytest.importorskip('redis')
self.app.conf.redis_backend_use_ssl = {
'ssl_cert_reqs': ssl.CERT_REQUIRED,
'ssl_ca_certs': '/path/to/ca.crt',
'ssl_certfile': '/path/to/client.crt',
'ssl_keyfile': '/path/to/client.key',
}
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'rediss://:bosco@vandelay.com:123//1', app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['socket_timeout'] == 30.0
assert x.connparams['socket_connect_timeout'] == 100.0
assert x.connparams['ssl_cert_reqs'] == ssl.CERT_REQUIRED
assert x.connparams['ssl_ca_certs'] == '/path/to/ca.crt'
assert x.connparams['ssl_certfile'] == '/path/to/client.crt'
assert x.connparams['ssl_keyfile'] == '/path/to/client.key'
from redis.connection import SSLConnection
assert x.connparams['connection_class'] is SSLConnection
@pytest.mark.parametrize('cert_str', [
"required",
"CERT_REQUIRED",
])
def test_backend_ssl_certreq_str(self, cert_str):
pytest.importorskip('redis')
self.app.conf.redis_backend_use_ssl = {
'ssl_cert_reqs': cert_str,
'ssl_ca_certs': '/path/to/ca.crt',
'ssl_certfile': '/path/to/client.crt',
'ssl_keyfile': '/path/to/client.key',
}
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'rediss://:bosco@vandelay.com:123//1', app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['socket_timeout'] == 30.0
assert x.connparams['socket_connect_timeout'] == 100.0
assert x.connparams['ssl_cert_reqs'] == ssl.CERT_REQUIRED
assert x.connparams['ssl_ca_certs'] == '/path/to/ca.crt'
assert x.connparams['ssl_certfile'] == '/path/to/client.crt'
assert x.connparams['ssl_keyfile'] == '/path/to/client.key'
from redis.connection import SSLConnection
assert x.connparams['connection_class'] is SSLConnection
@pytest.mark.parametrize('cert_str', [
"required",
"CERT_REQUIRED",
])
def test_backend_ssl_url(self, cert_str):
pytest.importorskip('redis')
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'rediss://:bosco@vandelay.com:123//1?ssl_cert_reqs=%s' % cert_str,
app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['socket_timeout'] == 30.0
assert x.connparams['socket_connect_timeout'] == 100.0
assert x.connparams['ssl_cert_reqs'] == ssl.CERT_REQUIRED
from redis.connection import SSLConnection
assert x.connparams['connection_class'] is SSLConnection
@pytest.mark.parametrize('cert_str', [
"none",
"CERT_NONE",
])
def test_backend_ssl_url_options(self, cert_str):
pytest.importorskip('redis')
x = self.Backend(
(
'rediss://:bosco@vandelay.com:123//1'
'?ssl_cert_reqs={cert_str}'
'&ssl_ca_certs=%2Fvar%2Fssl%2Fmyca.pem'
'&ssl_certfile=%2Fvar%2Fssl%2Fredis-server-cert.pem'
'&ssl_keyfile=%2Fvar%2Fssl%2Fprivate%2Fworker-key.pem'
).format(cert_str=cert_str),
app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['password'] == 'bosco'
assert x.connparams['ssl_cert_reqs'] == ssl.CERT_NONE
assert x.connparams['ssl_ca_certs'] == '/var/ssl/myca.pem'
assert x.connparams['ssl_certfile'] == '/var/ssl/redis-server-cert.pem'
assert x.connparams['ssl_keyfile'] == '/var/ssl/private/worker-key.pem'
@pytest.mark.parametrize('cert_str', [
"optional",
"CERT_OPTIONAL",
])
def test_backend_ssl_url_cert_none(self, cert_str):
pytest.importorskip('redis')
x = self.Backend(
'rediss://:bosco@vandelay.com:123//1?ssl_cert_reqs=%s' % cert_str,
app=self.app,
)
assert x.connparams
assert x.connparams['host'] == 'vandelay.com'
assert x.connparams['db'] == 1
assert x.connparams['port'] == 123
assert x.connparams['ssl_cert_reqs'] == ssl.CERT_OPTIONAL
from redis.connection import SSLConnection
assert x.connparams['connection_class'] is SSLConnection
@pytest.mark.parametrize("uri", [
'rediss://:bosco@vandelay.com:123//1?ssl_cert_reqs=CERT_KITTY_CATS',
'rediss://:bosco@vandelay.com:123//1'
])
def test_backend_ssl_url_invalid(self, uri):
pytest.importorskip('redis')
with pytest.raises(ValueError):
self.Backend(
uri,
app=self.app,
)
def test_conf_raises_KeyError(self):
self.app.conf = AttributeDict({
'result_serializer': 'json',
'result_cache_max': 1,
'result_expires': None,
'accept_content': ['json'],
'result_accept_content': ['json'],
})
self.Backend(app=self.app)
@patch('celery.backends.redis.logger')
def test_on_connection_error(self, logger):
intervals = iter([10, 20, 30])
exc = KeyError()
assert self.b.on_connection_error(None, exc, intervals, 1) == 10
logger.error.assert_called_with(
self.E_LOST, 1, 'Inf', 'in 10.00 seconds')
assert self.b.on_connection_error(10, exc, intervals, 2) == 20
logger.error.assert_called_with(self.E_LOST, 2, 10, 'in 20.00 seconds')
assert self.b.on_connection_error(10, exc, intervals, 3) == 30
logger.error.assert_called_with(self.E_LOST, 3, 10, 'in 30.00 seconds')
@patch('celery.backends.redis.retry_over_time')
def test_retry_policy_conf(self, retry_over_time):
self.app.conf.result_backend_transport_options = dict(
retry_policy=dict(
max_retries=2,
interval_start=0,
interval_step=0.01,
),
)
b = self.Backend(app=self.app)
# We don't want to re-test retry_over_time, just check we called it
# with the expected args
fn = lambda: 1
b.ensure(fn, (),)
retry_over_time.assert_called_with(
fn, b.connection_errors, (), {}, ANY,
max_retries=2, interval_start=0, interval_step=0.01, interval_max=1
)
def test_incr(self):
self.b.client = Mock(name='client')
self.b.incr('foo')
self.b.client.incr.assert_called_with('foo')
def test_expire(self):
self.b.client = Mock(name='client')
self.b.expire('foo', 300)
self.b.client.expire.assert_called_with('foo', 300)
def test_apply_chord(self, unlock='celery.chord_unlock'):
self.app.tasks[unlock] = Mock()
header_result = self.app.GroupResult(
uuid(),
[self.app.AsyncResult(x) for x in range(3)],
)
self.b.apply_chord(header_result, None)
assert self.app.tasks[unlock].apply_async.call_count == 0
def test_unpack_chord_result(self):
self.b.exception_to_python = Mock(name='etp')
decode = Mock(name='decode')
exc = KeyError()
tup = decode.return_value = (1, 'id1', states.FAILURE, exc)
with pytest.raises(ChordError):
self.b._unpack_chord_result(tup, decode)
decode.assert_called_with(tup)
self.b.exception_to_python.assert_called_with(exc)
exc = ValueError()
tup = decode.return_value = (2, 'id2', states.RETRY, exc)
ret = self.b._unpack_chord_result(tup, decode)
self.b.exception_to_python.assert_called_with(exc)
assert ret is self.b.exception_to_python()
def test_on_chord_part_return_no_gid_or_tid(self):
request = Mock(name='request')
request.id = request.group = request.group_index = None
assert self.b.on_chord_part_return(request, 'SUCCESS', 10) is None
def test_ConnectionPool(self):
self.b.redis = Mock(name='redis')
assert self.b._ConnectionPool is None
assert self.b.ConnectionPool is self.b.redis.ConnectionPool
assert self.b.ConnectionPool is self.b.redis.ConnectionPool
def test_expires_defaults_to_config(self):
self.app.conf.result_expires = 10
b = self.Backend(expires=None, app=self.app)
assert b.expires == 10
def test_expires_is_int(self):
b = self.Backend(expires=48, app=self.app)
assert b.expires == 48
def test_add_to_chord(self):
b = self.Backend('redis://', app=self.app)
gid = uuid()
b.add_to_chord(gid, 'sig')
b.client.incr.assert_called_with(b.get_key_for_group(gid, '.t'), 1)
def test_expires_is_None(self):
b = self.Backend(expires=None, app=self.app)
assert b.expires == self.app.conf.result_expires.total_seconds()
def test_expires_is_timedelta(self):
b = self.Backend(expires=timedelta(minutes=1), app=self.app)
assert b.expires == 60
def test_mget(self):
assert self.b.mget(['a', 'b', 'c'])
self.b.client.mget.assert_called_with(['a', 'b', 'c'])
def test_set_no_expire(self):
self.b.expires = None
self.b._set_with_state('foo', 'bar', states.SUCCESS)
def create_task(self, i):
tid = uuid()
task = Mock(name=f'task-{tid}')
task.name = 'foobarbaz'
self.app.tasks['foobarbaz'] = task
task.request.chord = signature(task)
task.request.id = tid
task.request.chord['chord_size'] = 10
task.request.group = 'group_id'
task.request.group_index = i
return task
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return(self, restore):
tasks = [self.create_task(i) for i in range(10)]
random.shuffle(tasks)
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.zadd.call_count
self.b.client.zadd.reset_mock()
assert self.b.client.zrangebyscore.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_has_calls([
call(jkey, 86400), call(tkey, 86400),
])
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return__unordered(self, restore):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
tasks = [self.create_task(i) for i in range(10)]
random.shuffle(tasks)
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.rpush.call_count
self.b.client.rpush.reset_mock()
assert self.b.client.lrange.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_has_calls([
call(jkey, 86400), call(tkey, 86400),
])
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return__ordered(self, restore):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
tasks = [self.create_task(i) for i in range(10)]
random.shuffle(tasks)
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.zadd.call_count
self.b.client.zadd.reset_mock()
assert self.b.client.zrangebyscore.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_has_calls([
call(jkey, 86400), call(tkey, 86400),
])
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return_no_expiry(self, restore):
old_expires = self.b.expires
self.b.expires = None
tasks = [self.create_task(i) for i in range(10)]
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.zadd.call_count
self.b.client.zadd.reset_mock()
assert self.b.client.zrangebyscore.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_not_called()
self.b.expires = old_expires
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return_no_expiry__unordered(self, restore):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
old_expires = self.b.expires
self.b.expires = None
tasks = [self.create_task(i) for i in range(10)]
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.rpush.call_count
self.b.client.rpush.reset_mock()
assert self.b.client.lrange.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_not_called()
self.b.expires = old_expires
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return_no_expiry__ordered(self, restore):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
old_expires = self.b.expires
self.b.expires = None
tasks = [self.create_task(i) for i in range(10)]
for i in range(10):
self.b.on_chord_part_return(tasks[i].request, states.SUCCESS, i)
assert self.b.client.zadd.call_count
self.b.client.zadd.reset_mock()
assert self.b.client.zrangebyscore.call_count
jkey = self.b.get_key_for_group('group_id', '.j')
tkey = self.b.get_key_for_group('group_id', '.t')
self.b.client.delete.assert_has_calls([call(jkey), call(tkey)])
self.b.client.expire.assert_not_called()
self.b.expires = old_expires
def test_on_chord_part_return__success(self):
with self.chord_context(2) as (_, request, callback):
self.b.on_chord_part_return(request, states.SUCCESS, 10)
callback.delay.assert_not_called()
self.b.on_chord_part_return(request, states.SUCCESS, 20)
callback.delay.assert_called_with([10, 20])
def test_on_chord_part_return__success__unordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
with self.chord_context(2) as (_, request, callback):
self.b.on_chord_part_return(request, states.SUCCESS, 10)
callback.delay.assert_not_called()
self.b.on_chord_part_return(request, states.SUCCESS, 20)
callback.delay.assert_called_with([10, 20])
def test_on_chord_part_return__success__ordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
with self.chord_context(2) as (_, request, callback):
self.b.on_chord_part_return(request, states.SUCCESS, 10)
callback.delay.assert_not_called()
self.b.on_chord_part_return(request, states.SUCCESS, 20)
callback.delay.assert_called_with([10, 20])
def test_on_chord_part_return__callback_raises(self):
with self.chord_context(1) as (_, request, callback):
callback.delay.side_effect = KeyError(10)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__callback_raises__unordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
with self.chord_context(1) as (_, request, callback):
callback.delay.side_effect = KeyError(10)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__callback_raises__ordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
with self.chord_context(1) as (_, request, callback):
callback.delay.side_effect = KeyError(10)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__ChordError(self):
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, ChordError())
self.b.client.pipeline.return_value.zadd().zcount().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__ChordError__unordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, ChordError())
self.b.client.pipeline.return_value.rpush().llen().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__ChordError__ordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, ChordError())
self.b.client.pipeline.return_value.zadd().zcount().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__other_error(self):
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, RuntimeError())
self.b.client.pipeline.return_value.zadd().zcount().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__other_error__unordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=False,
)
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, RuntimeError())
self.b.client.pipeline.return_value.rpush().llen().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
def test_on_chord_part_return__other_error__ordered(self):
self.app.conf.result_backend_transport_options = dict(
result_chord_ordered=True,
)
with self.chord_context(1) as (_, request, callback):
self.b.client.pipeline = ContextMock()
raise_on_second_call(self.b.client.pipeline, RuntimeError())
self.b.client.pipeline.return_value.zadd().zcount().get().expire(
).expire().execute.return_value = (1, 1, 0, 4, 5)
task = self.app._tasks['add'] = Mock(name='add_task')
self.b.on_chord_part_return(request, states.SUCCESS, 10)
task.backend.fail_from_current_stack.assert_called_with(
callback.id, exc=ANY,
)
@contextmanager
def chord_context(self, size=1):
with patch('celery.backends.redis.maybe_signature') as ms:
tasks = [self.create_task(i) for i in range(size)]
request = Mock(name='request')
request.id = 'id1'
request.group = 'gid1'
request.group_index = None
callback = ms.return_value = Signature('add')
callback.id = 'id1'
callback['chord_size'] = size
callback.delay = Mock(name='callback.delay')
yield tasks, request, callback
def test_process_cleanup(self):
self.b.process_cleanup()
def test_get_set_forget(self):
tid = uuid()
self.b.store_result(tid, 42, states.SUCCESS)
assert self.b.get_state(tid) == states.SUCCESS
assert self.b.get_result(tid) == 42
self.b.forget(tid)
assert self.b.get_state(tid) == states.PENDING
def test_set_expires(self):
self.b = self.Backend(expires=512, app=self.app)
tid = uuid()
key = self.b.get_key_for_task(tid)
self.b.store_result(tid, 42, states.SUCCESS)
self.b.client.expire.assert_called_with(
key, 512,
)
class test_SentinelBackend:
def get_backend(self):
from celery.backends.redis import SentinelBackend
class _SentinelBackend(SentinelBackend):
redis = redis
sentinel = sentinel
return _SentinelBackend
def get_E_LOST(self):
from celery.backends.redis import E_LOST
return E_LOST
def setup(self):
self.Backend = self.get_backend()
self.E_LOST = self.get_E_LOST()
self.b = self.Backend(app=self.app)
@pytest.mark.usefixtures('depends_on_current_app')
def test_reduce(self):
pytest.importorskip('redis')
from celery.backends.redis import SentinelBackend
x = SentinelBackend(app=self.app)
assert loads(dumps(x))
def test_no_redis(self):
self.Backend.redis = None
with pytest.raises(ImproperlyConfigured):
self.Backend(app=self.app)
def test_url(self):
self.app.conf.redis_socket_timeout = 30.0
self.app.conf.redis_socket_connect_timeout = 100.0
x = self.Backend(
'sentinel://:test@github.com:123/1;'
'sentinel://:test@github.com:124/1',
app=self.app,
)
assert x.connparams
assert "host" not in x.connparams
assert x.connparams['db'] == 1
assert "port" not in x.connparams
assert x.connparams['password'] == "test"
assert len(x.connparams['hosts']) == 2
expected_hosts = ["github.com", "github.com"]
found_hosts = [cp['host'] for cp in x.connparams['hosts']]
assert found_hosts == expected_hosts
expected_ports = [123, 124]
found_ports = [cp['port'] for cp in x.connparams['hosts']]
assert found_ports == expected_ports
expected_passwords = ["test", "test"]
found_passwords = [cp['password'] for cp in x.connparams['hosts']]
assert found_passwords == expected_passwords