4 # Runs tempest and pushes the results to the DB
7 # morgan.richomme@orange.com
8 # jose.lausuch@ericsson.com
9 # viktor.tikkanen@nokia.com
11 # All rights reserved. This program and the accompanying materials
12 # are made available under the terms of the Apache License, Version 2.0
13 # which accompanies this distribution, and is available at
14 # http://www.apache.org/licenses/LICENSE-2.0
25 import functest.utils.functest_logger as ft_logger
26 import functest.utils.functest_utils as ft_utils
27 import functest.utils.openstack_utils as os_utils
31 modes = ['full', 'smoke', 'baremetal', 'compute', 'data_processing',
32 'identity', 'image', 'network', 'object_storage', 'orchestration',
33 'telemetry', 'volume', 'custom', 'defcore', 'feature_multisite']
35 """ tests configuration """
36 parser = argparse.ArgumentParser()
37 parser.add_argument("-d", "--debug",
40 parser.add_argument("-s", "--serial",
41 help="Run tests in one thread",
43 parser.add_argument("-m", "--mode",
44 help="Tempest test mode [smoke, all]",
46 parser.add_argument("-r", "--report",
47 help="Create json result file",
49 parser.add_argument("-n", "--noclean",
50 help="Don't clean the created resources for this test.",
53 args = parser.parse_args()
55 """ logging configuration """
56 logger = ft_logger.Logger("run_tempest").getLogger()
58 REPO_PATH = os.environ['repos_dir'] + '/functest/'
60 with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
61 functest_yaml = yaml.safe_load(f)
63 TEST_DB = functest_yaml.get("results").get("test_db_url")
66 GLANCE_IMAGE_NAME = functest_yaml.get("general").get(
67 "openstack").get("image_name")
68 GLANCE_IMAGE_FILENAME = functest_yaml.get("general").get(
69 "openstack").get("image_file_name")
70 GLANCE_IMAGE_FORMAT = functest_yaml.get("general").get(
71 "openstack").get("image_disk_format")
72 GLANCE_IMAGE_PATH = functest_yaml.get("general").get("directories").get(
73 "dir_functest_data") + "/" + GLANCE_IMAGE_FILENAME
74 PRIVATE_NET_NAME = functest_yaml.get("tempest").get("private_net_name")
75 PRIVATE_SUBNET_NAME = functest_yaml.get("tempest").get("private_subnet_name")
76 PRIVATE_SUBNET_CIDR = functest_yaml.get("tempest").get("private_subnet_cidr")
77 ROUTER_NAME = functest_yaml.get("tempest").get("router_name")
78 TENANT_NAME = functest_yaml.get("tempest").get("identity").get("tenant_name")
79 TENANT_DESCRIPTION = functest_yaml.get("tempest").get("identity").get(
81 USER_NAME = functest_yaml.get("tempest").get("identity").get("user_name")
82 USER_PASSWORD = functest_yaml.get("tempest").get("identity").get(
84 DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
85 RALLY_INSTALLATION_DIR = functest_yaml.get("general").get("directories").get(
87 RESULTS_DIR = functest_yaml.get("general").get("directories").get(
89 TEMPEST_RESULTS_DIR = RESULTS_DIR + '/tempest'
90 TEST_LIST_DIR = functest_yaml.get("general").get("directories").get(
92 TEMPEST_CUSTOM = REPO_PATH + TEST_LIST_DIR + 'test_list.txt'
93 TEMPEST_BLACKLIST = REPO_PATH + TEST_LIST_DIR + 'blacklist.txt'
94 TEMPEST_DEFCORE = REPO_PATH + TEST_LIST_DIR + 'defcore_req.txt'
95 TEMPEST_RAW_LIST = TEMPEST_RESULTS_DIR + '/test_raw_list.txt'
96 TEMPEST_LIST = TEMPEST_RESULTS_DIR + '/test_list.txt'
99 def get_info(file_result):
104 p = subprocess.Popen('cat tempest.log',
105 shell=True, stdout=subprocess.PIPE,
106 stderr=subprocess.STDOUT)
107 for line in p.stdout.readlines():
109 if (len(test_run) < 1):
110 test_run = re.findall("[0-9]*\.[0-9]*s", line)
111 if (len(duration) < 1):
112 duration = re.findall("[0-9]*\ tests", line)
113 regexp = r"(failures=[0-9]+)"
114 if (len(test_failed) < 1):
115 test_failed = re.findall(regexp, line)
117 logger.debug("test_run:" + test_run)
118 logger.debug("duration:" + duration)
121 def create_tempest_resources():
122 keystone_client = os_utils.get_keystone_client()
123 neutron_client = os_utils.get_neutron_client()
124 glance_client = os_utils.get_glance_client()
126 logger.debug("Creating tenant and user for Tempest suite")
127 tenant_id = os_utils.create_tenant(keystone_client,
131 logger.error("Error : Failed to create %s tenant" % TENANT_NAME)
133 user_id = os_utils.create_user(keystone_client, USER_NAME, USER_PASSWORD,
136 logger.error("Error : Failed to create %s user" % USER_NAME)
138 logger.debug("Creating private network for Tempest suite")
139 network_dic = os_utils.create_network_full(neutron_client,
145 if not os_utils.update_neutron_net(neutron_client,
146 network_dic['net_id'],
148 logger.error("Failed to update private network...")
151 logger.debug("Network '%s' is available..." % PRIVATE_NET_NAME)
153 logger.error("Private network creation failed")
156 logger.debug("Creating image for Tempest suite")
157 # Check if the given image exists
158 image_id = os_utils.get_image_id(glance_client, GLANCE_IMAGE_NAME)
160 logger.info("Using existing image '%s'..." % GLANCE_IMAGE_NAME)
162 logger.info("Creating image '%s' from '%s'..." % (GLANCE_IMAGE_NAME,
164 image_id = os_utils.create_glance_image(glance_client,
168 logger.error("Failed to create a Glance image...")
170 logger.debug("Image '%s' with ID=%s created successfully."
171 % (GLANCE_IMAGE_NAME, image_id))
174 def configure_tempest(deployment_dir):
176 Add/update needed parameters into tempest.conf file generated by Rally
179 logger.debug("Generating tempest.conf file...")
180 cmd = "rally verify genconfig"
181 ft_utils.execute_command(cmd, logger)
183 logger.debug("Finding tempest.conf file...")
184 tempest_conf_file = deployment_dir + "/tempest.conf"
185 if not os.path.isfile(tempest_conf_file):
186 logger.error("Tempest configuration file %s NOT found."
190 logger.debug("Updating selected tempest.conf parameters...")
191 config = ConfigParser.RawConfigParser()
192 config.read(tempest_conf_file)
193 config.set('compute', 'fixed_network_name', PRIVATE_NET_NAME)
194 config.set('identity', 'tenant_name', TENANT_NAME)
195 config.set('identity', 'username', USER_NAME)
196 config.set('identity', 'password', USER_PASSWORD)
198 if os.getenv('OS_ENDPOINT_TYPE') is not None:
199 services_list = ['compute', 'volume', 'image', 'network',
200 'data-processing', 'object-storage', 'orchestration']
201 sections = config.sections()
202 for service in services_list:
203 if service not in sections:
204 config.add_section(service)
205 config.set(service, 'endpoint_type',
206 os.environ.get("OS_ENDPOINT_TYPE"))
208 with open(tempest_conf_file, 'wb') as config_file:
209 config.write(config_file)
211 # Copy tempest.conf to /home/opnfv/functest/results/tempest/
212 shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
216 def configure_tempest_feature(deployment_dir, mode):
218 Add/update needed parameters into tempest.conf file generated by Rally
221 logger.debug("Finding tempest.conf file...")
222 tempest_conf_file = deployment_dir + "/tempest.conf"
223 if not os.path.isfile(tempest_conf_file):
224 logger.error("Tempest configuration file %s NOT found."
228 logger.debug("Updating selected tempest.conf parameters...")
229 config = ConfigParser.RawConfigParser()
230 config.read(tempest_conf_file)
231 if mode == 'feature_multisite':
232 config.set('service_available', 'kingbird', 'true')
233 cmd = "openstack endpoint show kingbird | grep publicurl |\
234 awk '{print $4}' | awk -F '/' '{print $4}'"
235 kingbird_api_version = os.popen(cmd).read()
236 if os.environ.get("INSTALLER_TYPE") == 'fuel':
237 # For MOS based setup, the service is accessible
239 kingbird_conf_path = "/etc/kingbird/kingbird.conf"
240 installer_type = os.getenv('INSTALLER_TYPE', 'Unknown')
241 installer_ip = os.getenv('INSTALLER_IP', 'Unknown')
242 installer_username = ft_utils.get_parameter_from_yaml(
243 "multisite." + installer_type +
244 "_environment.installer_username")
245 installer_password = ft_utils.get_parameter_from_yaml(
246 "multisite." + installer_type +
247 "_environment.installer_password")
249 ssh_options = "-o UserKnownHostsFile=/dev/null -o \
250 StrictHostKeyChecking=no"
252 # Get the controller IP from the fuel node
253 cmd = 'sshpass -p %s ssh 2>/dev/null %s %s@%s \
254 \'fuel node --env 1| grep controller | grep "True\| 1" \
255 | awk -F\| "{print \$5}"\'' % (installer_password,
259 multisite_controller_ip = \
260 "".join(os.popen(cmd).read().split())
262 # Login to controller and get bind host details
263 cmd = 'sshpass -p %s ssh 2>/dev/null %s %s@%s "ssh %s \\" \
264 grep -e "^bind_" %s \\""' % (installer_password,
268 multisite_controller_ip,
270 bind_details = os.popen(cmd).read()
271 bind_details = "".join(bind_details.split())
272 # Extract port number from the bind details
273 bind_port = re.findall(r"\D(\d{4})", bind_details)[0]
274 # Extract ip address from the bind details
275 bind_host = re.findall(r"\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}",
277 kingbird_endpoint_url = "http://" + bind_host + ":" + bind_port + \
280 cmd = "openstack endpoint show kingbird | grep publicurl |\
281 awk '{print $4}' | awk -F '/' '{print $3}'"
282 kingbird_endpoint_url = os.popen(cmd).read()
285 config.add_section("kingbird")
287 logger.info('kingbird section exist')
288 config.set('kingbird', 'endpoint_type', 'publicURL')
289 config.set('kingbird', 'TIME_TO_SYNC', '20')
290 config.set('kingbird', 'endpoint_url', kingbird_endpoint_url)
291 config.set('kingbird', 'api_version', kingbird_api_version)
292 with open(tempest_conf_file, 'wb') as config_file:
293 config.write(config_file)
295 # Copy tempest.conf to /home/opnfv/functest/results/tempest/
296 shutil.copyfile(tempest_conf_file, TEMPEST_RESULTS_DIR + '/tempest.conf')
300 def read_file(filename):
301 with open(filename) as src:
302 return [line.strip() for line in src.readlines()]
305 def generate_test_list(deployment_dir, mode):
306 logger.debug("Generating test case list...")
307 if mode == 'defcore':
308 shutil.copyfile(TEMPEST_DEFCORE, TEMPEST_RAW_LIST)
309 elif mode == 'custom':
310 if os.path.isfile(TEMPEST_CUSTOM):
311 shutil.copyfile(TEMPEST_CUSTOM, TEMPEST_RAW_LIST)
313 logger.error("Tempest test list file %s NOT found."
319 elif mode == 'feature_multisite':
320 testr_mode = " | grep -i kingbird "
324 testr_mode = 'tempest.api.' + mode
325 cmd = ("cd " + deployment_dir + ";" + "testr list-tests " +
326 testr_mode + ">" + TEMPEST_RAW_LIST + ";cd")
327 ft_utils.execute_command(cmd, logger)
330 def apply_tempest_blacklist():
331 logger.debug("Applying tempest blacklist...")
332 cases_file = read_file(TEMPEST_RAW_LIST)
333 result_file = open(TEMPEST_LIST, 'w')
336 installer_type = os.getenv('INSTALLER_TYPE')
337 deploy_scenario = os.getenv('DEPLOY_SCENARIO')
338 if (bool(installer_type) * bool(deploy_scenario)):
339 # if INSTALLER_TYPE and DEPLOY_SCENARIO are set we read the file
340 black_list_file = open(TEMPEST_BLACKLIST)
341 black_list_yaml = yaml.safe_load(black_list_file)
342 black_list_file.close()
343 for item in black_list_yaml:
344 scenarios = item['scenarios']
345 installers = item['installers']
346 if (deploy_scenario in scenarios and
347 installer_type in installers):
348 tests = item['tests']
350 black_tests.append(test)
354 logger.debug("Tempest blacklist file does not exist.")
356 for line in cases_file:
357 if line not in black_tests:
358 result_file.write(str(line) + '\n')
362 def run_tempest(OPTION):
364 # the "main" function of the script which launches Rally to run Tempest
365 # :param option: tempest option (smoke, ..)
368 logger.info("Starting Tempest test suite: '%s'." % OPTION)
369 start_time = time.time()
370 stop_time = start_time
371 cmd_line = "rally verify start " + OPTION + " --system-wide"
373 header = ("Tempest environment:\n"
374 " Installer: %s\n Scenario: %s\n Node: %s\n Date: %s\n" %
375 (os.getenv('INSTALLER_TYPE', 'Unknown'),
376 os.getenv('DEPLOY_SCENARIO', 'Unknown'),
377 os.getenv('NODE_NAME', 'Unknown'),
378 time.strftime("%a %b %d %H:%M:%S %Z %Y")))
380 f_stdout = open(TEMPEST_RESULTS_DIR + "/tempest.log", 'w+')
381 f_stderr = open(TEMPEST_RESULTS_DIR + "/tempest-error.log", 'w+')
382 f_env = open(TEMPEST_RESULTS_DIR + "/environment.log", 'w+')
385 # subprocess.call(cmd_line, shell=True, stdout=f_stdout, stderr=f_stderr)
386 p = subprocess.Popen(
387 cmd_line, shell=True,
388 stdout=subprocess.PIPE,
393 for line in iter(p.stdout.readline, b''):
394 if re.search("\} tempest\.", line):
395 logger.info(line.replace('\n', ''))
403 cmd_line = "rally verify show"
405 p = subprocess.Popen(
406 cmd_line, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
407 for line in p.stdout:
408 if re.search("Tests\:", line):
413 cmd_line = "rally verify list"
414 cmd = os.popen(cmd_line)
415 output = (((cmd.read()).splitlines()[-2]).replace(" ", "")).split("|")
417 # | UUID | Deployment UUID | smoke | tests | failures | Created at |
418 # Duration | Status |
419 num_tests = output[4]
420 num_failures = output[5]
421 time_start = output[6]
423 # Compute duration (lets assume it does not take more than 60 min)
424 dur_min = int(duration.split(':')[1])
425 dur_sec_float = float(duration.split(':')[2])
426 dur_sec_int = int(round(dur_sec_float, 0))
427 dur_sec_int = dur_sec_int + 60 * dur_min
428 stop_time = time.time()
431 diff = (int(num_tests) - int(num_failures))
432 success_rate = 100 * diff / int(num_tests)
436 if 'smoke' in args.mode:
437 case_name = 'tempest_smoke_serial'
439 case_name = 'tempest_full_parallel'
441 status = ft_utils.check_success_rate(case_name, success_rate)
442 logger.info("Tempest %s success_rate is %s%%, is marked as %s"
443 % (case_name, success_rate, status))
445 # Push results in payload of testcase
447 # add the test in error in the details sections
448 # should be possible to do it during the test
449 logger.debug("Pushing tempest results into DB...")
450 with open(TEMPEST_RESULTS_DIR + "/tempest.log", 'r') as myfile:
451 output = myfile.read()
454 for match in re.findall('(.*?)[. ]*FAILED', output):
457 # Generate json results for DB
458 json_results = {"timestart": time_start, "duration": dur_sec_int,
459 "tests": int(num_tests), "failures": int(num_failures),
460 "errors": error_logs}
461 logger.info("Results: " + str(json_results))
462 # split Tempest smoke and full
465 ft_utils.push_results_to_db("functest",
473 logger.error("Error pushing results into Database '%s'"
485 if not (args.mode in modes):
486 logger.error("Tempest mode not valid. "
487 "Possible values are:\n" + str(modes))
490 if not os.path.exists(TEMPEST_RESULTS_DIR):
491 os.makedirs(TEMPEST_RESULTS_DIR)
493 deployment_dir = ft_utils.get_deployment_dir(logger)
494 configure_tempest(deployment_dir)
495 configure_tempest_feature(deployment_dir, args.mode)
496 create_tempest_resources()
497 generate_test_list(deployment_dir, args.mode)
498 apply_tempest_blacklist()
500 MODE = "--tests-file " + TEMPEST_LIST
502 MODE += " --concur 1"
504 ret_val = run_tempest(MODE)
511 if __name__ == '__main__':