3 # Copyright (c) 2015 All rights reserved
4 # This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # 0.1: This script boots the VM1 and allocates IP address from Nova
11 # Later, the VM2 boots then execute cloud-init to ping VM1.
12 # After successful ping, both the VMs are deleted.
13 # 0.2: measure test duration and publish results under json format
26 from scp import SCPClient
27 from novaclient import client as novaclient
28 from neutronclient.v2_0 import client as neutronclient
29 from keystoneclient.v2_0 import client as keystoneclient
30 from glanceclient import client as glanceclient
32 pp = pprint.PrettyPrinter(indent=4)
34 parser = argparse.ArgumentParser()
36 parser.add_argument("-d", "--debug", help="Debug mode", action="store_true")
37 parser.add_argument("-r", "--report",
38 help="Create json result file",
40 parser.add_argument("-n", "--noclean",
41 help="Don't clean the created resources for this test.",
44 args = parser.parse_args()
46 """ logging configuration """
48 logger = logging.getLogger('vPing_ssh')
49 logger.setLevel(logging.DEBUG)
51 ch = logging.StreamHandler()
54 ch.setLevel(logging.DEBUG)
56 ch.setLevel(logging.INFO)
58 formatter = logging.Formatter('%(asctime)s - %(name)s'
59 '- %(levelname)s - %(message)s')
61 ch.setFormatter(formatter)
63 paramiko.util.log_to_file("/var/log/paramiko.log")
65 REPO_PATH = os.environ['repos_dir']+'/functest/'
66 if not os.path.exists(REPO_PATH):
67 logger.error("Functest repository directory not found '%s'" % REPO_PATH)
69 sys.path.append(REPO_PATH + "testcases/")
72 with open("/home/opnfv/functest/conf/config_functest.yaml") as f:
73 functest_yaml = yaml.safe_load(f)
76 HOME = os.environ['HOME'] + "/"
79 VM_DELETE_TIMEOUT = 100
80 PING_TIMEOUT = functest_yaml.get("vping").get("ping_timeout")
81 TEST_DB = functest_yaml.get("results").get("test_db_url")
82 NAME_VM_1 = functest_yaml.get("vping").get("vm_name_1")
83 NAME_VM_2 = functest_yaml.get("vping").get("vm_name_2")
84 IP_1 = functest_yaml.get("vping").get("ip_1")
85 IP_2 = functest_yaml.get("vping").get("ip_2")
86 # GLANCE_IMAGE_NAME = functest_yaml.get("general"). \
87 # get("openstack").get("image_name")
88 GLANCE_IMAGE_NAME = "functest-vping"
89 GLANCE_IMAGE_FILENAME = functest_yaml.get("general"). \
90 get("openstack").get("image_file_name")
91 GLANCE_IMAGE_FORMAT = functest_yaml.get("general"). \
92 get("openstack").get("image_disk_format")
93 GLANCE_IMAGE_PATH = functest_yaml.get("general"). \
94 get("directories").get("dir_functest_data") + "/" + GLANCE_IMAGE_FILENAME
97 FLAVOR = functest_yaml.get("vping").get("vm_flavor")
99 # NEUTRON Private Network parameters
101 NEUTRON_PRIVATE_NET_NAME = functest_yaml.get("vping"). \
102 get("vping_private_net_name")
104 NEUTRON_PRIVATE_SUBNET_NAME = functest_yaml.get("vping"). \
105 get("vping_private_subnet_name")
107 NEUTRON_PRIVATE_SUBNET_CIDR = functest_yaml.get("vping"). \
108 get("vping_private_subnet_cidr")
110 NEUTRON_ROUTER_NAME = functest_yaml.get("vping"). \
111 get("vping_router_name")
116 """pretty printing"""
120 def waitVmActive(nova, vm):
122 # sleep and wait for VM status change
124 count = VM_BOOT_TIMEOUT / sleep_time
126 status = functest_utils.get_instance_status(nova, vm)
127 logger.debug("Status: %s" % status)
128 if status == "ACTIVE":
130 if status == "ERROR" or status == "error":
133 logger.debug("Booting a VM timed out...")
136 time.sleep(sleep_time)
140 def waitVmDeleted(nova, vm):
142 # sleep and wait for VM status change
144 count = VM_DELETE_TIMEOUT / sleep_time
146 status = functest_utils.get_instance_status(nova, vm)
150 logger.debug("Timeout")
155 time.sleep(sleep_time)
159 def create_private_neutron_net(neutron):
161 neutron.format = 'json'
162 logger.info('Creating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
163 network_id = functest_utils. \
164 create_neutron_net(neutron, NEUTRON_PRIVATE_NET_NAME)
168 logger.debug("Network '%s' created successfully" % network_id)
169 logger.debug('Creating Subnet....')
170 subnet_id = functest_utils. \
171 create_neutron_subnet(neutron,
172 NEUTRON_PRIVATE_SUBNET_NAME,
173 NEUTRON_PRIVATE_SUBNET_CIDR,
177 logger.debug("Subnet '%s' created successfully" % subnet_id)
178 logger.debug('Creating Router...')
179 router_id = functest_utils. \
180 create_neutron_router(neutron, NEUTRON_ROUTER_NAME)
185 logger.debug("Router '%s' created successfully" % router_id)
186 logger.debug('Adding router to subnet...')
188 if not functest_utils.add_interface_router(neutron, router_id, subnet_id):
190 logger.debug("Interface added successfully.")
192 logger.debug('Adding gateway to router...')
193 if not functest_utils.add_gateway_router(neutron, router_id):
195 logger.debug("Gateway added successfully.")
197 network_dic = {'net_id': network_id,
198 'subnet_id': subnet_id,
199 'router_id': router_id}
203 def cleanup(nova, neutron, image_id, network_dic, port_id1, port_id2, secgroup_id):
205 logger.debug("The OpenStack resources are not deleted.")
209 logger.info("Cleaning up...")
210 logger.debug("Deleting image...")
211 if not functest_utils.delete_glance_image(nova, image_id):
212 logger.error("Error deleting the glance image")
214 vm1 = functest_utils.get_instance_by_name(nova, NAME_VM_1)
216 logger.debug("Deleting '%s'..." % NAME_VM_1)
217 nova.servers.delete(vm1)
218 # wait until VMs are deleted
219 if not waitVmDeleted(nova, vm1):
221 "Instance '%s' with cannot be deleted. Status is '%s'" % (
222 NAME_VM_1, functest_utils.get_instance_status(nova, vm1)))
224 logger.debug("Instance %s terminated." % NAME_VM_1)
226 vm2 = functest_utils.get_instance_by_name(nova, NAME_VM_2)
229 logger.debug("Deleting '%s'..." % NAME_VM_2)
230 vm2 = nova.servers.find(name=NAME_VM_2)
231 nova.servers.delete(vm2)
233 if not waitVmDeleted(nova, vm2):
235 "Instance '%s' with cannot be deleted. Status is '%s'" % (
236 NAME_VM_2, functest_utils.get_instance_status(nova, vm2)))
238 logger.debug("Instance %s terminated." % NAME_VM_2)
240 # delete created network
241 logger.debug("Deleting network '%s'..." % NEUTRON_PRIVATE_NET_NAME)
242 net_id = network_dic["net_id"]
243 subnet_id = network_dic["subnet_id"]
244 router_id = network_dic["router_id"]
246 if not functest_utils.delete_neutron_port(neutron, port_id1):
247 logger.error("Unable to remove port '%s'" % port_id1)
249 logger.debug("Port '%s' removed successfully" % port_id1)
251 if not functest_utils.delete_neutron_port(neutron, port_id2):
252 logger.error("Unable to remove port '%s'" % port_id2)
254 logger.debug("Port '%s' removed successfully" % port_id2)
256 if not functest_utils.remove_interface_router(neutron, router_id,
258 logger.error("Unable to remove subnet '%s' from router '%s'" % (
259 subnet_id, router_id))
262 logger.debug("Interface removed successfully")
263 if not functest_utils.delete_neutron_router(neutron, router_id):
264 logger.error("Unable to delete router '%s'" % router_id)
267 logger.debug("Router deleted successfully")
269 if not functest_utils.delete_neutron_subnet(neutron, subnet_id):
270 logger.error("Unable to delete subnet '%s'" % subnet_id)
274 "Subnet '%s' deleted successfully" % NEUTRON_PRIVATE_SUBNET_NAME)
276 if not functest_utils.delete_neutron_net(neutron, net_id):
277 logger.error("Unable to delete network '%s'" % net_id)
281 "Network '%s' deleted successfully" % NEUTRON_PRIVATE_NET_NAME)
283 if not functest_utils.delete_security_group(neutron, secgroup_id):
284 logger.error("Unable to delete security group '%s'" % secgroup_id)
287 "Security group '%s' deleted successfully" % secgroup_id)
291 def push_results(start_time_ts, duration, test_status):
293 logger.debug("Pushing result into DB...")
294 scenario = functest_utils.get_scenario(logger)
295 pod_name = functest_utils.get_pod_name(logger)
296 functest_utils.push_results_to_db(TEST_DB,
298 logger, pod_name, scenario,
299 payload={'timestart': start_time_ts,
300 'duration': duration,
301 'status': test_status})
303 logger.error("Error pushing results into Database '%s'" % sys.exc_info()[0])
308 creds_nova = functest_utils.get_credentials("nova")
309 nova_client = novaclient.Client('2', **creds_nova)
310 creds_neutron = functest_utils.get_credentials("neutron")
311 neutron_client = neutronclient.Client(**creds_neutron)
312 creds_keystone = functest_utils.get_credentials("keystone")
313 keystone_client = keystoneclient.Client(**creds_keystone)
314 glance_endpoint = keystone_client.service_catalog.url_for(service_type='image',
315 endpoint_type='publicURL')
316 glance_client = glanceclient.Client(1, glance_endpoint,
317 token=keystone_client.auth_token)
323 logger.debug("Creating image '%s' from '%s'..." % (GLANCE_IMAGE_NAME,
325 image_id = functest_utils.create_glance_image(glance_client,
329 logger.error("Failed to create a Glance image...")
331 logger.debug("Image '%s' with ID=%s created successfully." %\
332 (GLANCE_IMAGE_NAME, image_id))
333 # Check if the given image exists
334 image = functest_utils.get_image_id(glance_client, GLANCE_IMAGE_NAME)
336 logger.error("ERROR: Glance image '%s' not found." % GLANCE_IMAGE_NAME)
337 logger.info("Available images are: ")
338 pMsg(nova_client.images.list())
341 network_dic = create_private_neutron_net(neutron_client)
345 "There has been a problem when creating the neutron network")
348 network_id = network_dic["net_id"]
350 # Check if the given flavor exists
353 flavor = nova_client.flavors.find(name=FLAVOR)
354 logger.info("Flavor found '%s'" % FLAVOR)
356 logger.error("Flavor '%s' not found." % FLAVOR)
357 logger.info("Available flavors are: ")
358 pMsg(nova_client.flavor.list())
361 # Deleting instances if they exist
363 servers = nova_client.servers.list()
364 for server in servers:
365 if server.name == NAME_VM_1 or server.name == NAME_VM_2:
366 logger.info("Instance %s found. Deleting..." % server.name)
369 SECGROUP_NAME = "vPing-sg"
370 SECGROUP_DESCR = "Security group for vPing test case"
371 logger.info("Creating security group '%s'..." % SECGROUP_NAME)
372 SECGROUP = functest_utils.create_security_group(neutron_client,
375 SECGROUP_ID = SECGROUP['id']
377 logger.error("Failed to create the security group...")
379 logger.debug("Security group '%s' with ID=%s created successfully." %\
380 (SECGROUP['name'], SECGROUP_ID))
382 logger.debug("Adding ICMP rules in security group '%s'..." % SECGROUP_NAME)
383 if not functest_utils.create_secgroup_rule(neutron_client, SECGROUP_ID, \
385 logger.error("Failed to create the security group rule...")
388 logger.debug("Adding SSH rules in security group '%s'..." % SECGROUP_NAME)
389 if not functest_utils.create_secgroup_rule(neutron_client, SECGROUP_ID, \
390 'ingress', 'tcp', '22', '22'):
391 logger.error("Failed to create the security group rule...")
394 if not functest_utils.create_secgroup_rule(neutron_client, SECGROUP_ID, \
395 'egress', 'tcp', '22', '22'):
396 logger.error("Failed to create the security group rule...")
401 # tune (e.g. flavor, images, network) to your specific
402 # openstack configuration here
403 # we consider start time at VM1 booting
404 start_time_ts = time.time()
405 end_time_ts = start_time_ts
406 logger.info("vPing Start Time:'%s'" % (
407 datetime.datetime.fromtimestamp(start_time_ts).strftime(
408 '%Y-%m-%d %H:%M:%S')))
411 logger.debug("Creating port 'vping-port-1' with IP %s..." % IP_1)
412 port_id1 = functest_utils.create_neutron_port(neutron_client,
413 "vping-port-1", network_id,
416 logger.error("Unable to create port.")
419 logger.info("Creating instance '%s' with IP %s..." % (NAME_VM_1, IP_1))
421 "Configuration:\n name=%s \n flavor=%s \n image=%s \n "
422 "network=%s \n" % (NAME_VM_1, flavor, image, network_id))
423 vm1 = nova_client.servers.create(
427 # nics = [{"net-id": network_id, "v4-fixed-ip": IP_1}]
428 nics=[{"port-id": port_id1}]
431 # wait until VM status is active
432 if not waitVmActive(nova_client, vm1):
433 logger.error("Instance '%s' cannot be booted. Status is '%s'" % (
434 NAME_VM_1, functest_utils.get_instance_status(nova_client, vm1)))
435 cleanup(nova_client, neutron_client, image_id, network_dic,
436 port_id1, SECGROUP_ID)
439 logger.info("Instance '%s' is ACTIVE." % NAME_VM_1)
441 # Retrieve IP of first VM
442 # logger.debug("Fetching IP...")
443 # server = functest_utils.get_instance_by_name(nova_client, NAME_VM_1)
444 # theoretically there is only one IP address so we take the
445 # first element of the table
446 # Dangerous! To be improved!
447 # test_ip = server.networks.get(NEUTRON_PRIVATE_NET_NAME)[0]
449 logger.debug("Instance '%s' got %s" % (NAME_VM_1, test_ip))
451 logger.info("Adding '%s' to security group '%s'..." % (NAME_VM_1, SECGROUP_NAME))
452 functest_utils.add_secgroup_to_instance(nova_client, vm1.id, SECGROUP['id'])
455 # we will boot then execute a ping script with cloud-init
456 # the long chain corresponds to the ping procedure converted with base 64
457 # tune (e.g. flavor, images, network) to your specific openstack
462 logger.debug("Creating port 'vping-port-2' with IP %s..." % IP_2)
463 port_id2 = functest_utils.create_neutron_port(neutron_client,
464 "vping-port-2", network_id,
468 logger.error("Unable to create port.")
471 logger.info("Creating instance '%s' with IP %s..." % (NAME_VM_2, IP_2))
473 "Configuration:\n name=%s \n flavor=%s \n image=%s \n "
474 "network=%s \n" % (NAME_VM_2, flavor, image, network_id))
475 vm2 = nova_client.servers.create(
479 nics=[{"port-id": port_id2}]
482 if not waitVmActive(nova_client, vm2):
483 logger.error("Instance '%s' cannot be booted. Status is '%s'" % (
484 NAME_VM_2, functest_utils.get_instance_status(nova_client, vm2)))
485 cleanup(nova_client, neutron_client, image_id, network_dic,
486 port_id1, port_id2, SECGROUP_ID)
489 logger.info("Instance '%s' is ACTIVE." % NAME_VM_2)
491 logger.info("Adding '%s' to security group '%s'..." % (NAME_VM_2, SECGROUP_NAME))
492 functest_utils.add_secgroup_to_instance(nova_client, vm2.id, SECGROUP['id'])
494 logger.info("Creating floating IP for VM '%s'..." % NAME_VM_2)
495 floatip = functest_utils.create_floating_ip(neutron_client)
497 logger.error("Cannot create floating IP.")
498 cleanup(nova_client, neutron_client, image_id, network_dic,
499 port_id1, port_id2, SECGROUP_ID)
501 logger.info("Floating IP created: '%s'" % floatip)
503 logger.info("Associating floating ip: '%s' to VM '%s' " % (floatip, NAME_VM_2))
504 if not functest_utils.add_floating_ip(nova_client, vm2.id, floatip):
505 logger.error("Cannot associate floating IP to VM.")
506 cleanup(nova_client, neutron_client, image_id, network_dic,
507 port_id1, port_id2, SECGROUP_ID)
510 logger.info("Trying to establish SSH connection to %s..." % floatip)
513 ssh = paramiko.SSHClient()
514 ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
519 ssh.connect(floatip, username=username, password=password, timeout=2)
520 logger.debug("SSH connection established to %s." % floatip)
524 logger.debug("Waiting for %s..." % floatip)
528 if timeout == 0: # 300 sec timeout (5 min)
529 logger.error("Cannot establish connection to IP '%s'. Aborting" % floatip)
530 cleanup(nova_client, neutron_client, image_id, network_dic,
531 port_id1, port_id2, SECGROUP_ID)
534 scp = SCPClient(ssh.get_transport())
536 ping_script = REPO_PATH + "testcases/vPing/CI/libraries/ping.sh"
538 scp.put(ping_script,"~/")
540 logger.error("Cannot SCP the file '%s' to VM '%s'" % (ping_script,floatip))
543 #SSH_OPTS="-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no "+\
544 # "-o LogLevel=quiet"
546 #cmd1 = "sshpass -p 'cubswin:)' scp " + SSH_OPTS + " " + \
547 # ping_script + " cirros@"+floatip+":~/ping.sh"
548 #cmd2 = "sshpass -p 'cubswin:)' ssh " + SSH_OPTS + \
549 # " cirros@"+floatip+" 'chmod 755 ~/ping.sh '"
550 #cmd3 = "sshpass -p 'cubswin:)' ssh " + SSH_OPTS + \
551 # " cirros@"+floatip+" '~/ping.sh "+IP_1+"'"
553 cmd = 'chmod 755 ~/ping.sh'
554 (stdin, stdout, stderr) = ssh.exec_command(cmd)
555 for line in stdout.readlines():
558 logger.info("Waiting for ping...")
562 cmd = '~/ping.sh ' + IP_1
566 # we do the SCP every time in the loop because while testing, I observed
567 # that for some strange reason, the cirros VM was deleting the file if
568 # do the scp only once
569 (stdin, stdout, stderr) = ssh.exec_command(cmd)
570 output = stdout.readlines()
574 # print "--"+console_log
575 # report if the test is failed
577 if "vPing OK" in line:
578 logger.info("vPing detected!")
580 # we consider start time at VM1 booting
581 end_time_ts = time.time()
582 duration = round(end_time_ts - start_time_ts, 1)
583 logger.info("vPing duration:'%s' s." % duration)
587 elif sec == PING_TIMEOUT:
588 logger.info("Timeout reached.")
593 logger.debug("Pinging %s. Waiting for response..." % IP_1)
596 cleanup(nova_client, neutron_client, image_id, network_dic,
597 port_id1, port_id2, SECGROUP_ID)
601 logger.info("vPing OK")
605 logger.error("vPing FAILED")
608 push_results(start_time_ts, duration, test_status)
612 if __name__ == '__main__':