test_request.py 30 KB

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