191 lines
5.7 KiB
Python
191 lines
5.7 KiB
Python
# Copyright (c) 2014 EMC Corporation.
|
|
# 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 types
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from oslo_utils import fnmatch
|
|
from oslo_utils import netutils
|
|
from oslo_utils import timeutils
|
|
from oslo_utils import units
|
|
import ssl
|
|
|
|
CONF = cfg.CONF
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
def decorate_all_methods(decorator, debug_only=False):
|
|
if debug_only and not CONF.debug:
|
|
return lambda cls: cls
|
|
|
|
def _decorate_all_methods(cls):
|
|
for attr_name, attr_val in cls.__dict__.items():
|
|
if (isinstance(attr_val, types.FunctionType) and
|
|
not attr_name.startswith("_")):
|
|
setattr(cls, attr_name, decorator(attr_val))
|
|
return cls
|
|
|
|
return _decorate_all_methods
|
|
|
|
|
|
def log_enter_exit(func):
|
|
if not CONF.debug:
|
|
return func
|
|
|
|
def inner(self, *args, **kwargs):
|
|
LOG.debug("Entering %(cls)s.%(method)s.",
|
|
{'cls': self.__class__.__name__,
|
|
'method': func.__name__})
|
|
start = timeutils.utcnow()
|
|
ret = func(self, *args, **kwargs)
|
|
end = timeutils.utcnow()
|
|
LOG.debug("Exiting %(cls)s.%(method)s. "
|
|
"Spent %(duration)s sec. "
|
|
"Return %(return)s.",
|
|
{'cls': self.__class__.__name__,
|
|
'duration': timeutils.delta_seconds(start, end),
|
|
'method': func.__name__,
|
|
'return': ret})
|
|
return ret
|
|
|
|
return inner
|
|
|
|
|
|
def do_match_any(full, matcher_list):
|
|
"""Finds items that match any of the matchers.
|
|
|
|
:param full: Full item list
|
|
:param matcher_list: The list of matchers. Each matcher supports
|
|
Unix shell-style wildcards
|
|
:return: The matched items set and the unmatched items set
|
|
"""
|
|
matched = set()
|
|
not_matched = set()
|
|
|
|
full = set([item.strip() for item in full])
|
|
matcher_list = set([item.strip() for item in matcher_list])
|
|
|
|
for matcher in matcher_list:
|
|
for item in full:
|
|
if fnmatch.fnmatchcase(item, matcher):
|
|
matched.add(item)
|
|
not_matched = full - matched
|
|
return matched, not_matched
|
|
|
|
|
|
def create_ssl_context(configuration):
|
|
"""Create context for ssl verification.
|
|
|
|
.. note:: starting from python 2.7.9 ssl adds create_default_context.
|
|
We need to keep compatibility with previous python as well.
|
|
"""
|
|
try:
|
|
if configuration.emc_ssl_cert_verify:
|
|
context = ssl.create_default_context(
|
|
capath=configuration.emc_ssl_cert_path)
|
|
else:
|
|
context = ssl.create_default_context()
|
|
context.check_hostname = False
|
|
context.verify_mode = ssl.CERT_NONE
|
|
except AttributeError:
|
|
LOG.warning('Creating ssl context is not supported on this '
|
|
'version of Python, ssl verification is disabled.')
|
|
context = None
|
|
return context
|
|
|
|
|
|
def parse_ipaddr(text):
|
|
"""Parse the output of VNX server_export command, get IPv4/IPv6 addresses.
|
|
|
|
Example:
|
|
input: 192.168.100.102:[fdf8:f53b:82e4::57]:[fdf8:f53b:82e4::54]
|
|
output: ['192.168.100.102', '[fdf8:f53b:82e4::57]', '[fdf8:f53b:82e4::54]']
|
|
|
|
:param text: The output of VNX server_export command.
|
|
:return: The list of IPv4/IPv6 addresses. The IPv6 address enclosed by [].
|
|
"""
|
|
rst = []
|
|
stk = []
|
|
|
|
ipaddr = ''
|
|
it = iter(text)
|
|
|
|
try:
|
|
while True:
|
|
i = next(it)
|
|
if i == ':' and not stk and ipaddr:
|
|
rst.append(ipaddr)
|
|
ipaddr = ''
|
|
elif i == ':' and not ipaddr:
|
|
continue
|
|
elif i == '[':
|
|
stk.append(i)
|
|
elif i == ']':
|
|
rst.append('[%s]' % ipaddr)
|
|
stk.pop()
|
|
ipaddr = ''
|
|
else:
|
|
ipaddr += i
|
|
except StopIteration:
|
|
if ipaddr:
|
|
rst.append(ipaddr)
|
|
|
|
return rst
|
|
|
|
|
|
def convert_ipv6_format_if_needed(ip_addr):
|
|
"""Convert IPv6 address format if needed. The IPv6 address enclosed by [].
|
|
|
|
For the invalid IPv6 cidr, its format will not be changed.
|
|
|
|
:param ip_addr: IPv6 address.
|
|
:return: Converted IPv6 address.
|
|
"""
|
|
if netutils.is_valid_ipv6_cidr(ip_addr):
|
|
ip_addr = '[%s]' % ip_addr
|
|
return ip_addr
|
|
|
|
|
|
def export_unc_path(ip_addr):
|
|
"""Convert IPv6 address to valid UNC path.
|
|
|
|
In Microsoft Windows OS, UNC (Uniform Naming Convention) specifies a
|
|
common syntax to describe the location of a network resource.
|
|
|
|
The colon which used by IPv6 is an illegal character in a UNC path name.
|
|
So the IPv6 address need to be converted to valid UNC path.
|
|
|
|
References:
|
|
- https://en.wikipedia.org/wiki/IPv6_address
|
|
#Literal_IPv6_addresses_in_UNC_path_names
|
|
- https://en.wikipedia.org/wiki/Path_(computing)#Uniform_Naming_Convention
|
|
|
|
:param ip_addr: IPv6 address.
|
|
:return: UNC path.
|
|
"""
|
|
unc_suffix = '.ipv6-literal.net'
|
|
if netutils.is_valid_ipv6(ip_addr):
|
|
ip_addr = ip_addr.replace(':', '-') + unc_suffix
|
|
return ip_addr
|
|
|
|
|
|
def bytes_to_gb(size):
|
|
return round(float(size) / units.Gi, 2)
|
|
|
|
|
|
def mb_to_gb(size):
|
|
return bytes_to_gb(size * units.Mi)
|