Merge "Module to manage pip packages"
[yardstick.git] / yardstick / common / utils.py
index 68c9ed6..a77a4ca 100644 (file)
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-# yardstick comment: this is a modified copy of rally/rally/common/utils.py
-
-from __future__ import absolute_import
-from __future__ import print_function
-
+import collections
+from contextlib import closing
 import datetime
 import errno
+import importlib
+import ipaddress
 import logging
 import os
+import random
+import re
+import socket
 import subprocess
 import sys
-import collections
-import socket
-import random
-import ipaddress
-from contextlib import closing
 
 import six
 from flask import jsonify
 from six.moves import configparser
-from oslo_utils import importutils
 from oslo_serialization import jsonutils
+from oslo_utils import encodeutils
 
 import yardstick
-from yardstick.common.yaml_loader import yaml_load
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.DEBUG)
@@ -71,40 +67,28 @@ def itersubclasses(cls, _seen=None):
 
 
 def import_modules_from_package(package):
-    """Import modules from package and append into sys.modules
+    """Import modules given a package name
 
     :param: package - Full package name. For example: rally.deploy.engines
     """
     yardstick_root = os.path.dirname(os.path.dirname(yardstick.__file__))
-    path = os.path.join(yardstick_root, *package.split("."))
-    for root, dirs, files in os.walk(path):
-        matches = (filename for filename in files if filename.endswith(".py") and
-                   not filename.startswith("__"))
-        new_package = os.path.relpath(root, yardstick_root).replace(os.sep, ".")
+    path = os.path.join(yardstick_root, *package.split('.'))
+    for root, _, files in os.walk(path):
+        matches = (filename for filename in files if filename.endswith('.py')
+                   and not filename.startswith('__'))
+        new_package = os.path.relpath(root, yardstick_root).replace(os.sep,
+                                                                    '.')
         module_names = set(
-            ("{}.{}".format(new_package, filename.rsplit(".py", 1)[0]) for filename in matches))
-        # find modules which haven't already been imported
+            '{}.{}'.format(new_package, filename.rsplit('.py', 1)[0])
+            for filename in matches)
+        # Find modules which haven't already been imported
         missing_modules = module_names.difference(sys.modules)
-        logger.debug("importing %s", missing_modules)
-        # we have already checked for already imported modules, so we don't need to check again
+        logger.debug('Importing modules: %s', missing_modules)
         for module_name in missing_modules:
             try:
-                sys.modules[module_name] = importutils.import_module(module_name)
+                importlib.import_module(module_name)
             except (ImportError, SyntaxError):
-                logger.exception("unable to import %s", module_name)
-
-
-def parse_yaml(file_path):
-    try:
-        with open(file_path) as f:
-            value = yaml_load(f)
-    except IOError:
-        return {}
-    except OSError as e:
-        if e.errno != errno.EEXIST:
-            raise
-    else:
-        return value
+                logger.exception('Unable to import module %s', module_name)
 
 
 def makedirs(d):
@@ -123,13 +107,12 @@ def remove_file(path):
             raise
 
 
-def execute_command(cmd):
+def execute_command(cmd, **kwargs):
     exec_msg = "Executing command: '%s'" % cmd
     logger.debug(exec_msg)
 
-    output = subprocess.check_output(cmd.split()).split(os.linesep)
-
-    return output
+    output = subprocess.check_output(cmd.split(), **kwargs)
+    return encodeutils.safe_decode(output, incoming='utf-8').split(os.linesep)
 
 
 def source_env(env_file):
@@ -265,10 +248,10 @@ def set_dict_value(dic, keys, value):
 
 def get_free_port(ip):
     with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
-        while True:
+        port = random.randint(5000, 10000)
+        while s.connect_ex((ip, port)) == 0:
             port = random.randint(5000, 10000)
-            if s.connect_ex((ip, port)) != 0:
-                return port
+        return port
 
 
 def mac_address_to_hex_list(mac):
@@ -364,10 +347,13 @@ def config_to_dict(config):
 
 
 def validate_non_string_sequence(value, default=None, raise_exc=None):
-    if isinstance(value, collections.Sequence) and not isinstance(value, str):
+    # NOTE(ralonsoh): refactor this function to check if raise_exc is an
+    # Exception. Remove duplicate code, this function is duplicated in this
+    # repository.
+    if isinstance(value, collections.Sequence) and not isinstance(value, six.string_types):
         return value
     if raise_exc:
-        raise raise_exc
+        raise raise_exc  # pylint: disable=raising-bad-type
     return default
 
 
@@ -379,6 +365,13 @@ def join_non_strings(separator, *non_strings):
     return str(separator).join(str(non_string) for non_string in non_strings)
 
 
+def safe_decode_utf8(s):
+    """Safe decode a str from UTF"""
+    if six.PY3 and isinstance(s, bytes):
+        return s.decode('utf-8', 'surrogateescape')
+    return s
+
+
 class ErrorClass(object):
 
     def __init__(self, *args, **kwargs):
@@ -403,3 +396,17 @@ class Timer(object):
 
     def __getattr__(self, item):
         return getattr(self.delta, item)
+
+
+def read_meminfo(ssh_client):
+    """Read "/proc/meminfo" file and parse all keys and values"""
+
+    cpuinfo = six.BytesIO()
+    ssh_client.get_file_obj('/proc/meminfo', cpuinfo)
+    lines = cpuinfo.getvalue().decode('utf-8')
+    matches = re.findall(r"([\w\(\)]+):\s+(\d+)( kB)*", lines)
+    output = {}
+    for match in matches:
+        output[match[0]] = match[1]
+
+    return output