Source code for keystone.tests.unit.common.test_cache

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

import uuid

from dogpile.cache import api as dogpile
from dogpile.cache.backends import memory
from oslo_config import fixture as config_fixture

from keystone.common import cache
import keystone.conf
from keystone.tests import unit


CONF = keystone.conf.CONF


[docs]class TestCacheRegion(unit.BaseTestCase):

[docs]    def setUp(self):
        super(TestCacheRegion, self).setUp()
        self.config_fixture = self.useFixture(config_fixture.Config(CONF))
        self.config_fixture.config(
            # TODO(morganfainberg): Make Cache Testing a separate test case
            # in tempest, and move it out of the base unit tests.
            group='cache',
            backend='dogpile.cache.memory')

        # replace existing backend since this may already be configured
        cache.CACHE_INVALIDATION_REGION.configure(
            backend='dogpile.cache.memory',
            expiration_time=None,
            replace_existing_backend=True)

        self.region_name = uuid.uuid4().hex
        self.region0 = cache.create_region('test_region')
        self.region1 = cache.create_region('test_region')
        cache.configure_cache(region=self.region0)
        cache.configure_cache(region=self.region1)

        # TODO(dstanek): this should be a mock entrypoint
        self.cache_dict = {}
        self.backend = memory.MemoryBackend({'cache_dict': self.cache_dict})
        self.region0.backend = self.backend
        self.region1.backend = self.backend

    def _assert_has_no_value(self, values):
        for value in values:
            self.assertIsInstance(value, dogpile.NoValue)

[docs]    def test_singular_methods_when_invalidating_the_region(self):
        key = uuid.uuid4().hex
        value = uuid.uuid4().hex

        # key does not exist
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)
        # make it exist
        self.region0.set(key, value)
        # ensure it exists
        self.assertEqual(value, self.region0.get(key))

        # invalidating region1 should invalidate region0
        self.region1.invalidate()
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)

[docs]    def test_region_singular_methods_delete(self):
        key = uuid.uuid4().hex
        value = uuid.uuid4().hex

        # key does not exist
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)
        # make it exist
        self.region0.set(key, value)
        # ensure it exists
        self.assertEqual(value, self.region0.get(key))
        # delete it
        self.region1.delete(key)
        # ensure it's gone
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)

[docs]    def test_multi_methods_when_invalidating_the_region(self):
        mapping = {uuid.uuid4().hex: uuid.uuid4().hex for _ in range(4)}
        keys = list(mapping.keys())
        values = [mapping[k] for k in keys]

        # keys do not exist
        self._assert_has_no_value(self.region0.get_multi(keys))
        # make them exist
        self.region0.set_multi(mapping)
        # ensure they exist
        self.assertEqual(values, self.region0.get_multi(keys))
        # check using the singular get method for completeness
        self.assertEqual(mapping[keys[0]], self.region0.get(keys[0]))

        # invalidating region1 should invalidate region0
        self.region1.invalidate()
        # ensure they are gone
        self._assert_has_no_value(self.region0.get_multi(keys))

[docs]    def test_region_multi_methods_delete(self):
        mapping = {uuid.uuid4().hex: uuid.uuid4().hex for _ in range(4)}
        keys = list(mapping.keys())
        values = [mapping[k] for k in keys]

        # keys do not exist
        self._assert_has_no_value(self.region0.get_multi(keys))
        # make them exist
        self.region0.set_multi(mapping)
        # ensure they exist
        keys = list(mapping.keys())
        self.assertEqual(values, self.region0.get_multi(keys))
        # check using the singular get method for completeness
        self.assertEqual(mapping[keys[0]], self.region0.get(keys[0]))

        # delete them
        self.region1.delete_multi(mapping.keys())
        # ensure they are gone
        self._assert_has_no_value(self.region0.get_multi(keys))

[docs]    def test_memoize_decorator_when_invalidating_the_region(self):
        memoize = cache.get_memoization_decorator('cache', region=self.region0)

        @memoize
        def func(value):
            return value + uuid.uuid4().hex

        key = uuid.uuid4().hex

        # test get/set
        return_value = func(key)
        # the values should be the same since it comes from the cache
        self.assertEqual(return_value, func(key))

        # invalidating region1 should invalidate region0
        self.region1.invalidate()
        new_value = func(key)
        self.assertNotEqual(return_value, new_value)

[docs]    def test_combination(self):
        memoize = cache.get_memoization_decorator('cache', region=self.region0)

        @memoize
        def func(value):
            return value + uuid.uuid4().hex

        key = uuid.uuid4().hex
        simple_value = uuid.uuid4().hex

        # test get/set using the decorator
        return_value = func(key)
        self.assertEqual(return_value, func(key))

        # test get/set using the singular methods
        self.region0.set(key, simple_value)
        self.assertEqual(simple_value, self.region0.get(key))

        # invalidating region1 should invalidate region0
        self.region1.invalidate()

        # ensure that the decorated function returns a new value
        new_value = func(key)
        self.assertNotEqual(return_value, new_value)

        # ensure that a get doesn't have a value
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)

[docs]    def test_direct_region_key_invalidation(self):
        """Invalidate by manually clearing the region key's value.

        NOTE(dstanek): I normally don't like tests that repeat application
        logic, but in this case we need to. There are too many ways that
        the tests above can erroneosly pass that we need this sanity check.
        """
        region_key = cache.RegionInvalidationManager(
            None, self.region0.name)._region_key
        key = uuid.uuid4().hex
        value = uuid.uuid4().hex

        # key does not exist
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)
        # make it exist
        self.region0.set(key, value)
        # ensure it exists
        self.assertEqual(value, self.region0.get(key))

        # test invalidation
        cache.CACHE_INVALIDATION_REGION.delete(region_key)
        self.assertIsInstance(self.region0.get(key), dogpile.NoValue)