3 # jose.lausuch@ericsson.com
4 # valentin.boucher@orange.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
17 from cinderclient import client as cinderclient
18 import functest.utils.functest_logger as ft_logger
19 from glanceclient import client as glanceclient
20 from keystoneclient.v2_0 import client as keystoneclient
21 from neutronclient.v2_0 import client as neutronclient
22 from novaclient import client as novaclient
24 logger = ft_logger.Logger("openstack_utils").getLogger()
27 # *********************************************
29 # *********************************************
30 def check_credentials():
32 Check if the OpenStack credentials (openrc) are sourced
34 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
35 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
38 def get_credentials(service):
39 """Returns a creds dictionary filled with the following keys:
41 * password/api_key (depending on the service)
42 * tenant_name/project_id (depending on the service)
44 :param service: a string indicating the name of the service
45 requesting the credentials.
49 # Check that the env vars exists:
50 envvars = ('OS_USERNAME', 'OS_PASSWORD', 'OS_AUTH_URL', 'OS_TENANT_NAME')
51 for envvar in envvars:
52 if os.getenv(envvar) is None:
53 logger.error("'%s' is not exported as an env variable." % envvar)
56 # Unfortunately, each of the OpenStack client will request slightly
57 # different entries in their credentials dict.
58 if service.lower() in ("nova", "cinder"):
63 tenant = "tenant_name"
65 # The most common way to pass these info to the script is to do it through
66 # environment variables.
68 "username": os.environ.get("OS_USERNAME"),
69 password: os.environ.get("OS_PASSWORD"),
70 "auth_url": os.environ.get("OS_AUTH_URL"),
71 tenant: os.environ.get("OS_TENANT_NAME")
73 cacert = os.environ.get("OS_CACERT")
74 if cacert is not None:
75 # each openstack client uses differnt kwargs for this
76 creds.update({"cacert": cacert,
78 "https_ca_cert": cacert,
79 "https_cacert": cacert,
81 creds.update({"insecure": "True", "https_insecure": "True"})
82 if not os.path.isfile(cacert):
83 logger.info("WARNING: The 'OS_CACERT' environment variable is "
84 "set to %s but the file does not exist." % cacert)
88 def source_credentials(rc_file):
89 pipe = subprocess.Popen(". %s; env" % rc_file, stdout=subprocess.PIPE,
91 output = pipe.communicate()[0]
92 env = dict((line.split("=", 1) for line in output.splitlines()))
93 os.environ.update(env)
97 # *********************************************
99 # *********************************************
100 def get_keystone_client():
101 creds_keystone = get_credentials("keystone")
102 return keystoneclient.Client(**creds_keystone)
105 def get_nova_client():
106 creds_nova = get_credentials("nova")
107 return novaclient.Client('2', **creds_nova)
110 def get_cinder_client():
111 creds_cinder = get_credentials("cinder")
112 return cinderclient.Client('2', creds_cinder['username'],
113 creds_cinder['api_key'],
114 creds_cinder['project_id'],
115 creds_cinder['auth_url'],
116 service_type="volume")
119 def get_neutron_client():
120 creds_neutron = get_credentials("neutron")
121 return neutronclient.Client(**creds_neutron)
124 def get_glance_client():
125 keystone_client = get_keystone_client()
126 glance_endpoint = keystone_client.service_catalog.url_for(
127 service_type='image', endpoint_type='publicURL')
128 return glanceclient.Client(1, glance_endpoint,
129 token=keystone_client.auth_token)
131 # *********************************************
133 # *********************************************
136 def get_instances(nova_client):
138 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
141 logger.error("Error [get_instances(nova_client)]: %s" % e)
145 def get_instance_status(nova_client, instance):
147 instance = nova_client.servers.get(instance.id)
148 return instance.status
150 logger.error("Error [get_instance_status(nova_client)]: %s" % e)
154 def get_instance_by_name(nova_client, instance_name):
156 instance = nova_client.servers.find(name=instance_name)
159 logger.error("Error [get_instance_by_name(nova_client, '%s')]: %s"
160 % (instance_name, e))
164 def get_flavor_id(nova_client, flavor_name):
165 flavors = nova_client.flavors.list(detailed=True)
168 if f.name == flavor_name:
174 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
175 flavors = nova_client.flavors.list(detailed=True)
178 if min_ram <= f.ram and f.ram <= max_ram:
184 def get_floating_ips(nova_client):
186 floating_ips = nova_client.floating_ips.list()
189 logger.error("Error [get_floating_ips(nova_client)]: %s" % e)
193 def get_hypervisors(nova_client):
196 hypervisors = nova_client.hypervisors.list()
197 for hypervisor in hypervisors:
198 if hypervisor.state == "up":
199 nodes.append(hypervisor.hypervisor_hostname)
202 logger.error("Error [get_hypervisors(nova_client)]: %s" % e)
206 def create_flavor(nova_client, flavor_name, ram, disk, vcpus):
208 flavor = nova_client.flavors.create(flavor_name, ram, vcpus, disk)
210 logger.error("Error [create_flavor(nova_client, '%s', '%s', '%s', "
211 "'%s')]: %s" % (flavor_name, ram, disk, vcpus, e))
216 def create_instance(flavor_name,
219 instance_name="functest-vm",
225 nova_client = get_nova_client()
227 flavor = nova_client.flavors.find(name=flavor_name)
229 flavors = nova_client.flavors.list()
230 logger.error("Error: Flavor '%s' not found. Available flavors are: "
231 "\n%s" % (flavor_name, flavors))
233 if fixed_ip is not None:
234 nics = {"net-id": network_id, "v4-fixed-ip": fixed_ip}
236 nics = {"net-id": network_id}
238 instance = nova_client.servers.create(
243 availability_zone=av_zone,
247 instance = nova_client.servers.create(
252 config_drive=confdrive,
254 availability_zone=av_zone,
260 def create_instance_and_wait_for_active(flavor_name,
270 VM_BOOT_TIMEOUT = 180
271 nova_client = get_nova_client()
272 instance = create_instance(flavor_name,
281 count = VM_BOOT_TIMEOUT / SLEEP
282 for n in range(count, -1, -1):
283 status = get_instance_status(nova_client, instance)
284 if status.lower() == "active":
286 elif status.lower() == "error":
287 logger.error("The instance %s went to ERROR status."
291 logger.error("Timeout booting the instance %s." % instance_name)
295 def create_floating_ip(neutron_client):
296 extnet_id = get_external_net_id(neutron_client)
297 props = {'floating_network_id': extnet_id}
299 ip_json = neutron_client.create_floatingip({'floatingip': props})
300 fip_addr = ip_json['floatingip']['floating_ip_address']
301 fip_id = ip_json['floatingip']['id']
303 logger.error("Error [create_floating_ip(neutron_client)]: %s" % e)
305 return {'fip_addr': fip_addr, 'fip_id': fip_id}
308 def add_floating_ip(nova_client, server_id, floatingip_id):
310 nova_client.servers.add_floating_ip(server_id, floatingip_id)
313 logger.error("Error [add_floating_ip(nova_client, '%s', '%s')]: %s"
314 % (server_id, floatingip_id, e))
318 def delete_instance(nova_client, instance_id):
320 nova_client.servers.force_delete(instance_id)
323 logger.error("Error [delete_instance(nova_client, '%s')]: %s"
328 def delete_floating_ip(nova_client, floatingip_id):
330 nova_client.floating_ips.delete(floatingip_id)
333 logger.error("Error [delete_floating_ip(nova_client, '%s')]:"
334 % (floatingip_id, e))
338 # *********************************************
340 # *********************************************
341 def get_network_list(neutron_client):
342 network_list = neutron_client.list_networks()['networks']
343 if len(network_list) == 0:
349 def get_router_list(neutron_client):
350 router_list = neutron_client.list_routers()['routers']
351 if len(router_list) == 0:
357 def get_port_list(neutron_client):
358 port_list = neutron_client.list_ports()['ports']
359 if len(port_list) == 0:
365 def get_network_id(neutron_client, network_name):
366 networks = neutron_client.list_networks()['networks']
369 if n['name'] == network_name:
375 def get_subnet_id(neutron_client, subnet_name):
376 subnets = neutron_client.list_subnets()['subnets']
379 if s['name'] == subnet_name:
385 def get_router_id(neutron_client, router_name):
386 routers = neutron_client.list_routers()['routers']
389 if r['name'] == router_name:
395 def get_private_net(neutron_client):
396 # Checks if there is an existing shared private network
397 networks = neutron_client.list_networks()['networks']
398 if len(networks) == 0:
401 if (net['router:external'] is False) and (net['shared'] is True):
406 def get_external_net(neutron_client):
407 for network in neutron_client.list_networks()['networks']:
408 if network['router:external']:
409 return network['name']
413 def get_external_net_id(neutron_client):
414 for network in neutron_client.list_networks()['networks']:
415 if network['router:external']:
420 def check_neutron_net(neutron_client, net_name):
421 for network in neutron_client.list_networks()['networks']:
422 if network['name'] == net_name:
423 for subnet in network['subnets']:
428 def create_neutron_net(neutron_client, name):
429 json_body = {'network': {'name': name,
430 'admin_state_up': True}}
432 network = neutron_client.create_network(body=json_body)
433 network_dict = network['network']
434 return network_dict['id']
436 logger.error("Error [create_neutron_net(neutron_client, '%s')]: %s"
441 def create_neutron_subnet(neutron_client, name, cidr, net_id):
442 json_body = {'subnets': [{'name': name, 'cidr': cidr,
443 'ip_version': 4, 'network_id': net_id}]}
445 subnet = neutron_client.create_subnet(body=json_body)
446 return subnet['subnets'][0]['id']
448 logger.error("Error [create_neutron_subnet(neutron_client, '%s', "
449 "'%s', '%s')]: %s" % (name, cidr, net_id, e))
453 def create_neutron_router(neutron_client, name):
454 json_body = {'router': {'name': name, 'admin_state_up': True}}
456 router = neutron_client.create_router(json_body)
457 return router['router']['id']
459 logger.error("Error [create_neutron_router(neutron_client, '%s')]: %s"
464 def create_neutron_port(neutron_client, name, network_id, ip):
465 json_body = {'port': {
466 'admin_state_up': True,
468 'network_id': network_id,
469 'fixed_ips': [{"ip_address": ip}]
472 port = neutron_client.create_port(body=json_body)
473 return port['port']['id']
475 logger.error("Error [create_neutron_port(neutron_client, '%s', '%s', "
476 "'%s')]: %s" % (name, network_id, ip, e))
480 def update_neutron_net(neutron_client, network_id, shared=False):
481 json_body = {'network': {'shared': shared}}
483 neutron_client.update_network(network_id, body=json_body)
486 logger.error("Error [update_neutron_net(neutron_client, '%s', '%s')]: "
487 "%s" % (network_id, str(shared), e))
491 def update_neutron_port(neutron_client, port_id, device_owner):
492 json_body = {'port': {
493 'device_owner': device_owner,
496 port = neutron_client.update_port(port=port_id,
498 return port['port']['id']
500 logger.error("Error [update_neutron_port(neutron_client, '%s', '%s')]:"
501 " %s" % (port_id, device_owner, e))
505 def add_interface_router(neutron_client, router_id, subnet_id):
506 json_body = {"subnet_id": subnet_id}
508 neutron_client.add_interface_router(router=router_id, body=json_body)
511 logger.error("Error [add_interface_router(neutron_client, '%s', "
512 "'%s')]: %s" % (router_id, subnet_id, e))
516 def add_gateway_router(neutron_client, router_id):
517 ext_net_id = get_external_net_id(neutron_client)
518 router_dict = {'network_id': ext_net_id}
520 neutron_client.add_gateway_router(router_id, router_dict)
523 logger.error("Error [add_gateway_router(neutron_client, '%s')]: %s"
528 def delete_neutron_net(neutron_client, network_id):
530 neutron_client.delete_network(network_id)
533 logger.error("Error [delete_neutron_net(neutron_client, '%s')]: %s"
538 def delete_neutron_subnet(neutron_client, subnet_id):
540 neutron_client.delete_subnet(subnet_id)
543 logger.error("Error [delete_neutron_subnet(neutron_client, '%s')]: %s"
548 def delete_neutron_router(neutron_client, router_id):
550 neutron_client.delete_router(router=router_id)
553 logger.error("Error [delete_neutron_router(neutron_client, '%s')]: %s"
558 def delete_neutron_port(neutron_client, port_id):
560 neutron_client.delete_port(port_id)
563 logger.error("Error [delete_neutron_port(neutron_client, '%s')]: %s"
568 def remove_interface_router(neutron_client, router_id, subnet_id):
569 json_body = {"subnet_id": subnet_id}
571 neutron_client.remove_interface_router(router=router_id,
575 logger.error("Error [remove_interface_router(neutron_client, '%s', "
576 "'%s')]: %s" % (router_id, subnet_id, e))
580 def remove_gateway_router(neutron_client, router_id):
582 neutron_client.remove_gateway_router(router_id)
585 logger.error("Error [remove_gateway_router(neutron_client, '%s')]: %s"
590 def create_network_full(neutron_client,
596 # Check if the network already exists
597 network_id = get_network_id(neutron_client, net_name)
598 subnet_id = get_subnet_id(neutron_client, subnet_name)
599 router_id = get_router_id(neutron_client, router_name)
601 if network_id != '' and subnet_id != '' and router_id != '':
602 logger.info("A network with name '%s' already exists..." % net_name)
604 neutron_client.format = 'json'
605 logger.info('Creating neutron network %s...' % net_name)
606 network_id = create_neutron_net(neutron_client, net_name)
611 logger.debug("Network '%s' created successfully" % network_id)
612 logger.debug('Creating Subnet....')
613 subnet_id = create_neutron_subnet(neutron_client, subnet_name,
618 logger.debug("Subnet '%s' created successfully" % subnet_id)
619 logger.debug('Creating Router...')
620 router_id = create_neutron_router(neutron_client, router_name)
625 logger.debug("Router '%s' created successfully" % router_id)
626 logger.debug('Adding router to subnet...')
628 if not add_interface_router(neutron_client, router_id, subnet_id):
631 logger.debug("Interface added successfully.")
633 logger.debug('Adding gateway to router...')
634 if not add_gateway_router(neutron_client, router_id):
637 logger.debug("Gateway added successfully.")
639 network_dic = {'net_id': network_id,
640 'subnet_id': subnet_id,
641 'router_id': router_id}
645 def create_bgpvpn(neutron_client, **kwargs):
646 # route_distinguishers
648 json_body = {"bgpvpn": kwargs}
649 return neutron_client.create_bgpvpn(json_body)
652 def create_network_association(neutron_client, bgpvpn_id, neutron_network_id):
653 json_body = {"network_association": {"network_id": neutron_network_id}}
654 return neutron_client.create_network_association(bgpvpn_id, json_body)
657 def update_bgpvpn(neutron_client, bgpvpn_id, **kwargs):
658 json_body = {"bgpvpn": kwargs}
659 return neutron_client.update_bgpvpn(bgpvpn_id, json_body)
662 def delete_bgpvpn(neutron_client, bgpvpn_id):
663 return neutron_client.delete_bgpvpn(bgpvpn_id)
665 # *********************************************
667 # *********************************************
670 def get_security_groups(neutron_client):
672 security_groups = neutron_client.list_security_groups()[
674 return security_groups
676 logger.error("Error [get_security_groups(neutron_client)]: %s" % e)
680 def get_security_group_id(neutron_client, sg_name):
681 security_groups = get_security_groups(neutron_client)
683 for sg in security_groups:
684 if sg['name'] == sg_name:
690 def create_security_group(neutron_client, sg_name, sg_description):
691 json_body = {'security_group': {'name': sg_name,
692 'description': sg_description}}
694 secgroup = neutron_client.create_security_group(json_body)
695 return secgroup['security_group']
697 logger.error("Error [create_security_group(neutron_client, '%s', "
698 "'%s')]: %s" % (sg_name, sg_description, e))
702 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
703 port_range_min=None, port_range_max=None):
704 if port_range_min is None and port_range_max is None:
705 json_body = {'security_group_rule': {'direction': direction,
706 'security_group_id': sg_id,
707 'protocol': protocol}}
708 elif port_range_min is not None and port_range_max is not None:
709 json_body = {'security_group_rule': {'direction': direction,
710 'security_group_id': sg_id,
711 'port_range_min': port_range_min,
712 'port_range_max': port_range_max,
713 'protocol': protocol}}
715 logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
716 "'%s', '%s', '%s', '%s')]:" % (neutron_client,
721 " Invalid values for port_range_min, port_range_max")
724 neutron_client.create_security_group_rule(json_body)
727 logger.error("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
728 "'%s', '%s', '%s', '%s')]: %s" % (neutron_client,
737 def create_security_group_full(neutron_client,
738 sg_name, sg_description):
739 sg_id = get_security_group_id(neutron_client, sg_name)
741 logger.info("Using existing security group '%s'..." % sg_name)
743 logger.info("Creating security group '%s'..." % sg_name)
744 SECGROUP = create_security_group(neutron_client,
748 logger.error("Failed to create the security group...")
751 sg_id = SECGROUP['id']
753 logger.debug("Security group '%s' with ID=%s created successfully."
754 % (SECGROUP['name'], sg_id))
756 logger.debug("Adding ICMP rules in security group '%s'..."
758 if not create_secgroup_rule(neutron_client, sg_id,
760 logger.error("Failed to create the security group rule...")
763 logger.debug("Adding SSH rules in security group '%s'..."
765 if not create_secgroup_rule(
766 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
767 logger.error("Failed to create the security group rule...")
770 if not create_secgroup_rule(
771 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
772 logger.error("Failed to create the security group rule...")
777 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
779 nova_client.servers.add_security_group(instance_id, secgroup_id)
782 logger.error("Error [add_secgroup_to_instance(nova_client, '%s', "
783 "'%s')]: %s" % (instance_id, secgroup_id, e))
787 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
788 json_body = {"quota": {
789 "security_group": sg_quota,
790 "security_group_rule": sg_rule_quota
794 neutron_client.update_quota(tenant_id=tenant_id,
798 logger.error("Error [update_sg_quota(neutron_client, '%s', '%s', "
799 "'%s')]: %s" % (tenant_id, sg_quota, sg_rule_quota, e))
803 def delete_security_group(neutron_client, secgroup_id):
805 neutron_client.delete_security_group(secgroup_id)
808 logger.error("Error [delete_security_group(neutron_client, '%s')]: %s"
813 # *********************************************
815 # *********************************************
816 def get_images(nova_client):
818 images = nova_client.images.list()
821 logger.error("Error [get_images]: %s" % e)
825 def get_image_id(glance_client, image_name):
826 images = glance_client.images.list()
829 if i.name == image_name:
835 def create_glance_image(glance_client, image_name, file_path, disk="qcow2",
836 container="bare", public=True):
837 if not os.path.isfile(file_path):
838 logger.error("Error: file %s does not exist." % file_path)
841 image_id = get_image_id(glance_client, image_name)
844 logger.info("Image %s already exists." % image_name)
847 logger.info("Creating image '%s' from '%s'..." % (image_name,
849 with open(file_path) as fimage:
850 image = glance_client.images.create(name=image_name,
853 container_format=container,
858 logger.error("Error [create_glance_image(glance_client, '%s', '%s', "
859 "'%s')]: %s" % (image_name, file_path, str(public), e))
863 def delete_glance_image(nova_client, image_id):
865 nova_client.images.delete(image_id)
868 logger.error("Error [delete_glance_image(nova_client, '%s')]: %s"
873 # *********************************************
875 # *********************************************
876 def get_volumes(cinder_client):
878 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
881 logger.error("Error [get_volumes(cinder_client)]: %s" % e)
885 def list_volume_types(cinder_client, public=True, private=True):
887 volume_types = cinder_client.volume_types.list()
889 volume_types = [vt for vt in volume_types if not vt.is_public]
891 volume_types = [vt for vt in volume_types if vt.is_public]
894 logger.error("Error [list_volume_types(cinder_client)]: %s" % e)
898 def create_volume_type(cinder_client, name):
900 volume_type = cinder_client.volume_types.create(name)
903 logger.error("Error [create_volume_type(cinder_client, '%s')]: %s"
908 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
909 snapshots_quota, gigabytes_quota):
910 quotas_values = {"volumes": vols_quota,
911 "snapshots": snapshots_quota,
912 "gigabytes": gigabytes_quota}
915 cinder_client.quotas.update(tenant_id, **quotas_values)
918 logger.error("Error [update_cinder_quota(cinder_client, '%s', '%s', "
919 "'%s' '%s')]: %s" % (tenant_id, vols_quota,
920 snapshots_quota, gigabytes_quota, e))
924 def delete_volume(cinder_client, volume_id, forced=False):
928 cinder_client.volumes.detach(volume_id)
930 logger.error(sys.exc_info()[0])
931 cinder_client.volumes.force_delete(volume_id)
933 cinder_client.volumes.delete(volume_id)
936 logger.error("Error [delete_volume(cinder_client, '%s', '%s')]: %s"
937 % (volume_id, str(forced), e))
941 def delete_volume_type(cinder_client, volume_type):
943 cinder_client.volume_types.delete(volume_type)
946 logger.error("Error [delete_volume_type(cinder_client, '%s')]: %s"
951 # *********************************************
953 # *********************************************
954 def get_tenants(keystone_client):
956 tenants = keystone_client.tenants.list()
959 logger.error("Error [get_tenants(keystone_client)]: %s" % e)
963 def get_users(keystone_client):
965 users = keystone_client.users.list()
968 logger.error("Error [get_users(keystone_client)]: %s" % e)
972 def get_tenant_id(keystone_client, tenant_name):
973 tenants = keystone_client.tenants.list()
976 if t.name == tenant_name:
982 def get_user_id(keystone_client, user_name):
983 users = keystone_client.users.list()
986 if u.name == user_name:
992 def get_role_id(keystone_client, role_name):
993 roles = keystone_client.roles.list()
996 if r.name == role_name:
1002 def create_tenant(keystone_client, tenant_name, tenant_description):
1004 tenant = keystone_client.tenants.create(tenant_name,
1008 except Exception, e:
1009 logger.error("Error [create_tenant(cinder_client, '%s', '%s')]: %s"
1010 % (tenant_name, tenant_description, e))
1014 def create_user(keystone_client, user_name, user_password,
1015 user_email, tenant_id):
1017 user = keystone_client.users.create(user_name, user_password,
1018 user_email, tenant_id,
1021 except Exception, e:
1022 logger.error("Error [create_user(keystone_client, '%s', '%s', '%s'"
1023 "'%s')]: %s" % (user_name, user_password,
1024 user_email, tenant_id, e))
1028 def add_role_user(keystone_client, user_id, role_id, tenant_id):
1030 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
1032 except Exception, e:
1033 logger.error("Error [add_role_user(keystone_client, '%s', '%s'"
1034 "'%s')]: %s " % (user_id, role_id, tenant_id, e))
1038 def delete_tenant(keystone_client, tenant_id):
1040 keystone_client.tenants.delete(tenant_id)
1042 except Exception, e:
1043 logger.error("Error [delete_tenant(keystone_client, '%s')]: %s"
1048 def delete_user(keystone_client, user_id):
1050 keystone_client.users.delete(user_id)
1052 except Exception, e:
1053 logger.error("Error [delete_user(keystone_client, '%s')]: %s"