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 glanceclient import client as glanceclient
18 from keystoneclient.v2_0 import client as keystoneclient
19 from neutronclient.v2_0 import client as neutronclient
20 from novaclient import client as novaclient
23 # *********************************************
25 # *********************************************
26 def check_credentials():
28 Check if the OpenStack credentials (openrc) are sourced
30 env_vars = ['OS_AUTH_URL', 'OS_USERNAME', 'OS_PASSWORD', 'OS_TENANT_NAME']
31 return all(map(lambda v: v in os.environ and os.environ[v], env_vars))
34 def get_credentials(service):
35 """Returns a creds dictionary filled with the following keys:
37 * password/api_key (depending on the service)
38 * tenant_name/project_id (depending on the service)
40 :param service: a string indicating the name of the service
41 requesting the credentials.
45 # Check that the env vars exists:
46 envvars = ('OS_USERNAME', 'OS_PASSWORD', 'OS_AUTH_URL', 'OS_TENANT_NAME')
47 for envvar in envvars:
48 if os.getenv(envvar) is None:
49 print("'%s' is not exported as an env variable." % envvar)
52 # Unfortunately, each of the OpenStack client will request slightly
53 # different entries in their credentials dict.
54 if service.lower() in ("nova", "cinder"):
59 tenant = "tenant_name"
61 # The most common way to pass these info to the script is to do it through
62 # environment variables.
64 "username": os.environ.get("OS_USERNAME"),
65 password: os.environ.get("OS_PASSWORD"),
66 "auth_url": os.environ.get("OS_AUTH_URL"),
67 tenant: os.environ.get("OS_TENANT_NAME")
69 cacert = os.environ.get("OS_CACERT")
70 if cacert is not None:
71 # each openstack client uses differnt kwargs for this
72 creds.update({"cacert": cacert,
74 "https_ca_cert": cacert,
75 "https_cacert": cacert,
77 creds.update({"insecure": "True", "https_insecure": "True"})
78 if not os.path.isfile(cacert):
79 print ("WARNING: The 'OS_CACERT' environment variable is " +
80 "set to %s but the file does not exist." % cacert)
84 def source_credentials(rc_file):
85 pipe = subprocess.Popen(". %s; env" % rc_file, stdout=subprocess.PIPE,
87 output = pipe.communicate()[0]
88 env = dict((line.split("=", 1) for line in output.splitlines()))
89 os.environ.update(env)
93 # *********************************************
95 # *********************************************
96 def get_keystone_client():
97 creds_keystone = get_credentials("keystone")
98 return keystoneclient.Client(**creds_keystone)
101 def get_nova_client():
102 creds_nova = get_credentials("nova")
103 return novaclient.Client('2', **creds_nova)
106 def get_neutron_client():
107 creds_neutron = get_credentials("neutron")
108 return neutronclient.Client(**creds_neutron)
111 def get_glance_client():
112 keystone_client = get_keystone_client()
113 glance_endpoint = keystone_client.service_catalog.url_for(
114 service_type='image', endpoint_type='publicURL')
115 return glanceclient.Client(1, glance_endpoint,
116 token=keystone_client.auth_token)
118 # *********************************************
120 # *********************************************
123 def get_instances(nova_client):
125 instances = nova_client.servers.list(search_opts={'all_tenants': 1})
128 print "Error [get_instances(nova_client)]:", e
132 def get_instance_status(nova_client, instance):
134 instance = nova_client.servers.get(instance.id)
135 return instance.status
137 # print ("Error [get_instance_status(nova_client, '%s')]:" %
142 def get_instance_by_name(nova_client, instance_name):
144 instance = nova_client.servers.find(name=instance_name)
147 print ("Error [get_instance_by_name(nova_client, '%s')]:" %
152 def get_flavor_id(nova_client, flavor_name):
153 flavors = nova_client.flavors.list(detailed=True)
156 if f.name == flavor_name:
162 def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
163 flavors = nova_client.flavors.list(detailed=True)
166 if min_ram <= f.ram and f.ram <= max_ram:
172 def get_floating_ips(nova_client):
174 floating_ips = nova_client.floating_ips.list()
177 print "Error [get_floating_ips(nova_client)]:", e
181 def get_hypervisors(nova_client):
184 hypervisors = nova_client.hypervisors.list()
185 for hypervisor in hypervisors:
186 if hypervisor.state == "up":
187 nodes.append(hypervisor.hypervisor_hostname)
190 print "Error [get_hypervisors(nova_client)]:", e
194 def create_flavor(nova_client, flavor_name, ram, disk, vcpus):
196 flavor = nova_client.flavors.create(flavor_name, ram, vcpus, disk)
198 print ("Error [create_flavor(nova_client, '%s', '%s', '%s', "
199 "'%s')]:" % (flavor_name, ram, disk, vcpus)), e
204 def create_instance(flavor_name,
207 instance_name="functest-vm",
211 nova_client = get_nova_client()
213 flavor = nova_client.flavors.find(name=flavor_name)
215 print("Error: Flavor '%s' not found. Available flavors are:" %
217 print(nova_client.flavor.list())
220 instance = nova_client.servers.create(
224 nics=[{"net-id": network_id}],
225 availability_zone=av_zone
228 instance = nova_client.servers.create(
232 nics=[{"net-id": network_id}],
233 config_drive=confdrive,
235 availability_zone=av_zone
240 def create_instance_and_wait_for_active(flavor_name,
248 VM_BOOT_TIMEOUT = 180
249 nova_client = get_nova_client()
250 instance = create_instance(flavor_name,
258 count = VM_BOOT_TIMEOUT / SLEEP
259 for n in range(count, -1, -1):
260 status = get_instance_status(nova_client, instance)
261 if status.lower() == "active":
263 elif status.lower() == "error":
264 print("The instance %s went to ERROR status." % instance_name)
267 print("Timeout booting the instance %s." % instance_name)
271 def create_floating_ip(neutron_client):
272 extnet_id = get_external_net_id(neutron_client)
273 props = {'floating_network_id': extnet_id}
275 ip_json = neutron_client.create_floatingip({'floatingip': props})
276 fip_addr = ip_json['floatingip']['floating_ip_address']
277 fip_id = ip_json['floatingip']['id']
279 print "Error [create_floating_ip(neutron_client)]:", e
281 return {'fip_addr': fip_addr, 'fip_id': fip_id}
284 def add_floating_ip(nova_client, server_id, floatingip_id):
286 nova_client.servers.add_floating_ip(server_id, floatingip_id)
289 print ("Error [add_floating_ip(nova_client, '%s', '%s')]:" %
290 (server_id, floatingip_id)), e
294 def delete_instance(nova_client, instance_id):
296 nova_client.servers.force_delete(instance_id)
299 print "Error [delete_instance(nova_client, '%s')]:" % instance_id, e
303 def delete_floating_ip(nova_client, floatingip_id):
305 nova_client.floating_ips.delete(floatingip_id)
308 print ("Error [delete_floating_ip(nova_client, '%s')]:" %
313 # *********************************************
315 # *********************************************
316 def get_network_list(neutron_client):
317 network_list = neutron_client.list_networks()['networks']
318 if len(network_list) == 0:
324 def get_router_list(neutron_client):
325 router_list = neutron_client.list_routers()['routers']
326 if len(router_list) == 0:
332 def get_port_list(neutron_client):
333 port_list = neutron_client.list_ports()['ports']
334 if len(port_list) == 0:
340 def get_network_id(neutron_client, network_name):
341 networks = neutron_client.list_networks()['networks']
344 if n['name'] == network_name:
350 def get_subnet_id(neutron_client, subnet_name):
351 subnets = neutron_client.list_subnets()['subnets']
354 if s['name'] == subnet_name:
360 def get_router_id(neutron_client, router_name):
361 routers = neutron_client.list_routers()['routers']
364 if r['name'] == router_name:
370 def get_private_net(neutron_client):
371 # Checks if there is an existing shared private network
372 networks = neutron_client.list_networks()['networks']
373 if len(networks) == 0:
376 if (net['router:external'] is False) and (net['shared'] is True):
381 def get_external_net(neutron_client):
382 for network in neutron_client.list_networks()['networks']:
383 if network['router:external']:
384 return network['name']
388 def get_external_net_id(neutron_client):
389 for network in neutron_client.list_networks()['networks']:
390 if network['router:external']:
395 def check_neutron_net(neutron_client, net_name):
396 for network in neutron_client.list_networks()['networks']:
397 if network['name'] == net_name:
398 for subnet in network['subnets']:
403 def create_neutron_net(neutron_client, name):
404 json_body = {'network': {'name': name,
405 'admin_state_up': True}}
407 network = neutron_client.create_network(body=json_body)
408 network_dict = network['network']
409 return network_dict['id']
411 print "Error [create_neutron_net(neutron_client, '%s')]:" % name, e
415 def create_neutron_subnet(neutron_client, name, cidr, net_id):
416 json_body = {'subnets': [{'name': name, 'cidr': cidr,
417 'ip_version': 4, 'network_id': net_id}]}
419 subnet = neutron_client.create_subnet(body=json_body)
420 return subnet['subnets'][0]['id']
422 print ("Error [create_neutron_subnet(neutron_client, '%s', '%s', "
423 "'%s')]:" % (name, cidr, net_id)), e
427 def create_neutron_router(neutron_client, name):
428 json_body = {'router': {'name': name, 'admin_state_up': True}}
430 router = neutron_client.create_router(json_body)
431 return router['router']['id']
433 print "Error [create_neutron_router(neutron_client, '%s')]:" % name, e
437 def create_neutron_port(neutron_client, name, network_id, ip):
438 json_body = {'port': {
439 'admin_state_up': True,
441 'network_id': network_id,
442 'fixed_ips': [{"ip_address": ip}]
445 port = neutron_client.create_port(body=json_body)
446 return port['port']['id']
448 print ("Error [create_neutron_port(neutron_client, '%s', '%s', "
449 "'%s')]:" % (name, network_id, ip)), e
453 def update_neutron_net(neutron_client, network_id, shared=False):
454 json_body = {'network': {'shared': shared}}
456 neutron_client.update_network(network_id, body=json_body)
459 print ("Error [update_neutron_net(neutron_client, '%s', '%s')]:" %
460 (network_id, str(shared))), e
464 def update_neutron_port(neutron_client, port_id, device_owner):
465 json_body = {'port': {
466 'device_owner': device_owner,
469 port = neutron_client.update_port(port=port_id,
471 return port['port']['id']
473 print ("Error [update_neutron_port(neutron_client, '%s', '%s')]:" %
474 (port_id, device_owner)), e
478 def add_interface_router(neutron_client, router_id, subnet_id):
479 json_body = {"subnet_id": subnet_id}
481 neutron_client.add_interface_router(router=router_id, body=json_body)
484 print ("Error [add_interface_router(neutron_client, '%s', '%s')]:" %
485 (router_id, subnet_id)), e
489 def add_gateway_router(neutron_client, router_id):
490 ext_net_id = get_external_net_id(neutron_client)
491 router_dict = {'network_id': ext_net_id}
493 neutron_client.add_gateway_router(router_id, router_dict)
496 print ("Error [add_gateway_router(neutron_client, '%s')]:" %
501 def delete_neutron_net(neutron_client, network_id):
503 neutron_client.delete_network(network_id)
506 print ("Error [delete_neutron_net(neutron_client, '%s')]:" %
511 def delete_neutron_subnet(neutron_client, subnet_id):
513 neutron_client.delete_subnet(subnet_id)
516 print ("Error [delete_neutron_subnet(neutron_client, '%s')]:" %
521 def delete_neutron_router(neutron_client, router_id):
523 neutron_client.delete_router(router=router_id)
526 print ("Error [delete_neutron_router(neutron_client, '%s')]:" %
531 def delete_neutron_port(neutron_client, port_id):
533 neutron_client.delete_port(port_id)
536 print "Error [delete_neutron_port(neutron_client, '%s')]:" % port_id, e
540 def remove_interface_router(neutron_client, router_id, subnet_id):
541 json_body = {"subnet_id": subnet_id}
543 neutron_client.remove_interface_router(router=router_id,
547 print ("Error [remove_interface_router(neutron_client, '%s', '%s')]:" %
548 (router_id, subnet_id)), e
552 def remove_gateway_router(neutron_client, router_id):
554 neutron_client.remove_gateway_router(router_id)
557 print ("Error [remove_gateway_router(neutron_client, '%s')]:" %
562 def create_network_full(logger,
569 # Check if the network already exists
570 network_id = get_network_id(neutron_client, net_name)
571 subnet_id = get_subnet_id(neutron_client, subnet_name)
572 router_id = get_router_id(neutron_client, router_name)
574 if network_id != '' and subnet_id != '' and router_id != '':
575 logger.info("A network with name '%s' already exists..." % net_name)
577 neutron_client.format = 'json'
578 logger.info('Creating neutron network %s...' % net_name)
579 network_id = create_neutron_net(neutron_client, net_name)
584 logger.debug("Network '%s' created successfully" % network_id)
585 logger.debug('Creating Subnet....')
586 subnet_id = create_neutron_subnet(neutron_client, subnet_name,
591 logger.debug("Subnet '%s' created successfully" % subnet_id)
592 logger.debug('Creating Router...')
593 router_id = create_neutron_router(neutron_client, router_name)
598 logger.debug("Router '%s' created successfully" % router_id)
599 logger.debug('Adding router to subnet...')
601 if not add_interface_router(neutron_client, router_id, subnet_id):
604 logger.debug("Interface added successfully.")
606 logger.debug('Adding gateway to router...')
607 if not add_gateway_router(neutron_client, router_id):
610 logger.debug("Gateway added successfully.")
612 network_dic = {'net_id': network_id,
613 'subnet_id': subnet_id,
614 'router_id': router_id}
618 def create_bgpvpn(neutron_client, **kwargs):
619 # route_distinguishers
621 json_body = {"bgpvpn": kwargs}
622 return neutron_client.create_bgpvpn(json_body)
625 def create_network_association(neutron_client, bgpvpn_id, neutron_network_id):
626 json_body = {"network_association": {"network_id": neutron_network_id}}
627 return neutron_client.create_network_association(bgpvpn_id, json_body)
630 def update_bgpvpn(neutron_client, bgpvpn_id, **kwargs):
631 json_body = {"bgpvpn": kwargs}
632 return neutron_client.update_bgpvpn(bgpvpn_id, json_body)
635 def delete_bgpvpn(neutron_client, bgpvpn_id):
636 return neutron_client.delete_bgpvpn(bgpvpn_id)
639 # *********************************************
641 # *********************************************
644 def get_security_groups(neutron_client):
646 security_groups = neutron_client.list_security_groups()[
648 return security_groups
650 print "Error [get_security_groups(neutron_client)]:", e
654 def get_security_group_id(neutron_client, sg_name):
655 security_groups = get_security_groups(neutron_client)
657 for sg in security_groups:
658 if sg['name'] == sg_name:
664 def create_security_group(neutron_client, sg_name, sg_description):
665 json_body = {'security_group': {'name': sg_name,
666 'description': sg_description}}
668 secgroup = neutron_client.create_security_group(json_body)
669 return secgroup['security_group']
671 print ("Error [create_security_group(neutron_client, '%s', '%s')]:" %
672 (sg_name, sg_description)), e
676 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
677 port_range_min=None, port_range_max=None):
678 if port_range_min is None and port_range_max is None:
679 json_body = {'security_group_rule': {'direction': direction,
680 'security_group_id': sg_id,
681 'protocol': protocol}}
682 elif port_range_min is not None and port_range_max is not None:
683 json_body = {'security_group_rule': {'direction': direction,
684 'security_group_id': sg_id,
685 'port_range_min': port_range_min,
686 'port_range_max': port_range_max,
687 'protocol': protocol}}
689 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
690 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
691 port_range_min, port_range_max,
693 " Invalid values for port_range_min, port_range_max")
696 neutron_client.create_security_group_rule(json_body)
699 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
700 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
701 port_range_min, port_range_max,
706 def create_security_group_full(logger, neutron_client,
707 sg_name, sg_description):
708 sg_id = get_security_group_id(neutron_client, sg_name)
710 logger.info("Using existing security group '%s'..." % sg_name)
712 logger.info("Creating security group '%s'..." % sg_name)
713 SECGROUP = create_security_group(neutron_client,
717 logger.error("Failed to create the security group...")
720 sg_id = SECGROUP['id']
722 logger.debug("Security group '%s' with ID=%s created successfully."
723 % (SECGROUP['name'], sg_id))
725 logger.debug("Adding ICMP rules in security group '%s'..."
727 if not create_secgroup_rule(neutron_client, sg_id,
729 logger.error("Failed to create the security group rule...")
732 logger.debug("Adding SSH rules in security group '%s'..."
734 if not create_secgroup_rule(
735 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
736 logger.error("Failed to create the security group rule...")
739 if not create_secgroup_rule(
740 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
741 logger.error("Failed to create the security group rule...")
746 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
748 nova_client.servers.add_security_group(instance_id, secgroup_id)
751 print ("Error [add_secgroup_to_instance(nova_client, '%s', '%s')]: " %
752 (instance_id, secgroup_id)), e
756 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
757 json_body = {"quota": {
758 "security_group": sg_quota,
759 "security_group_rule": sg_rule_quota
763 neutron_client.update_quota(tenant_id=tenant_id,
767 print ("Error [update_sg_quota(neutron_client, '%s', '%s', "
768 "'%s')]:" % (tenant_id, sg_quota, sg_rule_quota)), e
772 def delete_security_group(neutron_client, secgroup_id):
774 neutron_client.delete_security_group(secgroup_id)
777 print ("Error [delete_security_group(neutron_client, '%s')]:" %
782 # *********************************************
784 # *********************************************
785 def get_images(nova_client):
787 images = nova_client.images.list()
790 print "Error [get_images]:", e
794 def get_image_id(glance_client, image_name):
795 images = glance_client.images.list()
798 if i.name == image_name:
804 def create_glance_image(glance_client, image_name, file_path, disk="qcow2",
805 container="bare", public=True, logger=None):
806 if not os.path.isfile(file_path):
807 print "Error: file " + file_path + " does not exist."
810 image_id = get_image_id(glance_client, image_name)
813 logger.info("Image %s already exists." % image_name)
816 logger.info("Creating image '%s' from '%s'..." % (image_name,
818 with open(file_path) as fimage:
819 image = glance_client.images.create(name=image_name,
822 container_format=container,
827 print ("Error [create_glance_image(glance_client, '%s', '%s', "
828 "'%s')]:" % (image_name, file_path, str(public))), e
832 def delete_glance_image(nova_client, image_id):
834 nova_client.images.delete(image_id)
837 print ("Error [delete_glance_image(nova_client, '%s')]:" % image_id), e
841 # *********************************************
843 # *********************************************
844 def get_volumes(cinder_client):
846 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
849 print "Error [get_volumes(cinder_client)]:", e
853 def list_volume_types(cinder_client, public=True, private=True):
855 volume_types = cinder_client.volume_types.list()
857 volume_types = [vt for vt in volume_types if not vt.is_public]
859 volume_types = [vt for vt in volume_types if vt.is_public]
862 print "Error [list_volume_types(cinder_client)]:", e
866 def create_volume_type(cinder_client, name):
868 volume_type = cinder_client.volume_types.create(name)
871 print "Error [create_volume_type(cinder_client, '%s')]:" % name, e
875 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
876 snapshots_quota, gigabytes_quota):
877 quotas_values = {"volumes": vols_quota,
878 "snapshots": snapshots_quota,
879 "gigabytes": gigabytes_quota}
882 cinder_client.quotas.update(tenant_id, **quotas_values)
885 print ("Error [update_cinder_quota(cinder_client, '%s', '%s', '%s'"
886 "'%s')]:" % (tenant_id, vols_quota,
887 snapshots_quota, gigabytes_quota)), e
891 def delete_volume(cinder_client, volume_id, forced=False):
895 cinder_client.volumes.detach(volume_id)
897 print "Error:", sys.exc_info()[0]
898 cinder_client.volumes.force_delete(volume_id)
900 cinder_client.volumes.delete(volume_id)
903 print ("Error [delete_volume(cinder_client, '%s', '%s')]:" %
904 (volume_id, str(forced))), e
908 def delete_volume_type(cinder_client, volume_type):
910 cinder_client.volume_types.delete(volume_type)
913 print ("Error [delete_volume_type(cinder_client, '%s')]:" %
918 # *********************************************
920 # *********************************************
921 def get_tenants(keystone_client):
923 tenants = keystone_client.tenants.list()
926 print "Error [get_tenants(keystone_client)]:", e
930 def get_users(keystone_client):
932 users = keystone_client.users.list()
935 print "Error [get_users(keystone_client)]:", e
939 def get_tenant_id(keystone_client, tenant_name):
940 tenants = keystone_client.tenants.list()
943 if t.name == tenant_name:
949 def get_user_id(keystone_client, user_name):
950 users = keystone_client.users.list()
953 if u.name == user_name:
959 def get_role_id(keystone_client, role_name):
960 roles = keystone_client.roles.list()
963 if r.name == role_name:
969 def create_tenant(keystone_client, tenant_name, tenant_description):
971 tenant = keystone_client.tenants.create(tenant_name,
976 print ("Error [create_tenant(cinder_client, '%s', '%s')]:" %
977 (tenant_name, tenant_description)), e
981 def create_user(keystone_client, user_name, user_password,
982 user_email, tenant_id):
984 user = keystone_client.users.create(user_name, user_password,
985 user_email, tenant_id,
989 print ("Error [create_user(keystone_client, '%s', '%s', '%s'"
990 "'%s')]:" % (user_name, user_password, user_email, tenant_id),
995 def add_role_user(keystone_client, user_id, role_id, tenant_id):
997 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
1000 print ("Error [add_role_user(keystone_client, '%s', '%s'"
1001 "'%s')]:" % (user_id, role_id, tenant_id)), e
1005 def delete_tenant(keystone_client, tenant_id):
1007 keystone_client.tenants.delete(tenant_id)
1009 except Exception, e:
1010 print "Error [delete_tenant(keystone_client, '%s')]:" % tenant_id, e
1014 def delete_user(keystone_client, user_id):
1016 keystone_client.users.delete(user_id)
1018 except Exception, e:
1019 print "Error [delete_user(keystone_client, '%s')]:" % user_id, e