vmware-nsx/vmware_nsx/shell/admin/plugins/common/utils.py

115 lines
3.7 KiB
Python

# Copyright 2015 VMware, Inc. All 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 sys
import six
from vmware_nsx._i18n import _
from vmware_nsx.shell import resources as nsxadmin
from neutron.common import profiler # noqa
from neutron_lib.callbacks import registry
from oslo_log import log as logging
LOG = logging.getLogger(__name__)
def output_header(func):
"""Decorator to demarcate the output of various hooks.
Based on the callback function name we add a header to the
cli output. Callback name's should follow the convention of
component_operation_it_does to leverage the decorator
"""
def func_desc(*args, **kwargs):
component = '[%s]' % func.__name__.split('_')[0].upper()
op_desc = [n.capitalize() for n in func.__name__.split('_')[1:]]
LOG.info('==== %(component)s %(operation)s ====',
{'component': component, 'operation': ' '.join(op_desc)})
return func(*args, **kwargs)
func_desc.__name__ = func.__name__
return func_desc
def parse_multi_keyval_opt(opt_list):
"""Converts a MutliStrOpt to a key-value dict"""
result = dict()
opt_list = opt_list if opt_list else []
for opt_value in opt_list:
try:
key, value = opt_value.split('=')
result[key] = value
except ValueError:
raise ValueError(_("Illegal argument [%s]: input should have the "
"format of '--property key=value'") % opt_value)
return result
def query_yes_no(question, default="yes"):
"""Ask a yes/no question via raw_input() and return their answer.
"question" is a string that is presented to the user.
"default" is the presumed answer if the user just hits <Enter>.
It must be "yes" (the default), "no" or None (meaning
an answer is required of the user).
The "answer" return value is True for "yes" or False for "no".
"""
valid = {"yes": True, "y": True, "ye": True,
"no": False, "n": False}
if default is None:
prompt = " [y/n] "
elif default == "yes":
prompt = " [Y/n] "
elif default == "no":
prompt = " [y/N] "
else:
raise ValueError(_("invalid default answer: '%s'") % default)
while True:
sys.stdout.write(question + prompt)
choice = six.moves.input().lower()
if default is not None and choice == '':
return valid[default]
elif choice in valid:
return valid[choice]
else:
sys.stdout.write("Please respond with 'yes' or 'no' "
"(or 'y' or 'n').\n")
def list_handler(resource):
def wrap(func):
registry.subscribe(func, resource,
nsxadmin.Operations.LIST.value)
return func
return wrap
def list_mismatches_handler(resource):
def wrap(func):
registry.subscribe(func, resource,
nsxadmin.Operations.LIST_MISMATCHES.value)
return func
return wrap
def fix_mismatches_handler(resource):
def wrap(func):
registry.subscribe(func, resource,
nsxadmin.Operations.FIX_MISMATCH.value)
return func
return wrap