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
33 from flask import jsonify
34 from six.moves import configparser
35 from oslo_serialization import jsonutils
36 from oslo_utils import encodeutils
39 from yardstick.common import exceptions
42 logger = logging.getLogger(__name__)
43 logger.setLevel(logging.DEBUG)
46 # Decorator for cli-args
47 def cliargs(*args, **kwargs):
49 func.__dict__.setdefault('arguments', []).insert(0, (args, kwargs))
54 def itersubclasses(cls, _seen=None):
55 """Generator over all subclasses of a given class in depth first order."""
57 if not isinstance(cls, type):
58 raise TypeError("itersubclasses must be called with "
59 "new-style classes, not %.100r" % cls)
60 _seen = _seen or set()
62 subs = cls.__subclasses__()
63 except TypeError: # fails only when cls is type
64 subs = cls.__subclasses__(cls)
69 for sub in itersubclasses(sub, _seen):
73 def import_modules_from_package(package, raise_exception=False):
74 """Import modules given a package name
76 :param: package - Full package name. For example: rally.deploy.engines
78 yardstick_root = os.path.dirname(os.path.dirname(yardstick.__file__))
79 path = os.path.join(yardstick_root, *package.split('.'))
80 for root, _, files in os.walk(path):
81 matches = (filename for filename in files if filename.endswith('.py')
82 and not filename.startswith('__'))
83 new_package = os.path.relpath(root, yardstick_root).replace(os.sep,
86 '{}.{}'.format(new_package, filename.rsplit('.py', 1)[0])
87 for filename in matches)
88 # Find modules which haven't already been imported
89 missing_modules = module_names.difference(sys.modules)
90 logger.debug('Importing modules: %s', missing_modules)
91 for module_name in missing_modules:
93 importlib.import_module(module_name)
94 except (ImportError, SyntaxError) as exc:
97 logger.exception('Unable to import module %s', module_name)
100 NON_NONE_DEFAULT = object()
103 def get_key_with_default(data, key, default=NON_NONE_DEFAULT):
104 value = data.get(key, default)
105 if value is NON_NONE_DEFAULT:
110 def make_dict_from_map(data, key_map):
111 return {dest_key: get_key_with_default(data, src_key, default)
112 for dest_key, (src_key, default) in key_map.items()}
119 if e.errno != errno.EEXIST:
123 def remove_file(path):
127 if e.errno != errno.ENOENT:
131 def execute_command(cmd, **kwargs):
132 exec_msg = "Executing command: '%s'" % cmd
133 logger.debug(exec_msg)
135 output = subprocess.check_output(cmd.split(), **kwargs)
136 return encodeutils.safe_decode(output, incoming='utf-8').split(os.linesep)
139 def source_env(env_file):
140 p = subprocess.Popen(". %s; env" % env_file, stdout=subprocess.PIPE,
142 output = p.communicate()[0]
144 # sometimes output type would be binary_type, and it don't have splitlines
145 # method, so we need to decode
146 if isinstance(output, six.binary_type):
147 output = encodeutils.safe_decode(output)
148 env = dict(line.split('=', 1) for line in output.splitlines() if '=' in line)
149 os.environ.update(env)
153 def read_json_from_file(path):
154 with open(path, 'r') as f:
156 # don't use jsonutils.load() it conflicts with already decoded input
157 return jsonutils.loads(j)
160 def write_json_to_file(path, data, mode='w'):
161 with open(path, mode) as f:
162 jsonutils.dump(data, f)
165 def write_file(path, data, mode='w'):
166 with open(path, mode) as f:
170 def parse_ini_file(path):
171 parser = configparser.ConfigParser()
174 files = parser.read(path)
175 except configparser.MissingSectionHeaderError:
176 logger.exception('invalid file type')
180 raise RuntimeError('file not exist')
183 default = {k: v for k, v in parser.items('DEFAULT')}
184 except configparser.NoSectionError:
187 config = dict(DEFAULT=default,
188 **{s: {k: v for k, v in parser.items(
189 s)} for s in parser.sections()})
194 def get_port_mac(sshclient, port):
195 cmd = "ifconfig |grep HWaddr |grep %s |awk '{print $5}' " % port
196 status, stdout, stderr = sshclient.execute(cmd)
199 raise RuntimeError(stderr)
200 return stdout.rstrip()
203 def get_port_ip(sshclient, port):
204 cmd = "ifconfig %s |grep 'inet addr' |awk '{print $2}' " \
205 "|cut -d ':' -f2 " % port
206 status, stdout, stderr = sshclient.execute(cmd)
209 raise RuntimeError(stderr)
210 return stdout.rstrip()
213 def flatten_dict_key(data):
216 # use list, because iterable is too generic
217 if not any(isinstance(v, (collections.Mapping, list))
218 for v in data.values()):
221 for k, v in data.items():
222 if isinstance(v, collections.Mapping):
223 for n_k, n_v in v.items():
224 next_data["%s.%s" % (k, n_k)] = n_v
225 # use list because iterable is too generic
226 elif isinstance(v, collections.Iterable) and not isinstance(v, six.string_types):
227 for index, item in enumerate(v):
228 next_data["%s%d" % (k, index)] = item
232 return flatten_dict_key(next_data)
235 def translate_to_str(obj):
236 if isinstance(obj, collections.Mapping):
237 return {str(k): translate_to_str(v) for k, v in obj.items()}
238 elif isinstance(obj, list):
239 return [translate_to_str(ele) for ele in obj]
240 elif isinstance(obj, six.text_type):
245 def result_handler(status, data):
250 return jsonify(result)
253 def change_obj_to_dict(obj):
255 for k, v in vars(obj).items():
263 def set_dict_value(dic, keys, value):
266 for key in keys.split('.'):
267 return_dic.setdefault(key, {})
268 if key == keys.split('.')[-1]:
269 return_dic[key] = value
271 return_dic = return_dic[key]
275 def get_free_port(ip):
276 with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
277 port = random.randint(5000, 10000)
278 while s.connect_ex((ip, port)) == 0:
279 port = random.randint(5000, 10000)
283 def mac_address_to_hex_list(mac):
284 octets = ["0x{:02x}".format(int(elem, 16)) for elem in mac.split(':')]
285 assert len(octets) == 6 and all(len(octet) == 4 for octet in octets)
289 def safe_ip_address(ip_addr):
290 """ get ip address version v6 or v4 """
292 return ipaddress.ip_address(six.text_type(ip_addr))
294 logging.error("%s is not valid", ip_addr)
298 def get_ip_version(ip_addr):
299 """ get ip address version v6 or v4 """
301 address = ipaddress.ip_address(six.text_type(ip_addr))
303 logging.error("%s is not valid", ip_addr)
306 return address.version
309 def make_ip_addr(ip, mask):
311 :param ip[str]: ip adddress
312 :param mask[str]: /24 prefix of 255.255.255.0 netmask
313 :return: IPv4Interface object
316 return ipaddress.ip_interface(six.text_type('/'.join([ip, mask])))
317 except (TypeError, ValueError):
318 # None so we can skip later
322 def ip_to_hex(ip_addr, separator=''):
324 address = ipaddress.ip_address(six.text_type(ip_addr))
326 logging.error("%s is not valid", ip_addr)
329 if address.version != 4:
333 return '{:08x}'.format(int(address))
335 return separator.join('{:02x}'.format(octet) for octet in address.packed)
338 def try_int(s, *args):
339 """Convert to integer if possible."""
342 except (TypeError, ValueError):
343 return args[0] if args else s
346 class SocketTopology(dict):
349 def parse_cpuinfo(cls, cpuinfo):
352 lines = cpuinfo.splitlines()
358 name, value = line.split(":", 1)
359 core_lines[name.strip()] = try_int(value.strip())
361 core_details.append(core_lines)
364 for core in core_details:
365 socket_map.setdefault(core["physical id"], {}).setdefault(
366 core["core id"], {})[core["processor"]] = (
367 core["processor"], core["core id"], core["physical id"])
369 return cls(socket_map)
372 return sorted(self.keys())
375 return sorted(core for cores in self.values() for core in cores)
377 def processors(self):
379 proc for cores in self.values() for procs in cores.values() for
383 def config_to_dict(config):
384 return {section: dict(config.items(section)) for section in
388 def validate_non_string_sequence(value, default=None, raise_exc=None):
389 # NOTE(ralonsoh): refactor this function to check if raise_exc is an
390 # Exception. Remove duplicate code, this function is duplicated in this
392 if isinstance(value, collections.Sequence) and not isinstance(value, six.string_types):
395 raise raise_exc # pylint: disable=raising-bad-type
399 def join_non_strings(separator, *non_strings):
401 non_strings = validate_non_string_sequence(non_strings[0], raise_exc=RuntimeError)
402 except (IndexError, RuntimeError):
404 return str(separator).join(str(non_string) for non_string in non_strings)
407 def safe_decode_utf8(s):
408 """Safe decode a str from UTF"""
409 if six.PY3 and isinstance(s, bytes):
410 return s.decode('utf-8', 'surrogateescape')
414 class ErrorClass(object):
416 def __init__(self, *args, **kwargs):
417 if 'test' not in kwargs:
420 def __getattr__(self, item):
425 def __init__(self, timeout=None, raise_exception=True):
426 super(Timer, self).__init__()
427 self.start = self.delta = None
428 self._timeout = int(timeout) if timeout else None
429 self._timeout_flag = False
430 self._raise_exception = raise_exception
432 def _timeout_handler(self, *args):
433 self._timeout_flag = True
434 if self._raise_exception:
435 raise exceptions.TimerTimeout(timeout=self._timeout)
439 self.start = datetime.datetime.now()
441 signal.signal(signal.SIGALRM, self._timeout_handler)
442 signal.alarm(self._timeout)
445 def __exit__(self, *_):
448 self.delta = datetime.datetime.now() - self.start
450 def __getattr__(self, item):
451 return getattr(self.delta, item)
454 self._raise_exception = False
455 return self.__enter__()
457 def next(self): # pragma: no cover
458 # NOTE(ralonsoh): Python 2 support.
459 if not self._timeout_flag:
460 return datetime.datetime.now()
461 raise StopIteration()
463 def __next__(self): # pragma: no cover
464 # NOTE(ralonsoh): Python 3 support.
467 def __del__(self): # pragma: no cover
471 def read_meminfo(ssh_client):
472 """Read "/proc/meminfo" file and parse all keys and values"""
474 cpuinfo = six.BytesIO()
475 ssh_client.get_file_obj('/proc/meminfo', cpuinfo)
476 lines = cpuinfo.getvalue().decode('utf-8')
477 matches = re.findall(r"([\w\(\)]+):\s+(\d+)( kB)*", lines)
479 for match in matches:
480 output[match[0]] = match[1]
485 def find_relative_file(path, task_path):
487 Find file in one of places: in abs of path or relative to a directory path,
492 :return str: full path to file
494 # fixme: create schema to validate all fields have been provided
495 for lookup in [os.path.abspath(path), os.path.join(task_path, path)]:
501 raise IOError(errno.ENOENT, 'Unable to find {} file'.format(path))
504 def open_relative_file(path, task_path):
508 if e.errno == errno.ENOENT:
509 return open(os.path.join(task_path, path))
513 def wait_until_true(predicate, timeout=60, sleep=1, exception=None):
514 """Wait until callable predicate is evaluated as True
516 :param predicate: (func) callable deciding whether waiting should continue
517 :param timeout: (int) timeout in seconds how long should function wait
518 :param sleep: (int) polling interval for results in seconds
519 :param exception: exception instance to raise on timeout. If None is passed
520 (default) then WaitTimeout exception is raised.
523 with Timer(timeout=timeout):
524 while not predicate():
526 except exceptions.TimerTimeout:
527 if exception and issubclass(exception, Exception):
528 raise exception # pylint: disable=raising-bad-type
529 raise exceptions.WaitTimeout
532 def send_socket_command(host, port, command):
533 """Send a string command to a specific port in a host
535 :param host: (str) ip or hostname of the host
536 :param port: (int) port number
537 :param command: (str) command to send
538 :return: 0 if success, error number if error
540 sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
543 err_number = sock.connect_ex((host, int(port)))
546 sock.sendall(six.b(command))
547 except Exception: # pylint: disable=broad-except