From 3e3c96b2aa15d7757f281ce00518a67e2a1225a9 Mon Sep 17 00:00:00 2001 From: helenyao Date: Mon, 21 Nov 2016 06:50:06 -0500 Subject: Extracted all global parameters into functest_constants.py JIRA: FUNCTEST-533 1. Extracted all global variables into functest_constants.py and updated all affected areas accordingly 2. Used os.path.join to replace '/' to come up with the path for better cross-platform support and improve the path accuracy 3. Removed unused variables 4. Updated the hardcoded path in Dockerfile by using variable reference 5. Removed "/" ending from all path variables 6. Updated the unit test Change-Id: Ib30a81d1f0c83fbaef042d63c187c27bd18301bb Signed-off-by: helenyao --- functest/ci/prepare_env.py | 158 ++++++++++++++++++++++----------------------- 1 file changed, 78 insertions(+), 80 deletions(-) mode change 100644 => 100755 functest/ci/prepare_env.py (limited to 'functest/ci/prepare_env.py') diff --git a/functest/ci/prepare_env.py b/functest/ci/prepare_env.py old mode 100644 new mode 100755 index e5c24cc3..246a02a8 --- a/functest/ci/prepare_env.py +++ b/functest/ci/prepare_env.py @@ -25,6 +25,7 @@ import yaml import functest.utils.functest_logger as ft_logger import functest.utils.functest_utils as ft_utils import functest.utils.openstack_utils as os_utils +import functest.utils.functest_constants as ft_constants actions = ['start', 'check'] parser = argparse.ArgumentParser() @@ -38,34 +39,13 @@ args = parser.parse_args() logger = ft_logger.Logger("prepare_env").getLogger() -""" global variables """ -INSTALLERS = ['fuel', 'compass', 'apex', 'joid'] -CI_INSTALLER_TYPE = "" -CI_INSTALLER_IP = "" -CI_SCENARIO = "" -CI_DEBUG = False -CONFIG_FUNCTEST_PATH = os.environ["CONFIG_FUNCTEST_YAML"] +CONFIG_FUNCTEST_PATH = ft_constants.CONFIG_FUNCTEST_YAML CONFIG_PATCH_PATH = os.path.join(os.path.dirname( CONFIG_FUNCTEST_PATH), "config_patch.yaml") with open(CONFIG_PATCH_PATH) as f: functest_patch_yaml = yaml.safe_load(f) -FUNCTEST_CONF_DIR = \ - ft_utils.get_functest_config('general.directories.dir_functest_conf') - - -FUNCTEST_DATA_DIR = \ - ft_utils.get_functest_config('general.directories.dir_functest_data') -FUNCTEST_RESULTS_DIR = \ - ft_utils.get_functest_config('general.directories.dir_results') -DEPLOYMENT_MAME = \ - ft_utils.get_functest_config('rally.deployment_name') -TEMPEST_REPO_DIR = \ - ft_utils.get_functest_config('general.directories.dir_repo_tempest') - -ENV_FILE = FUNCTEST_CONF_DIR + "/env_active" - def print_separator(): logger.info("==============================================") @@ -74,97 +54,97 @@ def print_separator(): def check_env_variables(): print_separator() logger.info("Checking environment variables...") - global CI_INSTALLER_TYPE - global CI_INSTALLER_IP - global CI_DEBUG - global CI_SCENARIO - CI_INSTALLER_TYPE = os.getenv('INSTALLER_TYPE') - CI_INSTALLER_IP = os.getenv('INSTALLER_IP') - CI_SCENARIO = os.getenv('DEPLOY_SCENARIO') - CI_NODE = os.getenv('NODE_NAME') - CI_BUILD_TAG = os.getenv('BUILD_TAG') - CI_DEBUG = os.getenv('CI_DEBUG') - - if CI_INSTALLER_TYPE is None: + + if ft_constants.CI_INSTALLER_TYPE is None: logger.warning("The env variable 'INSTALLER_TYPE' is not defined.") - CI_INSTALLER_TYPE = "undefined" + ft_constants.CI_INSTALLER_TYPE = "undefined" else: - if CI_INSTALLER_TYPE not in INSTALLERS: + if ft_constants.CI_INSTALLER_TYPE not in ft_constants.INSTALLERS: logger.warning("INSTALLER_TYPE=%s is not a valid OPNFV installer. " "Available OPNFV Installers are : %s. " "Setting INSTALLER_TYPE=undefined." - % (CI_INSTALLER_TYPE, INSTALLERS)) - CI_INSTALLER_TYPE = "undefined" + % (ft_constants.CI_INSTALLER_TYPE, + ft_constants.INSTALLERS)) + ft_constants.CI_INSTALLER_TYPE = "undefined" else: - logger.info(" INSTALLER_TYPE=%s" % CI_INSTALLER_TYPE) + logger.info(" INSTALLER_TYPE=%s" + % ft_constants.CI_INSTALLER_TYPE) - if CI_INSTALLER_IP is None: + if ft_constants.CI_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.") else: - logger.info(" INSTALLER_IP=%s" % CI_INSTALLER_IP) + logger.info(" INSTALLER_IP=%s" % ft_constants.CI_INSTALLER_IP) - if CI_SCENARIO is None: + if ft_constants.CI_SCENARIO is None: logger.warning("The env variable 'DEPLOY_SCENARIO' is not defined. " "Setting CI_SCENARIO=undefined.") - CI_SCENARIO = "undefined" + ft_constants.CI_SCENARIO = "undefined" else: - logger.info(" DEPLOY_SCENARIO=%s" % CI_SCENARIO) - if CI_DEBUG: - logger.info(" CI_DEBUG=%s" % CI_DEBUG) + logger.info(" DEPLOY_SCENARIO=%s" % ft_constants.CI_SCENARIO) + if ft_constants.CI_DEBUG: + logger.info(" CI_DEBUG=%s" % ft_constants.CI_DEBUG) - if CI_NODE: - logger.info(" NODE_NAME=%s" % CI_NODE) + if ft_constants.CI_NODE: + logger.info(" NODE_NAME=%s" % ft_constants.CI_NODE) - if CI_BUILD_TAG: - logger.info(" BUILD_TAG=%s" % CI_BUILD_TAG) + if ft_constants.CI_BUILD_TAG: + logger.info(" BUILD_TAG=%s" % ft_constants.CI_BUILD_TAG) + + if ft_constants.IS_CI_RUN: + logger.info(" IS_CI_RUN=%s" % ft_constants.IS_CI_RUN) def create_directories(): print_separator() logger.info("Creating needed directories...") - if not os.path.exists(FUNCTEST_CONF_DIR): - os.makedirs(FUNCTEST_CONF_DIR) - logger.info(" %s created." % FUNCTEST_CONF_DIR) + if not os.path.exists(ft_constants.FUNCTEST_CONF_DIR): + os.makedirs(ft_constants.FUNCTEST_CONF_DIR) + logger.info(" %s created." % ft_constants.FUNCTEST_CONF_DIR) else: - logger.debug(" %s already exists." % FUNCTEST_CONF_DIR) + logger.debug(" %s already exists." + % ft_constants.FUNCTEST_CONF_DIR) - if not os.path.exists(FUNCTEST_DATA_DIR): - os.makedirs(FUNCTEST_DATA_DIR) - logger.info(" %s created." % FUNCTEST_DATA_DIR) + if not os.path.exists(ft_constants.FUNCTEST_DATA_DIR): + os.makedirs(ft_constants.FUNCTEST_DATA_DIR) + logger.info(" %s created." % ft_constants.FUNCTEST_DATA_DIR) else: - logger.debug(" %s already exists." % FUNCTEST_DATA_DIR) + logger.debug(" %s already exists." + % ft_constants.FUNCTEST_DATA_DIR) def source_rc_file(): print_separator() logger.info("Fetching RC file...") - rc_file = os.getenv('creds') - if rc_file is None: + + if ft_constants.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 ...") - rc_file = "/home/opnfv/functest/conf/openstack.creds" + ft_constants.OPENSTACK_CREDS = \ + "/home/opnfv/functest/conf/openstack.creds" - if not os.path.isfile(rc_file): + if not os.path.isfile(ft_constants.OPENSTACK_CREDS): logger.info("RC file not provided. " "Fetching it from the installer...") - if CI_INSTALLER_IP is None: + if ft_constants.CI_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 CI_INSTALLER_TYPE not in INSTALLERS: + if ft_constants.CI_INSTALLER_TYPE not in ft_constants.INSTALLERS: logger.error("Cannot fetch credentials. INSTALLER_TYPE=%s is " "not a valid OPNFV installer. Available " - "installers are : %s." % INSTALLERS) + "installers are : %s." % ft_constants.INSTALLERS) sys.exit("Wrong INSTALLER_TYPE.") cmd = ("/home/opnfv/repos/releng/utils/fetch_os_creds.sh " "-d %s -i %s -a %s" - % (rc_file, CI_INSTALLER_TYPE, CI_INSTALLER_IP)) + % (ft_constants.OPENSTACK_CREDS, + ft_constants.CI_INSTALLER_TYPE, + ft_constants.CI_INSTALLER_IP)) logger.debug("Executing command: %s" % cmd) p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE) output = p.communicate()[0] @@ -173,24 +153,39 @@ def source_rc_file(): logger.error("Failed to fetch credentials from installer.") sys.exit(1) else: - logger.info("RC file provided in %s." % rc_file) - if os.path.getsize(rc_file) == 0: - logger.error("The file %s is empty." % rc_file) + logger.info("RC file provided in %s." + % ft_constants.OPENSTACK_CREDS) + if os.path.getsize(ft_constants.OPENSTACK_CREDS) == 0: + logger.error("The file %s is empty." + % ft_constants.OPENSTACK_CREDS) sys.exit(1) logger.info("Sourcing the OpenStack RC file...") - creds = os_utils.source_credentials(rc_file) + creds = os_utils.source_credentials( + ft_constants.OPENSTACK_CREDS) str = "" for key, value in creds.iteritems(): if re.search("OS_", key): str += "\n\t\t\t\t\t\t " + key + "=" + value + if key == 'OS_AUTH_URL': + ft_constants.OS_AUTH_URL = value + elif key == 'OS_USERNAME': + ft_constants.OS_USERNAME = value + elif key == 'OS_TENANT_NAME': + ft_constants.OS_TENANT_NAME = value + elif key == 'OS_PASSWORD': + ft_constants.OS_PASSWORD = value logger.debug("Used credentials: %s" % str) + logger.debug("OS_AUTH_URL:%s" % ft_constants.OS_AUTH_URL) + logger.debug("OS_USERNAME:%s" % ft_constants.OS_USERNAME) + logger.debug("OS_TENANT_NAME:%s" % ft_constants.OS_TENANT_NAME) + logger.debug("OS_PASSWORD:%s" % ft_constants.OS_PASSWORD) def patch_config_file(): updated = False for key in functest_patch_yaml: - if key in CI_SCENARIO: + if key in ft_constants.CI_SCENARIO: new_functest_yaml = dict(ft_utils.merge_dicts( ft_utils.get_functest_yaml(), functest_patch_yaml[key])) updated = True @@ -205,7 +200,7 @@ def patch_config_file(): def verify_deployment(): print_separator() logger.info("Verifying OpenStack services...") - cmd = ("%s/functest/ci/check_os.sh" % ft_utils.FUNCTEST_REPO) + cmd = ("%s/functest/ci/check_os.sh" % ft_constants.FUNCTEST_REPO_DIR) logger.debug("Executing command: %s" % cmd) p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True) @@ -223,19 +218,21 @@ def install_rally(): logger.info("Creating Rally environment...") cmd = "rally deployment destroy opnfv-rally" - ft_utils.execute_command(cmd, - error_msg=("Deployment %s does not exist." - % DEPLOYMENT_MAME), verbose=False) + ft_utils.execute_command(cmd, error_msg=( + "Deployment %s does not exist." + % ft_constants.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 += DEPLOYMENT_MAME + cmd += ft_constants.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 " + TEMPEST_REPO_DIR + + cmd = ("rally verify install --source " + + ft_constants.TEMPEST_REPO_DIR + " --system-wide") ft_utils.execute_command(cmd, error_msg="Problem installing Tempest.") @@ -258,11 +255,11 @@ def install_rally(): def check_environment(): msg_not_active = "The Functest environment is not installed." - if not os.path.isfile(ENV_FILE): + if not os.path.isfile(ft_constants.ENV_FILE): logger.error(msg_not_active) sys.exit(1) - with open(ENV_FILE, "r") as env_file: + with open(ft_constants.ENV_FILE, "r") as env_file: s = env_file.read() if not re.search("1", s): logger.error(msg_not_active) @@ -285,7 +282,7 @@ def main(): verify_deployment() install_rally() - with open(ENV_FILE, "w") as env_file: + with open(ft_constants.ENV_FILE, "w") as env_file: env_file.write("1") check_environment() @@ -295,5 +292,6 @@ def main(): exit(0) + if __name__ == '__main__': main() -- cgit 1.2.3-korg