openstack/oslo.cache
Code Issues Proposed changes

Don't use global conf

Browse Source 
The library shouldn't be using the global CONF object and instead
allow the application to use whatever conf it wants to.

Change-Id: Ia2c6d9694033d71ebf9edc912571341f76986b89
Closes-Bug: 1469830
This commit is contained in:
Brant Knudson 2015-06-30 20:03:14 -05:00 committed by Steve Martinelli
parent b59623d6f9
commit 008af8e68d
4 changed files with 53 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
oslo_cache/_opts.py
View File

@ -95,13 +95,7 @@ FILE_OPTIONS = {
} }
CONF = cfg.CONF def configure(conf):
def configure(conf=None):
if conf is None:
conf = CONF
for section in FILE_OPTIONS: for section in FILE_OPTIONS:
for option in FILE_OPTIONS[section]: for option in FILE_OPTIONS[section]:
conf.register_opt(option, group=section) conf.register_opt(option, group=section)

53
oslo_cache/core.py
View File

@ -17,7 +17,6 @@
import dogpile.cache import dogpile.cache
from dogpile.cache import proxy from dogpile.cache import proxy
from dogpile.cache import util from dogpile.cache import util
from oslo_config import cfg
from oslo_log import log from oslo_log import log
from oslo_utils import importutils from oslo_utils import importutils
@ -33,7 +32,6 @@ __all__ = [
'REGION', 'REGION',
] ]
_CONF = cfg.CONF
_LOG = log.getLogger(__name__) _LOG = log.getLogger(__name__)
_make_region = dogpile.cache.make_region _make_region = dogpile.cache.make_region
@ -92,16 +90,16 @@ class _DebugProxy(proxy.ProxyBackend):
self.proxied.delete_multi(keys) self.proxied.delete_multi(keys)
def _build_cache_config(): def _build_cache_config(conf):
"""Build the cache region dictionary configuration. """Build the cache region dictionary configuration.
:returns: dict :returns: dict
""" """
prefix = _CONF.cache.config_prefix prefix = conf.cache.config_prefix
conf_dict = {} conf_dict = {}
conf_dict['%s.backend' % prefix] = _CONF.cache.backend conf_dict['%s.backend' % prefix] = conf.cache.backend
conf_dict['%s.expiration_time' % prefix] = _CONF.cache.expiration_time conf_dict['%s.expiration_time' % prefix] = conf.cache.expiration_time
for argument in _CONF.cache.backend_argument: for argument in conf.cache.backend_argument:
try: try:
(argname, argvalue) = argument.split(':', 1) (argname, argvalue) = argument.split(':', 1)
except ValueError: except ValueError:
@ -118,10 +116,10 @@ def _build_cache_config():
# backends. Use setdefault for url to support old-style setting through # backends. Use setdefault for url to support old-style setting through
# backend_argument=url:127.0.0.1:11211 # backend_argument=url:127.0.0.1:11211
conf_dict.setdefault('%s.arguments.url' % prefix, conf_dict.setdefault('%s.arguments.url' % prefix,
_CONF.cache.memcache_servers) conf.cache.memcache_servers)
for arg in ('dead_retry', 'socket_timeout', 'pool_maxsize', for arg in ('dead_retry', 'socket_timeout', 'pool_maxsize',
'pool_unused_timeout', 'pool_connection_get_timeout'): 'pool_unused_timeout', 'pool_connection_get_timeout'):
value = getattr(_CONF.cache, 'memcache_' + arg) value = getattr(conf.cache, 'memcache_' + arg)
conf_dict['%s.arguments.%s' % (prefix, arg)] = value conf_dict['%s.arguments.%s' % (prefix, arg)] = value
return conf_dict return conf_dict
@ -142,7 +140,7 @@ def _sha1_mangle_key(key):
return util.sha1_mangle_key(key) return util.sha1_mangle_key(key)
def configure_cache_region(region): def configure_cache_region(region, conf):
"""Configure a cache region. """Configure a cache region.
If the cache region is already configured, this function does nothing. If the cache region is already configured, this function does nothing.
@ -150,6 +148,8 @@ def configure_cache_region(region):
:param region: Cache region to configure :param region: Cache region to configure
:type region: dogpile.cache.CacheRegion :type region: dogpile.cache.CacheRegion
:param conf: config object, must have had :func:`configure` called on it.
:type conf: oslo_config.cfg.ConfigOpts
:raises oslo_cache.exception.ConfigurationError: If the region parameter is :raises oslo_cache.exception.ConfigurationError: If the region parameter is
not a dogpile.cache.CacheRegion. not a dogpile.cache.CacheRegion.
:returns: The region. :returns: The region.
@ -163,11 +163,11 @@ def configure_cache_region(region):
# There is a request logged with dogpile.cache upstream to make this # There is a request logged with dogpile.cache upstream to make this
# easier / less ugly. # easier / less ugly.
config_dict = _build_cache_config() config_dict = _build_cache_config(conf)
region.configure_from_config(config_dict, region.configure_from_config(config_dict,
'%s.' % _CONF.cache.config_prefix) '%s.' % conf.cache.config_prefix)
if _CONF.cache.debug_cache_backend: if conf.cache.debug_cache_backend:
region.wrap(_DebugProxy) region.wrap(_DebugProxy)
# NOTE(morganfainberg): if the backend requests the use of a # NOTE(morganfainberg): if the backend requests the use of a
@ -178,7 +178,7 @@ def configure_cache_region(region):
if region.key_mangler is None: if region.key_mangler is None:
region.key_mangler = _sha1_mangle_key region.key_mangler = _sha1_mangle_key
for class_path in _CONF.cache.proxies: for class_path in conf.cache.proxies:
# NOTE(morganfainberg): if we have any proxy wrappers, we should # NOTE(morganfainberg): if we have any proxy wrappers, we should
# ensure they are added to the cache region's backend. Since # ensure they are added to the cache region's backend. Since
# configure_from_config doesn't handle the wrap argument, we need # configure_from_config doesn't handle the wrap argument, we need
@ -192,7 +192,7 @@ def configure_cache_region(region):
return region return region
def _get_should_cache_fn(section): def _get_should_cache_fn(conf, section):
"""Build a function that returns a config section's caching status. """Build a function that returns a config section's caching status.
For any given object that has caching capabilities, a boolean config option For any given object that has caching capabilities, a boolean config option
@ -203,19 +203,21 @@ def _get_should_cache_fn(section):
Pass the new variable to the caching decorator as the named argument Pass the new variable to the caching decorator as the named argument
``should_cache_fn``. ``should_cache_fn``.
:param conf: config object, must have had :func:`configure` called on it.
:type conf: oslo_config.cfg.ConfigOpts
:param section: name of the configuration section to examine :param section: name of the configuration section to examine
:type section: string :type section: string
:returns: function reference :returns: function reference
""" """
def should_cache(value): def should_cache(value):
if not _CONF.cache.enabled: if not conf.cache.enabled:
return False return False
conf_group = getattr(_CONF, section) conf_group = getattr(conf, section)
return getattr(conf_group, 'caching', True) return getattr(conf_group, 'caching', True)
return should_cache return should_cache
def _get_expiration_time_fn(section): def _get_expiration_time_fn(conf, section):
"""Build a function that returns a config section's expiration time status. """Build a function that returns a config section's expiration time status.
For any given object that has caching capabilities, an int config option For any given object that has caching capabilities, an int config option
@ -237,7 +239,7 @@ def _get_expiration_time_fn(section):
:rtype: function reference :rtype: function reference
""" """
def get_expiration_time(): def get_expiration_time():
conf_group = getattr(_CONF, section) conf_group = getattr(conf, section)
return getattr(conf_group, 'cache_time', None) return getattr(conf_group, 'cache_time', None)
return get_expiration_time return get_expiration_time
@ -264,7 +266,7 @@ REGION = dogpile.cache.make_region(
_on_arguments = REGION.cache_on_arguments _on_arguments = REGION.cache_on_arguments
def get_memoization_decorator(section, expiration_section=None): def get_memoization_decorator(conf, section, expiration_section=None):
"""Build a function based on the `_on_arguments` decorator for the section. """Build a function based on the `_on_arguments` decorator for the section.
For any given object that has caching capabilities, a pair of functions is For any given object that has caching capabilities, a pair of functions is
@ -277,7 +279,8 @@ def get_memoization_decorator(section, expiration_section=None):
import oslo_cache.core import oslo_cache.core
MEMOIZE = oslo_cache.core.get_memoization_decorator(section='section1') MEMOIZE = oslo_cache.core.get_memoization_decorator(conf,
section='section1')
@MEMOIZE @MEMOIZE
def function(arg1, arg2): def function(arg1, arg2):
@ -285,12 +288,14 @@ def get_memoization_decorator(section, expiration_section=None):
ALTERNATE_MEMOIZE = oslo_cache.core.get_memoization_decorator( ALTERNATE_MEMOIZE = oslo_cache.core.get_memoization_decorator(
section='section2', expiration_section='section3') conf, section='section2', expiration_section='section3')
@ALTERNATE_MEMOIZE @ALTERNATE_MEMOIZE
def function2(arg1, arg2): def function2(arg1, arg2):
... ...
:param conf: config object, must have had :func:`configure` called on it.
:type conf: oslo_config.cfg.ConfigOpts
:param section: name of the configuration section to examine :param section: name of the configuration section to examine
:type section: string :type section: string
:param expiration_section: name of the configuration section to examine :param expiration_section: name of the configuration section to examine
@ -302,8 +307,8 @@ def get_memoization_decorator(section, expiration_section=None):
""" """
if expiration_section is None: if expiration_section is None:
expiration_section = section expiration_section = section
should_cache = _get_should_cache_fn(section) should_cache = _get_should_cache_fn(conf, section)
expiration_time = _get_expiration_time_fn(expiration_section) expiration_time = _get_expiration_time_fn(conf, expiration_section)
memoize = REGION.cache_on_arguments(should_cache_fn=should_cache, memoize = REGION.cache_on_arguments(should_cache_fn=should_cache,
expiration_time=expiration_time) expiration_time=expiration_time)

5
oslo_cache/tests/__init__.py
View File

@ -12,4 +12,7 @@
from oslo_cache import _opts from oslo_cache import _opts
_opts.configure() from oslo_config import cfg
_opts.configure(cfg.CONF)

43
oslo_cache/tests/test_cache.py
View File

@ -28,7 +28,6 @@ from oslo_cache import exception
from oslo_config import fixture as config_fixture from oslo_config import fixture as config_fixture
CONF = cfg.CONF
NO_VALUE = api.NO_VALUE NO_VALUE = api.NO_VALUE
TEST_GROUP = uuid.uuid4().hex TEST_GROUP = uuid.uuid4().hex
TEST_GROUP2 = uuid.uuid4().hex TEST_GROUP2 = uuid.uuid4().hex
@ -37,15 +36,7 @@ TEST_GROUP2 = uuid.uuid4().hex
class BaseTestCase(base.BaseTestCase): class BaseTestCase(base.BaseTestCase):
def setUp(self): def setUp(self):
super(BaseTestCase, self).setUp() super(BaseTestCase, self).setUp()
self.config_fixture = self.useFixture(config_fixture.Config())
self.addCleanup(CONF.reset)
self.config_fixture = self.useFixture(config_fixture.Config(CONF))
self.addCleanup(delattr, self, 'config_fixture')
self.config_overrides()
def config_overrides(self):
self.config_fixture.config( self.config_fixture.config(
# TODO(morganfainberg): Make Cache Testing a separate test case # TODO(morganfainberg): Make Cache Testing a separate test case
# in tempest, and move it out of the base unit tests. # in tempest, and move it out of the base unit tests.
@ -104,7 +95,7 @@ class CacheRegionTest(BaseTestCase):
def setUp(self): def setUp(self):
super(CacheRegionTest, self).setUp() super(CacheRegionTest, self).setUp()
self.region = cache._make_region() self.region = cache._make_region()
cache.configure_cache_region(self.region) cache.configure_cache_region(self.region, self.config_fixture.conf)
self.region.wrap(TestProxy) self.region.wrap(TestProxy)
self.test_value = TestProxyValue('Decorator Test') self.test_value = TestProxyValue('Decorator Test')
@ -121,7 +112,8 @@ class CacheRegionTest(BaseTestCase):
def _get_cacheable_function(self): def _get_cacheable_function(self):
with mock.patch.object(cache.REGION, 'cache_on_arguments', with mock.patch.object(cache.REGION, 'cache_on_arguments',
self.region.cache_on_arguments): self.region.cache_on_arguments):
memoize = cache.get_memoization_decorator(section='cache') memoize = cache.get_memoization_decorator(self.config_fixture.conf,
section='cache')
@memoize @memoize
def cacheable_function(value): def cacheable_function(value):
@ -138,13 +130,14 @@ class CacheRegionTest(BaseTestCase):
def test_cache_region_no_error_multiple_config(self): def test_cache_region_no_error_multiple_config(self):
# Verify configuring the CacheRegion again doesn't error. # Verify configuring the CacheRegion again doesn't error.
cache.configure_cache_region(self.region) cache.configure_cache_region(self.region, self.config_fixture.conf)
cache.configure_cache_region(self.region) cache.configure_cache_region(self.region, self.config_fixture.conf)
def _get_cache_fallthrough_fn(self, cache_time): def _get_cache_fallthrough_fn(self, cache_time):
with mock.patch.object(cache.REGION, 'cache_on_arguments', with mock.patch.object(cache.REGION, 'cache_on_arguments',
self.region.cache_on_arguments): self.region.cache_on_arguments):
memoize = cache.get_memoization_decorator( memoize = cache.get_memoization_decorator(
self.config_fixture.conf,
section='cache', section='cache',
expiration_section=TEST_GROUP2) expiration_section=TEST_GROUP2)
@ -190,7 +183,8 @@ class CacheRegionTest(BaseTestCase):
# this value is set the same as the expiration_time default in the # this value is set the same as the expiration_time default in the
# [cache] section # [cache] section
cache_time = 600 cache_time = 600
expiration_time = cache._get_expiration_time_fn(TEST_GROUP) expiration_time = cache._get_expiration_time_fn(
self.config_fixture.conf, TEST_GROUP)
do_test = self._get_cache_fallthrough_fn(cache_time) do_test = self._get_cache_fallthrough_fn(cache_time)
# Run the test with the dummy group cache_time value # Run the test with the dummy group cache_time value
self.config_fixture.config(cache_time=cache_time, self.config_fixture.config(cache_time=cache_time,
@ -205,7 +199,8 @@ class CacheRegionTest(BaseTestCase):
# this value is set the same as the expiration_time default in the # this value is set the same as the expiration_time default in the
# [cache] section # [cache] section
cache_time = 599 cache_time = 599
expiration_time = cache._get_expiration_time_fn(TEST_GROUP) expiration_time = cache._get_expiration_time_fn(
self.config_fixture.conf, TEST_GROUP)
do_test = self._get_cache_fallthrough_fn(cache_time) do_test = self._get_cache_fallthrough_fn(cache_time)
# Run the test with the dummy group cache_time value set to None and # Run the test with the dummy group cache_time value set to None and
# the global value set. # the global value set.
@ -286,11 +281,12 @@ class CacheRegionTest(BaseTestCase):
'arg2:test:test', 'arg2:test:test',
'arg3.invalid']) 'arg3.invalid'])
config_dict = cache._build_cache_config() config_dict = cache._build_cache_config(self.config_fixture.conf)
self.assertEqual( self.assertEqual(
CONF.cache.backend, config_dict['test_prefix.backend']) self.config_fixture.conf.cache.backend,
config_dict['test_prefix.backend'])
self.assertEqual( self.assertEqual(
CONF.cache.expiration_time, self.config_fixture.conf.cache.expiration_time,
config_dict['test_prefix.expiration_time']) config_dict['test_prefix.expiration_time'])
self.assertEqual('test', config_dict['test_prefix.arguments.arg1']) self.assertEqual('test', config_dict['test_prefix.arguments.arg1'])
self.assertEqual('test:test', self.assertEqual('test:test',
@ -321,6 +317,7 @@ class CacheRegionTest(BaseTestCase):
def test_configure_non_region_object_raises_error(self): def test_configure_non_region_object_raises_error(self):
self.assertRaises(exception.ConfigurationError, self.assertRaises(exception.ConfigurationError,
cache.configure_cache_region, cache.configure_cache_region,
self.config_fixture.conf,
"bogus") "bogus")
@ -346,14 +343,12 @@ class CacheNoopBackendTest(BaseTestCase):
def setUp(self): def setUp(self):
super(CacheNoopBackendTest, self).setUp() super(CacheNoopBackendTest, self).setUp()
self.region = cache._make_region()
cache.configure_cache_region(self.region)
def config_overrides(self):
super(CacheNoopBackendTest, self).config_overrides()
self.config_fixture.config(group='cache', self.config_fixture.config(group='cache',
backend='oslo_cache.noop') backend='oslo_cache.noop')
self.region = cache._make_region()
cache.configure_cache_region(self.region, self.config_fixture.conf)
def test_noop_backend(self): def test_noop_backend(self):
single_value = 'Test Value' single_value = 'Test Value'
single_key = 'testkey' single_key = 'testkey'