test_app.py 33 KB

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