3 # Copyright (c) 2015 Ericsson
4 # jose.lausuch@ericsson.com
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
11 import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml, sys, getpass
15 from pwd import getpwuid
16 from neutronclient.v2_0 import client as neutronclient
18 actions = ['start', 'check', 'clean']
19 parser = argparse.ArgumentParser()
20 parser.add_argument("repo_path", help="Path to the repository")
21 parser.add_argument("action", help="Possible actions are: '{d[0]}|{d[1]}|{d[2]}' ".format(d=actions))
22 parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
23 parser.add_argument("-f", "--force", help="Force", action="store_true")
24 args = parser.parse_args()
27 """ logging configuration """
28 logger = logging.getLogger('config_functest')
29 logger.setLevel(logging.DEBUG)
31 ch = logging.StreamHandler()
33 ch.setLevel(logging.DEBUG)
35 ch.setLevel(logging.INFO)
37 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
38 ch.setFormatter(formatter)
41 if not os.path.exists(args.repo_path):
42 logger.error("Repo directory not found '%s'" % args.repo_path)
45 with open(args.repo_path+"testcases/config_functest.yaml") as f:
46 functest_yaml = yaml.safe_load(f)
52 """ global variables """
54 HOME = os.environ['HOME']+"/"
55 REPO_PATH = args.repo_path
56 RALLY_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_rally")
57 RALLY_REPO_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_repo")
58 RALLY_INSTALLATION_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_inst")
59 RALLY_RESULT_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_res")
60 VPING_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_vping")
61 ODL_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_odl")
63 # Tempest/Rally configuration details
64 DEPLOYMENT_MAME = "opnfv-rally"
66 #GLANCE image parameters
67 IMAGE_URL = functest_yaml.get("general").get("openstack").get("image_url")
68 IMAGE_DISK_FORMAT = functest_yaml.get("general").get("openstack").get("image_disk_format")
69 IMAGE_NAME = functest_yaml.get("general").get("openstack").get("image_name")
70 IMAGE_FILE_NAME = IMAGE_URL.rsplit('/')[-1]
71 IMAGE_DIR = HOME + functest_yaml.get("general").get("openstack").get("image_download_path")
72 IMAGE_PATH = IMAGE_DIR + IMAGE_FILE_NAME
77 Start the functest environment installation
79 if not check_permissions():
80 logger.error("Bad Python cache directory ownership.")
83 if not functest_utils.check_internet_connectivity():
84 logger.error("There is no Internet connectivity. Please check the network configuration.")
88 logger.info("Functest environment already installed. Nothing to do.")
92 # Clean in case there are left overs
93 logger.debug("Cleaning possible functest environment leftovers.")
96 logger.info("Installing needed libraries on the host")
97 cmd = "sudo yum -y install gcc libffi-devel python-devel openssl-devel gmp-devel libxml2-devel libxslt-devel postgresql-devel git wget crudini"
98 if not functest_utils.execute_command(cmd, logger):
99 logger.error("There has been a problem while installing software packages.")
102 logger.info("Installing ODL environment...")
103 if not install_odl():
104 logger.error("There has been a problem while installing Robot.")
108 logger.info("Starting installation of functest environment")
109 logger.info("Installing Rally...")
110 if not install_rally():
111 logger.error("There has been a problem while installing Rally.")
115 logger.info("Configuring Tempest...")
116 if not configure_tempest():
117 logger.error("There has been a problem while configuring Tempest.")
121 # Create result folder under functest if necessary
122 if not os.path.exists(RALLY_RESULT_DIR):
123 os.makedirs(RALLY_RESULT_DIR)
125 logger.info("Downloading image...")
126 if not functest_utils.download_url(IMAGE_URL, IMAGE_DIR):
127 logger.error("There has been a problem downloading the image '%s'." %IMAGE_URL)
131 logger.info("Creating Glance image: %s ..." %IMAGE_NAME)
132 if not create_glance_image(IMAGE_PATH,IMAGE_NAME,IMAGE_DISK_FORMAT):
133 logger.error("There has been a problem while creating the Glance image.")
142 Check if the functest environment is properly installed
146 logger.info("Checking current functest configuration...")
148 logger.debug("Checking script directories...")
150 dirs = [RALLY_DIR, RALLY_INSTALLATION_DIR, VPING_DIR, ODL_DIR]
152 if not os.path.exists(dir):
153 logger.debug("The directory '%s' does NOT exist." % dir)
157 logger.debug(" %s found" % dir)
159 logger.debug("...OK")
161 logger.debug("...FAIL")
164 logger.debug("Checking Rally deployment...")
165 if not check_rally():
166 logger.debug(" Rally deployment NOT installed.")
168 logger.debug("...FAIL")
170 logger.debug("...OK")
172 logger.debug("Checking Image...")
174 if not os.path.isfile(IMAGE_PATH):
175 logger.debug(" Image file '%s' NOT found." % IMAGE_PATH)
179 logger.debug(" Image file found in %s" % IMAGE_PATH)
181 cmd="glance image-list | grep " + IMAGE_NAME
182 FNULL = open(os.devnull, 'w');
183 logger.debug(' Executing command : {}'.format(cmd))
184 p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
185 #if the command does not exist or there is no glance image
186 line = p.stdout.readline()
188 logger.debug(" Glance image NOT found.")
192 logger.debug(" Glance image found.")
195 logger.debug("...OK")
197 logger.debug("...FAIL")
199 #TODO: check OLD environment setup
210 Clean the existing functest environment
212 logger.info("Removing current functest environment...")
213 if os.path.exists(RALLY_INSTALLATION_DIR):
214 logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
215 shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
217 if os.path.exists(RALLY_REPO_DIR):
218 logger.debug("Removing Rally repository %s" % RALLY_REPO_DIR)
219 cmd = "sudo rm -rf " + RALLY_REPO_DIR #need to be sudo, not possible with rmtree
220 functest_utils.execute_command(cmd,logger)
222 if os.path.exists(IMAGE_PATH):
223 logger.debug("Deleting image")
224 os.remove(IMAGE_PATH)
226 cmd = "glance image-list | grep "+IMAGE_NAME+" | cut -c3-38"
227 p = os.popen(cmd,"r")
229 #while image_id = p.readline()
230 for image_id in p.readlines():
231 cmd = "glance image-delete " + image_id
232 functest_utils.execute_command(cmd,logger)
234 if os.path.exists(RALLY_RESULT_DIR):
235 logger.debug("Removing Result directory")
236 shutil.rmtree(RALLY_RESULT_DIR,ignore_errors=True)
239 logger.info("Functest environment clean!")
243 def check_permissions():
244 current_user = getpass.getuser()
245 cache_dir = HOME+".cache/pip"
246 logger.info("Checking permissions of '%s'..." %cache_dir)
247 logger.debug("Current user is '%s'" %current_user)
248 cache_user = getpwuid(stat(cache_dir).st_uid).pw_name
249 logger.debug("Cache directory owner is '%s'" %cache_user)
250 if cache_user != current_user:
251 logger.info("The owner of '%s' is '%s'. Please run 'sudo chown -R %s %s'." %(cache_dir, cache_user, current_user, cache_dir))
259 logger.info("Rally is already installed.")
261 logger.debug("Cloning repository...")
262 url = "https://git.openstack.org/openstack/rally"
263 Repo.clone_from(url, RALLY_REPO_DIR)
265 logger.debug("Executing %s./install_rally.sh..." %RALLY_REPO_DIR)
266 install_script = RALLY_REPO_DIR + "install_rally.sh --yes"
267 cmd = 'sudo ' + install_script
268 functest_utils.execute_command(cmd,logger)
270 logger.debug("Creating Rally environment...")
271 cmd = "rally deployment create --fromenv --name="+DEPLOYMENT_MAME
272 functest_utils.execute_command(cmd,logger)
274 logger.debug("Installing tempest...")
275 cmd = "rally verify install"
276 functest_utils.execute_command(cmd,logger)
278 cmd = "rally deployment check"
279 functest_utils.execute_command(cmd,logger)
280 #TODO: check that everything is 'Available' and warn if not
282 cmd = "rally show images"
283 functest_utils.execute_command(cmd,logger)
285 cmd = "rally show flavors"
286 functest_utils.execute_command(cmd,logger)
291 def configure_tempest():
293 Add/update needed parameters into tempest.conf file generated by Rally
296 creds_neutron = functest_utils.get_credentials("neutron")
297 neutron_client = neutronclient.Client(**creds_neutron)
299 logger.debug("Generating tempest.conf file...")
300 cmd = "rally verify genconfig"
301 functest_utils.execute_command(cmd,logger)
303 logger.debug("Resolving deployment UUID...")
304 cmd = "rally deployment list | awk '/"+DEPLOYMENT_MAME+"/ {print $2}'"
305 p = subprocess.Popen(cmd, shell=True,
306 stdout=subprocess.PIPE,
307 stderr=subprocess.STDOUT);
308 deployment_uuid = p.stdout.readline().rstrip()
309 if deployment_uuid == "":
310 logger.debug(" Rally deployment NOT found")
313 logger.debug("Finding tempest.conf file...")
314 tempest_conf_file = RALLY_INSTALLATION_DIR+"tempest/for-deployment-" \
315 +deployment_uuid+"/tempest.conf"
317 logger.debug(" Updating fixed_network_name...")
318 fixed_network = functest_utils.get_network_list(neutron_client)[0]['name']
319 if fixed_network != None:
320 cmd = "crudini --set "+tempest_conf_file+" compute fixed_network_name "+fixed_network
321 functest_utils.execute_command(cmd,logger)
328 Check if Rally is installed and properly configured
330 if os.path.exists(RALLY_INSTALLATION_DIR):
331 logger.debug(" Rally installation directory found in %s" % RALLY_INSTALLATION_DIR)
332 FNULL = open(os.devnull, 'w');
333 cmd="rally deployment list | grep "+DEPLOYMENT_MAME
334 logger.debug(' Executing command : {}'.format(cmd))
335 p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
336 #if the command does not exist or there is no deployment
337 line = p.stdout.readline()
339 logger.debug(" Rally deployment NOT found")
341 logger.debug(" Rally deployment found")
348 cmd = "chmod +x " + ODL_DIR + "start_tests.sh"
349 functest_utils.execute_command(cmd,logger)
350 cmd = "chmod +x " + ODL_DIR + "create_venv.sh"
351 functest_utils.execute_command(cmd,logger)
352 cmd = ODL_DIR + "create_venv.sh"
353 functest_utils.execute_command(cmd,logger)
358 def create_glance_image(path,name,disk_format):
360 Create a glance image given the absolute path of the image, its name and the disk format
362 cmd = "glance image-create --name "+name+" --is-public true --disk-format "+disk_format+" --container-format bare --file "+path
363 functest_utils.execute_command(cmd,logger)
370 if not (args.action in actions):
371 logger.error('argument not valid')
375 if not functest_utils.check_credentials():
376 logger.error("Please source the openrc credentials and run the script again.")
377 #TODO: source the credentials in this script
380 if args.action == "start":
383 if args.action == "check":
385 logger.info("Functest environment correctly installed")
387 logger.info("Functest environment not found or faulty")
389 if args.action == "clean":
394 print("Are you sure? [y|n]")
395 answer = raw_input("")
402 print("Invalid option.")
406 if __name__ == '__main__':