test_request.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008
  1. # -*- coding: utf-8 -*-
  2. from __future__ import absolute_import, unicode_literals
  3. import numbers
  4. import os
  5. import signal
  6. import socket
  7. import sys
  8. from datetime import datetime, timedelta
  9. from time import time
  10. import pytest
  11. from billiard.einfo import ExceptionInfo
  12. from case import Mock, patch
  13. from kombu.utils.encoding import (default_encode, from_utf8, safe_repr,
  14. safe_str)
  15. from kombu.utils.uuid import uuid
  16. from celery import states
  17. from celery.app.trace import (TraceInfo, _trace_task_ret, build_tracer,
  18. mro_lookup, reset_worker_optimizations,
  19. setup_worker_optimizations, trace_task)
  20. from celery.exceptions import (Ignore, InvalidTaskError, Reject, Retry,
  21. TaskRevokedError, Terminated, WorkerLostError)
  22. from celery.five import monotonic
  23. from celery.signals import task_revoked
  24. from celery.worker import request as module
  25. from celery.worker.request import Request, create_request_cls
  26. from celery.worker.request import logger as req_logger
  27. from celery.worker.state import revoked
  28. class RequestCase:
  29. def setup(self):
  30. self.app.conf.result_serializer = 'pickle'
  31. @self.app.task(shared=False)
  32. def add(x, y, **kw_):
  33. return x + y
  34. self.add = add
  35. @self.app.task(shared=False)
  36. def mytask(i, **kwargs):
  37. return i ** i
  38. self.mytask = mytask
  39. @self.app.task(shared=False)
  40. def mytask_raising(i):
  41. raise KeyError(i)
  42. self.mytask_raising = mytask_raising
  43. def xRequest(self, name=None, id=None, args=None, kwargs=None,
  44. on_ack=None, on_reject=None, Request=Request, **head):
  45. args = [1] if args is None else args
  46. kwargs = {'f': 'x'} if kwargs is None else kwargs
  47. on_ack = on_ack or Mock(name='on_ack')
  48. on_reject = on_reject or Mock(name='on_reject')
  49. message = self.TaskMessage(
  50. name or self.mytask.name, id, args=args, kwargs=kwargs, **head
  51. )
  52. return Request(message, app=self.app,
  53. on_ack=on_ack, on_reject=on_reject)
  54. class test_mro_lookup:
  55. def test_order(self):
  56. class A(object):
  57. pass
  58. class B(A):
  59. pass
  60. class C(B):
  61. pass
  62. class D(C):
  63. @classmethod
  64. def mro(cls):
  65. return ()
  66. A.x = 10
  67. assert mro_lookup(C, 'x') == A
  68. assert mro_lookup(C, 'x', stop={A}) is None
  69. B.x = 10
  70. assert mro_lookup(C, 'x') == B
  71. C.x = 10
  72. assert mro_lookup(C, 'x') == C
  73. assert mro_lookup(D, 'x') is None
  74. def jail(app, task_id, name, args, kwargs):
  75. request = {'id': task_id}
  76. task = app.tasks[name]
  77. task.__trace__ = None # rebuild
  78. return trace_task(
  79. task, task_id, args, kwargs, request=request, eager=False, app=app,
  80. ).retval
  81. @pytest.mark.skipif(sys.version_info[0] > 3, reason='Py2 only')
  82. class test_default_encode:
  83. def test_jython(self):
  84. prev, sys.platform = sys.platform, 'java 1.6.1'
  85. try:
  86. assert default_encode(b'foo') == b'foo'
  87. finally:
  88. sys.platform = prev
  89. def test_cpython(self):
  90. prev, sys.platform = sys.platform, 'darwin'
  91. gfe, sys.getfilesystemencoding = (
  92. sys.getfilesystemencoding,
  93. lambda: 'utf-8',
  94. )
  95. try:
  96. assert default_encode(b'foo') == b'foo'
  97. finally:
  98. sys.platform = prev
  99. sys.getfilesystemencoding = gfe
  100. class test_Retry:
  101. def test_retry_semipredicate(self):
  102. try:
  103. raise Exception('foo')
  104. except Exception as exc:
  105. ret = Retry('Retrying task', exc)
  106. assert ret.exc == exc
  107. class test_trace_task(RequestCase):
  108. def test_process_cleanup_fails(self, patching):
  109. _logger = patching('celery.app.trace.logger')
  110. self.mytask.backend = Mock()
  111. self.mytask.backend.process_cleanup = Mock(side_effect=KeyError())
  112. tid = uuid()
  113. ret = jail(self.app, tid, self.mytask.name, [2], {})
  114. assert ret == 4
  115. self.mytask.backend.mark_as_done.assert_called()
  116. assert 'Process cleanup failed' in _logger.error.call_args[0][0]
  117. def test_process_cleanup_BaseException(self):
  118. self.mytask.backend = Mock()
  119. self.mytask.backend.process_cleanup = Mock(side_effect=SystemExit())
  120. with pytest.raises(SystemExit):
  121. jail(self.app, uuid(), self.mytask.name, [2], {})
  122. def test_execute_jail_success(self):
  123. ret = jail(self.app, uuid(), self.mytask.name, [2], {})
  124. assert ret == 4
  125. def test_marked_as_started(self):
  126. _started = []
  127. def store_result(tid, meta, state, **kwargs):
  128. if state == states.STARTED:
  129. _started.append(tid)
  130. self.mytask.backend.store_result = Mock(name='store_result')
  131. self.mytask.backend.store_result.side_effect = store_result
  132. self.mytask.track_started = True
  133. tid = uuid()
  134. jail(self.app, tid, self.mytask.name, [2], {})
  135. assert tid in _started
  136. self.mytask.ignore_result = True
  137. tid = uuid()
  138. jail(self.app, tid, self.mytask.name, [2], {})
  139. assert tid not in _started
  140. def test_execute_jail_failure(self):
  141. ret = jail(
  142. self.app, uuid(), self.mytask_raising.name, [4], {},
  143. )
  144. assert isinstance(ret, ExceptionInfo)
  145. assert ret.exception.args == (4,)
  146. def test_execute_ignore_result(self):
  147. @self.app.task(shared=False, ignore_result=True)
  148. def ignores_result(i):
  149. return i ** i
  150. task_id = uuid()
  151. ret = jail(self.app, task_id, ignores_result.name, [4], {})
  152. assert ret == 256
  153. assert not self.app.AsyncResult(task_id).ready()
  154. class test_Request(RequestCase):
  155. def get_request(self, sig, Request=Request, **kwargs):
  156. return Request(
  157. self.task_message_from_sig(self.app, sig),
  158. on_ack=Mock(name='on_ack'),
  159. on_reject=Mock(name='on_reject'),
  160. eventer=Mock(name='eventer'),
  161. app=self.app,
  162. connection_errors=(socket.error,),
  163. task=sig.type,
  164. **kwargs
  165. )
  166. def test_shadow(self):
  167. assert self.get_request(
  168. self.add.s(2, 2).set(shadow='fooxyz')).name == 'fooxyz'
  169. def test_invalid_eta_raises_InvalidTaskError(self):
  170. with pytest.raises(InvalidTaskError):
  171. self.get_request(self.add.s(2, 2).set(eta='12345'))
  172. def test_invalid_expires_raises_InvalidTaskError(self):
  173. with pytest.raises(InvalidTaskError):
  174. self.get_request(self.add.s(2, 2).set(expires='12345'))
  175. def test_valid_expires_with_utc_makes_aware(self):
  176. with patch('celery.worker.request.maybe_make_aware') as mma:
  177. self.get_request(self.add.s(2, 2).set(expires=10),
  178. maybe_make_aware=mma)
  179. mma.assert_called()
  180. def test_maybe_expire_when_expires_is_None(self):
  181. req = self.get_request(self.add.s(2, 2))
  182. assert not req.maybe_expire()
  183. def test_on_retry_acks_if_late(self):
  184. self.add.acks_late = True
  185. req = self.get_request(self.add.s(2, 2))
  186. req.on_retry(Mock())
  187. req.on_ack.assert_called_with(req_logger, req.connection_errors)
  188. def test_on_failure_Termianted(self):
  189. einfo = None
  190. try:
  191. raise Terminated('9')
  192. except Terminated:
  193. einfo = ExceptionInfo()
  194. assert einfo is not None
  195. req = self.get_request(self.add.s(2, 2))
  196. req.on_failure(einfo)
  197. req.eventer.send.assert_called_with(
  198. 'task-revoked',
  199. uuid=req.id, terminated=True, signum='9', expired=False,
  200. )
  201. def test_on_failure_propagates_MemoryError(self):
  202. einfo = None
  203. try:
  204. raise MemoryError()
  205. except MemoryError:
  206. einfo = ExceptionInfo(internal=True)
  207. assert einfo is not None
  208. req = self.get_request(self.add.s(2, 2))
  209. with pytest.raises(MemoryError):
  210. req.on_failure(einfo)
  211. def test_on_failure_Ignore_acknowledges(self):
  212. einfo = None
  213. try:
  214. raise Ignore()
  215. except Ignore:
  216. einfo = ExceptionInfo(internal=True)
  217. assert einfo is not None
  218. req = self.get_request(self.add.s(2, 2))
  219. req.on_failure(einfo)
  220. req.on_ack.assert_called_with(req_logger, req.connection_errors)
  221. def test_on_failure_Reject_rejects(self):
  222. einfo = None
  223. try:
  224. raise Reject()
  225. except Reject:
  226. einfo = ExceptionInfo(internal=True)
  227. assert einfo is not None
  228. req = self.get_request(self.add.s(2, 2))
  229. req.on_failure(einfo)
  230. req.on_reject.assert_called_with(
  231. req_logger, req.connection_errors, False,
  232. )
  233. def test_on_failure_Reject_rejects_with_requeue(self):
  234. einfo = None
  235. try:
  236. raise Reject(requeue=True)
  237. except Reject:
  238. einfo = ExceptionInfo(internal=True)
  239. assert einfo is not None
  240. req = self.get_request(self.add.s(2, 2))
  241. req.on_failure(einfo)
  242. req.on_reject.assert_called_with(
  243. req_logger, req.connection_errors, True,
  244. )
  245. def test_on_failure_WorkerLostError_rejects_with_requeue(self):
  246. einfo = None
  247. try:
  248. raise WorkerLostError()
  249. except:
  250. einfo = ExceptionInfo(internal=True)
  251. req = self.get_request(self.add.s(2, 2))
  252. req.task.acks_late = True
  253. req.task.reject_on_worker_lost = True
  254. req.delivery_info['redelivered'] = False
  255. req.on_failure(einfo)
  256. req.on_reject.assert_called_with(
  257. req_logger, req.connection_errors, True)
  258. def test_on_failure_WorkerLostError_redelivered_None(self):
  259. einfo = None
  260. try:
  261. raise WorkerLostError()
  262. except:
  263. einfo = ExceptionInfo(internal=True)
  264. req = self.get_request(self.add.s(2, 2))
  265. req.task.acks_late = True
  266. req.task.reject_on_worker_lost = True
  267. req.delivery_info['redelivered'] = None
  268. req.on_failure(einfo)
  269. req.on_reject.assert_called_with(
  270. req_logger, req.connection_errors, True)
  271. def test_tzlocal_is_cached(self):
  272. req = self.get_request(self.add.s(2, 2))
  273. req._tzlocal = 'foo'
  274. assert req.tzlocal == 'foo'
  275. def test_task_wrapper_repr(self):
  276. assert repr(self.xRequest())
  277. def test_sets_store_errors(self):
  278. self.mytask.ignore_result = True
  279. job = self.xRequest()
  280. assert not job.store_errors
  281. self.mytask.store_errors_even_if_ignored = True
  282. job = self.xRequest()
  283. assert job.store_errors
  284. def test_send_event(self):
  285. job = self.xRequest()
  286. job.eventer = Mock(name='.eventer')
  287. job.send_event('task-frobulated')
  288. job.eventer.send.assert_called_with('task-frobulated', uuid=job.id)
  289. def test_send_events__disabled_at_task_level(self):
  290. job = self.xRequest()
  291. job.task.send_events = False
  292. job.eventer = Mock(name='.eventer')
  293. job.send_event('task-frobulated')
  294. job.eventer.send.assert_not_called()
  295. def test_on_retry(self):
  296. job = self.get_request(self.mytask.s(1, f='x'))
  297. job.eventer = Mock(name='.eventer')
  298. try:
  299. raise Retry('foo', KeyError('moofoobar'))
  300. except:
  301. einfo = ExceptionInfo()
  302. job.on_failure(einfo)
  303. job.eventer.send.assert_called_with(
  304. 'task-retried',
  305. uuid=job.id,
  306. exception=safe_repr(einfo.exception.exc),
  307. traceback=safe_str(einfo.traceback),
  308. )
  309. prev, module._does_info = module._does_info, False
  310. try:
  311. job.on_failure(einfo)
  312. finally:
  313. module._does_info = prev
  314. einfo.internal = True
  315. job.on_failure(einfo)
  316. def test_compat_properties(self):
  317. job = self.xRequest()
  318. assert job.task_id == job.id
  319. assert job.task_name == job.name
  320. job.task_id = 'ID'
  321. assert job.id == 'ID'
  322. job.task_name = 'NAME'
  323. assert job.name == 'NAME'
  324. def test_terminate__pool_ref(self):
  325. pool = Mock()
  326. signum = signal.SIGTERM
  327. job = self.get_request(self.mytask.s(1, f='x'))
  328. job._apply_result = Mock(name='_apply_result')
  329. with self.assert_signal_called(
  330. task_revoked, sender=job.task, request=job,
  331. terminated=True, expired=False, signum=signum):
  332. job.time_start = monotonic()
  333. job.worker_pid = 314
  334. job.terminate(pool, signal='TERM')
  335. job._apply_result().terminate.assert_called_with(signum)
  336. job._apply_result = Mock(name='_apply_result2')
  337. job._apply_result.return_value = None
  338. job.terminate(pool, signal='TERM')
  339. def test_terminate__task_started(self):
  340. pool = Mock()
  341. signum = signal.SIGTERM
  342. job = self.get_request(self.mytask.s(1, f='x'))
  343. with self.assert_signal_called(
  344. task_revoked, sender=job.task, request=job,
  345. terminated=True, expired=False, signum=signum):
  346. job.time_start = monotonic()
  347. job.worker_pid = 313
  348. job.terminate(pool, signal='TERM')
  349. pool.terminate_job.assert_called_with(job.worker_pid, signum)
  350. def test_terminate__task_reserved(self):
  351. pool = Mock()
  352. job = self.get_request(self.mytask.s(1, f='x'))
  353. job.time_start = None
  354. job.terminate(pool, signal='TERM')
  355. pool.terminate_job.assert_not_called()
  356. assert job._terminate_on_ack == (pool, 15)
  357. job.terminate(pool, signal='TERM')
  358. def test_revoked_expires_expired(self):
  359. job = self.get_request(self.mytask.s(1, f='x').set(
  360. expires=datetime.utcnow() - timedelta(days=1)
  361. ))
  362. with self.assert_signal_called(
  363. task_revoked, sender=job.task, request=job,
  364. terminated=False, expired=True, signum=None):
  365. job.revoked()
  366. assert job.id in revoked
  367. assert self.mytask.backend.get_status(job.id) == states.REVOKED
  368. def test_revoked_expires_not_expired(self):
  369. job = self.xRequest(
  370. expires=datetime.utcnow() + timedelta(days=1),
  371. )
  372. job.revoked()
  373. assert job.id not in revoked
  374. assert self.mytask.backend.get_status(job.id) != states.REVOKED
  375. def test_revoked_expires_ignore_result(self):
  376. self.mytask.ignore_result = True
  377. job = self.xRequest(
  378. expires=datetime.utcnow() - timedelta(days=1),
  379. )
  380. job.revoked()
  381. assert job.id in revoked
  382. assert self.mytask.backend.get_status(job.id) != states.REVOKED
  383. def test_already_revoked(self):
  384. job = self.xRequest()
  385. job._already_revoked = True
  386. assert job.revoked()
  387. def test_revoked(self):
  388. job = self.xRequest()
  389. with self.assert_signal_called(
  390. task_revoked, sender=job.task, request=job,
  391. terminated=False, expired=False, signum=None):
  392. revoked.add(job.id)
  393. assert job.revoked()
  394. assert job._already_revoked
  395. assert job.acknowledged
  396. def test_execute_does_not_execute_revoked(self):
  397. job = self.xRequest()
  398. revoked.add(job.id)
  399. job.execute()
  400. def test_execute_acks_late(self):
  401. self.mytask_raising.acks_late = True
  402. job = self.xRequest(
  403. name=self.mytask_raising.name,
  404. kwargs={},
  405. )
  406. job.execute()
  407. assert job.acknowledged
  408. job.execute()
  409. def test_execute_using_pool_does_not_execute_revoked(self):
  410. job = self.xRequest()
  411. revoked.add(job.id)
  412. with pytest.raises(TaskRevokedError):
  413. job.execute_using_pool(None)
  414. def test_on_accepted_acks_early(self):
  415. job = self.xRequest()
  416. job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
  417. assert job.acknowledged
  418. prev, module._does_debug = module._does_debug, False
  419. try:
  420. job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
  421. finally:
  422. module._does_debug = prev
  423. def test_on_accepted_acks_late(self):
  424. job = self.xRequest()
  425. self.mytask.acks_late = True
  426. job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
  427. assert not job.acknowledged
  428. def test_on_accepted_terminates(self):
  429. signum = signal.SIGTERM
  430. pool = Mock()
  431. job = self.xRequest()
  432. with self.assert_signal_called(
  433. task_revoked, sender=job.task, request=job,
  434. terminated=True, expired=False, signum=signum):
  435. job.terminate(pool, signal='TERM')
  436. assert not pool.terminate_job.call_count
  437. job.on_accepted(pid=314, time_accepted=monotonic())
  438. pool.terminate_job.assert_called_with(314, signum)
  439. def test_on_accepted_time_start(self):
  440. job = self.xRequest()
  441. job.on_accepted(pid=os.getpid(), time_accepted=monotonic())
  442. assert time() - job.time_start < 1
  443. def test_on_success_acks_early(self):
  444. job = self.xRequest()
  445. job.time_start = 1
  446. job.on_success((0, 42, 0.001))
  447. prev, module._does_info = module._does_info, False
  448. try:
  449. job.on_success((0, 42, 0.001))
  450. assert not job.acknowledged
  451. finally:
  452. module._does_info = prev
  453. def test_on_success_BaseException(self):
  454. job = self.xRequest()
  455. job.time_start = 1
  456. with pytest.raises(SystemExit):
  457. try:
  458. raise SystemExit()
  459. except SystemExit:
  460. job.on_success((1, ExceptionInfo(), 0.01))
  461. else:
  462. assert False
  463. def test_on_success_eventer(self):
  464. job = self.xRequest()
  465. job.time_start = 1
  466. job.eventer = Mock()
  467. job.eventer.send = Mock()
  468. job.on_success((0, 42, 0.001))
  469. job.eventer.send.assert_called()
  470. def test_on_success_when_failure(self):
  471. job = self.xRequest()
  472. job.time_start = 1
  473. job.on_failure = Mock()
  474. try:
  475. raise KeyError('foo')
  476. except Exception:
  477. job.on_success((1, ExceptionInfo(), 0.001))
  478. job.on_failure.assert_called()
  479. def test_on_success_acks_late(self):
  480. job = self.xRequest()
  481. job.time_start = 1
  482. self.mytask.acks_late = True
  483. job.on_success((0, 42, 0.001))
  484. assert job.acknowledged
  485. def test_on_failure_WorkerLostError(self):
  486. def get_ei():
  487. try:
  488. raise WorkerLostError('do re mi')
  489. except WorkerLostError:
  490. return ExceptionInfo()
  491. job = self.xRequest()
  492. exc_info = get_ei()
  493. job.on_failure(exc_info)
  494. assert self.mytask.backend.get_status(job.id) == states.FAILURE
  495. self.mytask.ignore_result = True
  496. exc_info = get_ei()
  497. job = self.xRequest()
  498. job.on_failure(exc_info)
  499. assert self.mytask.backend.get_status(job.id) == states.PENDING
  500. def test_on_failure_acks_late(self):
  501. job = self.xRequest()
  502. job.time_start = 1
  503. self.mytask.acks_late = True
  504. try:
  505. raise KeyError('foo')
  506. except KeyError:
  507. exc_info = ExceptionInfo()
  508. job.on_failure(exc_info)
  509. assert job.acknowledged
  510. def test_from_message_invalid_kwargs(self):
  511. m = self.TaskMessage(self.mytask.name, args=(), kwargs='foo')
  512. req = Request(m, app=self.app)
  513. with pytest.raises(InvalidTaskError):
  514. raise req.execute().exception
  515. def test_on_hard_timeout(self, patching):
  516. error = patching('celery.worker.request.error')
  517. job = self.xRequest()
  518. job.acknowledge = Mock(name='ack')
  519. job.task.acks_late = True
  520. job.on_timeout(soft=False, timeout=1337)
  521. assert 'Hard time limit' in error.call_args[0][0]
  522. assert self.mytask.backend.get_status(job.id) == states.FAILURE
  523. job.acknowledge.assert_called_with()
  524. job = self.xRequest()
  525. job.acknowledge = Mock(name='ack')
  526. job.task.acks_late = False
  527. job.on_timeout(soft=False, timeout=1335)
  528. job.acknowledge.assert_not_called()
  529. def test_on_soft_timeout(self, patching):
  530. warn = patching('celery.worker.request.warn')
  531. job = self.xRequest()
  532. job.acknowledge = Mock(name='ack')
  533. job.task.acks_late = True
  534. job.on_timeout(soft=True, timeout=1337)
  535. assert 'Soft time limit' in warn.call_args[0][0]
  536. assert self.mytask.backend.get_status(job.id) == states.PENDING
  537. job.acknowledge.assert_not_called()
  538. self.mytask.ignore_result = True
  539. job = self.xRequest()
  540. job.on_timeout(soft=True, timeout=1336)
  541. assert self.mytask.backend.get_status(job.id) == states.PENDING
  542. def test_fast_trace_task(self):
  543. from celery.app import trace
  544. setup_worker_optimizations(self.app)
  545. assert trace.trace_task_ret is trace._fast_trace_task
  546. tid = uuid()
  547. message = self.TaskMessage(self.mytask.name, tid, args=[4])
  548. assert len(message.payload) == 3
  549. try:
  550. self.mytask.__trace__ = build_tracer(
  551. self.mytask.name, self.mytask, self.app.loader, 'test',
  552. app=self.app,
  553. )
  554. failed, res, runtime = trace.trace_task_ret(
  555. self.mytask.name, tid, message.headers, message.body,
  556. message.content_type, message.content_encoding)
  557. assert not failed
  558. assert res == repr(4 ** 4)
  559. assert runtime is not None
  560. assert isinstance(runtime, numbers.Real)
  561. finally:
  562. reset_worker_optimizations()
  563. assert trace.trace_task_ret is trace._trace_task_ret
  564. delattr(self.mytask, '__trace__')
  565. failed, res, runtime = trace.trace_task_ret(
  566. self.mytask.name, tid, message.headers, message.body,
  567. message.content_type, message.content_encoding, app=self.app,
  568. )
  569. assert not failed
  570. assert res == repr(4 ** 4)
  571. assert runtime is not None
  572. assert isinstance(runtime, numbers.Real)
  573. def test_trace_task_ret(self):
  574. self.mytask.__trace__ = build_tracer(
  575. self.mytask.name, self.mytask, self.app.loader, 'test',
  576. app=self.app,
  577. )
  578. tid = uuid()
  579. message = self.TaskMessage(self.mytask.name, tid, args=[4])
  580. _, R, _ = _trace_task_ret(
  581. self.mytask.name, tid, message.headers,
  582. message.body, message.content_type,
  583. message.content_encoding, app=self.app,
  584. )
  585. assert R == repr(4 ** 4)
  586. def test_trace_task_ret__no_trace(self):
  587. try:
  588. delattr(self.mytask, '__trace__')
  589. except AttributeError:
  590. pass
  591. tid = uuid()
  592. message = self.TaskMessage(self.mytask.name, tid, args=[4])
  593. _, R, _ = _trace_task_ret(
  594. self.mytask.name, tid, message.headers,
  595. message.body, message.content_type,
  596. message.content_encoding, app=self.app,
  597. )
  598. assert R == repr(4 ** 4)
  599. def test_trace_catches_exception(self):
  600. @self.app.task(request=None, shared=False)
  601. def raising():
  602. raise KeyError('baz')
  603. with pytest.warns(RuntimeWarning):
  604. res = trace_task(raising, uuid(), [], {}, app=self.app)[0]
  605. assert isinstance(res, ExceptionInfo)
  606. def test_worker_task_trace_handle_retry(self):
  607. tid = uuid()
  608. self.mytask.push_request(id=tid)
  609. try:
  610. raise ValueError('foo')
  611. except Exception as exc:
  612. try:
  613. raise Retry(str(exc), exc=exc)
  614. except Retry as exc:
  615. w = TraceInfo(states.RETRY, exc)
  616. w.handle_retry(
  617. self.mytask, self.mytask.request, store_errors=False,
  618. )
  619. assert self.mytask.backend.get_status(tid) == states.PENDING
  620. w.handle_retry(
  621. self.mytask, self.mytask.request, store_errors=True,
  622. )
  623. assert self.mytask.backend.get_status(tid) == states.RETRY
  624. finally:
  625. self.mytask.pop_request()
  626. def test_worker_task_trace_handle_failure(self):
  627. tid = uuid()
  628. self.mytask.push_request()
  629. try:
  630. self.mytask.request.id = tid
  631. try:
  632. raise ValueError('foo')
  633. except Exception as exc:
  634. w = TraceInfo(states.FAILURE, exc)
  635. w.handle_failure(
  636. self.mytask, self.mytask.request, store_errors=False,
  637. )
  638. assert self.mytask.backend.get_status(tid) == states.PENDING
  639. w.handle_failure(
  640. self.mytask, self.mytask.request, store_errors=True,
  641. )
  642. assert self.mytask.backend.get_status(tid) == states.FAILURE
  643. finally:
  644. self.mytask.pop_request()
  645. def test_from_message(self):
  646. us = 'æØåveéðƒeæ'
  647. tid = uuid()
  648. m = self.TaskMessage(
  649. self.mytask.name, tid, args=[2], kwargs={us: 'bar'},
  650. )
  651. job = Request(m, app=self.app)
  652. assert isinstance(job, Request)
  653. assert job.name == self.mytask.name
  654. assert job.id == tid
  655. assert job.message is m
  656. def test_from_message_empty_args(self):
  657. tid = uuid()
  658. m = self.TaskMessage(self.mytask.name, tid, args=[], kwargs={})
  659. job = Request(m, app=self.app)
  660. assert isinstance(job, Request)
  661. def test_from_message_missing_required_fields(self):
  662. m = self.TaskMessage(self.mytask.name)
  663. m.headers.clear()
  664. with pytest.raises(KeyError):
  665. Request(m, app=self.app)
  666. def test_from_message_nonexistant_task(self):
  667. m = self.TaskMessage(
  668. 'cu.mytask.doesnotexist',
  669. args=[2], kwargs={'æØåveéðƒeæ': 'bar'},
  670. )
  671. with pytest.raises(KeyError):
  672. Request(m, app=self.app)
  673. def test_execute(self):
  674. tid = uuid()
  675. job = self.xRequest(id=tid, args=[4], kwargs={})
  676. assert job.execute() == 256
  677. meta = self.mytask.backend.get_task_meta(tid)
  678. assert meta['status'] == states.SUCCESS
  679. assert meta['result'] == 256
  680. def test_execute_success_no_kwargs(self):
  681. @self.app.task # traverses coverage for decorator without parens
  682. def mytask_no_kwargs(i):
  683. return i ** i
  684. tid = uuid()
  685. job = self.xRequest(
  686. name=mytask_no_kwargs.name,
  687. id=tid,
  688. args=[4],
  689. kwargs={},
  690. )
  691. assert job.execute() == 256
  692. meta = mytask_no_kwargs.backend.get_task_meta(tid)
  693. assert meta['result'] == 256
  694. assert meta['status'] == states.SUCCESS
  695. def test_execute_ack(self):
  696. scratch = {'ACK': False}
  697. def on_ack(*args, **kwargs):
  698. scratch['ACK'] = True
  699. tid = uuid()
  700. job = self.xRequest(id=tid, args=[4], on_ack=on_ack)
  701. assert job.execute() == 256
  702. meta = self.mytask.backend.get_task_meta(tid)
  703. assert scratch['ACK']
  704. assert meta['result'] == 256
  705. assert meta['status'] == states.SUCCESS
  706. def test_execute_fail(self):
  707. tid = uuid()
  708. job = self.xRequest(
  709. name=self.mytask_raising.name,
  710. id=tid,
  711. args=[4],
  712. kwargs={},
  713. )
  714. assert isinstance(job.execute(), ExceptionInfo)
  715. assert self.mytask_raising.backend.serializer == 'pickle'
  716. meta = self.mytask_raising.backend.get_task_meta(tid)
  717. assert meta['status'] == states.FAILURE
  718. assert isinstance(meta['result'], KeyError)
  719. def test_execute_using_pool(self):
  720. tid = uuid()
  721. job = self.xRequest(id=tid, args=[4])
  722. p = Mock()
  723. job.execute_using_pool(p)
  724. p.apply_async.assert_called_once()
  725. args = p.apply_async.call_args[1]['args']
  726. assert args[0] == self.mytask.name
  727. assert args[1] == tid
  728. assert args[2] == job.request_dict
  729. assert args[3] == job.message.body
  730. def _test_on_failure(self, exception, **kwargs):
  731. tid = uuid()
  732. job = self.xRequest(id=tid, args=[4])
  733. job.send_event = Mock(name='send_event')
  734. job.task.backend.mark_as_failure = Mock(name='mark_as_failure')
  735. try:
  736. raise exception
  737. except type(exception):
  738. exc_info = ExceptionInfo()
  739. job.on_failure(exc_info, **kwargs)
  740. job.send_event.assert_called()
  741. return job
  742. def test_on_failure(self):
  743. self._test_on_failure(Exception('Inside unit tests'))
  744. def test_on_failure__unicode_exception(self):
  745. self._test_on_failure(Exception('Бобры атакуют'))
  746. def test_on_failure__utf8_exception(self):
  747. self._test_on_failure(Exception(
  748. from_utf8('Бобры атакуют')))
  749. def test_on_failure__WorkerLostError(self):
  750. exc = WorkerLostError()
  751. job = self._test_on_failure(exc)
  752. job.task.backend.mark_as_failure.assert_called_with(
  753. job.id, exc, request=job, store_result=True,
  754. )
  755. def test_on_failure__return_ok(self):
  756. self._test_on_failure(KeyError(), return_ok=True)
  757. def test_reject(self):
  758. job = self.xRequest(id=uuid())
  759. job.on_reject = Mock(name='on_reject')
  760. job.reject(requeue=True)
  761. job.on_reject.assert_called_with(
  762. req_logger, job.connection_errors, True,
  763. )
  764. assert job.acknowledged
  765. job.on_reject.reset_mock()
  766. job.reject(requeue=True)
  767. job.on_reject.assert_not_called()
  768. def test_group(self):
  769. gid = uuid()
  770. job = self.xRequest(id=uuid(), group=gid)
  771. assert job.group == gid
  772. class test_create_request_class(RequestCase):
  773. def setup(self):
  774. self.task = Mock(name='task')
  775. self.pool = Mock(name='pool')
  776. self.eventer = Mock(name='eventer')
  777. RequestCase.setup(self)
  778. def create_request_cls(self, **kwargs):
  779. return create_request_cls(
  780. Request, self.task, self.pool, 'foo', self.eventer, **kwargs
  781. )
  782. def zRequest(self, Request=None, revoked_tasks=None, ref=None, **kwargs):
  783. return self.xRequest(
  784. Request=Request or self.create_request_cls(
  785. ref=ref,
  786. revoked_tasks=revoked_tasks,
  787. ),
  788. **kwargs)
  789. def test_on_success(self):
  790. self.zRequest(id=uuid()).on_success((False, 'hey', 3.1222))
  791. def test_on_success__SystemExit(self,
  792. errors=(SystemExit, KeyboardInterrupt)):
  793. for exc in errors:
  794. einfo = None
  795. try:
  796. raise exc()
  797. except exc:
  798. einfo = ExceptionInfo()
  799. with pytest.raises(exc):
  800. self.zRequest(id=uuid()).on_success((True, einfo, 1.0))
  801. def test_on_success__calls_failure(self):
  802. job = self.zRequest(id=uuid())
  803. einfo = Mock(name='einfo')
  804. job.on_failure = Mock(name='on_failure')
  805. job.on_success((True, einfo, 1.0))
  806. job.on_failure.assert_called_with(einfo, return_ok=True)
  807. def test_on_success__acks_late_enabled(self):
  808. self.task.acks_late = True
  809. job = self.zRequest(id=uuid())
  810. job.acknowledge = Mock(name='ack')
  811. job.on_success((False, 'foo', 1.0))
  812. job.acknowledge.assert_called_with()
  813. def test_on_success__acks_late_disabled(self):
  814. self.task.acks_late = False
  815. job = self.zRequest(id=uuid())
  816. job.acknowledge = Mock(name='ack')
  817. job.on_success((False, 'foo', 1.0))
  818. job.acknowledge.assert_not_called()
  819. def test_on_success__no_events(self):
  820. self.eventer = None
  821. job = self.zRequest(id=uuid())
  822. job.send_event = Mock(name='send_event')
  823. job.on_success((False, 'foo', 1.0))
  824. job.send_event.assert_not_called()
  825. def test_on_success__with_events(self):
  826. job = self.zRequest(id=uuid())
  827. job.send_event = Mock(name='send_event')
  828. job.on_success((False, 'foo', 1.0))
  829. job.send_event.assert_called_with(
  830. 'task-succeeded', result='foo', runtime=1.0,
  831. )
  832. def test_execute_using_pool__revoked(self):
  833. tid = uuid()
  834. job = self.zRequest(id=tid, revoked_tasks={tid})
  835. job.revoked = Mock()
  836. job.revoked.return_value = True
  837. with pytest.raises(TaskRevokedError):
  838. job.execute_using_pool(self.pool)
  839. def test_execute_using_pool__expired(self):
  840. tid = uuid()
  841. job = self.zRequest(id=tid, revoked_tasks=set())
  842. job.expires = 1232133
  843. job.revoked = Mock()
  844. job.revoked.return_value = True
  845. with pytest.raises(TaskRevokedError):
  846. job.execute_using_pool(self.pool)
  847. def test_execute_using_pool(self):
  848. from celery.app.trace import trace_task_ret as trace
  849. weakref_ref = Mock(name='weakref.ref')
  850. job = self.zRequest(id=uuid(), revoked_tasks=set(), ref=weakref_ref)
  851. job.execute_using_pool(self.pool)
  852. self.pool.apply_async.assert_called_with(
  853. trace,
  854. args=(job.type, job.id, job.request_dict, job.body,
  855. job.content_type, job.content_encoding),
  856. accept_callback=job.on_accepted,
  857. timeout_callback=job.on_timeout,
  858. callback=job.on_success,
  859. error_callback=job.on_failure,
  860. soft_timeout=self.task.soft_time_limit,
  861. timeout=self.task.time_limit,
  862. correlation_id=job.id,
  863. )
  864. assert job._apply_result
  865. weakref_ref.assert_called_with(self.pool.apply_async())
  866. assert job._apply_result is weakref_ref()