test_app.py 32 KB

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