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

""" 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')

    @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 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_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')

    @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 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()

    @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)

    @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 KeyBuilderTestCase(unittest.TestCase):

    def setUp(self):
        from wheezy.caching.patterns import args_key_builder
        self.mk = args_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', '')
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.