Merge "Added means to override the RC file credentials."
[functest.git] / functest / ci / prepare_env.py
old mode 100755 (executable)
new mode 100644 (file)
index 3df3a0e..9ed585f
@@ -1,51 +1,64 @@
 #!/usr/bin/env python
 #
-# Author: Jose Lausuch (jose.lausuch@ericsson.com)
-#
-# Installs the Functest framework within the Docker container
-# and run the tests automatically
-#
-#
 # All rights reserved. This program and the accompanying materials
 # are made available under the terms of the Apache License, Version 2.0
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 
-
 import argparse
 import json
+import logging
+import logging.config
 import os
+import pkg_resources
 import re
 import subprocess
 import sys
+import fileinput
 
 import yaml
-from opnfv.utils import constants as opnfv_constants
 
-import functest.utils.functest_logger as ft_logger
+from functest.ci import check_deployment
 import functest.utils.functest_utils as ft_utils
 import functest.utils.openstack_utils as os_utils
 from functest.utils.constants import CONST
 
-actions = ['start', 'check']
-parser = argparse.ArgumentParser()
-parser.add_argument("action", help="Possible actions are: "
-                    "'{d[0]}|{d[1]}' ".format(d=actions))
-parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
-args = parser.parse_args()
+from opnfv.utils import constants as opnfv_constants
+from opnfv.deployment import factory
 
+actions = ['start', 'check']
 
 """ logging configuration """
-logger = ft_logger.Logger("prepare_env").getLogger()
+logger = logging.getLogger('functest.ci.prepare_env')
+handler = None
+# set the architecture to default
+pod_arch = os.getenv("HOST_ARCH", None)
+arch_filter = ['aarch64']
+
+CONFIG_FUNCTEST_PATH = pkg_resources.resource_filename(
+            'functest', 'ci/config_functest.yaml')
+CONFIG_PATCH_PATH = pkg_resources.resource_filename(
+            'functest', 'ci/config_patch.yaml')
+CONFIG_AARCH64_PATCH_PATH = pkg_resources.resource_filename(
+            'functest', 'ci/config_aarch64_patch.yaml')
+RALLY_CONF_PATH = "/etc/rally/rally.conf"
+RALLY_AARCH64_PATCH_PATH = pkg_resources.resource_filename(
+            'functest', 'ci/rally_aarch64_patch.conf')
 
 
-CONFIG_FUNCTEST_PATH = CONST.CONFIG_FUNCTEST_YAML
-CONFIG_PATCH_PATH = os.path.join(os.path.dirname(
-    CONFIG_FUNCTEST_PATH), "config_patch.yaml")
+class PrepareEnvParser(object):
 
-with open(CONFIG_PATCH_PATH) as f:
-    functest_patch_yaml = yaml.safe_load(f)
+    def __init__(self):
+        self.parser = argparse.ArgumentParser()
+        self.parser.add_argument("action", help="Possible actions are: "
+                                 "'{d[0]}|{d[1]}' ".format(d=actions),
+                                 choices=actions)
+        self.parser.add_argument("-d", "--debug", help="Debug mode",
+                                 action="store_true")
+
+    def parse_args(self, argv=[]):
+        return vars(self.parser.parse_args(argv))
 
 
 def print_separator():
@@ -56,244 +69,295 @@ def check_env_variables():
     print_separator()
     logger.info("Checking environment variables...")
 
-    if CONST.INSTALLER_TYPE is None:
+    if CONST.__getattribute__('INSTALLER_TYPE') is None:
         logger.warning("The env variable 'INSTALLER_TYPE' is not defined.")
-        CONST.INSTALLER_TYPE = "undefined"
+        CONST.__setattr__('INSTALLER_TYPE', 'undefined')
     else:
-        if CONST.INSTALLER_TYPE not in opnfv_constants.INSTALLERS:
+        if (CONST.__getattribute__('INSTALLER_TYPE') not in
+                opnfv_constants.INSTALLERS):
             logger.warning("INSTALLER_TYPE=%s is not a valid OPNFV installer. "
                            "Available OPNFV Installers are : %s. "
                            "Setting INSTALLER_TYPE=undefined."
-                           % (CONST.INSTALLER_TYPE,
+                           % (CONST.__getattribute__('INSTALLER_TYPE'),
                               opnfv_constants.INSTALLERS))
-            CONST.INSTALLER_TYPE = "undefined"
+            CONST.__setattr__('INSTALLER_TYPE', 'undefined')
         else:
             logger.info("    INSTALLER_TYPE=%s"
-                        % CONST.INSTALLER_TYPE)
-
-    if CONST.INSTALLER_IP is None:
-        logger.warning("The env variable 'INSTALLER_IP' is not defined. "
-                       "It is needed to fetch the OpenStack credentials. "
-                       "If the credentials are not provided to the "
-                       "container as a volume, please add this env variable "
-                       "to the 'docker run' command.")
+                        % CONST.__getattribute__('INSTALLER_TYPE'))
+
+    if CONST.__getattribute__('INSTALLER_IP') is None:
+        logger.warning(
+            "The env variable 'INSTALLER_IP' is not defined. It is recommended"
+            " to extract some information from the deployment")
     else:
-        logger.info("    INSTALLER_IP=%s" % CONST.INSTALLER_IP)
+        logger.info("    INSTALLER_IP=%s" %
+                    CONST.__getattribute__('INSTALLER_IP'))
 
-    if CONST.DEPLOY_SCENARIO is None:
+    if CONST.__getattribute__('DEPLOY_SCENARIO') is None:
         logger.warning("The env variable 'DEPLOY_SCENARIO' is not defined. "
                        "Setting CI_SCENARIO=undefined.")
-        CONST.DEPLOY_SCENARIO = "undefined"
+        CONST.__setattr__('DEPLOY_SCENARIO', 'undefined')
     else:
-        logger.info("    DEPLOY_SCENARIO=%s" % CONST.DEPLOY_SCENARIO)
-    if CONST.CI_DEBUG:
-        logger.info("    CI_DEBUG=%s" % CONST.CI_DEBUG)
-
-    if CONST.NODE_NAME:
-        logger.info("    NODE_NAME=%s" % CONST.NODE_NAME)
-
-    if CONST.BUILD_TAG:
-        logger.info("    BUILD_TAG=%s" % CONST.BUILD_TAG)
-
-    if CONST.IS_CI_RUN:
-        logger.info("    IS_CI_RUN=%s" % CONST.IS_CI_RUN)
+        logger.info("    DEPLOY_SCENARIO=%s"
+                    % CONST.__getattribute__('DEPLOY_SCENARIO'))
+    if CONST.__getattribute__('CI_DEBUG'):
+        logger.info("    CI_DEBUG=%s" % CONST.__getattribute__('CI_DEBUG'))
+
+    if CONST.__getattribute__('NODE_NAME'):
+        logger.info("    NODE_NAME=%s" % CONST.__getattribute__('NODE_NAME'))
+
+    if CONST.__getattribute__('BUILD_TAG'):
+        logger.info("    BUILD_TAG=%s" % CONST.__getattribute__('BUILD_TAG'))
+
+    if CONST.__getattribute__('IS_CI_RUN'):
+        logger.info("    IS_CI_RUN=%s" % CONST.__getattribute__('IS_CI_RUN'))
+
+
+def get_deployment_handler():
+    global handler
+    global pod_arch
+
+    installer_params_yaml = pkg_resources.resource_filename(
+            'functest', 'ci/installer_params.yaml')
+    if (CONST.__getattribute__('INSTALLER_IP') and
+        CONST.__getattribute__('INSTALLER_TYPE') and
+            CONST.__getattribute__('INSTALLER_TYPE') in
+            opnfv_constants.INSTALLERS):
+        try:
+            installer_params = ft_utils.get_parameter_from_yaml(
+                CONST.__getattribute__('INSTALLER_TYPE'),
+                installer_params_yaml)
+        except ValueError as e:
+            logger.debug('Printing deployment info is not supported for %s' %
+                         CONST.__getattribute__('INSTALLER_TYPE'))
+            logger.debug(e)
+        else:
+            user = installer_params.get('user', None)
+            password = installer_params.get('password', None)
+            pkey = installer_params.get('pkey', None)
+            try:
+                handler = factory.Factory.get_handler(
+                    installer=CONST.__getattribute__('INSTALLER_TYPE'),
+                    installer_ip=CONST.__getattribute__('INSTALLER_IP'),
+                    installer_user=user,
+                    installer_pwd=password,
+                    pkey_file=pkey)
+                if handler:
+                    pod_arch = handler.get_arch()
+            except Exception as e:
+                logger.debug("Cannot get deployment information. %s" % e)
 
 
 def create_directories():
     print_separator()
     logger.info("Creating needed directories...")
-    if not os.path.exists(CONST.dir_functest_conf):
-        os.makedirs(CONST.dir_functest_conf)
-        logger.info("    %s created." % CONST.dir_functest_conf)
+    if not os.path.exists(CONST.__getattribute__('dir_functest_conf')):
+        os.makedirs(CONST.__getattribute__('dir_functest_conf'))
+        logger.info("    %s created." %
+                    CONST.__getattribute__('dir_functest_conf'))
     else:
-        logger.debug("   %s already exists."
-                     % CONST.dir_functest_conf)
+        logger.debug("   %s already exists." %
+                     CONST.__getattribute__('dir_functest_conf'))
 
-    if not os.path.exists(CONST.dir_functest_data):
-        os.makedirs(CONST.dir_functest_data)
-        logger.info("    %s created." % CONST.dir_functest_data)
+    if not os.path.exists(CONST.__getattribute__('dir_functest_data')):
+        os.makedirs(CONST.__getattribute__('dir_functest_data'))
+        logger.info("    %s created." %
+                    CONST.__getattribute__('dir_functest_data'))
+    else:
+        logger.debug("   %s already exists." %
+                     CONST.__getattribute__('dir_functest_data'))
+    if not os.path.exists(CONST.__getattribute__('dir_functest_images')):
+        os.makedirs(CONST.__getattribute__('dir_functest_images'))
+        logger.info("    %s created." %
+                    CONST.__getattribute__('dir_functest_images'))
     else:
-        logger.debug("   %s already exists."
-                     % CONST.dir_functest_data)
+        logger.debug("   %s already exists." %
+                     CONST.__getattribute__('dir_functest_images'))
 
 
 def source_rc_file():
     print_separator()
-    logger.info("Fetching RC file...")
-
-    if CONST.openstack_creds is None:
-        logger.warning("The environment variable 'creds' must be set and"
-                       "pointing to the local RC file. Using default: "
-                       "/home/opnfv/functest/conf/openstack.creds ...")
-        os.path.join(CONST.dir_functest_conf, 'openstack.creds')
-
-    if not os.path.isfile(CONST.openstack_creds):
-        logger.info("RC file not provided. "
-                    "Fetching it from the installer...")
-        if CONST.INSTALLER_IP is None:
-            logger.error("The env variable CI_INSTALLER_IP must be provided in"
-                         " order to fetch the credentials from the installer.")
-            sys.exit("Missing CI_INSTALLER_IP.")
-        if CONST.INSTALLER_TYPE not in opnfv_constants.INSTALLERS:
-            logger.error("Cannot fetch credentials. INSTALLER_TYPE=%s is "
-                         "not a valid OPNFV installer. Available "
-                         "installers are : %s." %
-                         (CONST.INSTALLER_TYPE,
-                          opnfv_constants.INSTALLERS))
-            sys.exit("Wrong INSTALLER_TYPE.")
-
-        cmd = ("/home/opnfv/repos/releng/utils/fetch_os_creds.sh "
-               "-d %s -i %s -a %s"
-               % (CONST.openstack_creds,
-                  CONST.INSTALLER_TYPE,
-                  CONST.INSTALLER_IP))
-        logger.debug("Executing command: %s" % cmd)
-        p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
-        output = p.communicate()[0]
-        logger.debug("\n%s" % output)
-        if p.returncode != 0:
-            logger.error("Failed to fetch credentials from installer.")
-            sys.exit(1)
-    else:
-        logger.info("RC file provided in %s."
-                    % CONST.openstack_creds)
-        if os.path.getsize(CONST.openstack_creds) == 0:
-            logger.error("The file %s is empty."
-                         % CONST.openstack_creds)
-            sys.exit(1)
 
     logger.info("Sourcing the OpenStack RC file...")
-    creds = os_utils.source_credentials(
-        CONST.openstack_creds)
-    str = ""
-    for key, value in creds.iteritems():
+    os_utils.source_credentials(CONST.__getattribute__('openstack_creds'))
+    for key, value in os.environ.iteritems():
         if re.search("OS_", key):
-            str += "\n\t\t\t\t\t\t   " + key + "=" + value
             if key == 'OS_AUTH_URL':
-                CONST.OS_AUTH_URL = value
+                CONST.__setattr__('OS_AUTH_URL', value)
             elif key == 'OS_USERNAME':
-                CONST.OS_USERNAME = value
+                CONST.__setattr__('OS_USERNAME', value)
             elif key == 'OS_TENANT_NAME':
-                CONST.OS_TENANT_NAME = value
+                CONST.__setattr__('OS_TENANT_NAME', value)
             elif key == 'OS_PASSWORD':
-                CONST.OS_PASSWORD = value
-    logger.debug("Used credentials: %s" % str)
-    logger.debug("OS_AUTH_URL:%s" % CONST.OS_AUTH_URL)
-    logger.debug("OS_USERNAME:%s" % CONST.OS_USERNAME)
-    logger.debug("OS_TENANT_NAME:%s" % CONST.OS_TENANT_NAME)
-    logger.debug("OS_PASSWORD:%s" % CONST.OS_PASSWORD)
+                CONST.__setattr__('OS_PASSWORD', value)
+
+
+def update_config_file():
+    patch_file(CONFIG_PATCH_PATH)
+
+    if pod_arch and pod_arch in arch_filter:
+        patch_file(CONFIG_AARCH64_PATCH_PATH)
+
+    if "TEST_DB_URL" in os.environ:
+        update_db_url()
 
 
-def patch_config_file():
+def patch_file(patch_file_path):
+    logger.debug('Updating file: %s', patch_file_path)
+    with open(patch_file_path) as f:
+        patch_file = yaml.safe_load(f)
+
     updated = False
-    for key in functest_patch_yaml:
-        if key in CONST.DEPLOY_SCENARIO:
+    for key in patch_file:
+        if key in CONST.__getattribute__('DEPLOY_SCENARIO'):
             new_functest_yaml = dict(ft_utils.merge_dicts(
-                ft_utils.get_functest_yaml(), functest_patch_yaml[key]))
+                ft_utils.get_functest_yaml(), patch_file[key]))
             updated = True
 
     if updated:
         os.remove(CONFIG_FUNCTEST_PATH)
         with open(CONFIG_FUNCTEST_PATH, "w") as f:
             f.write(yaml.dump(new_functest_yaml, default_style='"'))
-        f.close()
 
 
-def verify_deployment():
-    print_separator()
-    logger.info("Verifying OpenStack services...")
-    cmd = ("%s/functest/ci/check_os.sh" % CONST.dir_repo_functest)
+def update_db_url():
+    with open(CONFIG_FUNCTEST_PATH) as f:
+        functest_yaml = yaml.safe_load(f)
 
-    logger.debug("Executing command: %s" % cmd)
-    p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
+    with open(CONFIG_FUNCTEST_PATH, "w") as f:
+        functest_yaml["results"]["test_db_url"] = os.environ.get('TEST_DB_URL')
+        f.write(yaml.dump(functest_yaml, default_style='"'))
 
-    while p.poll() is None:
-        line = p.stdout.readline().rstrip()
-        if "ERROR" in line:
-            logger.error(line)
-            sys.exit("Problem while running 'check_os.sh'.")
-        logger.info(line)
+
+def verify_deployment():
+    print_separator()
+    logger.info("Verifying OpenStack deployment...")
+    deployment = check_deployment.CheckDeployment()
+    deployment.check_all()
 
 
 def install_rally():
     print_separator()
+
+    if pod_arch and pod_arch in arch_filter:
+        logger.info("Apply aarch64 specific to rally config...")
+        with open(RALLY_AARCH64_PATCH_PATH, "r") as f:
+            rally_patch_conf = f.read()
+
+        for line in fileinput.input(RALLY_CONF_PATH, inplace=1):
+            print line,
+            if "cirros|testvm" in line:
+                print rally_patch_conf
+
     logger.info("Creating Rally environment...")
 
     cmd = "rally deployment destroy opnfv-rally"
     ft_utils.execute_command(cmd, error_msg=(
         "Deployment %s does not exist."
-        % CONST.rally_deployment_name),
+        % CONST.__getattribute__('rally_deployment_name')),
         verbose=False)
+
     rally_conf = os_utils.get_credentials_for_rally()
     with open('rally_conf.json', 'w') as fp:
         json.dump(rally_conf, fp)
-    cmd = "rally deployment create --file=rally_conf.json --name="
-    cmd += CONST.rally_deployment_name
-    ft_utils.execute_command(cmd,
-                             error_msg="Problem creating Rally deployment")
-
-    logger.info("Installing tempest from existing repo...")
-    cmd = ("rally verify install --source " +
-           CONST.dir_repo_tempest +
-           " --system-wide")
-    ft_utils.execute_command(cmd,
-                             error_msg="Problem installing Tempest.")
+    cmd = ("rally deployment create "
+           "--file=rally_conf.json --name={0}"
+           .format(CONST.__getattribute__('rally_deployment_name')))
+    error_msg = "Problem while creating Rally deployment"
+    ft_utils.execute_command_raise(cmd, error_msg=error_msg)
 
     cmd = "rally deployment check"
-    ft_utils.execute_command(cmd,
-                             error_msg=("OpenStack not responding or "
-                                        "faulty Rally deployment."))
+    error_msg = "OpenStack not responding or faulty Rally deployment."
+    ft_utils.execute_command_raise(cmd, error_msg=error_msg)
 
-    cmd = "rally show images"
+    cmd = "rally deployment list"
     ft_utils.execute_command(cmd,
                              error_msg=("Problem while listing "
-                                        "OpenStack images."))
+                                        "Rally deployment."))
 
-    cmd = "rally show flavors"
+    cmd = "rally plugin list | head -5"
     ft_utils.execute_command(cmd,
                              error_msg=("Problem while showing "
-                                        "OpenStack flavors."))
+                                        "Rally plugins."))
+
+
+def install_tempest():
+    logger.info("Installing tempest from existing repo...")
+    cmd = ("rally verify list-verifiers | "
+           "grep '{0}' | wc -l".format(
+               CONST.__getattribute__('tempest_deployment_name')))
+    p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
+    while p.poll() is None:
+        line = p.stdout.readline().rstrip()
+        if str(line) == '0':
+            logger.debug("Tempest %s does not exist" %
+                         CONST.__getattribute__('tempest_deployment_name'))
+            cmd = ("rally verify create-verifier --source {0} "
+                   "--name {1} --type tempest --system-wide"
+                   .format(CONST.__getattribute__('dir_repo_tempest'),
+                           CONST.__getattribute__('tempest_deployment_name')))
+            error_msg = "Problem while installing Tempest."
+            ft_utils.execute_command_raise(cmd, error_msg=error_msg)
+
+
+def create_flavor():
+    _, flavor_id = os_utils.get_or_create_flavor('m1.tiny',
+                                                 '512',
+                                                 '1',
+                                                 '1',
+                                                 public=True)
+    if flavor_id is None:
+        raise Exception('Failed to create flavor')
 
 
 def check_environment():
     msg_not_active = "The Functest environment is not installed."
-    if not os.path.isfile(CONST.env_active):
-        logger.error(msg_not_active)
-        sys.exit(1)
+    if not os.path.isfile(CONST.__getattribute__('env_active')):
+        raise Exception(msg_not_active)
 
-    with open(CONST.env_active, "r") as env_file:
+    with open(CONST.__getattribute__('env_active'), "r") as env_file:
         s = env_file.read()
         if not re.search("1", s):
-            logger.error(msg_not_active)
-            sys.exit(1)
-
-    logger.info("Functest environment installed.")
+            raise Exception(msg_not_active)
+
+    logger.info("Functest environment is installed.")
+
+
+def print_deployment_info():
+    if handler:
+        logger.info('\n\nDeployment information:\n%s' %
+                    handler.get_deployment_info())
+
+
+def prepare_env(**kwargs):
+    try:
+        if not (kwargs['action'] in actions):
+            logger.error('Argument not valid.')
+            return -1
+        elif kwargs['action'] == "start":
+            logger.info("######### Preparing Functest environment #########\n")
+            verify_deployment()
+            check_env_variables()
+            create_directories()
+            source_rc_file()
+            update_config_file()
+            install_rally()
+            install_tempest()
+            create_flavor()
+            with open(CONST.__getattribute__('env_active'), "w") as env_file:
+                env_file.write("1")
+            check_environment()
+        elif kwargs['action'] == "check":
+            check_environment()
+    except Exception as e:
+        logger.error(e)
+        return -1
+    return 0
 
 
 def main():
-    if not (args.action in actions):
-        logger.error('Argument not valid.')
-        sys.exit()
-
-    if args.action == "start":
-        logger.info("######### Preparing Functest environment #########\n")
-        check_env_variables()
-        create_directories()
-        source_rc_file()
-        patch_config_file()
-        verify_deployment()
-        install_rally()
-
-        with open(CONST.env_active, "w") as env_file:
-            env_file.write("1")
-
-        check_environment()
-
-    if args.action == "check":
-        check_environment()
-
-    exit(0)
-
-
-if __name__ == '__main__':
-    main()
+    logging.config.fileConfig(pkg_resources.resource_filename(
+        'functest', 'ci/logging.ini'))
+    parser = PrepareEnvParser()
+    args = parser.parse_args(sys.argv[1:])
+    return prepare_env(**args)