1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
from contextlib import contextmanager
from unittest.mock import MagicMock, Mock, patch
import pytest
from celery.fixups.django import DjangoFixup, DjangoWorkerFixup, FixupWarning, _maybe_close_fd, fixup
from t.unit import conftest
class FixupCase:
Fixup = None
@contextmanager
def fixup_context(self, app):
with patch('celery.fixups.django.DjangoWorkerFixup.validate_models'):
with patch('celery.fixups.django.symbol_by_name') as symbyname:
with patch('celery.fixups.django.import_module') as impmod:
f = self.Fixup(app)
yield f, impmod, symbyname
class test_DjangoFixup(FixupCase):
Fixup = DjangoFixup
def test_setting_default_app(self):
from celery import _state
prev, _state.default_app = _state.default_app, None
try:
app = Mock(name='app')
DjangoFixup(app)
app.set_default.assert_called_with()
finally:
_state.default_app = prev
@patch('celery.fixups.django.DjangoWorkerFixup')
def test_worker_fixup_property(self, DjangoWorkerFixup):
f = DjangoFixup(self.app)
f._worker_fixup = None
assert f.worker_fixup is DjangoWorkerFixup()
assert f.worker_fixup is DjangoWorkerFixup()
def test_on_import_modules(self):
f = DjangoFixup(self.app)
f.worker_fixup = Mock(name='worker_fixup')
f.on_import_modules()
f.worker_fixup.validate_models.assert_called_with()
def test_autodiscover_tasks(self, patching):
patching.modules('django.apps')
from django.apps import apps
f = DjangoFixup(self.app)
configs = [Mock(name='c1'), Mock(name='c2')]
apps.get_app_configs.return_value = configs
assert f.autodiscover_tasks() == [c.name for c in configs]
@pytest.mark.masked_modules('django')
def test_fixup_no_django(self, patching, mask_modules):
with patch('celery.fixups.django.DjangoFixup') as Fixup:
patching.setenv('DJANGO_SETTINGS_MODULE', '')
fixup(self.app)
Fixup.assert_not_called()
patching.setenv('DJANGO_SETTINGS_MODULE', 'settings')
with pytest.warns(FixupWarning):
fixup(self.app)
Fixup.assert_not_called()
def test_fixup(self, patching):
with patch('celery.fixups.django.DjangoFixup') as Fixup:
patching.setenv('DJANGO_SETTINGS_MODULE', '')
fixup(self.app)
Fixup.assert_not_called()
patching.setenv('DJANGO_SETTINGS_MODULE', 'settings')
with conftest.module_exists('django'):
import django
django.VERSION = (1, 11, 1)
fixup(self.app)
Fixup.assert_called()
def test_maybe_close_fd(self):
with patch('os.close'):
_maybe_close_fd(Mock())
_maybe_close_fd(object())
def test_init(self):
with self.fixup_context(self.app) as (f, importmod, sym):
assert f
@pytest.mark.patched_module(
'django',
'django.db',
'django.db.transaction',
)
def test_install(self, patching, module):
self.app.loader = Mock()
self.cw = patching('os.getcwd')
self.p = patching('sys.path')
self.sigs = patching('celery.fixups.django.signals')
with self.fixup_context(self.app) as (f, _, _):
self.cw.return_value = '/opt/vandelay'
f.install()
self.sigs.worker_init.connect.assert_called_with(f.on_worker_init)
assert self.app.loader.now == f.now
# Specialized DjangoTask class is used
assert self.app.task_cls == 'celery.contrib.django.task:DjangoTask'
from celery.contrib.django.task import DjangoTask
assert issubclass(f.app.Task, DjangoTask)
assert hasattr(f.app.Task, 'delay_on_commit')
assert hasattr(f.app.Task, 'apply_async_on_commit')
self.p.insert.assert_called_with(0, '/opt/vandelay')
def test_install_custom_user_task(self, patching):
patching('celery.fixups.django.signals')
self.app.task_cls = 'myapp.celery.tasks:Task'
self.app._custom_task_cls_used = True
with self.fixup_context(self.app) as (f, _, _):
f.install()
# Specialized DjangoTask class is NOT used,
# The one from the user's class is
assert self.app.task_cls == 'myapp.celery.tasks:Task'
def test_install_custom_user_task_as_class_attribute(self, patching):
patching('celery.fixups.django.signals')
from celery.app import Celery
class MyCeleryApp(Celery):
task_cls = 'myapp.celery.tasks:Task'
app = MyCeleryApp('mytestapp')
with self.fixup_context(app) as (f, _, _):
f.install()
# Specialized DjangoTask class is NOT used,
# The one from the user's class is
assert app.task_cls == 'myapp.celery.tasks:Task'
def test_now(self):
with self.fixup_context(self.app) as (f, _, _):
assert f.now(utc=True)
f._now.assert_not_called()
assert f.now(utc=False)
f._now.assert_called()
def test_on_worker_init(self):
with self.fixup_context(self.app) as (f, _, _):
with patch('celery.fixups.django.DjangoWorkerFixup') as DWF:
f.on_worker_init()
DWF.assert_called_with(f.app)
DWF.return_value.install.assert_called_with()
assert f._worker_fixup is DWF.return_value
class InterfaceError(Exception):
pass
class test_DjangoWorkerFixup(FixupCase):
Fixup = DjangoWorkerFixup
def test_init(self):
with self.fixup_context(self.app) as (f, importmod, sym):
assert f
def test_install(self):
self.app.conf = {'CELERY_DB_REUSE_MAX': None}
self.app.loader = Mock()
with self.fixup_context(self.app) as (f, _, _):
with patch('celery.fixups.django.signals') as sigs:
f.install()
sigs.beat_embedded_init.connect.assert_called_with(
f.close_database,
)
sigs.task_prerun.connect.assert_called_with(f.on_task_prerun)
sigs.task_postrun.connect.assert_called_with(f.on_task_postrun)
sigs.worker_process_init.connect.assert_called_with(
f.on_worker_process_init,
)
def test_on_worker_process_init(self, patching):
with self.fixup_context(self.app) as (f, _, _):
with patch('celery.fixups.django._maybe_close_fd', side_effect=InterfaceError) as mcf:
_all = f._db.connections.all = Mock()
conns = _all.return_value = [
Mock(), MagicMock(),
]
conns[0].connection = None
with patch.object(f, 'close_cache'):
with patch.object(f, '_close_database'):
f.interface_errors = (InterfaceError, )
f.on_worker_process_init()
mcf.assert_called_with(conns[1].connection)
f.close_cache.assert_called_with()
f._close_database.assert_called_with(force=True)
f.validate_models = Mock(name='validate_models')
patching.setenv('FORKED_BY_MULTIPROCESSING', '1')
f.on_worker_process_init()
f.validate_models.assert_called_with()
def test_on_task_prerun(self):
task = Mock()
with self.fixup_context(self.app) as (f, _, _):
task.request.is_eager = False
with patch.object(f, 'close_database'):
f.on_task_prerun(task)
f.close_database.assert_called_with()
task.request.is_eager = True
with patch.object(f, 'close_database'):
f.on_task_prerun(task)
f.close_database.assert_not_called()
def test_on_task_postrun(self):
task = Mock()
with self.fixup_context(self.app) as (f, _, _):
with patch.object(f, 'close_cache'):
task.request.is_eager = False
with patch.object(f, 'close_database'):
f.on_task_postrun(task)
f.close_database.assert_called()
f.close_cache.assert_called()
# when a task is eager, don't close connections
with patch.object(f, 'close_cache'):
task.request.is_eager = True
with patch.object(f, 'close_database'):
f.on_task_postrun(task)
f.close_database.assert_not_called()
f.close_cache.assert_not_called()
def test_close_database(self):
with self.fixup_context(self.app) as (f, _, _):
with patch.object(f, '_close_database') as _close:
f.db_reuse_max = None
f.close_database()
_close.assert_called_with()
_close.reset_mock()
f.db_reuse_max = 10
f._db_recycles = 3
f.close_database()
_close.assert_not_called()
assert f._db_recycles == 4
_close.reset_mock()
f._db_recycles = 20
f.close_database()
_close.assert_called_with()
assert f._db_recycles == 1
def test__close_database(self):
with self.fixup_context(self.app) as (f, _, _):
conns = [Mock(), Mock(), Mock()]
conns[1].close.side_effect = KeyError('already closed')
f.DatabaseError = KeyError
f.interface_errors = ()
f._db.connections = Mock() # ConnectionHandler
f._db.connections.all.side_effect = lambda: conns
f._close_database(force=True)
conns[0].close.assert_called_with()
conns[0].close_if_unusable_or_obsolete.assert_not_called()
conns[1].close.assert_called_with()
conns[1].close_if_unusable_or_obsolete.assert_not_called()
conns[2].close.assert_called_with()
conns[2].close_if_unusable_or_obsolete.assert_not_called()
for conn in conns:
conn.reset_mock()
f._close_database()
conns[0].close.assert_not_called()
conns[0].close_if_unusable_or_obsolete.assert_called_with()
conns[1].close.assert_not_called()
conns[1].close_if_unusable_or_obsolete.assert_called_with()
conns[2].close.assert_not_called()
conns[2].close_if_unusable_or_obsolete.assert_called_with()
conns[1].close.side_effect = KeyError(
'omg')
f._close_database()
with pytest.raises(KeyError):
f._close_database(force=True)
conns[1].close.side_effect = None
conns[1].close_if_unusable_or_obsolete.side_effect = KeyError(
'omg')
f._close_database(force=True)
with pytest.raises(KeyError):
f._close_database()
def test_close_cache(self):
with self.fixup_context(self.app) as (f, _, _):
f.close_cache()
f._cache.close_caches.assert_called_with()
@pytest.mark.patched_module('django', 'django.db', 'django.core',
'django.core.cache', 'django.conf',
'django.db.utils')
def test_validate_models(self, patching, module):
f = self.Fixup(self.app)
f.django_setup = Mock(name='django.setup')
patching.modules('django.core.checks')
from django.core.checks import run_checks
f.validate_models()
f.django_setup.assert_called_with()
run_checks.assert_called_with()
# test --skip-checks flag
f.django_setup.reset_mock()
run_checks.reset_mock()
patching.setenv('CELERY_SKIP_CHECKS', 'true')
f.validate_models()
f.django_setup.assert_called_with()
run_checks.assert_not_called()
def test_django_setup(self, patching):
patching('celery.fixups.django.symbol_by_name')
patching('celery.fixups.django.import_module')
django, = patching.modules('django')
f = self.Fixup(self.app)
f.django_setup()
django.setup.assert_called_with()
|
