Source

wheezy.caching / src / wheezy / caching / tests / test_patterns.py

Full commit
  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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

""" Unit tests for ``wheezy.caching.patterns``.
"""

import unittest

from mock import ANY
from mock import Mock
from mock import patch


class OnePassTestCase(unittest.TestCase):

    def setUp(self):
        from wheezy.caching.patterns import OnePass
        self.mock_cache = Mock()
        self.one_pass = OnePass(self.mock_cache, 'key',
                                time=10, namespace='ns')

    def test_enter(self):
        """ Enter returns one_pass instance.
        """
        self.mock_cache.add.return_value = True
        assert self.one_pass == self.one_pass.__enter__()
        assert self.one_pass.acquired
        self.mock_cache.add.assert_called_once_with('key', ANY, 10, 'ns')

    def test_exit_acquired(self):
        """ Releases key if acquired.
        """
        self.mock_cache.add.return_value = True
        self.one_pass.__enter__()
        assert self.one_pass.acquired
        self.one_pass.__exit__(None, None, None)
        self.mock_cache.delete.assert_called_once_with('key', 'ns')
        assert not self.one_pass.acquired

    def test_exit_not_acquired(self):
        """ If one pass was not acquired, do not release key.
        """
        self.mock_cache.add.return_value = False
        self.one_pass.__enter__()
        assert not self.one_pass.acquired
        self.one_pass.__exit__(None, None, None)
        assert not self.mock_cache.delete.called

    @patch('wheezy.caching.patterns.sleep')
    def test_wait_no_marker(self, mock_sleep):
        """ Exit wait loop if there is no marker.
        """
        self.mock_cache.add.return_value = False
        self.one_pass.__enter__()
        assert not self.one_pass.acquired
        self.mock_cache.get.return_value = None
        assert True == self.one_pass.wait()

    @patch('wheezy.caching.patterns.sleep')
    def test_wait_timeout(self, mock_sleep):
        """ Exit wait loop if there is timeout reached.
        """
        self.mock_cache.add.return_value = False
        self.one_pass.__enter__()
        assert not self.one_pass.acquired
        self.mock_cache.get.return_value = 1
        assert False == self.one_pass.wait()


class GetOrAddTestCase(unittest.TestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_add(self, dependency_factory=None):
        from wheezy.caching.patterns import get_or_add as ga
        return ga('key', self.mock_create_factory, dependency_factory,
                  10, 'ns', self.mock_cache)

    def test_found(self):
        """ An item found in cache.
        """
        self.mock_cache.get.return_value = 'x'
        assert 'x' == self.get_or_add()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        assert not self.mock_create_factory.called

    def test_create_none(self):
        """ Create factory returned None.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = None

        assert not self.get_or_add()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_create_factory.assert_called_once_with()
        assert not self.mock_cache.add.called

    def test_add_failed(self):
        """ Attempt to add a value to cache failed.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = 'x'
        self.mock_cache.add.return_value = False

        assert 'x' == self.get_or_add()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_cache.add.assert_called_once_with('key', 'x', 10, 'ns')

    def test_has_dependency(self):
        """ There is specified `dependency_factory`.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = 'x'
        self.mock_cache.add.return_value = True
        mock_dependency_factory = Mock()

        assert 'x' == self.get_or_add(mock_dependency_factory)
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_cache.add.assert_called_once_with('key', 'x', 10, 'ns')
        mock_dependency_factory.return_value.add.assert_called_once_with(
            'key', 'ns')


class PartialGetOrAddTestCase(GetOrAddTestCase):

    @patch('wheezy.caching.patterns.get_or_add')
    def test_partial(self, mock_get_or_add):
        """ Ensure call defaults.
        """
        from wheezy.caching.patterns import partial_get_or_add
        cached = partial_get_or_add(
            'cache', time='time', namespace='namespace')

        cached('key', 'create_factory', 'dependency_factory')
        mock_get_or_add.assert_called_once_with(
            'key', 'create_factory', 'dependency_factory',
            'time', 'namespace', 'cache')


class WrapsGetOrAddTestCase(GetOrAddTestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_add(self, dependency_factory=None):
        from wheezy.caching.patterns import wraps_get_or_add as wga
        key_builder = lambda f: lambda *args, **kwargs: 'key'
        return wga(self.mock_cache, key_builder, 10, 'ns')(
            self.mock_create_factory)()

    def test_has_dependency(self):
        """ Not supported.
        """
        pass


class GetOrSetTestCase(unittest.TestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_set(self, dependency_factory=None):
        from wheezy.caching.patterns import get_or_set as gs
        return gs('key', self.mock_create_factory, dependency_factory,
                  10, 'ns', self.mock_cache)

    def test_found(self):
        """ An item found in cache.
        """
        self.mock_cache.get.return_value = 'x'
        assert 'x' == self.get_or_set()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        assert not self.mock_create_factory.called

    def test_create_none(self):
        """ Create factory returned None.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = None

        assert not self.get_or_set()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_create_factory.assert_called_once_with()
        assert not self.mock_cache.add.called

    def test_no_dependency(self):
        """ There is specified `dependency_factory`.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = 'x'
        self.mock_cache.set.return_value = True

        assert 'x' == self.get_or_set()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_cache.set.assert_called_once_with('key', 'x', 10, 'ns')

    def test_has_dependency(self):
        """ There is specified `dependency_factory`.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = 'x'
        self.mock_cache.set.return_value = True
        mock_dependency_factory = Mock()

        assert 'x' == self.get_or_set(mock_dependency_factory)
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        self.mock_cache.set.assert_called_once_with('key', 'x', 10, 'ns')
        mock_dependency_factory.return_value.add.assert_called_once_with(
            'key', 'ns')


class PartialGetOrSetTestCase(GetOrSetTestCase):

    @patch('wheezy.caching.patterns.get_or_set')
    def test_partial(self, mock_get_or_set):
        """ Ensure call defaults.
        """
        from wheezy.caching.patterns import partial_get_or_set
        cached = partial_get_or_set(
            'cache', time='time', namespace='namespace')

        cached('key', 'create_factory', 'dependency_factory')
        mock_get_or_set.assert_called_once_with(
            'key', 'create_factory', 'dependency_factory',
            'time', 'namespace', 'cache')


class WrapsGetOrSetTestCase(GetOrSetTestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_set(self, dependency_factory=None):
        from wheezy.caching.patterns import wraps_get_or_set as wgs
        key_builder = lambda f: lambda *args, **kwargs: 'key'
        return wgs(self.mock_cache, key_builder, 10, 'ns')(
            self.mock_create_factory)()

    def test_has_dependency(self):
        """ Not supported.
        """
        pass


class OnePassCreateTestCase(unittest.TestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def one_pass_create(self, dependency_factory=None):
        from wheezy.caching.patterns import one_pass_create as opc
        return opc('key', self.mock_create_factory, dependency_factory,
                   10, 'ns', self.mock_cache, 5)

    def test_create_none(self):
        """ One pass has been entered and create factory returns None.
        """
        self.mock_cache.add.return_value = True
        self.mock_create_factory.return_value = None
        assert not self.one_pass_create()

        self.mock_cache.add.assert_called_once_with(
            'one_pass:key', ANY, 5, 'ns')
        self.mock_create_factory.assert_called_once_with()
        assert not self.mock_cache.set.called
        self.mock_cache.delete.assert_called_once_with('one_pass:key', 'ns')

    def test_no_dependency(self):
        """ Create factory returned value.
        """
        self.mock_cache.add.return_value = True
        self.mock_create_factory.return_value = 'x'
        assert 'x' == self.one_pass_create()

        self.mock_cache.add.assert_called_once_with(
            'one_pass:key', ANY, 5, 'ns')
        self.mock_create_factory.assert_called_once_with()
        self.mock_cache.set.assert_called_once_with('key', 'x', 10, 'ns')
        self.mock_cache.delete.assert_called_once_with('one_pass:key', 'ns')

    def test_with_dependency(self):
        """ Create factory returned value.
        """
        self.mock_cache.add.return_value = True
        self.mock_create_factory.return_value = 'x'
        mock_dependency_factory = Mock()
        assert 'x' == self.one_pass_create(mock_dependency_factory)

        self.mock_cache.add.assert_called_once_with(
            'one_pass:key', ANY, 5, 'ns')
        self.mock_create_factory.assert_called_once_with()
        self.mock_cache.set.assert_called_once_with('key', 'x', 10, 'ns')
        self.mock_cache.delete.assert_called_once_with('one_pass:key', 'ns')
        mock_dependency_factory.return_value.add.assert_called_once_with(
            'key', 'ns')

    @patch('wheezy.caching.patterns.OnePass')
    def test_wait_timedout(self, mock_cls_one_pass):
        """ Wait on one pass has timed out.
        """
        mock_one_pass = mock_cls_one_pass.return_value
        self.mock_cache.add.return_value = False
        mock_one_pass.acquired = False
        mock_one_pass.wait.return_value = False

        assert not self.one_pass_create()

    @patch('wheezy.caching.patterns.OnePass')
    def test_wait_get(self, mock_cls_one_pass):
        """ Wait on one pass succeed, get value.
        """
        mock_one_pass = mock_cls_one_pass.return_value
        self.mock_cache.add.return_value = False
        mock_one_pass.acquired = False
        mock_one_pass.wait.return_value = True
        self.mock_cache.get.return_value = 'x'

        assert 'x' == self.one_pass_create()


class PartialOnePassCreateTestCase(unittest.TestCase):

    @patch('wheezy.caching.patterns.one_pass_create')
    def test_partial(self, mock_one_pass_create):
        """ Ensure call defaults.
        """
        from wheezy.caching.patterns import partial_one_pass_create
        cached = partial_one_pass_create(
            'cache', time='time', namespace='namespace',
            timeout='timeout', key_prefix='key_prefix')

        cached('key', 'create_factory', 'dependency_factory')
        mock_one_pass_create.assert_called_once_with(
            'key', 'create_factory', 'dependency_factory',
            'time', 'namespace', 'cache',
            'timeout', 'key_prefix')


class GetOrCreateTestCase(unittest.TestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_create(self):
        from wheezy.caching.patterns import get_or_create as gc
        return gc('key', self.mock_create_factory, None,
                  10, 'ns', self.mock_cache, 5)

    def test_found(self):
        """ An item found in cache.
        """
        self.mock_cache.get.return_value = 'x'
        assert 'x' == self.get_or_create()
        self.mock_cache.get.assert_called_once_with('key', 'ns')
        assert not self.mock_create_factory.called

    def test_not_found(self):
        """ Not found in cache.
        """
        self.mock_cache.get.return_value = None
        self.mock_create_factory.return_value = 'x'
        assert 'x' == self.get_or_create()
        self.mock_cache.get.assert_called_once_with('key', 'ns')

    def test_partial_found(self):
        """ An item found in cache.
        """
        from wheezy.caching.patterns import partial_get_or_create
        self.mock_cache.get.return_value = 'x'
        cached = partial_get_or_create(
            self.mock_cache, time='time', namespace='namespace',
            timeout='timeout', key_prefix='key_prefix')

        assert 'x' == cached('key', None)


class PartialGetOrCreateTestCase(GetOrCreateTestCase):

    @patch('wheezy.caching.patterns.one_pass_create')
    def test_partial(self, mock_one_pass_create):
        """ Ensure call defaults.
        """
        from wheezy.caching.patterns import partial_get_or_create
        self.mock_cache.get.return_value = None
        cached = partial_get_or_create(
            self.mock_cache, time='time', namespace='namespace',
            timeout='timeout', key_prefix='key_prefix')

        cached('key', 'create_factory', 'dependency_factory')
        mock_one_pass_create.assert_called_once_with(
            'key', 'create_factory', 'dependency_factory',
            'time', 'namespace', self.mock_cache,
            'timeout', 'key_prefix')


class WrapsGetOrCreateTestCase(GetOrCreateTestCase):

    def setUp(self):
        self.mock_cache = Mock()
        self.mock_create_factory = Mock()

    def get_or_create(self, dependency_factory=None):
        from wheezy.caching.patterns import wraps_get_or_create as wgc
        key_builder = lambda f: lambda *args, **kwargs: 'key'
        return wgc(self.mock_cache, key_builder, 10, 'ns', 5)(
            self.mock_create_factory)()


class KeyBuilderTestCase(unittest.TestCase):

    def setUp(self):
        from wheezy.caching.patterns import key_builder
        self.mk = key_builder('prefix')

    def test_noargs(self):
        def items():
            pass
        assert 'prefix-items' == self.mk(items)()

    def test_args(self):
        def items(x, y):
            pass
        assert "prefix-items:'None':None" == self.mk(items)('None', None)

    def test_defaults(self):
        def items(x, y=''):
            pass
        assert "prefix-items:1:''" == self.mk(items)(1)
        assert "prefix-items:1:'s'" == self.mk(items)(1, y='s')
        assert "prefix-items:1:2" == self.mk(items)(1, y=2)

    def test_sepecial(self):
        def items(cls, y):
            pass
        assert 'prefix-items:1' == self.mk(items)('cls', 1)
        assert 'prefix-items:None' == self.mk(items)('cls', None)
        assert "prefix-items:''" == self.mk(items)('cls', '')