3 # Copyright (c) 2015 Orange
4 # guyrodrigue.koffi@orange.com
5 # morgan.richomme@orange.com
6 # All rights reserved. This program and the accompanying materials
7 # are made available under the terms of the Apache License, Version 2.0
8 # which accompanies this distribution, and is available at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # 0.1 (05/2015) initial commit
12 # 0.2 (28/09/2015) extract Tempest, format json result, add ceilometer suite
13 # 0.3 (19/10/2015) remove Tempest from run_rally
14 # and push result into test DB
25 from novaclient import client as novaclient
26 from glanceclient import client as glanceclient
27 from keystoneclient.v2_0 import client as keystoneclient
28 from neutronclient.v2_0 import client as neutronclient
29 from cinderclient import client as cinderclient
31 import functest.utils.functest_logger as ft_logger
32 import functest.utils.functest_utils as functest_utils
33 import functest.utils.openstack_utils as openstack_utils
35 """ tests configuration """
36 tests = ['authenticate', 'glance', 'cinder', 'heat', 'keystone',
37 'neutron', 'nova', 'quotas', 'requests', 'vm', 'all']
38 parser = argparse.ArgumentParser()
39 parser.add_argument("test_name",
40 help="Module name to be tested. "
41 "Possible values are : "
42 "[ {d[0]} | {d[1]} | {d[2]} | {d[3]} | {d[4]} | "
43 "{d[5]} | {d[6]} | {d[7]} | {d[8]} | {d[9]} | "
46 "performs all possible test scenarios"
49 parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
50 parser.add_argument("-r", "--report",
51 help="Create json result file",
53 parser.add_argument("-s", "--smoke",
54 help="Smoke test mode",
56 parser.add_argument("-v", "--verbose",
57 help="Print verbose info about the progress",
59 parser.add_argument("-n", "--noclean",
60 help="Don't clean the created resources for this test.",
62 parser.add_argument("-z", "--sanity",
63 help="Sanity test mode, execute only a subset of tests",
66 args = parser.parse_args()
72 RALLY_STDERR = subprocess.STDOUT
74 RALLY_STDERR = open(os.devnull, 'w')
76 """ logging configuration """
77 logger = ft_logger.Logger("run_rally").getLogger()
79 REPO_PATH = os.environ['repos_dir'] + '/functest/'
80 if not os.path.exists(REPO_PATH):
81 logger.error("Functest repository directory not found '%s'" % REPO_PATH)
85 with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
86 functest_yaml = yaml.safe_load(f)
89 HOME = os.environ['HOME'] + "/"
90 RALLY_DIR = REPO_PATH + functest_yaml.get("general").get(
91 "directories").get("dir_rally")
92 TEMPLATE_DIR = RALLY_DIR + "scenario/templates"
93 SUPPORT_DIR = RALLY_DIR + "scenario/support"
95 FLAVOR_NAME = "m1.tiny"
98 ITERATIONS_AMOUNT = 10
101 RESULTS_DIR = functest_yaml.get("general").get("directories").get(
103 TEMPEST_CONF_FILE = functest_yaml.get("general").get("directories").get(
104 "dir_results") + '/tempest/tempest.conf'
105 TEST_DB = functest_yaml.get("results").get("test_db_url")
107 PRIVATE_NET_NAME = functest_yaml.get("rally").get("network_name")
108 PRIVATE_SUBNET_NAME = functest_yaml.get("rally").get("subnet_name")
109 PRIVATE_SUBNET_CIDR = functest_yaml.get("rally").get("subnet_cidr")
110 ROUTER_NAME = functest_yaml.get("rally").get("router_name")
112 GLANCE_IMAGE_NAME = functest_yaml.get("general").get("openstack").get(
114 GLANCE_IMAGE_FILENAME = functest_yaml.get("general").get("openstack").get(
116 GLANCE_IMAGE_FORMAT = functest_yaml.get("general").get("openstack").get(
118 GLANCE_IMAGE_PATH = functest_yaml.get("general").get("directories").get(
119 "dir_functest_data") + "/" + GLANCE_IMAGE_FILENAME
121 CINDER_VOLUME_TYPE_NAME = "volume_test"
127 def get_task_id(cmd_raw):
129 get task id from command rally result
131 :return: task_id as string
133 taskid_re = re.compile('^Task +(.*): started$')
134 for line in cmd_raw.splitlines(True):
136 match = taskid_re.match(line)
138 return match.group(1)
142 def task_succeed(json_raw):
144 Parse JSON from rally JSON results
148 rally_report = json.loads(json_raw)
149 for report in rally_report:
150 if report is None or report.get('result') is None:
153 for result in report.get('result'):
154 if result is None or len(result.get('error')) > 0:
160 def live_migration_supported():
161 config = iniparse.ConfigParser()
162 if (config.read(TEMPEST_CONF_FILE) and
163 config.has_section('compute-feature-enabled') and
164 config.has_option('compute-feature-enabled', 'live_migration')):
165 return config.getboolean('compute-feature-enabled', 'live_migration')
170 def build_task_args(test_file_name):
171 task_args = {'service_list': [test_file_name]}
172 task_args['image_name'] = GLANCE_IMAGE_NAME
173 task_args['flavor_name'] = FLAVOR_NAME
174 task_args['glance_image_location'] = GLANCE_IMAGE_PATH
175 task_args['tmpl_dir'] = TEMPLATE_DIR
176 task_args['sup_dir'] = SUPPORT_DIR
177 task_args['users_amount'] = USERS_AMOUNT
178 task_args['tenants_amount'] = TENANTS_AMOUNT
179 task_args['use_existing_users'] = False
180 task_args['iterations'] = ITERATIONS_AMOUNT
181 task_args['concurrency'] = CONCURRENCY
184 task_args['full_mode'] = False
185 task_args['smoke'] = True
187 task_args['full_mode'] = True
188 task_args['smoke'] = args.smoke
190 ext_net = openstack_utils.get_external_net(client_dict['neutron'])
192 task_args['floating_network'] = str(ext_net)
194 task_args['floating_network'] = ''
196 net_id = network_dict['net_id']
197 task_args['netid'] = str(net_id)
198 task_args['live_migration'] = live_migration_supported()
200 auth_url = os.getenv('OS_AUTH_URL')
201 if auth_url is not None:
202 task_args['request_url'] = auth_url.rsplit(":", 1)[0]
204 task_args['request_url'] = ''
209 def get_output(proc, test_name):
213 overall_duration = 0.0
217 while proc.poll() is None:
218 line = proc.stdout.readline()
222 if ("Load duration" in line or
224 "finished" in line or
225 " Preparing" in line or
229 elif "test scenario" in line:
230 result += "\n" + line
231 elif "Full duration" in line:
232 result += line + "\n\n"
234 # parse output for summary report
236 "| action" not in line and
237 "| Starting" not in line and
238 "| Completed" not in line and
239 "| ITER" not in line and
241 "| total" not in line):
243 elif "| total" in line:
244 percentage = ((line.split('|')[8]).strip(' ')).strip('%')
246 success += float(percentage)
248 logger.info('Percentage error: %s, %s' % (percentage, line))
250 elif "Full duration" in line:
251 duration = line.split(': ')[1]
253 overall_duration += float(duration)
255 logger.info('Duration error: %s, %s' % (duration, line))
257 overall_duration = "{:10.2f}".format(overall_duration)
261 success_avg = "{:0.2f}".format(success / nb_totals)
263 scenario_summary = {'test_name': test_name,
264 'overall_duration': overall_duration,
265 'nb_tests': nb_tests,
266 'success': success_avg}
267 SUMMARY.append(scenario_summary)
269 logger.info("\n" + result)
274 def get_cmd_output(proc):
277 while proc.poll() is None:
278 line = proc.stdout.readline()
284 def run_task(test_name):
286 # the "main" function of the script who launch rally for a task
287 # :param test_name: name for the rally test
291 logger.info('Starting test scenario "{}" ...'.format(test_name))
292 start_time = time.time()
293 stop_time = start_time
295 task_file = '{}task.yaml'.format(RALLY_DIR)
296 if not os.path.exists(task_file):
297 logger.error("Task file '%s' does not exist." % task_file)
300 test_file_name = '{}opnfv-{}.yaml'.format(RALLY_DIR + "scenario/",
302 if not os.path.exists(test_file_name):
303 logger.error("The scenario '%s' does not exist." % test_file_name)
306 logger.debug('Scenario fetched from : {}'.format(test_file_name))
308 cmd_line = ("rally task start --abort-on-sla-failure " +
309 "--task {} ".format(task_file) +
310 "--task-args \"{}\" ".format(build_task_args(test_name)))
311 logger.debug('running command line : {}'.format(cmd_line))
313 p = subprocess.Popen(cmd_line, stdout=subprocess.PIPE,
314 stderr=RALLY_STDERR, shell=True)
315 output = get_output(p, test_name)
316 task_id = get_task_id(output)
317 logger.debug('task_id : {}'.format(task_id))
320 logger.error('Failed to retrieve task_id, validating task...')
321 cmd_line = ("rally task validate " +
322 "--task {} ".format(task_file) +
323 "--task-args \"{}\" ".format(build_task_args(test_name)))
324 logger.debug('running command line : {}'.format(cmd_line))
325 p = subprocess.Popen(cmd_line, stdout=subprocess.PIPE,
326 stderr=subprocess.STDOUT, shell=True)
327 output = get_cmd_output(p)
328 logger.error("Task validation result:" + "\n" + output)
331 # check for result directory and create it otherwise
332 if not os.path.exists(RESULTS_DIR):
333 logger.debug('%s does not exist, we create it.'.format(RESULTS_DIR))
334 os.makedirs(RESULTS_DIR)
336 # write html report file
337 report_file_name = '{}opnfv-{}.html'.format(RESULTS_DIR, test_name)
338 cmd_line = "rally task report {} --out {}".format(task_id,
341 logger.debug('running command line : {}'.format(cmd_line))
344 # get and save rally operation JSON result
345 cmd_line = "rally task results %s" % task_id
346 logger.debug('running command line : {}'.format(cmd_line))
347 cmd = os.popen(cmd_line)
348 json_results = cmd.read()
349 with open('{}opnfv-{}.json'.format(RESULTS_DIR, test_name), 'w') as f:
350 logger.debug('saving json file')
351 f.write(json_results)
353 with open('{}opnfv-{}.json'
354 .format(RESULTS_DIR, test_name)) as json_file:
355 json_data = json.load(json_file)
357 """ parse JSON operation result """
359 if task_succeed(json_results):
360 logger.info('Test scenario: "{}" OK.'.format(test_name) + "\n")
363 logger.info('Test scenario: "{}" Failed.'.format(test_name) + "\n")
365 # Push results in payload of testcase
367 stop_time = time.time()
368 logger.debug("Push Rally detailed results into DB")
369 functest_utils.push_results_to_db("functest",
381 start_time = time.time()
382 stop_time = start_time
385 if not (args.test_name in tests):
386 logger.error('argument not valid')
390 creds_nova = openstack_utils.get_credentials("nova")
391 nova_client = novaclient.Client('2', **creds_nova)
392 creds_neutron = openstack_utils.get_credentials("neutron")
393 neutron_client = neutronclient.Client(**creds_neutron)
394 creds_keystone = openstack_utils.get_credentials("keystone")
395 keystone_client = keystoneclient.Client(**creds_keystone)
396 glance_endpoint = keystone_client.service_catalog.url_for(
397 service_type='image', endpoint_type='publicURL')
398 glance_client = glanceclient.Client(1, glance_endpoint,
399 token=keystone_client.auth_token)
400 creds_cinder = openstack_utils.get_credentials("cinder")
401 cinder_client = cinderclient.Client('2', creds_cinder['username'],
402 creds_cinder['api_key'],
403 creds_cinder['project_id'],
404 creds_cinder['auth_url'],
405 service_type="volume")
407 client_dict['neutron'] = neutron_client
409 volume_types = openstack_utils.list_volume_types(cinder_client,
412 volume_type = openstack_utils.create_volume_type(
413 cinder_client, CINDER_VOLUME_TYPE_NAME)
415 logger.error("Failed to create volume type...")
418 logger.debug("Volume type '%s' created succesfully..."
419 % CINDER_VOLUME_TYPE_NAME)
421 logger.debug("Using existing volume type(s)...")
423 image_id = openstack_utils.get_image_id(glance_client, GLANCE_IMAGE_NAME)
427 logger.debug("Creating image '%s' from '%s'..." % (GLANCE_IMAGE_NAME,
429 image_id = openstack_utils.create_glance_image(glance_client,
433 logger.error("Failed to create the Glance image...")
436 logger.debug("Image '%s' with ID '%s' created succesfully ."
437 % (GLANCE_IMAGE_NAME, image_id))
439 logger.debug("Using existing image '%s' with ID '%s'..."
440 % (GLANCE_IMAGE_NAME, image_id))
443 logger.debug("Creating network '%s'..." % PRIVATE_NET_NAME)
444 network_dict = openstack_utils.create_network_full(logger,
445 client_dict['neutron'],
451 logger.error("Failed to create network...")
454 if not openstack_utils.update_neutron_net(client_dict['neutron'],
455 network_dict['net_id'],
457 logger.error("Failed to update network...")
460 logger.debug("Network '%s' available..." % PRIVATE_NET_NAME)
462 if args.test_name == "all":
463 for test_name in tests:
464 if not (test_name == 'all' or
468 logger.debug("Test name: " + args.test_name)
469 run_task(args.test_name)
474 " Rally Summary Report\n"
476 "+===================+============+===============+===========+"
478 "| Module | Duration | nb. Test Run | Success |"
480 "+===================+============+===============+===========+"
483 stop_time = time.time()
485 # for each scenario we draw a row for the table
490 name = "{0:<17}".format(s['test_name'])
491 duration = float(s['overall_duration'])
492 total_duration += duration
493 duration = time.strftime("%M:%S", time.gmtime(duration))
494 duration = "{0:<10}".format(duration)
495 nb_tests = "{0:<13}".format(s['nb_tests'])
496 total_nb_tests += int(s['nb_tests'])
497 success = "{0:<10}".format(str(s['success']) + '%')
498 total_success += float(s['success'])
500 "| " + name + " | " + duration + " | " +
501 nb_tests + " | " + success + "|\n" +
502 "+-------------------+------------"
503 "+---------------+-----------+\n")
504 payload.append({'module': name,
505 'details': {'duration': s['overall_duration'],
506 'nb tests': s['nb_tests'],
507 'success': s['success']}})
509 total_duration_str = time.strftime("%H:%M:%S", time.gmtime(total_duration))
510 total_duration_str2 = "{0:<10}".format(total_duration_str)
511 total_nb_tests_str = "{0:<13}".format(total_nb_tests)
512 total_success = "{:0.2f}".format(total_success / len(SUMMARY))
513 total_success_str = "{0:<10}".format(str(total_success) + '%')
514 report += "+===================+============+===============+===========+"
516 report += ("| TOTAL: | " + total_duration_str2 + " | " +
517 total_nb_tests_str + " | " + total_success_str + "|\n")
518 report += "+===================+============+===============+===========+"
521 logger.info("\n" + report)
522 payload.append({'summary': {'duration': total_duration,
523 'nb tests': total_nb_tests,
524 'nb success': total_success}})
526 # Generate json results for DB
527 # json_results = {"timestart": time_start, "duration": total_duration,
528 # "tests": int(total_nb_tests),
529 # "success": int(total_success)}
530 # logger.info("Results: "+str(json_results))
532 # Evaluation of the success criteria
534 # for Rally we decided that the overall success rate must be above 90%
535 if total_success >= 90:
539 logger.debug("Pushing Rally summary into DB...")
540 functest_utils.push_results_to_db("functest",
551 logger.debug("Deleting image '%s' with ID '%s'..."
552 % (GLANCE_IMAGE_NAME, image_id))
553 if not openstack_utils.delete_glance_image(nova_client, image_id):
554 logger.error("Error deleting the glance image")
557 logger.debug("Deleting volume type '%s'..."
558 % CINDER_VOLUME_TYPE_NAME)
559 if not openstack_utils.delete_volume_type(cinder_client, volume_type):
560 logger.error("Error in deleting volume type...")
563 if __name__ == '__main__':