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
|
import sys
import types
from contextlib import contextmanager
from unittest.mock import Mock, patch
import pytest
from kombu.utils.encoding import ensure_bytes, str_to_bytes
from celery import signature, states, uuid
from celery.backends.cache import CacheBackend, DummyClient, backends
from celery.exceptions import ImproperlyConfigured
from t.unit import conftest
class SomeClass:
def __init__(self, data):
self.data = data
class test_CacheBackend:
def setup_method(self):
self.app.conf.result_serializer = 'pickle'
self.tb = CacheBackend(backend='memory://', app=self.app)
self.tid = uuid()
self.old_get_best_memcached = backends['memcache']
backends['memcache'] = lambda: (DummyClient, ensure_bytes)
def teardown_method(self):
backends['memcache'] = self.old_get_best_memcached
def test_no_backend(self):
self.app.conf.cache_backend = None
with pytest.raises(ImproperlyConfigured):
CacheBackend(backend=None, app=self.app)
def test_memory_client_is_shared(self):
"""This test verifies that memory:// backend state is shared over multiple threads"""
from threading import Thread
t = Thread(
target=lambda: CacheBackend(backend='memory://', app=self.app).set('test', 12345)
)
t.start()
t.join()
assert self.tb.client.get('test') == 12345
def test_mark_as_done(self):
assert self.tb.get_state(self.tid) == states.PENDING
assert self.tb.get_result(self.tid) is None
self.tb.mark_as_done(self.tid, 42)
assert self.tb.get_state(self.tid) == states.SUCCESS
assert self.tb.get_result(self.tid) == 42
def test_is_pickled(self):
result = {'foo': 'baz', 'bar': SomeClass(12345)}
self.tb.mark_as_done(self.tid, result)
# is serialized properly.
rindb = self.tb.get_result(self.tid)
assert rindb.get('foo') == 'baz'
assert rindb.get('bar').data == 12345
def test_mark_as_failure(self):
try:
raise KeyError('foo')
except KeyError as exception:
self.tb.mark_as_failure(self.tid, exception)
assert self.tb.get_state(self.tid) == states.FAILURE
assert isinstance(self.tb.get_result(self.tid), KeyError)
def test_apply_chord(self):
tb = CacheBackend(backend='memory://', app=self.app)
result_args = (
uuid(),
[self.app.AsyncResult(uuid()) for _ in range(3)],
)
tb.apply_chord(result_args, None)
assert self.app.GroupResult.restore(result_args[0], backend=tb) == self.app.GroupResult(*result_args)
@patch('celery.result.GroupResult.restore')
def test_on_chord_part_return(self, restore):
tb = CacheBackend(backend='memory://', app=self.app)
deps = Mock()
deps.__len__ = Mock()
deps.__len__.return_value = 2
restore.return_value = deps
task = Mock()
task.name = 'foobarbaz'
self.app.tasks['foobarbaz'] = task
task.request.chord = signature(task)
result_args = (
uuid(),
[self.app.AsyncResult(uuid()) for _ in range(3)],
)
task.request.group = result_args[0]
tb.apply_chord(result_args, None)
deps.join_native.assert_not_called()
tb.on_chord_part_return(task.request, 'SUCCESS', 10)
deps.join_native.assert_not_called()
tb.on_chord_part_return(task.request, 'SUCCESS', 10)
deps.join_native.assert_called_with(propagate=True, timeout=3.0)
deps.delete.assert_called_with()
def test_mget(self):
self.tb._set_with_state('foo', 1, states.SUCCESS)
self.tb._set_with_state('bar', 2, states.SUCCESS)
assert self.tb.mget(['foo', 'bar']) == {'foo': 1, 'bar': 2}
def test_forget(self):
self.tb.mark_as_done(self.tid, {'foo': 'bar'})
x = self.app.AsyncResult(self.tid, backend=self.tb)
x.forget()
assert x.result is None
def test_process_cleanup(self):
self.tb.process_cleanup()
def test_expires_as_int(self):
tb = CacheBackend(backend='memory://', expires=10, app=self.app)
assert tb.expires == 10
def test_unknown_backend_raises_ImproperlyConfigured(self):
with pytest.raises(ImproperlyConfigured):
CacheBackend(backend='unknown://', app=self.app)
def test_as_uri_no_servers(self):
assert self.tb.as_uri() == 'memory:///'
def test_as_uri_one_server(self):
backend = 'memcache://127.0.0.1:11211/'
b = CacheBackend(backend=backend, app=self.app)
assert b.as_uri() == backend
def test_as_uri_multiple_servers(self):
backend = 'memcache://127.0.0.1:11211;127.0.0.2:11211;127.0.0.3/'
b = CacheBackend(backend=backend, app=self.app)
assert b.as_uri() == backend
def test_regression_worker_startup_info(self):
pytest.importorskip('memcache')
self.app.conf.result_backend = (
'cache+memcached://127.0.0.1:11211;127.0.0.2:11211;127.0.0.3/'
)
worker = self.app.Worker()
with conftest.stdouts():
worker.on_start()
assert worker.startup_info()
class MyMemcachedStringEncodingError(Exception):
pass
class MemcachedClient(DummyClient):
def set(self, key, value, *args, **kwargs):
key_t, must_be, not_be, cod = bytes, 'string', 'bytes', 'decode'
if isinstance(key, key_t):
raise MyMemcachedStringEncodingError(
f'Keys must be {must_be}, not {not_be}. Convert your '
f'strings using mystring.{cod}(charset)!')
return super().set(key, value, *args, **kwargs)
class MockCacheMixin:
@contextmanager
def mock_memcache(self):
memcache = types.ModuleType('memcache')
memcache.Client = MemcachedClient
memcache.Client.__module__ = memcache.__name__
prev, sys.modules['memcache'] = sys.modules.get('memcache'), memcache
try:
yield True
finally:
if prev is not None:
sys.modules['memcache'] = prev
@contextmanager
def mock_pylibmc(self):
pylibmc = types.ModuleType('pylibmc')
pylibmc.Client = MemcachedClient
pylibmc.Client.__module__ = pylibmc.__name__
prev = sys.modules.get('pylibmc')
sys.modules['pylibmc'] = pylibmc
try:
yield True
finally:
if prev is not None:
sys.modules['pylibmc'] = prev
class test_get_best_memcache(MockCacheMixin):
def test_pylibmc(self):
with self.mock_pylibmc():
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
assert cache.get_best_memcache()[0].__module__ == 'pylibmc'
@pytest.mark.masked_modules('pylibmc')
def test_memcache(self, mask_modules):
with self.mock_memcache():
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
assert (cache.get_best_memcache()[0]().__module__ ==
'memcache')
@pytest.mark.masked_modules('pylibmc', 'memcache')
def test_no_implementations(self, mask_modules):
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
with pytest.raises(ImproperlyConfigured):
cache.get_best_memcache()
def test_cached(self):
with self.mock_pylibmc():
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
cache.get_best_memcache()[0](behaviors={'foo': 'bar'})
assert cache._imp[0]
cache.get_best_memcache()[0]()
def test_backends(self):
from celery.backends.cache import backends
with self.mock_memcache():
for name, fun in backends.items():
assert fun()
class test_memcache_key(MockCacheMixin):
@pytest.mark.masked_modules('pylibmc')
def test_memcache_unicode_key(self, mask_modules):
with self.mock_memcache():
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
task_id, result = str(uuid()), 42
b = cache.CacheBackend(backend='memcache', app=self.app)
b.store_result(task_id, result, state=states.SUCCESS)
assert b.get_result(task_id) == result
@pytest.mark.masked_modules('pylibmc')
def test_memcache_bytes_key(self, mask_modules):
with self.mock_memcache():
with conftest.reset_modules('celery.backends.cache'):
from celery.backends import cache
cache._imp = [None]
task_id, result = str_to_bytes(uuid()), 42
b = cache.CacheBackend(backend='memcache', app=self.app)
b.store_result(task_id, result, state=states.SUCCESS)
assert b.get_result(task_id) == result
def test_pylibmc_unicode_key(self):
with conftest.reset_modules('celery.backends.cache'):
with self.mock_pylibmc():
from celery.backends import cache
cache._imp = [None]
task_id, result = str(uuid()), 42
b = cache.CacheBackend(backend='memcache', app=self.app)
b.store_result(task_id, result, state=states.SUCCESS)
assert b.get_result(task_id) == result
def test_pylibmc_bytes_key(self):
with conftest.reset_modules('celery.backends.cache'):
with self.mock_pylibmc():
from celery.backends import cache
cache._imp = [None]
task_id, result = str_to_bytes(uuid()), 42
b = cache.CacheBackend(backend='memcache', app=self.app)
b.store_result(task_id, result, state=states.SUCCESS)
assert b.get_result(task_id) == result
|
