91 lines
3.0 KiB
Python
91 lines
3.0 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# 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 collections
|
|
import importlib
|
|
import os
|
|
import pkgutil
|
|
|
|
LIST_OPTS_FUNC_NAME = "list_opts"
|
|
IGNORED_MODULES = ('opts', 'constants', 'utils')
|
|
CONFIG_PATH = 'shipyard_airflow.conf'
|
|
|
|
|
|
class ConfigSection(object):
|
|
"""
|
|
Defines a configuration section
|
|
"""
|
|
|
|
def __init__(self, name, title, options, help=None):
|
|
self.name = name
|
|
self.title = title
|
|
self.help = help
|
|
self.options = options
|
|
|
|
|
|
def _tupleize(dct):
|
|
"""Take the dict of options and convert to the 2-tuple format."""
|
|
return [(key, val) for key, val in dct.items()]
|
|
|
|
|
|
def list_opts():
|
|
"""Entry point used only in the context of sample file generation.
|
|
This is the single point of entry to generate the sample configuration
|
|
file. It 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
|
|
return 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 {program}.conf package doesn't have further packages with config
|
|
options
|
|
"""
|
|
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 _list_module_names():
|
|
module_names = []
|
|
package_path = os.path.dirname(os.path.abspath(__file__))
|
|
for _, modname, ispkg in pkgutil.iter_modules(path=[package_path]):
|
|
if modname in IGNORED_MODULES or ispkg:
|
|
continue
|
|
else:
|
|
module_names.append(modname)
|
|
return module_names
|
|
|
|
|
|
def _import_modules(module_names):
|
|
imported_modules = []
|
|
for modname in module_names:
|
|
mod = importlib.import_module(CONFIG_PATH + '.' + modname)
|
|
if not hasattr(mod, LIST_OPTS_FUNC_NAME):
|
|
msg = "The module '%s.%s' should have a '%s' "\
|
|
"function which returns the config options." % \
|
|
(CONFIG_PATH, modname, LIST_OPTS_FUNC_NAME)
|
|
raise Exception(msg)
|
|
else:
|
|
imported_modules.append(mod)
|
|
return imported_modules
|
|
|
|
|
|
def _append_config_options(imported_modules, config_options):
|
|
for mod in imported_modules:
|
|
configs = mod.list_opts()
|
|
for key, val in configs.items():
|
|
config_options[key].extend(val)
|