test_app.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970
  1. from __future__ import absolute_import, unicode_literals
  2. import gc
  3. import os
  4. import itertools
  5. from copy import deepcopy
  6. from pickle import loads, dumps
  7. from vine import promise
  8. from celery import Celery
  9. from celery import shared_task, current_app
  10. from celery import app as _app
  11. from celery import _state
  12. from celery.app import base as _appbase
  13. from celery.app import defaults
  14. from celery.exceptions import ImproperlyConfigured
  15. from celery.five import keys
  16. from celery.loaders.base import unconfigured
  17. from celery.platforms import pyimplementation
  18. from celery.utils.serialization import pickle
  19. from celery.utils.timeutils import timezone
  20. from celery.tests.case import (
  21. CELERY_TEST_CONFIG,
  22. AppCase,
  23. Mock,
  24. Case,
  25. ContextMock,
  26. depends_on_current_app,
  27. mock,
  28. patch,
  29. )
  30. from celery.utils.objects import Bunch
  31. THIS_IS_A_KEY = 'this is a value'
  32. class ObjectConfig(object):
  33. FOO = 1
  34. BAR = 2
  35. object_config = ObjectConfig()
  36. dict_config = dict(FOO=10, BAR=20)
  37. class ObjectConfig2(object):
  38. LEAVE_FOR_WORK = True
  39. MOMENT_TO_STOP = True
  40. CALL_ME_BACK = 123456789
  41. WANT_ME_TO = False
  42. UNDERSTAND_ME = True
  43. def _get_test_config():
  44. return deepcopy(CELERY_TEST_CONFIG)
  45. test_config = _get_test_config()
  46. class test_module(AppCase):
  47. def test_default_app(self):
  48. self.assertEqual(_app.default_app, _state.default_app)
  49. def test_bugreport(self):
  50. self.assertTrue(_app.bugreport(app=self.app))
  51. class test_task_join_will_block(Case):
  52. def test_task_join_will_block(self):
  53. prev, _state._task_join_will_block = _state._task_join_will_block, 0
  54. try:
  55. self.assertEqual(_state._task_join_will_block, 0)
  56. _state._set_task_join_will_block(True)
  57. print(_state.task_join_will_block)
  58. self.assertTrue(_state.task_join_will_block())
  59. finally:
  60. _state._task_join_will_block = prev
  61. class test_App(AppCase):
  62. def setup(self):
  63. self.app.add_defaults(test_config)
  64. def test_task_autofinalize_disabled(self):
  65. with self.Celery('xyzibari', autofinalize=False) as app:
  66. @app.task
  67. def ttafd():
  68. return 42
  69. with self.assertRaises(RuntimeError):
  70. ttafd()
  71. with self.Celery('xyzibari', autofinalize=False) as app:
  72. @app.task
  73. def ttafd2():
  74. return 42
  75. app.finalize()
  76. self.assertEqual(ttafd2(), 42)
  77. def test_registry_autofinalize_disabled(self):
  78. with self.Celery('xyzibari', autofinalize=False) as app:
  79. with self.assertRaises(RuntimeError):
  80. app.tasks['celery.chain']
  81. app.finalize()
  82. self.assertTrue(app.tasks['celery.chain'])
  83. def test_task(self):
  84. with self.Celery('foozibari') as app:
  85. def fun():
  86. pass
  87. fun.__module__ = '__main__'
  88. task = app.task(fun)
  89. self.assertEqual(task.name, app.main + '.fun')
  90. def test_task_too_many_args(self):
  91. with self.assertRaises(TypeError):
  92. self.app.task(Mock(name='fun'), True)
  93. with self.assertRaises(TypeError):
  94. self.app.task(Mock(name='fun'), True, 1, 2)
  95. def test_with_config_source(self):
  96. with self.Celery(config_source=ObjectConfig) as app:
  97. self.assertEqual(app.conf.FOO, 1)
  98. self.assertEqual(app.conf.BAR, 2)
  99. @depends_on_current_app
  100. def test_task_windows_execv(self):
  101. prev, _appbase.USING_EXECV = _appbase.USING_EXECV, True
  102. try:
  103. @self.app.task(shared=False)
  104. def foo():
  105. pass
  106. self.assertTrue(foo._get_current_object()) # is proxy
  107. finally:
  108. _appbase.USING_EXECV = prev
  109. assert not _appbase.USING_EXECV
  110. def test_task_takes_no_args(self):
  111. with self.assertRaises(TypeError):
  112. @self.app.task(1)
  113. def foo():
  114. pass
  115. def test_add_defaults(self):
  116. self.assertFalse(self.app.configured)
  117. _conf = {'FOO': 300}
  118. def conf():
  119. return _conf
  120. self.app.add_defaults(conf)
  121. self.assertIn(conf, self.app._pending_defaults)
  122. self.assertFalse(self.app.configured)
  123. self.assertEqual(self.app.conf.FOO, 300)
  124. self.assertTrue(self.app.configured)
  125. self.assertFalse(self.app._pending_defaults)
  126. # defaults not pickled
  127. appr = loads(dumps(self.app))
  128. with self.assertRaises(AttributeError):
  129. appr.conf.FOO
  130. # add more defaults after configured
  131. conf2 = {'FOO': 'BAR'}
  132. self.app.add_defaults(conf2)
  133. self.assertEqual(self.app.conf.FOO, 'BAR')
  134. self.assertIn(_conf, self.app.conf.defaults)
  135. self.assertIn(conf2, self.app.conf.defaults)
  136. def test_connection_or_acquire(self):
  137. with self.app.connection_or_acquire(block=True):
  138. self.assertTrue(self.app.pool._dirty)
  139. with self.app.connection_or_acquire(pool=False):
  140. self.assertFalse(self.app.pool._dirty)
  141. def test_using_v1_reduce(self):
  142. self.app._using_v1_reduce = True
  143. self.assertTrue(loads(dumps(self.app)))
  144. def test_autodiscover_tasks_force(self):
  145. self.app.loader.autodiscover_tasks = Mock()
  146. self.app.autodiscover_tasks(['proj.A', 'proj.B'], force=True)
  147. self.app.loader.autodiscover_tasks.assert_called_with(
  148. ['proj.A', 'proj.B'], 'tasks',
  149. )
  150. self.app.loader.autodiscover_tasks = Mock()
  151. def lazy_list():
  152. return ['proj.A', 'proj.B']
  153. self.app.autodiscover_tasks(
  154. lazy_list,
  155. related_name='george',
  156. force=True,
  157. )
  158. self.app.loader.autodiscover_tasks.assert_called_with(
  159. ['proj.A', 'proj.B'], 'george',
  160. )
  161. def test_autodiscover_tasks_lazy(self):
  162. with patch('celery.signals.import_modules') as import_modules:
  163. def lazy_list():
  164. return [1, 2, 3]
  165. self.app.autodiscover_tasks(lazy_list)
  166. import_modules.connect.assert_called()
  167. prom = import_modules.connect.call_args[0][0]
  168. self.assertIsInstance(prom, promise)
  169. self.assertEqual(prom.fun, self.app._autodiscover_tasks)
  170. self.assertEqual(prom.args[0](), [1, 2, 3])
  171. def test_autodiscover_tasks__no_packages(self):
  172. fixup1 = Mock(name='fixup')
  173. fixup2 = Mock(name='fixup')
  174. self.app._autodiscover_tasks_from_names = Mock(name='auto')
  175. self.app._fixups = [fixup1, fixup2]
  176. fixup1.autodiscover_tasks.return_value = ['A', 'B', 'C']
  177. fixup2.autodiscover_tasks.return_value = ['D', 'E', 'F']
  178. self.app.autodiscover_tasks(force=True)
  179. self.app._autodiscover_tasks_from_names.assert_called_with(
  180. ['A', 'B', 'C', 'D', 'E', 'F'], related_name='tasks',
  181. )
  182. @mock.environ('CELERY_BROKER_URL', '')
  183. def test_with_broker(self):
  184. with self.Celery(broker='foo://baribaz') as app:
  185. self.assertEqual(app.conf.broker_url, 'foo://baribaz')
  186. def test_pending_configuration__setattr(self):
  187. with self.Celery(broker='foo://bar') as app:
  188. app.conf.task_default_delivery_mode = 44
  189. app.conf.worker_agent = 'foo:Bar'
  190. self.assertFalse(app.configured)
  191. self.assertEqual(app.conf.worker_agent, 'foo:Bar')
  192. self.assertEqual(app.conf.broker_url, 'foo://bar')
  193. self.assertEqual(app._preconf['worker_agent'], 'foo:Bar')
  194. self.assertTrue(app.configured)
  195. reapp = pickle.loads(pickle.dumps(app))
  196. self.assertEqual(reapp._preconf['worker_agent'], 'foo:Bar')
  197. self.assertFalse(reapp.configured)
  198. self.assertEqual(reapp.conf.worker_agent, 'foo:Bar')
  199. self.assertTrue(reapp.configured)
  200. self.assertEqual(reapp.conf.broker_url, 'foo://bar')
  201. self.assertEqual(reapp._preconf['worker_agent'], 'foo:Bar')
  202. def test_pending_configuration__update(self):
  203. with self.Celery(broker='foo://bar') as app:
  204. app.conf.update(
  205. task_default_delivery_mode=44,
  206. worker_agent='foo:Bar',
  207. )
  208. self.assertFalse(app.configured)
  209. self.assertEqual(app.conf.worker_agent, 'foo:Bar')
  210. self.assertEqual(app.conf.broker_url, 'foo://bar')
  211. self.assertEqual(app._preconf['worker_agent'], 'foo:Bar')
  212. def test_pending_configuration__compat_settings(self):
  213. with self.Celery(broker='foo://bar', backend='foo') as app:
  214. app.conf.update(
  215. CELERY_ALWAYS_EAGER=4,
  216. CELERY_DEFAULT_DELIVERY_MODE=63,
  217. CELERYD_AGENT='foo:Barz',
  218. )
  219. self.assertEqual(app.conf.task_always_eager, 4)
  220. self.assertEqual(app.conf.task_default_delivery_mode, 63)
  221. self.assertEqual(app.conf.worker_agent, 'foo:Barz')
  222. self.assertEqual(app.conf.broker_url, 'foo://bar')
  223. self.assertEqual(app.conf.result_backend, 'foo')
  224. def test_pending_configuration__compat_settings_mixing(self):
  225. with self.Celery(broker='foo://bar', backend='foo') as app:
  226. app.conf.update(
  227. CELERY_ALWAYS_EAGER=4,
  228. CELERY_DEFAULT_DELIVERY_MODE=63,
  229. CELERYD_AGENT='foo:Barz',
  230. worker_consumer='foo:Fooz',
  231. )
  232. with self.assertRaises(ImproperlyConfigured):
  233. self.assertEqual(app.conf.task_always_eager, 4)
  234. def test_pending_configuration__compat_settings_mixing_new(self):
  235. with self.Celery(broker='foo://bar', backend='foo') as app:
  236. app.conf.update(
  237. task_always_eager=4,
  238. task_default_delivery_mode=63,
  239. worker_agent='foo:Barz',
  240. CELERYD_CONSUMER='foo:Fooz',
  241. CELERYD_POOL='foo:Xuzzy',
  242. )
  243. with self.assertRaises(ImproperlyConfigured):
  244. self.assertEqual(app.conf.worker_consumer, 'foo:Fooz')
  245. def test_pending_configuration__compat_settings_mixing_alt(self):
  246. with self.Celery(broker='foo://bar', backend='foo') as app:
  247. app.conf.update(
  248. task_always_eager=4,
  249. task_default_delivery_mode=63,
  250. worker_agent='foo:Barz',
  251. CELERYD_CONSUMER='foo:Fooz',
  252. worker_consumer='foo:Fooz',
  253. CELERYD_POOL='foo:Xuzzy',
  254. worker_pool='foo:Xuzzy'
  255. )
  256. self.assertEqual(app.conf.task_always_eager, 4)
  257. self.assertEqual(app.conf.worker_pool, 'foo:Xuzzy')
  258. def test_pending_configuration__setdefault(self):
  259. with self.Celery(broker='foo://bar') as app:
  260. app.conf.setdefault('worker_agent', 'foo:Bar')
  261. self.assertFalse(app.configured)
  262. def test_pending_configuration__iter(self):
  263. with self.Celery(broker='foo://bar') as app:
  264. app.conf.worker_agent = 'foo:Bar'
  265. self.assertFalse(app.configured)
  266. self.assertTrue(list(keys(app.conf)))
  267. self.assertFalse(app.configured)
  268. self.assertIn('worker_agent', app.conf)
  269. self.assertFalse(app.configured)
  270. self.assertTrue(dict(app.conf))
  271. self.assertTrue(app.configured)
  272. def test_pending_configuration__raises_ImproperlyConfigured(self):
  273. with self.Celery(set_as_current=False) as app:
  274. app.conf.worker_agent = 'foo://bar'
  275. app.conf.task_default_delivery_mode = 44
  276. app.conf.CELERY_ALWAYS_EAGER = 5
  277. with self.assertRaises(ImproperlyConfigured):
  278. app.finalize()
  279. with self.Celery() as app:
  280. self.assertFalse(self.app.conf.task_always_eager)
  281. def test_repr(self):
  282. self.assertTrue(repr(self.app))
  283. def test_custom_task_registry(self):
  284. with self.Celery(tasks=self.app.tasks) as app2:
  285. self.assertIs(app2.tasks, self.app.tasks)
  286. def test_include_argument(self):
  287. with self.Celery(include=('foo', 'bar.foo')) as app:
  288. self.assertEqual(app.conf.include, ('foo', 'bar.foo'))
  289. def test_set_as_current(self):
  290. current = _state._tls.current_app
  291. try:
  292. app = self.Celery(set_as_current=True)
  293. self.assertIs(_state._tls.current_app, app)
  294. finally:
  295. _state._tls.current_app = current
  296. def test_current_task(self):
  297. @self.app.task
  298. def foo(shared=False):
  299. pass
  300. _state._task_stack.push(foo)
  301. try:
  302. self.assertEqual(self.app.current_task.name, foo.name)
  303. finally:
  304. _state._task_stack.pop()
  305. def test_task_not_shared(self):
  306. with patch('celery.app.base.connect_on_app_finalize') as sh:
  307. @self.app.task(shared=False)
  308. def foo():
  309. pass
  310. sh.assert_not_called()
  311. def test_task_compat_with_filter(self):
  312. with self.Celery() as app:
  313. check = Mock()
  314. def filter(task):
  315. check(task)
  316. return task
  317. @app.task(filter=filter, shared=False)
  318. def foo():
  319. pass
  320. check.assert_called_with(foo)
  321. def test_task_with_filter(self):
  322. with self.Celery() as app:
  323. check = Mock()
  324. def filter(task):
  325. check(task)
  326. return task
  327. assert not _appbase.USING_EXECV
  328. @app.task(filter=filter, shared=False)
  329. def foo():
  330. pass
  331. check.assert_called_with(foo)
  332. def test_task_sets_main_name_MP_MAIN_FILE(self):
  333. from celery.utils import imports as _imports
  334. _imports.MP_MAIN_FILE = __file__
  335. try:
  336. with self.Celery('xuzzy') as app:
  337. @app.task
  338. def foo():
  339. pass
  340. self.assertEqual(foo.name, 'xuzzy.foo')
  341. finally:
  342. _imports.MP_MAIN_FILE = None
  343. def test_annotate_decorator(self):
  344. from celery.app.task import Task
  345. class adX(Task):
  346. def run(self, y, z, x):
  347. return y, z, x
  348. check = Mock()
  349. def deco(fun):
  350. def _inner(*args, **kwargs):
  351. check(*args, **kwargs)
  352. return fun(*args, **kwargs)
  353. return _inner
  354. self.app.conf.task_annotations = {
  355. adX.name: {'@__call__': deco}
  356. }
  357. adX.bind(self.app)
  358. self.assertIs(adX.app, self.app)
  359. i = adX()
  360. i(2, 4, x=3)
  361. check.assert_called_with(i, 2, 4, x=3)
  362. i.annotate()
  363. i.annotate()
  364. def test_apply_async_has__self__(self):
  365. @self.app.task(__self__='hello', shared=False)
  366. def aawsX(x, y):
  367. pass
  368. with self.assertRaises(TypeError):
  369. aawsX.apply_async(())
  370. with self.assertRaises(TypeError):
  371. aawsX.apply_async((2,))
  372. with patch('celery.app.amqp.AMQP.create_task_message') as create:
  373. with patch('celery.app.amqp.AMQP.send_task_message') as send:
  374. create.return_value = Mock(), Mock(), Mock(), Mock()
  375. aawsX.apply_async((4, 5))
  376. args = create.call_args[0][2]
  377. self.assertEqual(args, ('hello', 4, 5))
  378. send.assert_called()
  379. def test_apply_async_adds_children(self):
  380. from celery._state import _task_stack
  381. @self.app.task(bind=True, shared=False)
  382. def a3cX1(self):
  383. pass
  384. @self.app.task(bind=True, shared=False)
  385. def a3cX2(self):
  386. pass
  387. _task_stack.push(a3cX1)
  388. try:
  389. a3cX1.push_request(called_directly=False)
  390. try:
  391. res = a3cX2.apply_async(add_to_parent=True)
  392. self.assertIn(res, a3cX1.request.children)
  393. finally:
  394. a3cX1.pop_request()
  395. finally:
  396. _task_stack.pop()
  397. def test_pickle_app(self):
  398. changes = dict(THE_FOO_BAR='bars',
  399. THE_MII_MAR='jars')
  400. self.app.conf.update(changes)
  401. saved = pickle.dumps(self.app)
  402. self.assertLess(len(saved), 2048)
  403. restored = pickle.loads(saved)
  404. self.assertDictContainsSubset(changes, restored.conf)
  405. def test_worker_main(self):
  406. from celery.bin import worker as worker_bin
  407. class worker(worker_bin.worker):
  408. def execute_from_commandline(self, argv):
  409. return argv
  410. prev, worker_bin.worker = worker_bin.worker, worker
  411. try:
  412. ret = self.app.worker_main(argv=['--version'])
  413. self.assertListEqual(ret, ['--version'])
  414. finally:
  415. worker_bin.worker = prev
  416. def test_config_from_envvar(self):
  417. os.environ['CELERYTEST_CONFIG_OBJECT'] = 'celery.tests.app.test_app'
  418. self.app.config_from_envvar('CELERYTEST_CONFIG_OBJECT')
  419. self.assertEqual(self.app.conf.THIS_IS_A_KEY, 'this is a value')
  420. def assert_config2(self):
  421. self.assertTrue(self.app.conf.LEAVE_FOR_WORK)
  422. self.assertTrue(self.app.conf.MOMENT_TO_STOP)
  423. self.assertEqual(self.app.conf.CALL_ME_BACK, 123456789)
  424. self.assertFalse(self.app.conf.WANT_ME_TO)
  425. self.assertTrue(self.app.conf.UNDERSTAND_ME)
  426. def test_config_from_object__lazy(self):
  427. conf = ObjectConfig2()
  428. self.app.config_from_object(conf)
  429. self.assertIs(self.app.loader._conf, unconfigured)
  430. self.assertIs(self.app._config_source, conf)
  431. self.assert_config2()
  432. def test_config_from_object__force(self):
  433. self.app.config_from_object(ObjectConfig2(), force=True)
  434. self.assertTrue(self.app.loader._conf)
  435. self.assert_config2()
  436. def test_config_from_object__compat(self):
  437. class Config(object):
  438. CELERY_ALWAYS_EAGER = 44
  439. CELERY_DEFAULT_DELIVERY_MODE = 30
  440. CELERY_TASK_PUBLISH_RETRY = False
  441. self.app.config_from_object(Config)
  442. self.assertEqual(self.app.conf.task_always_eager, 44)
  443. self.assertEqual(self.app.conf.CELERY_ALWAYS_EAGER, 44)
  444. self.assertFalse(self.app.conf.task_publish_retry)
  445. self.assertEqual(self.app.conf.task_default_routing_key, 'celery')
  446. def test_config_from_object__supports_old_names(self):
  447. class Config(object):
  448. task_always_eager = 45
  449. task_default_delivery_mode = 301
  450. self.app.config_from_object(Config())
  451. self.assertEqual(self.app.conf.CELERY_ALWAYS_EAGER, 45)
  452. self.assertEqual(self.app.conf.task_always_eager, 45)
  453. self.assertEqual(self.app.conf.CELERY_DEFAULT_DELIVERY_MODE, 301)
  454. self.assertEqual(self.app.conf.task_default_delivery_mode, 301)
  455. self.assertEqual(self.app.conf.task_default_routing_key, 'testcelery')
  456. def test_config_from_object__namespace_uppercase(self):
  457. class Config(object):
  458. CELERY_TASK_ALWAYS_EAGER = 44
  459. CELERY_TASK_DEFAULT_DELIVERY_MODE = 301
  460. self.app.config_from_object(Config(), namespace='CELERY')
  461. self.assertEqual(self.app.conf.task_always_eager, 44)
  462. def test_config_from_object__namespace_lowercase(self):
  463. class Config(object):
  464. celery_task_always_eager = 44
  465. celery_task_default_delivery_mode = 301
  466. self.app.config_from_object(Config(), namespace='celery')
  467. self.assertEqual(self.app.conf.task_always_eager, 44)
  468. def test_config_from_object__mixing_new_and_old(self):
  469. class Config(object):
  470. task_always_eager = 44
  471. worker_agent = 'foo:Agent'
  472. worker_consumer = 'foo:Consumer'
  473. beat_schedule = '/foo/schedule'
  474. CELERY_DEFAULT_DELIVERY_MODE = 301
  475. with self.assertRaises(ImproperlyConfigured) as exc:
  476. self.app.config_from_object(Config(), force=True)
  477. self.assertTrue(
  478. exc.args[0].startswith('CELERY_DEFAULT_DELIVERY_MODE'))
  479. self.assertIn('task_default_delivery_mode', exc.args[0])
  480. def test_config_from_object__mixing_old_and_new(self):
  481. class Config(object):
  482. CELERY_ALWAYS_EAGER = 46
  483. CELERYD_AGENT = 'foo:Agent'
  484. CELERYD_CONSUMER = 'foo:Consumer'
  485. CELERYBEAT_SCHEDULE = '/foo/schedule'
  486. task_default_delivery_mode = 301
  487. with self.assertRaises(ImproperlyConfigured) as exc:
  488. self.app.config_from_object(Config(), force=True)
  489. self.assertTrue(
  490. exc.args[0].startswith('task_default_delivery_mode'))
  491. self.assertIn('CELERY_DEFAULT_DELIVERY_MODE', exc.args[0])
  492. def test_config_from_cmdline(self):
  493. cmdline = ['task_always_eager=no',
  494. 'result_backend=/dev/null',
  495. 'worker_prefetch_multiplier=368',
  496. '.foobarstring=(string)300',
  497. '.foobarint=(int)300',
  498. 'sqlalchemy_engine_options=(dict){"foo": "bar"}']
  499. self.app.config_from_cmdline(cmdline, namespace='worker')
  500. self.assertFalse(self.app.conf.task_always_eager)
  501. self.assertEqual(self.app.conf.result_backend, '/dev/null')
  502. self.assertEqual(self.app.conf.worker_prefetch_multiplier, 368)
  503. self.assertEqual(self.app.conf.worker_foobarstring, '300')
  504. self.assertEqual(self.app.conf.worker_foobarint, 300)
  505. self.assertDictEqual(self.app.conf.sqlalchemy_engine_options,
  506. {'foo': 'bar'})
  507. def test_setting__broker_transport_options(self):
  508. _args = {'foo': 'bar', 'spam': 'baz'}
  509. self.app.config_from_object(Bunch())
  510. self.assertEqual(self.app.conf.broker_transport_options, {})
  511. self.app.config_from_object(Bunch(broker_transport_options=_args))
  512. self.assertEqual(self.app.conf.broker_transport_options, _args)
  513. def test_Windows_log_color_disabled(self):
  514. self.app.IS_WINDOWS = True
  515. self.assertFalse(self.app.log.supports_color(True))
  516. def test_WorkController(self):
  517. x = self.app.WorkController
  518. self.assertIs(x.app, self.app)
  519. def test_Worker(self):
  520. x = self.app.Worker
  521. self.assertIs(x.app, self.app)
  522. @depends_on_current_app
  523. def test_AsyncResult(self):
  524. x = self.app.AsyncResult('1')
  525. self.assertIs(x.app, self.app)
  526. r = loads(dumps(x))
  527. # not set as current, so ends up as default app after reduce
  528. self.assertIs(r.app, current_app._get_current_object())
  529. def test_get_active_apps(self):
  530. self.assertTrue(list(_state._get_active_apps()))
  531. app1 = self.Celery()
  532. appid = id(app1)
  533. self.assertIn(app1, _state._get_active_apps())
  534. app1.close()
  535. del(app1)
  536. gc.collect()
  537. # weakref removed from list when app goes out of scope.
  538. with self.assertRaises(StopIteration):
  539. next(app for app in _state._get_active_apps() if id(app) == appid)
  540. def test_config_from_envvar_more(self, key='CELERY_HARNESS_CFG1'):
  541. self.assertFalse(
  542. self.app.config_from_envvar(
  543. 'HDSAJIHWIQHEWQU', force=True, silent=True),
  544. )
  545. with self.assertRaises(ImproperlyConfigured):
  546. self.app.config_from_envvar(
  547. 'HDSAJIHWIQHEWQU', force=True, silent=False,
  548. )
  549. os.environ[key] = __name__ + '.object_config'
  550. self.assertTrue(self.app.config_from_envvar(key, force=True))
  551. self.assertEqual(self.app.conf['FOO'], 1)
  552. self.assertEqual(self.app.conf['BAR'], 2)
  553. os.environ[key] = 'unknown_asdwqe.asdwqewqe'
  554. with self.assertRaises(ImportError):
  555. self.app.config_from_envvar(key, silent=False)
  556. self.assertFalse(
  557. self.app.config_from_envvar(key, force=True, silent=True),
  558. )
  559. os.environ[key] = __name__ + '.dict_config'
  560. self.assertTrue(self.app.config_from_envvar(key, force=True))
  561. self.assertEqual(self.app.conf['FOO'], 10)
  562. self.assertEqual(self.app.conf['BAR'], 20)
  563. @patch('celery.bin.celery.CeleryCommand.execute_from_commandline')
  564. def test_start(self, execute):
  565. self.app.start()
  566. execute.assert_called()
  567. def test_amqp_get_broker_info(self):
  568. self.assertDictContainsSubset(
  569. {'hostname': 'localhost',
  570. 'userid': 'guest',
  571. 'password': 'guest',
  572. 'virtual_host': '/'},
  573. self.app.connection('pyamqp://').info(),
  574. )
  575. self.app.conf.broker_port = 1978
  576. self.app.conf.broker_vhost = 'foo'
  577. self.assertDictContainsSubset(
  578. {'port': 1978, 'virtual_host': 'foo'},
  579. self.app.connection('pyamqp://:1978/foo').info(),
  580. )
  581. conn = self.app.connection('pyamqp:////value')
  582. self.assertDictContainsSubset({'virtual_host': '/value'},
  583. conn.info())
  584. def test_amqp_failover_strategy_selection(self):
  585. # Test passing in a string and make sure the string
  586. # gets there untouched
  587. self.app.conf.broker_failover_strategy = 'foo-bar'
  588. self.assertEqual(
  589. self.app.connection('amqp:////value').failover_strategy,
  590. 'foo-bar',
  591. )
  592. # Try passing in None
  593. self.app.conf.broker_failover_strategy = None
  594. self.assertEqual(
  595. self.app.connection('amqp:////value').failover_strategy,
  596. itertools.cycle,
  597. )
  598. # Test passing in a method
  599. def my_failover_strategy(it):
  600. yield True
  601. self.app.conf.broker_failover_strategy = my_failover_strategy
  602. self.assertEqual(
  603. self.app.connection('amqp:////value').failover_strategy,
  604. my_failover_strategy,
  605. )
  606. def test_after_fork(self):
  607. self.app._pool = Mock()
  608. self.app.on_after_fork = Mock(name='on_after_fork')
  609. self.app._after_fork()
  610. self.assertIsNone(self.app._pool)
  611. self.app.on_after_fork.send.assert_called_with(sender=self.app)
  612. self.app._after_fork()
  613. def test_global_after_fork(self):
  614. self.app._after_fork = Mock(name='_after_fork')
  615. _appbase._after_fork_cleanup_app(self.app)
  616. self.app._after_fork.assert_called_with()
  617. @patch('celery.app.base.logger')
  618. def test_after_fork_cleanup_app__raises(self, logger):
  619. self.app._after_fork = Mock(name='_after_fork')
  620. exc = self.app._after_fork.side_effect = KeyError()
  621. _appbase._after_fork_cleanup_app(self.app)
  622. logger.info.assert_called_with(
  623. 'after forker raised exception: %r', exc, exc_info=1)
  624. def test_ensure_after_fork__no_multiprocessing(self):
  625. prev, _appbase.register_after_fork = (
  626. _appbase.register_after_fork, None)
  627. try:
  628. self.app._after_fork_registered = False
  629. self.app._ensure_after_fork()
  630. self.assertTrue(self.app._after_fork_registered)
  631. finally:
  632. _appbase.register_after_fork = prev
  633. def test_canvas(self):
  634. self.assertTrue(self.app.canvas.Signature)
  635. def test_signature(self):
  636. sig = self.app.signature('foo', (1, 2))
  637. self.assertIs(sig.app, self.app)
  638. def test_timezone__none_set(self):
  639. self.app.conf.timezone = None
  640. tz = self.app.timezone
  641. self.assertEqual(tz, timezone.get_timezone('UTC'))
  642. def test_compat_on_configure(self):
  643. _on_configure = Mock(name='on_configure')
  644. class CompatApp(Celery):
  645. def on_configure(self, *args, **kwargs):
  646. # on pypy3 if named on_configure the class function
  647. # will be called, instead of the mock defined above,
  648. # so we add the underscore.
  649. _on_configure(*args, **kwargs)
  650. with CompatApp(set_as_current=False) as app:
  651. app.loader = Mock()
  652. app.loader.conf = {}
  653. app._load_config()
  654. _on_configure.assert_called_with()
  655. def test_add_periodic_task(self):
  656. @self.app.task
  657. def add(x, y):
  658. pass
  659. assert not self.app.configured
  660. self.app.add_periodic_task(
  661. 10, self.app.signature('add', (2, 2)),
  662. name='add1', expires=3,
  663. )
  664. self.assertTrue(self.app._pending_periodic_tasks)
  665. assert not self.app.configured
  666. sig2 = add.s(4, 4)
  667. self.assertTrue(self.app.configured)
  668. self.app.add_periodic_task(20, sig2, name='add2', expires=4)
  669. self.assertIn('add1', self.app.conf.beat_schedule)
  670. self.assertIn('add2', self.app.conf.beat_schedule)
  671. def test_pool_no_multiprocessing(self):
  672. with mock.mask_modules('multiprocessing.util'):
  673. pool = self.app.pool
  674. self.assertIs(pool, self.app._pool)
  675. def test_bugreport(self):
  676. self.assertTrue(self.app.bugreport())
  677. def test_send_task__connection_provided(self):
  678. connection = Mock(name='connection')
  679. router = Mock(name='router')
  680. router.route.return_value = {}
  681. self.app.amqp = Mock(name='amqp')
  682. self.app.amqp.Producer.attach_mock(ContextMock(), 'return_value')
  683. self.app.send_task('foo', (1, 2), connection=connection, router=router)
  684. self.app.amqp.Producer.assert_called_with(connection)
  685. self.app.amqp.send_task_message.assert_called_with(
  686. self.app.amqp.Producer(), 'foo',
  687. self.app.amqp.create_task_message())
  688. def test_send_task_sent_event(self):
  689. class Dispatcher(object):
  690. sent = []
  691. def publish(self, type, fields, *args, **kwargs):
  692. self.sent.append((type, fields))
  693. conn = self.app.connection()
  694. chan = conn.channel()
  695. try:
  696. for e in ('foo_exchange', 'moo_exchange', 'bar_exchange'):
  697. chan.exchange_declare(e, 'direct', durable=True)
  698. chan.queue_declare(e, durable=True)
  699. chan.queue_bind(e, e, e)
  700. finally:
  701. chan.close()
  702. assert conn.transport_cls == 'memory'
  703. message = self.app.amqp.create_task_message(
  704. 'id', 'footask', (), {}, create_sent_event=True,
  705. )
  706. prod = self.app.amqp.Producer(conn)
  707. dispatcher = Dispatcher()
  708. self.app.amqp.send_task_message(
  709. prod, 'footask', message,
  710. exchange='moo_exchange', routing_key='moo_exchange',
  711. event_dispatcher=dispatcher,
  712. )
  713. self.assertTrue(dispatcher.sent)
  714. self.assertEqual(dispatcher.sent[0][0], 'task-sent')
  715. self.app.amqp.send_task_message(
  716. prod, 'footask', message, event_dispatcher=dispatcher,
  717. exchange='bar_exchange', routing_key='bar_exchange',
  718. )
  719. def test_select_queues(self):
  720. self.app.amqp = Mock(name='amqp')
  721. self.app.select_queues({'foo', 'bar'})
  722. self.app.amqp.queues.select.assert_called_with({'foo', 'bar'})
  723. class test_defaults(AppCase):
  724. def test_strtobool(self):
  725. for s in ('false', 'no', '0'):
  726. self.assertFalse(defaults.strtobool(s))
  727. for s in ('true', 'yes', '1'):
  728. self.assertTrue(defaults.strtobool(s))
  729. with self.assertRaises(TypeError):
  730. defaults.strtobool('unsure')
  731. class test_debugging_utils(AppCase):
  732. def test_enable_disable_trace(self):
  733. try:
  734. _app.enable_trace()
  735. self.assertEqual(_app.app_or_default, _app._app_or_default_trace)
  736. _app.disable_trace()
  737. self.assertEqual(_app.app_or_default, _app._app_or_default)
  738. finally:
  739. _app.disable_trace()
  740. class test_pyimplementation(AppCase):
  741. def test_platform_python_implementation(self):
  742. with mock.platform_pyimp(lambda: 'Xython'):
  743. self.assertEqual(pyimplementation(), 'Xython')
  744. def test_platform_jython(self):
  745. with mock.platform_pyimp():
  746. with mock.sys_platform('java 1.6.51'):
  747. self.assertIn('Jython', pyimplementation())
  748. def test_platform_pypy(self):
  749. with mock.platform_pyimp():
  750. with mock.sys_platform('darwin'):
  751. with mock.pypy_version((1, 4, 3)):
  752. self.assertIn('PyPy', pyimplementation())
  753. with mock.pypy_version((1, 4, 3, 'a4')):
  754. self.assertIn('PyPy', pyimplementation())
  755. def test_platform_fallback(self):
  756. with mock.platform_pyimp():
  757. with mock.sys_platform('darwin'):
  758. with mock.pypy_version():
  759. self.assertEqual('CPython', pyimplementation())
  760. class test_shared_task(AppCase):
  761. def test_registers_to_all_apps(self):
  762. with self.Celery('xproj', set_as_current=True) as xproj:
  763. xproj.finalize()
  764. @shared_task
  765. def foo():
  766. return 42
  767. @shared_task()
  768. def bar():
  769. return 84
  770. self.assertIs(foo.app, xproj)
  771. self.assertIs(bar.app, xproj)
  772. self.assertTrue(foo._get_current_object())
  773. with self.Celery('yproj', set_as_current=True) as yproj:
  774. self.assertIs(foo.app, yproj)
  775. self.assertIs(bar.app, yproj)
  776. @shared_task()
  777. def baz():
  778. return 168
  779. self.assertIs(baz.app, yproj)