forked from celery/celery
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_request.py
1213 lines (1048 loc) · 41.5 KB
/
test_request.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 numbers
import os
import signal
import socket
import sys
from datetime import datetime, timedelta
from time import monotonic, time
from unittest.mock import Mock, patch
import pytest
from billiard.einfo import ExceptionInfo
from kombu.utils.encoding import (default_encode, from_utf8, safe_repr,
safe_str)
from kombu.utils.uuid import uuid
from celery import states
from celery.app.trace import (TraceInfo, _trace_task_ret, build_tracer,
mro_lookup, reset_worker_optimizations,
setup_worker_optimizations, trace_task)
from celery.backends.base import BaseDictBackend
from celery.exceptions import (Ignore, InvalidTaskError, Reject, Retry,
TaskRevokedError, Terminated, WorkerLostError)
from celery.signals import task_revoked
from celery.worker import request as module
from celery.worker import strategy
from celery.worker.request import Request, create_request_cls
from celery.worker.request import logger as req_logger
from celery.worker.state import revoked
class RequestCase:
def setup(self):
self.app.conf.result_serializer = 'pickle'
@self.app.task(shared=False)
def add(x, y, **kw_):
return x + y
self.add = add
@self.app.task(shared=False)
def mytask(i, **kwargs):
return i ** i
self.mytask = mytask
@self.app.task(shared=False)
def mytask_raising(i):
raise KeyError(i)
self.mytask_raising = mytask_raising
def xRequest(self, name=None, id=None, args=None, kwargs=None,
on_ack=None, on_reject=None, Request=Request, **head):
args = [1] if args is None else args
kwargs = {'f': 'x'} if kwargs is None else kwargs
on_ack = on_ack or Mock(name='on_ack')
on_reject = on_reject or Mock(name='on_reject')
message = self.TaskMessage(
name or self.mytask.name, id, args=args, kwargs=kwargs, **head
)
return Request(message, app=self.app,
on_ack=on_ack, on_reject=on_reject)
class test_mro_lookup:
def test_order(self):
class A:
pass
class B(A):
pass
class C(B):
pass
class D(C):
@classmethod
def mro(cls):
return ()
A.x = 10
assert mro_lookup(C, 'x') == A
assert mro_lookup(C, 'x', stop={A}) is None
B.x = 10
assert mro_lookup(C, 'x') == B
C.x = 10
assert mro_lookup(C, 'x') == C
assert mro_lookup(D, 'x') is None
def jail(app, task_id, name, args, kwargs):
request = {'id': task_id}
task = app.tasks[name]
task.__trace__ = None # rebuild
return trace_task(
task, task_id, args, kwargs, request=request, eager=False, app=app,
).retval
@pytest.mark.skipif(sys.version_info[0] > 3, reason='Py2 only')
class test_default_encode:
def test_jython(self):
prev, sys.platform = sys.platform, 'java 1.6.1'
try:
assert default_encode(b'foo') == b'foo'
finally:
sys.platform = prev
def test_cpython(self):
prev, sys.platform = sys.platform, 'darwin'
gfe, sys.getfilesystemencoding = (
sys.getfilesystemencoding,
lambda: 'utf-8',
)
try:
assert default_encode(b'foo') == b'foo'
finally:
sys.platform = prev
sys.getfilesystemencoding = gfe
class test_Retry:
def test_retry_semipredicate(self):
try:
raise Exception('foo')
except Exception as exc:
ret = Retry('Retrying task', exc)
assert ret.exc == exc
class test_trace_task(RequestCase):
def test_process_cleanup_fails(self, patching):
_logger = patching('celery.app.trace.logger')
self.mytask.backend = Mock()
self.mytask.backend.process_cleanup = Mock(side_effect=KeyError())
tid = uuid()
ret = jail(self.app, tid, self.mytask.name, [2], {})
assert ret == 4
self.mytask.backend.mark_as_done.assert_called()
assert 'Process cleanup failed' in _logger.error.call_args[0][0]
def test_process_cleanup_BaseException(self):
self.mytask.backend = Mock()
self.mytask.backend.process_cleanup = Mock(side_effect=SystemExit())
with pytest.raises(SystemExit):
jail(self.app, uuid(), self.mytask.name, [2], {})
def test_execute_jail_success(self):
ret = jail(self.app, uuid(), self.mytask.name, [2], {})
assert ret == 4
def test_marked_as_started(self):
_started = []
def store_result(tid, meta, state, **kwargs):
if state == states.STARTED:
_started.append(tid)
self.mytask.backend.store_result = Mock(name='store_result')
self.mytask.backend.store_result.side_effect = store_result
self.mytask.track_started = True
tid = uuid()
jail(self.app, tid, self.mytask.name, [2], {})
assert tid in _started
self.mytask.ignore_result = True
tid = uuid()
jail(self.app, tid, self.mytask.name, [2], {})
assert tid not in _started
def test_execute_jail_failure(self):
ret = jail(
self.app, uuid(), self.mytask_raising.name, [4], {},
)
assert isinstance(ret, ExceptionInfo)
assert ret.exception.args == (4,)
def test_execute_ignore_result(self):
@self.app.task(shared=False, ignore_result=True)
def ignores_result(i):
return i ** i
task_id = uuid()
ret = jail(self.app, task_id, ignores_result.name, [4], {})
assert ret == 256
assert not self.app.AsyncResult(task_id).ready()
class test_Request(RequestCase):
def get_request(self,
sig,
Request=Request,
exclude_headers=None,
**kwargs):
msg = self.task_message_from_sig(self.app, sig)
headers = None
if exclude_headers:
headers = msg.headers
for header in exclude_headers:
headers.pop(header)
return Request(
msg,
on_ack=Mock(name='on_ack'),
on_reject=Mock(name='on_reject'),
eventer=Mock(name='eventer'),
app=self.app,
connection_errors=(socket.error,),
task=sig.type,
headers=headers,
**kwargs
)
def test_shadow(self):
assert self.get_request(
self.add.s(2, 2).set(shadow='fooxyz')).name == 'fooxyz'
def test_args(self):
args = (2, 2)
assert self.get_request(
self.add.s(*args)).args == args
def test_kwargs(self):
kwargs = {'1': '2', '3': '4'}
assert self.get_request(
self.add.s(**kwargs)).kwargs == kwargs
def test_info_function(self):
import random
import string
kwargs = {}
for i in range(0, 2):
kwargs[str(i)] = ''.join(random.choice(string.ascii_lowercase) for i in range(1000))
assert self.get_request(
self.add.s(**kwargs)).info(safe=True).get('kwargs') == kwargs
assert self.get_request(
self.add.s(**kwargs)).info(safe=False).get('kwargs') == kwargs
args = []
for i in range(0, 2):
args.append(''.join(random.choice(string.ascii_lowercase) for i in range(1000)))
assert list(self.get_request(
self.add.s(*args)).info(safe=True).get('args')) == args
assert list(self.get_request(
self.add.s(*args)).info(safe=False).get('args')) == args
def test_no_shadow_header(self):
request = self.get_request(self.add.s(2, 2),
exclude_headers=['shadow'])
assert request.name == 't.unit.worker.test_request.add'
def test_invalid_eta_raises_InvalidTaskError(self):
with pytest.raises(InvalidTaskError):
self.get_request(self.add.s(2, 2).set(eta='12345'))
def test_invalid_expires_raises_InvalidTaskError(self):
with pytest.raises(InvalidTaskError):
self.get_request(self.add.s(2, 2).set(expires='12345'))
def test_valid_expires_with_utc_makes_aware(self):
with patch('celery.worker.request.maybe_make_aware') as mma:
self.get_request(self.add.s(2, 2).set(expires=10),
maybe_make_aware=mma)
mma.assert_called()
def test_maybe_expire_when_expires_is_None(self):
req = self.get_request(self.add.s(2, 2))
assert not req.maybe_expire()
def test_on_retry_acks_if_late(self):
self.add.acks_late = True
req = self.get_request(self.add.s(2, 2))
req.on_retry(Mock())
req.on_ack.assert_called_with(req_logger, req.connection_errors)
def test_on_failure_Terminated(self):
einfo = None
try:
raise Terminated('9')
except Terminated:
einfo = ExceptionInfo()
assert einfo is not None
req = self.get_request(self.add.s(2, 2))
req.on_failure(einfo)
req.eventer.send.assert_called_with(
'task-revoked',
uuid=req.id, terminated=True, signum='9', expired=False,
)
def test_on_failure_propagates_MemoryError(self):
einfo = None
try:
raise MemoryError()
except MemoryError:
einfo = ExceptionInfo(internal=True)
assert einfo is not None
req = self.get_request(self.add.s(2, 2))
with pytest.raises(MemoryError):
req.on_failure(einfo)
def test_on_failure_Ignore_acknowledges(self):
einfo = None
try:
raise Ignore()
except Ignore:
einfo = ExceptionInfo(internal=True)
assert einfo is not None
req = self.get_request(self.add.s(2, 2))
req.on_failure(einfo)
req.on_ack.assert_called_with(req_logger, req.connection_errors)
def test_on_failure_Reject_rejects(self):
einfo = None
try:
raise Reject()
except Reject:
einfo = ExceptionInfo(internal=True)
assert einfo is not None
req = self.get_request(self.add.s(2, 2))
req.on_failure(einfo)
req.on_reject.assert_called_with(
req_logger, req.connection_errors, False,
)
def test_on_failure_Reject_rejects_with_requeue(self):
einfo = None
try:
raise Reject(requeue=True)
except Reject:
einfo = ExceptionInfo(internal=True)
assert einfo is not None
req = self.get_request(self.add.s(2, 2))
req.on_failure(einfo)
req.on_reject.assert_called_with(
req_logger, req.connection_errors, True,
)
def test_on_failure_WorkerLostError_rejects_with_requeue(self):
einfo = None
try:
raise WorkerLostError()
except WorkerLostError:
einfo = ExceptionInfo(internal=True)
req = self.get_request(self.add.s(2, 2))
req.task.acks_late = True
req.task.reject_on_worker_lost = True
req.delivery_info['redelivered'] = False
req.on_failure(einfo)
req.on_reject.assert_called_with(
req_logger, req.connection_errors, True)
def test_on_failure_WorkerLostError_redelivered_None(self):
einfo = None
try:
raise WorkerLostError()
except WorkerLostError:
einfo = ExceptionInfo(internal=True)
req = self.get_request(self.add.s(2, 2))
req.task.acks_late = True
req.task.reject_on_worker_lost = True
req.delivery_info['redelivered'] = None
req.on_failure(einfo)
req.on_reject.assert_called_with(
req_logger, req.connection_errors, True)
def test_tzlocal_is_cached(self):
req = self.get_request(self.add.s(2, 2))
req._tzlocal = 'foo'
assert req.tzlocal == 'foo'
def test_task_wrapper_repr(self):
assert repr(self.xRequest())
def test_sets_store_errors(self):
self.mytask.ignore_result = True
job = self.xRequest()
assert not job.store_errors
self.mytask.store_errors_even_if_ignored = True
job = self.xRequest()
assert job.store_errors
def test_send_event(self):
job = self.xRequest()
job.eventer = Mock(name='.eventer')
job.send_event('task-frobulated')
job.eventer.send.assert_called_with('task-frobulated', uuid=job.id)
def test_send_events__disabled_at_task_level(self):
job = self.xRequest()
job.task.send_events = False
job.eventer = Mock(name='.eventer')
job.send_event('task-frobulated')
job.eventer.send.assert_not_called()
def test_on_retry(self):
job = self.get_request(self.mytask.s(1, f='x'))
job.eventer = Mock(name='.eventer')
try:
raise Retry('foo', KeyError('moofoobar'))
except Retry:
einfo = ExceptionInfo()
job.on_failure(einfo)
job.eventer.send.assert_called_with(
'task-retried',
uuid=job.id,
exception=safe_repr(einfo.exception.exc),
traceback=safe_str(einfo.traceback),
)
prev, module._does_info = module._does_info, False
try:
job.on_failure(einfo)
finally:
module._does_info = prev
einfo.internal = True
job.on_failure(einfo)
def test_compat_properties(self):
job = self.xRequest()
assert job.task_id == job.id
assert job.task_name == job.name
job.task_id = 'ID'
assert job.id == 'ID'
job.task_name = 'NAME'
assert job.name == 'NAME'
def test_terminate__pool_ref(self):
pool = Mock()
signum = signal.SIGTERM
job = self.get_request(self.mytask.s(1, f='x'))
job._apply_result = Mock(name='_apply_result')
with self.assert_signal_called(
task_revoked, sender=job.task, request=job._context,
terminated=True, expired=False, signum=signum):
job.time_start = monotonic()
job.worker_pid = 314
job.terminate(pool, signal='TERM')
job._apply_result().terminate.assert_called_with(signum)
job._apply_result = Mock(name='_apply_result2')
job._apply_result.return_value = None
job.terminate(pool, signal='TERM')
def test_terminate__task_started(self):
pool = Mock()
signum = signal.SIGTERM
job = self.get_request(self.mytask.s(1, f='x'))
with self.assert_signal_called(
task_revoked, sender=job.task, request=job._context,
terminated=True, expired=False, signum=signum):
job.time_start = monotonic()
job.worker_pid = 313
job.terminate(pool, signal='TERM')
pool.terminate_job.assert_called_with(job.worker_pid, signum)
def test_terminate__task_reserved(self):
pool = Mock()
job = self.get_request(self.mytask.s(1, f='x'))
job.time_start = None
job.terminate(pool, signal='TERM')
pool.terminate_job.assert_not_called()
assert job._terminate_on_ack == (pool, 15)
job.terminate(pool, signal='TERM')
def test_revoked_expires_expired(self):
job = self.get_request(self.mytask.s(1, f='x').set(
expires=datetime.utcnow() - timedelta(days=1)
))
with self.assert_signal_called(
task_revoked, sender=job.task, request=job._context,
terminated=False, expired=True, signum=None):
job.revoked()
assert job.id in revoked
self.app.set_current()
assert self.mytask.backend.get_status(job.id) == states.REVOKED
def test_revoked_expires_not_expired(self):
job = self.xRequest(
expires=datetime.utcnow() + timedelta(days=1),
)
job.revoked()
assert job.id not in revoked
assert self.mytask.backend.get_status(job.id) != states.REVOKED
def test_revoked_expires_ignore_result(self):
self.mytask.ignore_result = True
job = self.xRequest(
expires=datetime.utcnow() - timedelta(days=1),
)
job.revoked()
assert job.id in revoked
assert self.mytask.backend.get_status(job.id) != states.REVOKED
def test_already_revoked(self):
job = self.xRequest()
job._already_revoked = True
assert job.revoked()
def test_revoked(self):
job = self.xRequest()
with self.assert_signal_called(
task_revoked, sender=job.task, request=job._context,
terminated=False, expired=False, signum=None):
revoked.add(job.id)
assert job.revoked()
assert job._already_revoked
assert job.acknowledged
def test_execute_does_not_execute_revoked(self):
job = self.xRequest()
revoked.add(job.id)
job.execute()
def test_execute_acks_late(self):
self.mytask_raising.acks_late = True
job = self.xRequest(
name=self.mytask_raising.name,
kwargs={},
)
job.execute()
assert job.acknowledged
job.execute()
def test_execute_using_pool_does_not_execute_revoked(self):
job = self.xRequest()
revoked.add(job.id)
with pytest.raises(TaskRevokedError):
job.execute_using_pool(None)
def test_on_accepted_acks_early(self):
job = self.xRequest()
job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
assert job.acknowledged
prev, module._does_debug = module._does_debug, False
try:
job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
finally:
module._does_debug = prev
def test_on_accepted_acks_late(self):
job = self.xRequest()
self.mytask.acks_late = True
job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
assert not job.acknowledged
def test_on_accepted_terminates(self):
signum = signal.SIGTERM
pool = Mock()
job = self.xRequest()
with self.assert_signal_called(
task_revoked, sender=job.task, request=job._context,
terminated=True, expired=False, signum=signum):
job.terminate(pool, signal='TERM')
assert not pool.terminate_job.call_count
job.on_accepted(pid=314, time_accepted=monotonic())
pool.terminate_job.assert_called_with(314, signum)
def test_on_accepted_time_start(self):
job = self.xRequest()
job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
assert time() - job.time_start < 1
def test_on_success_acks_early(self):
job = self.xRequest()
job.time_start = 1
job.on_success((0, 42, 0.001))
prev, module._does_info = module._does_info, False
try:
job.on_success((0, 42, 0.001))
assert not job.acknowledged
finally:
module._does_info = prev
def test_on_success_BaseException(self):
job = self.xRequest()
job.time_start = 1
with pytest.raises(SystemExit):
try:
raise SystemExit()
except SystemExit:
job.on_success((1, ExceptionInfo(), 0.01))
else:
assert False
def test_on_success_eventer(self):
job = self.xRequest()
job.time_start = 1
job.eventer = Mock()
job.eventer.send = Mock()
job.on_success((0, 42, 0.001))
job.eventer.send.assert_called()
def test_on_success_when_failure(self):
job = self.xRequest()
job.time_start = 1
job.on_failure = Mock()
try:
raise KeyError('foo')
except Exception:
job.on_success((1, ExceptionInfo(), 0.001))
job.on_failure.assert_called()
def test_on_success_acks_late(self):
job = self.xRequest()
job.time_start = 1
self.mytask.acks_late = True
job.on_success((0, 42, 0.001))
assert job.acknowledged
def test_on_failure_WorkerLostError(self):
def get_ei():
try:
raise WorkerLostError('do re mi')
except WorkerLostError:
return ExceptionInfo()
job = self.xRequest()
exc_info = get_ei()
job.on_failure(exc_info)
self.app.set_current()
assert self.mytask.backend.get_status(job.id) == states.FAILURE
self.mytask.ignore_result = True
exc_info = get_ei()
job = self.xRequest()
job.on_failure(exc_info)
assert self.mytask.backend.get_status(job.id) == states.PENDING
def test_on_failure_acks_late_reject_on_worker_lost_enabled(self):
try:
raise WorkerLostError()
except WorkerLostError:
exc_info = ExceptionInfo()
self.mytask.acks_late = True
self.mytask.reject_on_worker_lost = True
job = self.xRequest()
job.delivery_info['redelivered'] = False
job.on_failure(exc_info)
assert self.mytask.backend.get_status(job.id) == states.PENDING
job = self.xRequest()
job.delivery_info['redelivered'] = True
job.on_failure(exc_info)
assert self.mytask.backend.get_status(job.id) == states.PENDING
def test_on_failure_acks_late(self):
job = self.xRequest()
job.time_start = 1
self.mytask.acks_late = True
try:
raise KeyError('foo')
except KeyError:
exc_info = ExceptionInfo()
job.on_failure(exc_info)
assert job.acknowledged
def test_on_failure_acks_on_failure_or_timeout_disabled_for_task(self):
job = self.xRequest()
job.time_start = 1
job._on_reject = Mock()
self.mytask.acks_late = True
self.mytask.acks_on_failure_or_timeout = False
try:
raise KeyError('foo')
except KeyError:
exc_info = ExceptionInfo()
job.on_failure(exc_info)
assert job.acknowledged is True
job._on_reject.assert_called_with(req_logger, job.connection_errors, False)
def test_on_failure_acks_on_failure_or_timeout_enabled_for_task(self):
job = self.xRequest()
job.time_start = 1
self.mytask.acks_late = True
self.mytask.acks_on_failure_or_timeout = True
try:
raise KeyError('foo')
except KeyError:
exc_info = ExceptionInfo()
job.on_failure(exc_info)
assert job.acknowledged is True
def test_on_failure_acks_on_failure_or_timeout_disabled(self):
self.app.conf.acks_on_failure_or_timeout = False
job = self.xRequest()
job.time_start = 1
self.mytask.acks_late = True
self.mytask.acks_on_failure_or_timeout = False
try:
raise KeyError('foo')
except KeyError:
exc_info = ExceptionInfo()
job.on_failure(exc_info)
assert job.acknowledged is True
job._on_reject.assert_called_with(req_logger, job.connection_errors,
False)
self.app.conf.acks_on_failure_or_timeout = True
def test_on_failure_acks_on_failure_or_timeout_enabled(self):
self.app.conf.acks_on_failure_or_timeout = True
job = self.xRequest()
job.time_start = 1
self.mytask.acks_late = True
try:
raise KeyError('foo')
except KeyError:
exc_info = ExceptionInfo()
job.on_failure(exc_info)
assert job.acknowledged is True
def test_from_message_invalid_kwargs(self):
m = self.TaskMessage(self.mytask.name, args=(), kwargs='foo')
req = Request(m, app=self.app)
with pytest.raises(InvalidTaskError):
raise req.execute().exception
def test_on_hard_timeout_acks_late(self, patching):
error = patching('celery.worker.request.error')
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = True
job.on_timeout(soft=False, timeout=1337)
assert 'Hard time limit' in error.call_args[0][0]
assert self.mytask.backend.get_status(job.id) == states.FAILURE
job.acknowledge.assert_called_with()
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = False
job.on_timeout(soft=False, timeout=1335)
job.acknowledge.assert_not_called()
def test_on_hard_timeout_acks_on_failure_or_timeout(self, patching):
error = patching('celery.worker.request.error')
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = True
job.task.acks_on_failure_or_timeout = True
job.on_timeout(soft=False, timeout=1337)
assert 'Hard time limit' in error.call_args[0][0]
assert self.mytask.backend.get_status(job.id) == states.FAILURE
job.acknowledge.assert_called_with()
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = True
job.task.acks_on_failure_or_timeout = False
job.on_timeout(soft=False, timeout=1337)
assert 'Hard time limit' in error.call_args[0][0]
assert self.mytask.backend.get_status(job.id) == states.FAILURE
job.acknowledge.assert_not_called()
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = False
job.task.acks_on_failure_or_timeout = True
job.on_timeout(soft=False, timeout=1335)
job.acknowledge.assert_not_called()
def test_on_soft_timeout(self, patching):
warn = patching('celery.worker.request.warn')
job = self.xRequest()
job.acknowledge = Mock(name='ack')
job.task.acks_late = True
job.on_timeout(soft=True, timeout=1337)
assert 'Soft time limit' in warn.call_args[0][0]
assert self.mytask.backend.get_status(job.id) == states.PENDING
job.acknowledge.assert_not_called()
self.mytask.ignore_result = True
job = self.xRequest()
job.on_timeout(soft=True, timeout=1336)
assert self.mytask.backend.get_status(job.id) == states.PENDING
def test_fast_trace_task(self):
from celery.app import trace
setup_worker_optimizations(self.app)
assert trace.trace_task_ret is trace._fast_trace_task
tid = uuid()
message = self.TaskMessage(self.mytask.name, tid, args=[4])
assert len(message.payload) == 3
try:
self.mytask.__trace__ = build_tracer(
self.mytask.name, self.mytask, self.app.loader, 'test',
app=self.app,
)
failed, res, runtime = trace.trace_task_ret(
self.mytask.name, tid, message.headers, message.body,
message.content_type, message.content_encoding)
assert not failed
assert res == repr(4 ** 4)
assert runtime is not None
assert isinstance(runtime, numbers.Real)
finally:
reset_worker_optimizations()
assert trace.trace_task_ret is trace._trace_task_ret
delattr(self.mytask, '__trace__')
failed, res, runtime = trace.trace_task_ret(
self.mytask.name, tid, message.headers, message.body,
message.content_type, message.content_encoding, app=self.app,
)
assert not failed
assert res == repr(4 ** 4)
assert runtime is not None
assert isinstance(runtime, numbers.Real)
def test_trace_task_ret(self):
self.mytask.__trace__ = build_tracer(
self.mytask.name, self.mytask, self.app.loader, 'test',
app=self.app,
)
tid = uuid()
message = self.TaskMessage(self.mytask.name, tid, args=[4])
_, R, _ = _trace_task_ret(
self.mytask.name, tid, message.headers,
message.body, message.content_type,
message.content_encoding, app=self.app,
)
assert R == repr(4 ** 4)
def test_trace_task_ret__no_trace(self):
try:
delattr(self.mytask, '__trace__')
except AttributeError:
pass
tid = uuid()
message = self.TaskMessage(self.mytask.name, tid, args=[4])
_, R, _ = _trace_task_ret(
self.mytask.name, tid, message.headers,
message.body, message.content_type,
message.content_encoding, app=self.app,
)
assert R == repr(4 ** 4)
def test_trace_catches_exception(self):
@self.app.task(request=None, shared=False)
def raising():
raise KeyError('baz')
with pytest.warns(RuntimeWarning):
res = trace_task(raising, uuid(), [], {}, app=self.app)[0]
assert isinstance(res, ExceptionInfo)
def test_worker_task_trace_handle_retry(self):
tid = uuid()
self.mytask.push_request(id=tid)
try:
raise ValueError('foo')
except Exception as exc:
try:
raise Retry(str(exc), exc=exc)
except Retry as exc:
w = TraceInfo(states.RETRY, exc)
w.handle_retry(
self.mytask, self.mytask.request, store_errors=False,
)
assert self.mytask.backend.get_status(tid) == states.PENDING
w.handle_retry(
self.mytask, self.mytask.request, store_errors=True,
)
assert self.mytask.backend.get_status(tid) == states.RETRY
finally:
self.mytask.pop_request()
def test_worker_task_trace_handle_failure(self):
tid = uuid()
self.mytask.push_request()
try:
self.mytask.request.id = tid
try:
raise ValueError('foo')
except Exception as exc:
w = TraceInfo(states.FAILURE, exc)
w.handle_failure(
self.mytask, self.mytask.request, store_errors=False,
)
assert self.mytask.backend.get_status(tid) == states.PENDING
w.handle_failure(
self.mytask, self.mytask.request, store_errors=True,
)
assert self.mytask.backend.get_status(tid) == states.FAILURE
finally:
self.mytask.pop_request()
def test_from_message(self):
us = 'æØåveéðƒeæ'
tid = uuid()
m = self.TaskMessage(
self.mytask.name, tid, args=[2], kwargs={us: 'bar'},
)
job = Request(m, app=self.app)
assert isinstance(job, Request)
assert job.name == self.mytask.name
assert job.id == tid
assert job.message is m
def test_from_message_empty_args(self):
tid = uuid()
m = self.TaskMessage(self.mytask.name, tid, args=[], kwargs={})
job = Request(m, app=self.app)
assert isinstance(job, Request)
def test_from_message_missing_required_fields(self):
m = self.TaskMessage(self.mytask.name)
m.headers.clear()
with pytest.raises(KeyError):
Request(m, app=self.app)
def test_from_message_nonexistant_task(self):
m = self.TaskMessage(
'cu.mytask.doesnotexist',
args=[2], kwargs={'æØåveéðƒeæ': 'bar'},
)
with pytest.raises(KeyError):
Request(m, app=self.app)
def test_execute(self):
tid = uuid()
job = self.xRequest(id=tid, args=[4], kwargs={})
assert job.execute() == 256
meta = self.mytask.backend.get_task_meta(tid)
assert meta['status'] == states.SUCCESS
assert meta['result'] == 256
def test_execute_backend_error_acks_late(self):
"""direct call to execute should reject task in case of internal failure."""
tid = uuid()
self.mytask.acks_late = True
job = self.xRequest(id=tid, args=[4], kwargs={})
job._on_reject = Mock()
job._on_ack = Mock()
self.mytask.backend = BaseDictBackend(app=self.app)
self.mytask.backend.mark_as_done = Mock()
self.mytask.backend.mark_as_done.side_effect = Exception()
self.mytask.backend.mark_as_failure = Mock()
self.mytask.backend.mark_as_failure.side_effect = Exception()
job.execute()
assert job.acknowledged
job._on_reject.assert_called_once()
job._on_ack.assert_not_called()
def test_execute_success_no_kwargs(self):
@self.app.task # traverses coverage for decorator without parens
def mytask_no_kwargs(i):
return i ** i
tid = uuid()
job = self.xRequest(
name=mytask_no_kwargs.name,
id=tid,
args=[4],
kwargs={},
)
assert job.execute() == 256
meta = mytask_no_kwargs.backend.get_task_meta(tid)
assert meta['result'] == 256
assert meta['status'] == states.SUCCESS
def test_execute_ack(self):
scratch = {'ACK': False}
def on_ack(*args, **kwargs):
scratch['ACK'] = True
tid = uuid()
job = self.xRequest(id=tid, args=[4], on_ack=on_ack)
assert job.execute() == 256
meta = self.mytask.backend.get_task_meta(tid)
assert scratch['ACK']
assert meta['result'] == 256
assert meta['status'] == states.SUCCESS
def test_execute_fail(self):
tid = uuid()
job = self.xRequest(
name=self.mytask_raising.name,
id=tid,
args=[4],
kwargs={},
)
assert isinstance(job.execute(), ExceptionInfo)
assert self.mytask_raising.backend.serializer == 'pickle'
meta = self.mytask_raising.backend.get_task_meta(tid)