Fix falsy links
[functest.git] / functest / utils / functest_utils.py
index e84a2b4..ef5dac7 100644 (file)
 from __future__ import print_function
 import logging
 import os
-import re
-import shutil
 import subprocess
 import sys
-
-import dns.resolver
-from six.moves import urllib
 import yaml
 
-from functest.utils import constants
+from shade import _utils
+import six
 
 LOGGER = logging.getLogger(__name__)
 
 
-# ----------------------------------------------------------
-#
-#               INTERNET UTILS
-#
-# -----------------------------------------------------------
-def check_internet_connectivity(url='http://www.opnfv.org/'):
-    """
-    Check if there is access to the internet
-    """
-    try:
-        urllib.request.urlopen(url, timeout=5)
-        return True
-    except urllib.error.URLError:
-        return False
-
-
-def download_url(url, dest_path):
-    """
-    Download a file to a destination path given a URL
-    """
-    name = url.rsplit('/')[-1]
-    dest = dest_path + "/" + name
-    try:
-        response = urllib.request.urlopen(url)
-    except (urllib.error.HTTPError, urllib.error.URLError):
-        return False
-
-    with open(dest, 'wb') as lfile:
-        shutil.copyfileobj(response, lfile)
-    return True
-
-
-# ----------------------------------------------------------
-#
-#               CI UTILS
-#
-# -----------------------------------------------------------
-def get_resolvconf_ns():
-    """
-    Get nameservers from current resolv.conf
-    """
-    nameservers = []
-    rconf = open("/etc/resolv.conf", "r")
-    line = rconf.readline()
-    resolver = dns.resolver.Resolver()
-    while line:
-        addr_ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
-        if addr_ip:
-            resolver.nameservers = [addr_ip.group(0)]
-            try:
-                result = resolver.query('opnfv.org')[0]
-                if result != "":
-                    nameservers.append(addr_ip.group())
-            except dns.exception.Timeout:
-                pass
-        line = rconf.readline()
-    return nameservers
-
-
-def get_ci_envvars():
-    """
-    Get the CI env variables
-    """
-    ci_env_var = {
-        "installer": os.environ.get('INSTALLER_TYPE'),
-        "scenario": os.environ.get('DEPLOY_SCENARIO')}
-    return ci_env_var
-
-
 def execute_command_raise(cmd, info=False, error_msg="",
                           verbose=True, output_file=None):
     ret = execute_command(cmd, info, error_msg, verbose, output_file)
@@ -118,10 +45,10 @@ def execute_command(cmd, info=False, error_msg="",
         ofd = open(output_file, "w")
     for line in iter(popen.stdout.readline, b''):
         if output_file:
-            ofd.write(line)
+            ofd.write(line.decode("utf-8"))
         else:
-            line = line.replace('\n', '')
-            print (line)
+            line = line.decode("utf-8").replace('\n', '')
+            print(line)
             sys.stdout.flush()
     if output_file:
         ofd.close()
@@ -134,11 +61,6 @@ def execute_command(cmd, info=False, error_msg="",
     return returncode
 
 
-# ----------------------------------------------------------
-#
-#               YAML UTILS
-#
-# -----------------------------------------------------------
 def get_parameter_from_yaml(parameter, yfile):
     """
     Returns the value of a given parameter in file.yaml
@@ -156,18 +78,140 @@ def get_parameter_from_yaml(parameter, yfile):
     return value
 
 
-def get_functest_config(parameter):
-    yaml_ = constants.CONST.__getattribute__('CONFIG_FUNCTEST_YAML')
-    return get_parameter_from_yaml(parameter, yaml_)
+def get_nova_version(cloud):
+    """ Get Nova API microversion
+
+    Returns:
+
+    - Nova API microversion
+    - None on operation error
+    """
+    # pylint: disable=protected-access
+    try:
+        request = cloud._compute_client.request("/", "GET")
+        LOGGER.debug('cloud._compute_client.request: %s', request)
+        version = request["version"]["version"]
+        major, minor = version.split('.')
+        LOGGER.debug('nova version: %s', (int(major), int(minor)))
+        return (int(major), int(minor))
+    except Exception:  # pylint: disable=broad-except
+        LOGGER.exception("Cannot detect Nova version")
+        return None
+
+
+def get_openstack_version(cloud):
+    """ Detect OpenStack version via Nova API microversion
+
+    It follows `MicroversionHistory
+    <https://docs.openstack.org/nova/latest/reference/api-microversion-history.html>`_.
+
+    Returns:
+
+    - OpenStack release
+    - Unknown on operation error
+    """
+    version = get_nova_version(cloud)
+    try:
+        assert version
+        if version > (2, 72):
+            osversion = "Master"
+        elif version > (2, 65):
+            osversion = "Stein"
+        elif version > (2, 60):
+            osversion = "Rocky"
+        elif version > (2, 53):
+            osversion = "Queens"
+        elif version > (2, 42):
+            osversion = "Pike"
+        elif version > (2, 38):
+            osversion = "Ocata"
+        elif version > (2, 25):
+            osversion = "Newton"
+        elif version > (2, 12):
+            osversion = "Mitaka"
+        elif version > (2, 3):
+            osversion = "Liberty"
+        elif version >= (2, 1):
+            osversion = "Kilo"
+        else:
+            osversion = "Unknown"
+        LOGGER.info('Detect OpenStack version: %s', osversion)
+        return osversion
+    except AssertionError:
+        LOGGER.exception("Cannot detect OpenStack version")
+        return "Unknown"
+
+
+def list_services(cloud):
+    # pylint: disable=protected-access
+    """Search Keystone services via $OS_INTERFACE.
 
+    It mainly conforms with `Shade
+    <https://docs.openstack.org/shade/latest>`_ but allows testing vs
+    public endpoints. It's worth mentioning that it doesn't support keystone
+    v2.
+
+    :returns: a list of ``munch.Munch`` containing the services description
+
+    :raises: ``OpenStackCloudException`` if something goes wrong during the
+        openstack API call.
+    """
+    url, key = '/services', 'services'
+    data = cloud._identity_client.get(
+        url, endpoint_filter={
+            'interface': os.environ.get('OS_INTERFACE', 'public')},
+        error_message="Failed to list services")
+    services = cloud._get_and_munchify(key, data)
+    return _utils.normalize_keystone_services(services)
 
-def get_functest_yaml():
-    # pylint: disable=bad-continuation
-    with open(constants.CONST.__getattribute__(
-            'CONFIG_FUNCTEST_YAML')) as yaml_fd:
-        functest_yaml = yaml.safe_load(yaml_fd)
-    return functest_yaml
+
+def search_services(cloud, name_or_id=None, filters=None):
+    # pylint: disable=protected-access
+    """Search Keystone services ia $OS_INTERFACE.
+
+    It mainly conforms with `Shade
+    <https://docs.openstack.org/shade/latest>`_ but allows testing vs
+    public endpoints. It's worth mentioning that it doesn't support keystone
+    v2.
+
+    :param name_or_id: Name or id of the desired service.
+    :param filters: a dict containing additional filters to use. e.g.
+                    {'type': 'network'}.
+
+    :returns: a list of ``munch.Munch`` containing the services description
+
+    :raises: ``OpenStackCloudException`` if something goes wrong during the
+        openstack API call.
+    """
+    services = list_services(cloud)
+    return _utils._filter_list(services, name_or_id, filters)
+
+
+def convert_dict_to_ini(value):
+    "Convert dict to oslo.conf input"
+    assert isinstance(value, dict)
+    return ",".join("{}:{}".format(
+        key, val) for (key, val) in six.iteritems(value))
+
+
+def convert_list_to_ini(value):
+    "Convert list to oslo.conf input"
+    assert isinstance(value, list)
+    return ",".join("{}".format(val) for val in value)
+
+
+def convert_ini_to_dict(value):
+    "Convert oslo.conf input to dict"
+    assert isinstance(value, str)
+    try:
+        return {k: v for k, v in (x.rsplit(':', 1) for x in value.split(','))}
+    except ValueError:
+        return {}
 
 
-def print_separator():
-    LOGGER.info("==============================================")
+def convert_ini_to_list(value):
+    "Convert list to oslo.conf input"
+    assert isinstance(value, str)
+    if not value:
+        return []
+    return [x for x in value.split(',')]