masakari-monitors/masakarimonitors/conf/base.py
poojajadhav b18793c672 Return user-friendly error message when monkey_patch enabled
If user has enabled “monkey_patch” config option and kept the default
“monkey_patch_modules” config option as is, then service gives
ValueError at the time of starting itself. The default value given to
the “monkey_patch_modules” config option is not according to the format
expected which results into ValueError at service starting.

This patch fixes this issue by making monkey_patch_modules's correct
default value and if user wants to apply monkey patching then syntax
must be correct so handled that value error.

Closes-Bug: #1660545
Change-Id: I637a36eacdabca8c4edbba201d491744690869ef
2017-02-14 19:34:36 +05:30

55 lines
1.4 KiB
Python

# Copyright(c) 2016 Nippon Telegraph and Telephone Corporation
#
# 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.
from oslo_config import cfg
base_options = [
cfg.StrOpt(
'tempdir',
help='Explicitly specify the temporary working directory.'),
cfg.BoolOpt(
'monkey_patch',
default=False,
help="""
Determine if monkey patching should be applied.
Related options:
* ``monkey_patch_modules``: This must have values set for this option to have
any effect
"""),
cfg.ListOpt(
'monkey_patch_modules',
default=[],
help="""
List of modules/decorators to monkey patch.
This option allows you to patch a decorator for all functions in specified
modules.
Related options:
* ``monkey_patch``: This must be set to ``True`` for this option to
have any effect
"""),
]
def register_opts(conf):
conf.register_opts(base_options)
def list_opts():
return {'DEFAULT': base_options}