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
16 """ tests configuration """
25 import functest.utils.functest_logger as ft_logger
26 import functest.utils.functest_utils as functest_utils
27 import functest.utils.openstack_utils as os_utils
30 tests = ['authenticate', 'glance', 'cinder', 'heat', 'keystone',
31 'neutron', 'nova', 'quotas', 'requests', 'vm', 'all']
32 parser = argparse.ArgumentParser()
33 parser.add_argument("test_name",
34 help="Module name to be tested. "
35 "Possible values are : "
36 "[ {d[0]} | {d[1]} | {d[2]} | {d[3]} | {d[4]} | "
37 "{d[5]} | {d[6]} | {d[7]} | {d[8]} | {d[9]} | "
40 "performs all possible test scenarios"
43 parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
44 parser.add_argument("-r", "--report",
45 help="Create json result file",
47 parser.add_argument("-s", "--smoke",
48 help="Smoke test mode",
50 parser.add_argument("-v", "--verbose",
51 help="Print verbose info about the progress",
53 parser.add_argument("-n", "--noclean",
54 help="Don't clean the created resources for this test.",
56 parser.add_argument("-z", "--sanity",
57 help="Sanity test mode, execute only a subset of tests",
60 args = parser.parse_args()
65 RALLY_STDERR = subprocess.STDOUT
67 RALLY_STDERR = open(os.devnull, 'w')
69 """ logging configuration """
70 logger = ft_logger.Logger("run_rally").getLogger()
72 REPO_PATH = os.environ['repos_dir'] + '/functest/'
73 if not os.path.exists(REPO_PATH):
74 logger.error("Functest repository directory not found '%s'" % REPO_PATH)
78 functest_yaml = functest_utils.get_functest_yaml()
80 HOME = os.environ['HOME'] + "/"
81 RALLY_DIR = REPO_PATH + functest_yaml.get("general").get(
82 "directories").get("dir_rally")
83 TEMPLATE_DIR = RALLY_DIR + "scenario/templates"
84 SUPPORT_DIR = RALLY_DIR + "scenario/support"
86 FLAVOR_NAME = "m1.tiny"
89 ITERATIONS_AMOUNT = 10
92 RESULTS_DIR = functest_yaml.get("general").get("directories").get(
94 TEMPEST_CONF_FILE = functest_yaml.get("general").get("directories").get(
95 "dir_results") + '/tempest/tempest.conf'
96 TEST_DB = functest_yaml.get("results").get("test_db_url")
98 PRIVATE_NET_NAME = functest_yaml.get("rally").get("network_name")
99 PRIVATE_SUBNET_NAME = functest_yaml.get("rally").get("subnet_name")
100 PRIVATE_SUBNET_CIDR = functest_yaml.get("rally").get("subnet_cidr")
101 ROUTER_NAME = functest_yaml.get("rally").get("router_name")
103 GLANCE_IMAGE_NAME = functest_yaml.get("general").get("openstack").get(
105 GLANCE_IMAGE_FILENAME = functest_yaml.get("general").get("openstack").get(
107 GLANCE_IMAGE_FORMAT = functest_yaml.get("general").get("openstack").get(
109 GLANCE_IMAGE_PATH = functest_yaml.get("general").get("directories").get(
110 "dir_functest_data") + "/" + GLANCE_IMAGE_FILENAME
112 CINDER_VOLUME_TYPE_NAME = "volume_test"
116 neutron_client = None
119 def get_task_id(cmd_raw):
121 get task id from command rally result
123 :return: task_id as string
125 taskid_re = re.compile('^Task +(.*): started$')
126 for line in cmd_raw.splitlines(True):
128 match = taskid_re.match(line)
130 return match.group(1)
134 def task_succeed(json_raw):
136 Parse JSON from rally JSON results
140 rally_report = json.loads(json_raw)
141 for report in rally_report:
142 if report is None or report.get('result') is None:
145 for result in report.get('result'):
146 if result is None or len(result.get('error')) > 0:
152 def live_migration_supported():
153 config = iniparse.ConfigParser()
154 if (config.read(TEMPEST_CONF_FILE) and
155 config.has_section('compute-feature-enabled') and
156 config.has_option('compute-feature-enabled', 'live_migration')):
157 return config.getboolean('compute-feature-enabled', 'live_migration')
162 def build_task_args(test_file_name):
163 task_args = {'service_list': [test_file_name]}
164 task_args['image_name'] = GLANCE_IMAGE_NAME
165 task_args['flavor_name'] = FLAVOR_NAME
166 task_args['glance_image_location'] = GLANCE_IMAGE_PATH
167 task_args['tmpl_dir'] = TEMPLATE_DIR
168 task_args['sup_dir'] = SUPPORT_DIR
169 task_args['users_amount'] = USERS_AMOUNT
170 task_args['tenants_amount'] = TENANTS_AMOUNT
171 task_args['use_existing_users'] = False
172 task_args['iterations'] = ITERATIONS_AMOUNT
173 task_args['concurrency'] = CONCURRENCY
176 task_args['full_mode'] = False
177 task_args['smoke'] = True
179 task_args['full_mode'] = True
180 task_args['smoke'] = args.smoke
182 ext_net = os_utils.get_external_net(neutron_client)
184 task_args['floating_network'] = str(ext_net)
186 task_args['floating_network'] = ''
188 net_id = network_dict['net_id']
189 task_args['netid'] = str(net_id)
190 task_args['live_migration'] = live_migration_supported()
192 auth_url = os.getenv('OS_AUTH_URL')
193 if auth_url is not None:
194 task_args['request_url'] = auth_url.rsplit(":", 1)[0]
196 task_args['request_url'] = ''
201 def get_output(proc, test_name):
205 overall_duration = 0.0
209 while proc.poll() is None:
210 line = proc.stdout.readline()
214 if ("Load duration" in line or
216 "finished" in line or
217 " Preparing" in line or
221 elif "test scenario" in line:
222 result += "\n" + line
223 elif "Full duration" in line:
224 result += line + "\n\n"
226 # parse output for summary report
228 "| action" not in line and
229 "| Starting" not in line and
230 "| Completed" not in line and
231 "| ITER" not in line and
233 "| total" not in line):
235 elif "| total" in line:
236 percentage = ((line.split('|')[8]).strip(' ')).strip('%')
238 success += float(percentage)
240 logger.info('Percentage error: %s, %s' % (percentage, line))
242 elif "Full duration" in line:
243 duration = line.split(': ')[1]
245 overall_duration += float(duration)
247 logger.info('Duration error: %s, %s' % (duration, line))
249 overall_duration = "{:10.2f}".format(overall_duration)
253 success_avg = "{:0.2f}".format(success / nb_totals)
255 scenario_summary = {'test_name': test_name,
256 'overall_duration': overall_duration,
257 'nb_tests': nb_tests,
258 'success': success_avg}
259 SUMMARY.append(scenario_summary)
261 logger.debug("\n" + result)
266 def get_cmd_output(proc):
269 while proc.poll() is None:
270 line = proc.stdout.readline()
276 def run_task(test_name):
278 # the "main" function of the script who launch rally for a task
279 # :param test_name: name for the rally test
283 logger.info('Starting test scenario "{}" ...'.format(test_name))
284 start_time = time.time()
286 task_file = '{}task.yaml'.format(RALLY_DIR)
287 if not os.path.exists(task_file):
288 logger.error("Task file '%s' does not exist." % task_file)
291 test_file_name = '{}opnfv-{}.yaml'.format(RALLY_DIR + "scenario/",
293 if not os.path.exists(test_file_name):
294 logger.error("The scenario '%s' does not exist." % test_file_name)
297 logger.debug('Scenario fetched from : {}'.format(test_file_name))
299 cmd_line = ("rally task start --abort-on-sla-failure " +
300 "--task {} ".format(task_file) +
301 "--task-args \"{}\" ".format(build_task_args(test_name)))
302 logger.debug('running command line : {}'.format(cmd_line))
304 p = subprocess.Popen(cmd_line, stdout=subprocess.PIPE,
305 stderr=RALLY_STDERR, shell=True)
306 output = get_output(p, test_name)
307 task_id = get_task_id(output)
308 logger.debug('task_id : {}'.format(task_id))
311 logger.error('Failed to retrieve task_id, validating task...')
312 cmd_line = ("rally task validate " +
313 "--task {} ".format(task_file) +
314 "--task-args \"{}\" ".format(build_task_args(test_name)))
315 logger.debug('running command line : {}'.format(cmd_line))
316 p = subprocess.Popen(cmd_line, stdout=subprocess.PIPE,
317 stderr=subprocess.STDOUT, shell=True)
318 output = get_cmd_output(p)
319 logger.error("Task validation result:" + "\n" + output)
322 # check for result directory and create it otherwise
323 if not os.path.exists(RESULTS_DIR):
324 logger.debug('%s does not exist, we create it.'.format(RESULTS_DIR))
325 os.makedirs(RESULTS_DIR)
327 # write html report file
328 report_file_name = '{}opnfv-{}.html'.format(RESULTS_DIR, test_name)
329 cmd_line = "rally task report {} --out {}".format(task_id,
332 logger.debug('running command line : {}'.format(cmd_line))
335 # get and save rally operation JSON result
336 cmd_line = "rally task results %s" % task_id
337 logger.debug('running command line : {}'.format(cmd_line))
338 cmd = os.popen(cmd_line)
339 json_results = cmd.read()
340 with open('{}opnfv-{}.json'.format(RESULTS_DIR, test_name), 'w') as f:
341 logger.debug('saving json file')
342 f.write(json_results)
344 with open('{}opnfv-{}.json'
345 .format(RESULTS_DIR, test_name)) as json_file:
346 json_data = json.load(json_file)
348 """ parse JSON operation result """
350 if task_succeed(json_results):
351 logger.info('Test scenario: "{}" OK.'.format(test_name) + "\n")
354 logger.info('Test scenario: "{}" Failed.'.format(test_name) + "\n")
356 # Push results in payload of testcase
358 stop_time = time.time()
359 logger.debug("Push Rally detailed results into DB")
360 functest_utils.push_results_to_db("functest",
372 global neutron_client
374 nova_client = os_utils.get_nova_client()
375 neutron_client = os_utils.get_neutron_client()
376 cinder_client = os_utils.get_cinder_client()
378 start_time = time.time()
381 if not (args.test_name in tests):
382 logger.error('argument not valid')
387 volume_types = os_utils.list_volume_types(cinder_client,
390 volume_type = os_utils.create_volume_type(
391 cinder_client, CINDER_VOLUME_TYPE_NAME)
393 logger.error("Failed to create volume type...")
396 logger.debug("Volume type '%s' created succesfully..."
397 % CINDER_VOLUME_TYPE_NAME)
399 logger.debug("Using existing volume type(s)...")
401 image_exists, image_id = os_utils.get_or_create_image(GLANCE_IMAGE_NAME,
407 logger.debug("Creating network '%s'..." % PRIVATE_NET_NAME)
408 network_dict = os_utils.create_shared_network_full(PRIVATE_NET_NAME,
415 if args.test_name == "all":
416 for test_name in tests:
417 if not (test_name == 'all' or
421 logger.debug("Test name: " + args.test_name)
422 run_task(args.test_name)
427 " Rally Summary Report\n"
429 "+===================+============+===============+===========+"
431 "| Module | Duration | nb. Test Run | Success |"
433 "+===================+============+===============+===========+"
436 stop_time = time.time()
438 # for each scenario we draw a row for the table
443 name = "{0:<17}".format(s['test_name'])
444 duration = float(s['overall_duration'])
445 total_duration += duration
446 duration = time.strftime("%M:%S", time.gmtime(duration))
447 duration = "{0:<10}".format(duration)
448 nb_tests = "{0:<13}".format(s['nb_tests'])
449 total_nb_tests += int(s['nb_tests'])
450 success = "{0:<10}".format(str(s['success']) + '%')
451 total_success += float(s['success'])
453 "| " + name + " | " + duration + " | " +
454 nb_tests + " | " + success + "|\n" +
455 "+-------------------+------------"
456 "+---------------+-----------+\n")
457 payload.append({'module': name,
458 'details': {'duration': s['overall_duration'],
459 'nb tests': s['nb_tests'],
460 'success': s['success']}})
462 total_duration_str = time.strftime("%H:%M:%S", time.gmtime(total_duration))
463 total_duration_str2 = "{0:<10}".format(total_duration_str)
464 total_nb_tests_str = "{0:<13}".format(total_nb_tests)
465 success_rate = "{:0.2f}".format(total_success / len(SUMMARY))
466 success_rate_str = "{0:<10}".format(str(success_rate) + '%')
467 report += "+===================+============+===============+===========+"
469 report += ("| TOTAL: | " + total_duration_str2 + " | " +
470 total_nb_tests_str + " | " + success_rate_str + "|\n")
471 report += "+===================+============+===============+===========+"
474 logger.info("\n" + report)
475 payload.append({'summary': {'duration': total_duration,
476 'nb tests': total_nb_tests,
477 'nb success': success_rate}})
480 case_name = "rally_sanity"
482 case_name = "rally_full"
484 # Evaluation of the success criteria
485 status = functest_utils.check_success_rate(case_name, success_rate)
492 logger.debug("Pushing Rally summary into DB...")
493 functest_utils.push_results_to_db("functest",
504 logger.debug("Deleting image '%s' with ID '%s'..."
505 % (GLANCE_IMAGE_NAME, image_id))
506 if not os_utils.delete_glance_image(nova_client, image_id):
507 logger.error("Error deleting the glance image")
510 logger.debug("Deleting volume type '%s'..."
511 % CINDER_VOLUME_TYPE_NAME)
512 if not os_utils.delete_volume_type(cinder_client, volume_type):
513 logger.error("Error in deleting volume type...")
518 if __name__ == '__main__':