1 # Copyright 2013: Mirantis Inc.
4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
5 # not use this file except in compliance with the License. You may obtain
6 # a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 # License for the specific language governing permissions and limitations
17 from contextlib import closing
31 from flask import jsonify
32 from six.moves import configparser
33 from oslo_serialization import jsonutils
34 from oslo_utils import encodeutils
38 logger = logging.getLogger(__name__)
39 logger.setLevel(logging.DEBUG)
42 # Decorator for cli-args
43 def cliargs(*args, **kwargs):
45 func.__dict__.setdefault('arguments', []).insert(0, (args, kwargs))
50 def itersubclasses(cls, _seen=None):
51 """Generator over all subclasses of a given class in depth first order."""
53 if not isinstance(cls, type):
54 raise TypeError("itersubclasses must be called with "
55 "new-style classes, not %.100r" % cls)
56 _seen = _seen or set()
58 subs = cls.__subclasses__()
59 except TypeError: # fails only when cls is type
60 subs = cls.__subclasses__(cls)
65 for sub in itersubclasses(sub, _seen):
69 def import_modules_from_package(package, raise_exception=False):
70 """Import modules given a package name
72 :param: package - Full package name. For example: rally.deploy.engines
74 yardstick_root = os.path.dirname(os.path.dirname(yardstick.__file__))
75 path = os.path.join(yardstick_root, *package.split('.'))
76 for root, _, files in os.walk(path):
77 matches = (filename for filename in files if filename.endswith('.py')
78 and not filename.startswith('__'))
79 new_package = os.path.relpath(root, yardstick_root).replace(os.sep,
82 '{}.{}'.format(new_package, filename.rsplit('.py', 1)[0])
83 for filename in matches)
84 # Find modules which haven't already been imported
85 missing_modules = module_names.difference(sys.modules)
86 logger.debug('Importing modules: %s', missing_modules)
87 for module_name in missing_modules:
89 importlib.import_module(module_name)
90 except (ImportError, SyntaxError) as exc:
93 logger.exception('Unable to import module %s', module_name)
96 NON_NONE_DEFAULT = object()
99 def get_key_with_default(data, key, default=NON_NONE_DEFAULT):
100 value = data.get(key, default)
101 if value is NON_NONE_DEFAULT:
106 def make_dict_from_map(data, key_map):
107 return {dest_key: get_key_with_default(data, src_key, default)
108 for dest_key, (src_key, default) in key_map.items()}
115 if e.errno != errno.EEXIST:
119 def remove_file(path):
123 if e.errno != errno.ENOENT:
127 def execute_command(cmd, **kwargs):
128 exec_msg = "Executing command: '%s'" % cmd
129 logger.debug(exec_msg)
131 output = subprocess.check_output(cmd.split(), **kwargs)
132 return encodeutils.safe_decode(output, incoming='utf-8').split(os.linesep)
135 def source_env(env_file):
136 p = subprocess.Popen(". %s; env" % env_file, stdout=subprocess.PIPE,
138 output = p.communicate()[0]
139 env = dict(line.split('=', 1) for line in output.splitlines() if '=' in line)
140 os.environ.update(env)
144 def read_json_from_file(path):
145 with open(path, 'r') as f:
147 # don't use jsonutils.load() it conflicts with already decoded input
148 return jsonutils.loads(j)
151 def write_json_to_file(path, data, mode='w'):
152 with open(path, mode) as f:
153 jsonutils.dump(data, f)
156 def write_file(path, data, mode='w'):
157 with open(path, mode) as f:
161 def parse_ini_file(path):
162 parser = configparser.ConfigParser()
165 files = parser.read(path)
166 except configparser.MissingSectionHeaderError:
167 logger.exception('invalid file type')
171 raise RuntimeError('file not exist')
174 default = {k: v for k, v in parser.items('DEFAULT')}
175 except configparser.NoSectionError:
178 config = dict(DEFAULT=default,
179 **{s: {k: v for k, v in parser.items(
180 s)} for s in parser.sections()})
185 def get_port_mac(sshclient, port):
186 cmd = "ifconfig |grep HWaddr |grep %s |awk '{print $5}' " % port
187 status, stdout, stderr = sshclient.execute(cmd)
190 raise RuntimeError(stderr)
191 return stdout.rstrip()
194 def get_port_ip(sshclient, port):
195 cmd = "ifconfig %s |grep 'inet addr' |awk '{print $2}' " \
196 "|cut -d ':' -f2 " % port
197 status, stdout, stderr = sshclient.execute(cmd)
200 raise RuntimeError(stderr)
201 return stdout.rstrip()
204 def flatten_dict_key(data):
207 # use list, because iterable is too generic
208 if not any(isinstance(v, (collections.Mapping, list))
209 for v in data.values()):
212 for k, v in data.items():
213 if isinstance(v, collections.Mapping):
214 for n_k, n_v in v.items():
215 next_data["%s.%s" % (k, n_k)] = n_v
216 # use list because iterable is too generic
217 elif isinstance(v, collections.Iterable) and not isinstance(v, six.string_types):
218 for index, item in enumerate(v):
219 next_data["%s%d" % (k, index)] = item
223 return flatten_dict_key(next_data)
226 def translate_to_str(obj):
227 if isinstance(obj, collections.Mapping):
228 return {str(k): translate_to_str(v) for k, v in obj.items()}
229 elif isinstance(obj, list):
230 return [translate_to_str(ele) for ele in obj]
231 elif isinstance(obj, six.text_type):
236 def result_handler(status, data):
241 return jsonify(result)
244 def change_obj_to_dict(obj):
246 for k, v in vars(obj).items():
254 def set_dict_value(dic, keys, value):
257 for key in keys.split('.'):
258 return_dic.setdefault(key, {})
259 if key == keys.split('.')[-1]:
260 return_dic[key] = value
262 return_dic = return_dic[key]
266 def get_free_port(ip):
267 with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
268 port = random.randint(5000, 10000)
269 while s.connect_ex((ip, port)) == 0:
270 port = random.randint(5000, 10000)
274 def mac_address_to_hex_list(mac):
275 octets = ["0x{:02x}".format(int(elem, 16)) for elem in mac.split(':')]
276 assert len(octets) == 6 and all(len(octet) == 4 for octet in octets)
280 def safe_ip_address(ip_addr):
281 """ get ip address version v6 or v4 """
283 return ipaddress.ip_address(six.text_type(ip_addr))
285 logging.error("%s is not valid", ip_addr)
289 def get_ip_version(ip_addr):
290 """ get ip address version v6 or v4 """
292 address = ipaddress.ip_address(six.text_type(ip_addr))
294 logging.error("%s is not valid", ip_addr)
297 return address.version
300 def ip_to_hex(ip_addr, separator=''):
302 address = ipaddress.ip_address(six.text_type(ip_addr))
304 logging.error("%s is not valid", ip_addr)
307 if address.version != 4:
311 return '{:08x}'.format(int(address))
313 return separator.join('{:02x}'.format(octet) for octet in address.packed)
316 def try_int(s, *args):
317 """Convert to integer if possible."""
320 except (TypeError, ValueError):
321 return args[0] if args else s
324 class SocketTopology(dict):
327 def parse_cpuinfo(cls, cpuinfo):
330 lines = cpuinfo.splitlines()
336 name, value = line.split(":", 1)
337 core_lines[name.strip()] = try_int(value.strip())
339 core_details.append(core_lines)
342 for core in core_details:
343 socket_map.setdefault(core["physical id"], {}).setdefault(
344 core["core id"], {})[core["processor"]] = (
345 core["processor"], core["core id"], core["physical id"])
347 return cls(socket_map)
350 return sorted(self.keys())
353 return sorted(core for cores in self.values() for core in cores)
355 def processors(self):
357 proc for cores in self.values() for procs in cores.values() for
361 def config_to_dict(config):
362 return {section: dict(config.items(section)) for section in
366 def validate_non_string_sequence(value, default=None, raise_exc=None):
367 # NOTE(ralonsoh): refactor this function to check if raise_exc is an
368 # Exception. Remove duplicate code, this function is duplicated in this
370 if isinstance(value, collections.Sequence) and not isinstance(value, six.string_types):
373 raise raise_exc # pylint: disable=raising-bad-type
377 def join_non_strings(separator, *non_strings):
379 non_strings = validate_non_string_sequence(non_strings[0], raise_exc=RuntimeError)
380 except (IndexError, RuntimeError):
382 return str(separator).join(str(non_string) for non_string in non_strings)
385 def safe_decode_utf8(s):
386 """Safe decode a str from UTF"""
387 if six.PY3 and isinstance(s, bytes):
388 return s.decode('utf-8', 'surrogateescape')
392 class ErrorClass(object):
394 def __init__(self, *args, **kwargs):
395 if 'test' not in kwargs:
398 def __getattr__(self, item):
404 super(Timer, self).__init__()
405 self.start = self.delta = None
408 self.start = datetime.datetime.now()
411 def __exit__(self, *_):
412 self.delta = datetime.datetime.now() - self.start
414 def __getattr__(self, item):
415 return getattr(self.delta, item)
418 def read_meminfo(ssh_client):
419 """Read "/proc/meminfo" file and parse all keys and values"""
421 cpuinfo = six.BytesIO()
422 ssh_client.get_file_obj('/proc/meminfo', cpuinfo)
423 lines = cpuinfo.getvalue().decode('utf-8')
424 matches = re.findall(r"([\w\(\)]+):\s+(\d+)( kB)*", lines)
426 for match in matches:
427 output[match[0]] = match[1]
432 def find_relative_file(path, task_path):
434 Find file in one of places: in abs of path or relative to a directory path,
439 :return str: full path to file
441 # fixme: create schema to validate all fields have been provided
442 for lookup in [os.path.abspath(path), os.path.join(task_path, path)]:
448 raise IOError(errno.ENOENT, 'Unable to find {} file'.format(path))
451 def open_relative_file(path, task_path):
455 if e.errno == errno.ENOENT:
456 return open(os.path.join(task_path, path))