test_request.py 28 KB

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