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 create_flavor(nova_client, flavor_name, ram, disk, vcpus):
183 flavor = nova_client.flavors.create(flavor_name, ram, vcpus, disk)
185 print ("Error [create_flavor(nova_client, '%s', '%s', '%s', "
186 "'%s')]:" % (flavor_name, ram, disk, vcpus)), e
191 def create_instance(flavor_name,
194 instance_name="functest-vm",
197 nova_client = get_nova_client()
199 flavor = nova_client.flavors.find(name=flavor_name)
201 print("Error: Flavor '%s' not found. Available flavors are:" %
203 print(nova_client.flavor.list())
206 instance = nova_client.servers.create(
210 nics=[{"net-id": network_id}]
213 instance = nova_client.servers.create(
217 nics=[{"net-id": network_id}],
218 config_drive=confdrive,
224 def create_instance_and_wait_for_active(flavor_name,
231 VM_BOOT_TIMEOUT = 180
232 nova_client = get_nova_client()
233 instance = create_instance(flavor_name,
240 count = VM_BOOT_TIMEOUT / SLEEP
241 for n in range(count, -1, -1):
242 status = get_instance_status(nova_client, instance)
243 if status.lower() == "active":
245 elif status.lower() == "error":
246 print("The instance %s went to ERROR status." % instance_name)
249 print("Timeout booting the instance %s." % instance_name)
253 def create_floating_ip(neutron_client):
254 extnet_id = get_external_net_id(neutron_client)
255 props = {'floating_network_id': extnet_id}
257 ip_json = neutron_client.create_floatingip({'floatingip': props})
258 fip_addr = ip_json['floatingip']['floating_ip_address']
259 fip_id = ip_json['floatingip']['id']
261 print "Error [create_floating_ip(neutron_client)]:", e
263 return {'fip_addr': fip_addr, 'fip_id': fip_id}
266 def add_floating_ip(nova_client, server_id, floatingip_id):
268 nova_client.servers.add_floating_ip(server_id, floatingip_id)
271 print ("Error [add_floating_ip(nova_client, '%s', '%s')]:" %
272 (server_id, floatingip_id)), e
276 def delete_instance(nova_client, instance_id):
278 nova_client.servers.force_delete(instance_id)
281 print "Error [delete_instance(nova_client, '%s')]:" % instance_id, e
285 def delete_floating_ip(nova_client, floatingip_id):
287 nova_client.floating_ips.delete(floatingip_id)
290 print ("Error [delete_floating_ip(nova_client, '%s')]:" %
295 # *********************************************
297 # *********************************************
298 def get_network_list(neutron_client):
299 network_list = neutron_client.list_networks()['networks']
300 if len(network_list) == 0:
306 def get_router_list(neutron_client):
307 router_list = neutron_client.list_routers()['routers']
308 if len(router_list) == 0:
314 def get_port_list(neutron_client):
315 port_list = neutron_client.list_ports()['ports']
316 if len(port_list) == 0:
322 def get_network_id(neutron_client, network_name):
323 networks = neutron_client.list_networks()['networks']
326 if n['name'] == network_name:
332 def get_subnet_id(neutron_client, subnet_name):
333 subnets = neutron_client.list_subnets()['subnets']
336 if s['name'] == subnet_name:
342 def get_router_id(neutron_client, router_name):
343 routers = neutron_client.list_routers()['routers']
346 if r['name'] == router_name:
352 def get_private_net(neutron_client):
353 # Checks if there is an existing shared private network
354 networks = neutron_client.list_networks()['networks']
355 if len(networks) == 0:
358 if (net['router:external'] is False) and (net['shared'] is True):
363 def get_external_net(neutron_client):
364 for network in neutron_client.list_networks()['networks']:
365 if network['router:external']:
366 return network['name']
370 def get_external_net_id(neutron_client):
371 for network in neutron_client.list_networks()['networks']:
372 if network['router:external']:
377 def check_neutron_net(neutron_client, net_name):
378 for network in neutron_client.list_networks()['networks']:
379 if network['name'] == net_name:
380 for subnet in network['subnets']:
385 def create_neutron_net(neutron_client, name):
386 json_body = {'network': {'name': name,
387 'admin_state_up': True}}
389 network = neutron_client.create_network(body=json_body)
390 network_dict = network['network']
391 return network_dict['id']
393 print "Error [create_neutron_net(neutron_client, '%s')]:" % name, e
397 def create_neutron_subnet(neutron_client, name, cidr, net_id):
398 json_body = {'subnets': [{'name': name, 'cidr': cidr,
399 'ip_version': 4, 'network_id': net_id}]}
401 subnet = neutron_client.create_subnet(body=json_body)
402 return subnet['subnets'][0]['id']
404 print ("Error [create_neutron_subnet(neutron_client, '%s', '%s', "
405 "'%s')]:" % (name, cidr, net_id)), e
409 def create_neutron_router(neutron_client, name):
410 json_body = {'router': {'name': name, 'admin_state_up': True}}
412 router = neutron_client.create_router(json_body)
413 return router['router']['id']
415 print "Error [create_neutron_router(neutron_client, '%s')]:" % name, e
419 def create_neutron_port(neutron_client, name, network_id, ip):
420 json_body = {'port': {
421 'admin_state_up': True,
423 'network_id': network_id,
424 'fixed_ips': [{"ip_address": ip}]
427 port = neutron_client.create_port(body=json_body)
428 return port['port']['id']
430 print ("Error [create_neutron_port(neutron_client, '%s', '%s', "
431 "'%s')]:" % (name, network_id, ip)), e
435 def update_neutron_net(neutron_client, network_id, shared=False):
436 json_body = {'network': {'shared': shared}}
438 neutron_client.update_network(network_id, body=json_body)
441 print ("Error [update_neutron_net(neutron_client, '%s', '%s')]:" %
442 (network_id, str(shared))), e
446 def update_neutron_port(neutron_client, port_id, device_owner):
447 json_body = {'port': {
448 'device_owner': device_owner,
451 port = neutron_client.update_port(port=port_id,
453 return port['port']['id']
455 print ("Error [update_neutron_port(neutron_client, '%s', '%s')]:" %
456 (port_id, device_owner)), e
460 def add_interface_router(neutron_client, router_id, subnet_id):
461 json_body = {"subnet_id": subnet_id}
463 neutron_client.add_interface_router(router=router_id, body=json_body)
466 print ("Error [add_interface_router(neutron_client, '%s', '%s')]:" %
467 (router_id, subnet_id)), e
471 def add_gateway_router(neutron_client, router_id):
472 ext_net_id = get_external_net_id(neutron_client)
473 router_dict = {'network_id': ext_net_id}
475 neutron_client.add_gateway_router(router_id, router_dict)
478 print ("Error [add_gateway_router(neutron_client, '%s')]:" %
483 def delete_neutron_net(neutron_client, network_id):
485 neutron_client.delete_network(network_id)
488 print ("Error [delete_neutron_net(neutron_client, '%s')]:" %
493 def delete_neutron_subnet(neutron_client, subnet_id):
495 neutron_client.delete_subnet(subnet_id)
498 print ("Error [delete_neutron_subnet(neutron_client, '%s')]:" %
503 def delete_neutron_router(neutron_client, router_id):
505 neutron_client.delete_router(router=router_id)
508 print ("Error [delete_neutron_router(neutron_client, '%s')]:" %
513 def delete_neutron_port(neutron_client, port_id):
515 neutron_client.delete_port(port_id)
518 print "Error [delete_neutron_port(neutron_client, '%s')]:" % port_id, e
522 def remove_interface_router(neutron_client, router_id, subnet_id):
523 json_body = {"subnet_id": subnet_id}
525 neutron_client.remove_interface_router(router=router_id,
529 print ("Error [remove_interface_router(neutron_client, '%s', '%s')]:" %
530 (router_id, subnet_id)), e
534 def remove_gateway_router(neutron_client, router_id):
536 neutron_client.remove_gateway_router(router_id)
539 print ("Error [remove_gateway_router(neutron_client, '%s')]:" %
544 def create_network_full(logger,
551 # Check if the network already exists
552 network_id = get_network_id(neutron_client, net_name)
553 subnet_id = get_subnet_id(neutron_client, subnet_name)
554 router_id = get_router_id(neutron_client, router_name)
556 if network_id != '' and subnet_id != '' and router_id != '':
557 logger.info("A network with name '%s' already exists..." % net_name)
559 neutron_client.format = 'json'
560 logger.info('Creating neutron network %s...' % net_name)
561 network_id = create_neutron_net(neutron_client, net_name)
566 logger.debug("Network '%s' created successfully" % network_id)
567 logger.debug('Creating Subnet....')
568 subnet_id = create_neutron_subnet(neutron_client, subnet_name,
573 logger.debug("Subnet '%s' created successfully" % subnet_id)
574 logger.debug('Creating Router...')
575 router_id = create_neutron_router(neutron_client, router_name)
580 logger.debug("Router '%s' created successfully" % router_id)
581 logger.debug('Adding router to subnet...')
583 if not add_interface_router(neutron_client, router_id, subnet_id):
586 logger.debug("Interface added successfully.")
588 logger.debug('Adding gateway to router...')
589 if not add_gateway_router(neutron_client, router_id):
592 logger.debug("Gateway added successfully.")
594 network_dic = {'net_id': network_id,
595 'subnet_id': subnet_id,
596 'router_id': router_id}
600 # *********************************************
602 # *********************************************
603 def get_security_groups(neutron_client):
605 security_groups = neutron_client.list_security_groups()[
607 return security_groups
609 print "Error [get_security_groups(neutron_client)]:", e
613 def get_security_group_id(neutron_client, sg_name):
614 security_groups = get_security_groups(neutron_client)
616 for sg in security_groups:
617 if sg['name'] == sg_name:
623 def create_security_group(neutron_client, sg_name, sg_description):
624 json_body = {'security_group': {'name': sg_name,
625 'description': sg_description}}
627 secgroup = neutron_client.create_security_group(json_body)
628 return secgroup['security_group']
630 print ("Error [create_security_group(neutron_client, '%s', '%s')]:" %
631 (sg_name, sg_description)), e
635 def create_secgroup_rule(neutron_client, sg_id, direction, protocol,
636 port_range_min=None, port_range_max=None):
637 if port_range_min is None and port_range_max is None:
638 json_body = {'security_group_rule': {'direction': direction,
639 'security_group_id': sg_id,
640 'protocol': protocol}}
641 elif port_range_min is not None and port_range_max is not None:
642 json_body = {'security_group_rule': {'direction': direction,
643 'security_group_id': sg_id,
644 'port_range_min': port_range_min,
645 'port_range_max': port_range_max,
646 'protocol': protocol}}
648 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
649 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
650 port_range_min, port_range_max,
652 " Invalid values for port_range_min, port_range_max")
655 neutron_client.create_security_group_rule(json_body)
658 print ("Error [create_secgroup_rule(neutron_client, '%s', '%s', "
659 "'%s', '%s', '%s', '%s')]:" % (neutron_client, sg_id, direction,
660 port_range_min, port_range_max,
665 def create_security_group_full(logger, neutron_client,
666 sg_name, sg_description):
667 sg_id = get_security_group_id(neutron_client, sg_name)
669 logger.info("Using existing security group '%s'..." % sg_name)
671 logger.info("Creating security group '%s'..." % sg_name)
672 SECGROUP = create_security_group(neutron_client,
676 logger.error("Failed to create the security group...")
679 sg_id = SECGROUP['id']
681 logger.debug("Security group '%s' with ID=%s created successfully."
682 % (SECGROUP['name'], sg_id))
684 logger.debug("Adding ICMP rules in security group '%s'..."
686 if not create_secgroup_rule(neutron_client, sg_id,
688 logger.error("Failed to create the security group rule...")
691 logger.debug("Adding SSH rules in security group '%s'..."
693 if not create_secgroup_rule(
694 neutron_client, sg_id, 'ingress', 'tcp', '22', '22'):
695 logger.error("Failed to create the security group rule...")
698 if not create_secgroup_rule(
699 neutron_client, sg_id, 'egress', 'tcp', '22', '22'):
700 logger.error("Failed to create the security group rule...")
705 def add_secgroup_to_instance(nova_client, instance_id, secgroup_id):
707 nova_client.servers.add_security_group(instance_id, secgroup_id)
710 print ("Error [add_secgroup_to_instance(nova_client, '%s', '%s')]: " %
711 (instance_id, secgroup_id)), e
715 def update_sg_quota(neutron_client, tenant_id, sg_quota, sg_rule_quota):
716 json_body = {"quota": {
717 "security_group": sg_quota,
718 "security_group_rule": sg_rule_quota
722 neutron_client.update_quota(tenant_id=tenant_id,
726 print ("Error [update_sg_quota(neutron_client, '%s', '%s', "
727 "'%s')]:" % (tenant_id, sg_quota, sg_rule_quota)), e
731 def delete_security_group(neutron_client, secgroup_id):
733 neutron_client.delete_security_group(secgroup_id)
736 print ("Error [delete_security_group(neutron_client, '%s')]:" %
741 # *********************************************
743 # *********************************************
744 def get_images(nova_client):
746 images = nova_client.images.list()
749 print "Error [get_images]:", e
753 def get_image_id(glance_client, image_name):
754 images = glance_client.images.list()
757 if i.name == image_name:
763 def create_glance_image(glance_client, image_name, file_path, disk="qcow2",
764 container="bare", public=True, logger=None):
765 if not os.path.isfile(file_path):
766 print "Error: file " + file_path + " does not exist."
769 image_id = get_image_id(glance_client, image_name)
772 logger.info("Image %s already exists." % image_name)
775 logger.info("Creating image '%s' from '%s'..." % (image_name,
777 with open(file_path) as fimage:
778 image = glance_client.images.create(name=image_name,
781 container_format=container,
786 print ("Error [create_glance_image(glance_client, '%s', '%s', "
787 "'%s')]:" % (image_name, file_path, str(public))), e
791 def delete_glance_image(nova_client, image_id):
793 nova_client.images.delete(image_id)
796 print ("Error [delete_glance_image(nova_client, '%s')]:" % image_id), e
800 # *********************************************
802 # *********************************************
803 def get_volumes(cinder_client):
805 volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
808 print "Error [get_volumes(cinder_client)]:", e
812 def list_volume_types(cinder_client, public=True, private=True):
814 volume_types = cinder_client.volume_types.list()
816 volume_types = [vt for vt in volume_types if not vt.is_public]
818 volume_types = [vt for vt in volume_types if vt.is_public]
821 print "Error [list_volume_types(cinder_client)]:", e
825 def create_volume_type(cinder_client, name):
827 volume_type = cinder_client.volume_types.create(name)
830 print "Error [create_volume_type(cinder_client, '%s')]:" % name, e
834 def update_cinder_quota(cinder_client, tenant_id, vols_quota,
835 snapshots_quota, gigabytes_quota):
836 quotas_values = {"volumes": vols_quota,
837 "snapshots": snapshots_quota,
838 "gigabytes": gigabytes_quota}
841 cinder_client.quotas.update(tenant_id, **quotas_values)
844 print ("Error [update_cinder_quota(cinder_client, '%s', '%s', '%s'"
845 "'%s')]:" % (tenant_id, vols_quota,
846 snapshots_quota, gigabytes_quota)), e
850 def delete_volume(cinder_client, volume_id, forced=False):
854 cinder_client.volumes.detach(volume_id)
856 print "Error:", sys.exc_info()[0]
857 cinder_client.volumes.force_delete(volume_id)
859 cinder_client.volumes.delete(volume_id)
862 print ("Error [delete_volume(cinder_client, '%s', '%s')]:" %
863 (volume_id, str(forced))), e
867 def delete_volume_type(cinder_client, volume_type):
869 cinder_client.volume_types.delete(volume_type)
872 print ("Error [delete_volume_type(cinder_client, '%s')]:" %
877 # *********************************************
879 # *********************************************
880 def get_tenants(keystone_client):
882 tenants = keystone_client.tenants.list()
885 print "Error [get_tenants(keystone_client)]:", e
889 def get_users(keystone_client):
891 users = keystone_client.users.list()
894 print "Error [get_users(keystone_client)]:", e
898 def get_tenant_id(keystone_client, tenant_name):
899 tenants = keystone_client.tenants.list()
902 if t.name == tenant_name:
908 def get_user_id(keystone_client, user_name):
909 users = keystone_client.users.list()
912 if u.name == user_name:
918 def get_role_id(keystone_client, role_name):
919 roles = keystone_client.roles.list()
922 if r.name == role_name:
928 def create_tenant(keystone_client, tenant_name, tenant_description):
930 tenant = keystone_client.tenants.create(tenant_name,
935 print ("Error [create_tenant(cinder_client, '%s', '%s')]:" %
936 (tenant_name, tenant_description)), e
940 def create_user(keystone_client, user_name, user_password,
941 user_email, tenant_id):
943 user = keystone_client.users.create(user_name, user_password,
944 user_email, tenant_id,
948 print ("Error [create_user(keystone_client, '%s', '%s', '%s'"
949 "'%s')]:" % (user_name, user_password, user_email, tenant_id),
954 def add_role_user(keystone_client, user_id, role_id, tenant_id):
956 keystone_client.roles.add_user_role(user_id, role_id, tenant_id)
959 print ("Error [add_role_user(keystone_client, '%s', '%s'"
960 "'%s')]:" % (user_id, role_id, tenant_id)), e
964 def delete_tenant(keystone_client, tenant_id):
966 keystone_client.tenants.delete(tenant_id)
969 print "Error [delete_tenant(keystone_client, '%s')]:" % tenant_id, e
973 def delete_user(keystone_client, user_id):
975 keystone_client.users.delete(user_id)
978 print "Error [delete_user(keystone_client, '%s')]:" % user_id, e