test_request.py 33 KB

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