3 # Author: Jose Lausuch (jose.lausuch@ericsson.com)
5 # Installs the Functest framework within the Docker container
6 # and run the tests automatically
9 # All rights reserved. This program and the accompanying materials
10 # are made available under the terms of the Apache License, Version 2.0
11 # which accompanies this distribution, and is available at
12 # http://www.apache.org/licenses/LICENSE-2.0
22 import functest.utils.functest_logger as ft_logger
23 import functest.utils.functest_utils as ft_utils
24 import functest.utils.openstack_utils as os_utils
28 actions = ['start', 'check']
29 parser = argparse.ArgumentParser()
30 parser.add_argument("action", help="Possible actions are: "
31 "'{d[0]}|{d[1]}' ".format(d=actions))
32 parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
33 args = parser.parse_args()
36 """ logging configuration """
37 logger = ft_logger.Logger("prepare_env").getLogger()
40 """ global variables """
41 INSTALLERS = ['fuel', 'compass', 'apex', 'joid']
42 CI_INSTALLER_TYPE = ""
46 REPOS_DIR = os.getenv('repos_dir')
47 FUNCTEST_REPO = REPOS_DIR + '/functest/'
49 with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
50 functest_yaml = yaml.safe_load(f)
52 FUNCTEST_CONF_DIR = functest_yaml.get("general").get(
53 "directories").get("dir_functest_conf")
55 FUNCTEST_DATA_DIR = functest_yaml.get("general").get(
56 "directories").get("dir_functest_data")
57 FUNCTEST_RESULTS_DIR = functest_yaml.get("general").get(
58 "directories").get("dir_results")
59 DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
60 TEMPEST_REPO_DIR = functest_yaml.get("general").get(
61 "directories").get("dir_repo_tempest")
63 ENV_FILE = FUNCTEST_CONF_DIR + "/env_active"
66 def print_separator():
67 logger.info("==============================================")
70 def check_env_variables():
72 logger.info("Checking environment variables...")
73 global CI_INSTALLER_TYPE
74 global CI_INSTALLER_IP
77 CI_INSTALLER_TYPE = os.getenv('INSTALLER_TYPE')
78 CI_INSTALLER_IP = os.getenv('INSTALLER_IP')
79 CI_SCENARIO = os.getenv('DEPLOY_SCENARIO')
80 CI_NODE = os.getenv('NODE_NAME')
81 CI_BUILD_TAG = os.getenv('BUILD_TAG')
82 CI_DEBUG = os.getenv('CI_DEBUG')
84 if CI_INSTALLER_TYPE is None:
85 logger.warning("The env variable 'INSTALLER_TYPE' is not defined.")
86 CI_INSTALLER_TYPE = "undefined"
88 if os.getenv('INSTALLER_TYPE') not in INSTALLERS:
89 logger.warning("INSTALLER_TYPE=%s is not a valid OPNFV installer. "
90 "Available OPNFV Installers are : %s."
91 "Setting INSTALLER_TYPE=undefined." % INSTALLERS)
92 CI_INSTALLER_TYPE = "undefined"
94 logger.info(" INSTALLER_TYPE=%s" % CI_INSTALLER_TYPE)
96 if CI_INSTALLER_IP is None:
97 logger.warning("The env variable 'INSTALLER_IP' is not defined. "
98 "It is needed to fetch the OpenStack credentials. "
99 "If the credentials are not provided to the "
100 "container as a volume, please add this env variable "
101 "to the 'docker run' command.")
103 logger.info(" INSTALLER_IP=%s" % CI_INSTALLER_IP)
105 if CI_SCENARIO is None:
106 logger.warning("The env variable 'DEPLOY_SCENARIO' is not defined. "
107 "Setting CE_SCENARIO=undefined.")
108 CI_SCENARIO = "undefined"
110 logger.info(" DEPLOY_SCENARIO=%s" % CI_SCENARIO)
112 logger.info(" CI_DEBUG=%s" % CI_DEBUG)
115 logger.info(" NODE_NAME=%s" % CI_NODE)
118 logger.info(" BUILD_TAG=%s" % CI_BUILD_TAG)
121 def create_directories():
123 logger.info("Creating needed directories...")
124 if not os.path.exists(FUNCTEST_CONF_DIR):
125 os.makedirs(FUNCTEST_CONF_DIR)
126 logger.info(" %s created." % FUNCTEST_CONF_DIR)
128 logger.debug(" %s already exists." % FUNCTEST_CONF_DIR)
130 if not os.path.exists(FUNCTEST_DATA_DIR):
131 os.makedirs(FUNCTEST_DATA_DIR)
132 logger.info(" %s created." % FUNCTEST_DATA_DIR)
134 logger.debug(" %s already exists." % FUNCTEST_DATA_DIR)
137 def source_rc_file():
139 logger.info("Fetching RC file...")
140 rc_file = os.getenv('creds')
142 logger.warning("The environment variable 'creds' must be set and"
143 "pointing to the local RC file. Using default: "
144 "/home/opnfv/functest/conf/openstack.creds ...")
145 rc_file = "/home/opnfv/functest/conf/openstack.creds"
147 if not os.path.isfile(rc_file):
148 logger.info("RC file not provided. "
149 "Fetching it from the installer...")
150 if CI_INSTALLER_IP is None:
151 logger.error("The env variable CI_INSTALLER_IP must be provided in"
152 " order to fetch the credentials from the installer.")
153 sys.exit("Missing CI_INSTALLER_IP.")
154 if CI_INSTALLER_TYPE not in INSTALLERS:
155 logger.error("Cannot fetch credentials. INSTALLER_TYPE=%s is "
156 "not a valid OPNFV installer. Available "
157 "installers are : %s." % INSTALLERS)
158 sys.exit("Wrong INSTALLER_TYPE.")
160 cmd = ("/home/opnfv/repos/releng/utils/fetch_os_creds.sh "
162 % (rc_file, CI_INSTALLER_TYPE, CI_INSTALLER_IP))
163 logger.debug("Executing command: %s" % cmd)
164 p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)
165 output = p.communicate()[0]
166 logger.debug("\n%s" % output)
167 if p.returncode != 0:
168 logger.error("Failed to fetch credentials from installer.")
171 logger.info("RC file provided in %s." % rc_file)
172 if os.path.getsize(rc_file) == 0:
173 logger.error("The file %s is empty." % rc_file)
176 logger.info("Sourcing the OpenStack RC file...")
177 creds = os_utils.source_credentials(rc_file)
179 for key, value in creds.iteritems():
180 if re.search("OS_", key):
181 str += "\n\t\t\t\t\t\t " + key + "=" + value
182 logger.debug("Used credentials: %s" % str)
185 def verify_deployment():
187 logger.info("Verifying OpenStack services...")
188 cmd = ("%s/ci/check_os.sh" % FUNCTEST_REPO)
190 logger.debug("Executing command: %s" % cmd)
191 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
193 while p.poll() is None:
194 line = p.stdout.readline().rstrip()
197 sys.exit("Problem while running 'check_os.sh'.")
203 logger.info("Creating Rally environment...")
205 cmd = "rally deployment destroy opnfv-rally"
206 ft_utils.execute_command(cmd, logger=logger, exit_on_error=False,
207 error_msg=("Deployment %s does not exist."
208 % DEPLOYMENT_MAME), verbose=False)
210 cmd = "rally deployment create --fromenv --name=" + DEPLOYMENT_MAME
211 ft_utils.execute_command(cmd, logger,
212 error_msg="Problem creating Rally deployment")
214 logger.info("Installing tempest from existing repo...")
215 cmd = ("rally verify install --source " + TEMPEST_REPO_DIR +
217 ft_utils.execute_command(cmd, logger,
218 error_msg="Problem installing Tempest.")
220 cmd = "rally deployment check"
221 ft_utils.execute_command(cmd, logger,
222 error_msg=("OpenStack not responding or "
223 "faulty Rally deployment."))
225 cmd = "rally show images"
226 ft_utils.execute_command(cmd, logger,
227 error_msg=("Problem while listing "
228 "OpenStack images."))
230 cmd = "rally show flavors"
231 ft_utils.execute_command(cmd, logger,
232 error_msg=("Problem while showing "
233 "OpenStack flavors."))
236 def check_environment():
237 msg_not_active = "The Functest environment is not installed."
238 if not os.path.isfile(ENV_FILE):
239 logger.error(msg_not_active)
242 with open(ENV_FILE, "r") as env_file:
244 if not re.search("1", s):
245 logger.error(msg_not_active)
248 logger.info("Functest environment installed.")
252 if not (args.action in actions):
253 logger.error('Argument not valid.')
256 if args.action == "start":
257 logger.info("######### Preparing Functest environment #########\n")
258 check_env_variables()
264 with open(ENV_FILE, "w") as env_file:
269 if args.action == "check":
274 if __name__ == '__main__':