d9c6b50a3a
keystone.common.config is 1200+ lines of super dense, merge-conflict prone, difficult to navigate, and finicky to maintain code. Let's follow nova's lead and break it down into more manageable modules. This patch creates a new Python package, keystone.conf, and moves all of our configuration options into it, mirroring nova's nova.conf package. There are a couple special modules in keystone.conf introduced here as well: - keystone.conf.__init__: This causes all of Keystone options to be registered on import, so consumers of keystone.conf don't have races with config initialization code while trying to use oslo_config.cfg.CONF directly (keystone.conf replaces all uses for oslo_config.cfg.CONF in keystone). - keystone.conf.base: Keystone's [DEFAULT] group options. I'd prefer this to be called 'default.py', but I'm just copying nova's lead here. - keystone.conf.opts: The entry point for oslo.config itself. - keystone.conf.constants: There are a few constants (deprecation messages, default paths, etc) that are used by multiple configuration modules, so they need to live in a common place. Change-Id: Ia3daffe3fef111b42de203762e966cd14d8927e2
98 lines
3.2 KiB
Python
98 lines
3.2 KiB
Python
# 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.
|
|
|
|
"""Single point of entry to generate the sample configuration file.
|
|
|
|
This module collects all the necessary info from the other modules in this
|
|
package. It is assumed that:
|
|
|
|
* Every other module in this package has a 'list_opts' function which
|
|
returns a dict where:
|
|
|
|
* The keys are strings which are the group names.
|
|
|
|
* The value of each key is a list of config options for that group.
|
|
|
|
* The conf package doesn't have further packages with config options.
|
|
|
|
* This module is only used in the context of sample file generation.
|
|
|
|
"""
|
|
|
|
import collections
|
|
import importlib
|
|
import os
|
|
import pkgutil
|
|
|
|
|
|
LIST_OPTS_FUNC_NAME = 'list_opts'
|
|
IGNORED_MODULES = ('opts', 'constants', 'utils')
|
|
|
|
|
|
def list_opts():
|
|
opts = collections.defaultdict(list)
|
|
module_names = _list_module_names()
|
|
imported_modules = _import_modules(module_names)
|
|
_append_config_options(imported_modules, opts)
|
|
return _tupleize(opts)
|
|
|
|
|
|
def _tupleize(d):
|
|
"""Convert a dict of options to the 2-tuple format."""
|
|
return [(key, value) for key, value in d.items()]
|
|
|
|
|
|
def _list_module_names():
|
|
module_names = []
|
|
package_path = os.path.dirname(os.path.abspath(__file__))
|
|
for _, module_name, ispkg in pkgutil.iter_modules(path=[package_path]):
|
|
if module_name in IGNORED_MODULES or ispkg:
|
|
# Skip this module.
|
|
continue
|
|
else:
|
|
module_names.append(module_name)
|
|
return module_names
|
|
|
|
|
|
def _import_modules(module_names):
|
|
imported_modules = []
|
|
for module_name in module_names:
|
|
full_module_path = '.'.join(__name__.split('.')[:-1] + [module_name])
|
|
module = importlib.import_module(full_module_path)
|
|
if not hasattr(module, LIST_OPTS_FUNC_NAME):
|
|
raise Exception(
|
|
"The module '%s' should have a '%s' function which "
|
|
"returns the config options." % (
|
|
full_module_path,
|
|
LIST_OPTS_FUNC_NAME))
|
|
else:
|
|
imported_modules.append(module)
|
|
return imported_modules
|
|
|
|
|
|
def _process_old_opts(configs):
|
|
"""Convert old-style 2-tuple configs to dicts."""
|
|
if isinstance(configs, tuple):
|
|
configs = [configs]
|
|
return {label: options for label, options in configs}
|
|
|
|
|
|
def _append_config_options(imported_modules, config_options):
|
|
for module in imported_modules:
|
|
configs = module.list_opts()
|
|
# TODO(markus_z): Remove this compatibility shim once all list_opts()
|
|
# functions have been updated to return dicts.
|
|
if not isinstance(configs, dict):
|
|
configs = _process_old_opts(configs)
|
|
for key, val in configs.items():
|
|
config_options[key].extend(val)
|