4 # Cleans possible leftovers after running functest tests:
9 # - Neutron networks, subnets and ports
14 # jose.lausuch@ericsson.com
17 # All rights reserved. This program and the accompanying materials
18 # are made available under the terms of the Apache License, Version 2.0
19 # which accompanies this distribution, and is available at
20 # http://www.apache.org/licenses/LICENSE-2.0
24 import functest.utils.functest_logger as ft_logger
25 import functest.utils.functest_utils as ft_utils
26 import functest.utils.openstack_utils as os_utils
30 logger = ft_logger.Logger("openstack_clean").getLogger()
32 OS_SNAPSHOT_FILE = ft_utils.get_parameter_from_yaml(
33 "general.openstack.snapshot_file")
37 logger.debug("-------------------------------------------")
40 def remove_instances(nova_client, default_instances):
41 logger.debug("Removing Nova instances...")
42 instances = os_utils.get_instances(nova_client)
43 if instances is None or len(instances) == 0:
44 logger.debug("No instances found.")
47 for instance in instances:
48 instance_name = getattr(instance, 'name')
49 instance_id = getattr(instance, 'id')
50 logger.debug("'%s', ID=%s " % (instance_name, instance_id))
51 if (instance_id not in default_instances and
52 instance_name not in default_instances.values()):
53 logger.debug("Removing instance '%s' ..." % instance_id)
54 if os_utils.delete_instance(nova_client, instance_id):
55 logger.debug(" > Request sent.")
57 logger.error("There has been a problem removing the "
58 "instance %s..." % instance_id)
60 logger.debug(" > this is a default instance and will "
65 instances = os_utils.get_instances(nova_client)
66 for instance in instances:
67 instance_id = getattr(instance, 'id')
68 if instance_id not in default_instances:
69 logger.debug("Waiting for instances to be terminated...")
76 def remove_images(nova_client, default_images):
77 logger.debug("Removing Glance images...")
78 images = os_utils.get_images(nova_client)
79 if images is None or len(images) == 0:
80 logger.debug("No images found.")
84 image_name = getattr(image, 'name')
85 image_id = getattr(image, 'id')
86 logger.debug("'%s', ID=%s " % (image_name, image_id))
87 if (image_id not in default_images and
88 image_name not in default_images.values()):
89 logger.debug("Removing image '%s', ID=%s ..."
90 % (image_name, image_id))
91 if os_utils.delete_glance_image(nova_client, image_id):
92 logger.debug(" > Done!")
94 logger.error("There has been a problem removing the"
95 "image %s..." % image_id)
97 logger.debug(" > this is a default image and will "
101 def remove_volumes(cinder_client, default_volumes):
102 logger.debug("Removing Cinder volumes...")
103 volumes = os_utils.get_volumes(cinder_client)
104 if volumes is None or len(volumes) == 0:
105 logger.debug("No volumes found.")
108 for volume in volumes:
109 volume_id = getattr(volume, 'id')
110 volume_name = getattr(volume, 'display_name')
111 logger.debug("'%s', ID=%s " % (volume_name, volume_id))
112 if (volume_id not in default_volumes and
113 volume_name not in default_volumes.values()):
114 logger.debug("Removing cinder volume %s ..." % volume_id)
115 if os_utils.delete_volume(cinder_client, volume_id):
116 logger.debug(" > Done!")
118 logger.debug("Trying forced removal...")
119 if os_utils.delete_volume(cinder_client,
122 logger.debug(" > Done!")
124 logger.error("There has been a problem removing the "
125 "volume %s..." % volume_id)
127 logger.debug(" > this is a default volume and will "
131 def remove_floatingips(nova_client, default_floatingips):
132 logger.debug("Removing floating IPs...")
133 floatingips = os_utils.get_floating_ips(nova_client)
134 if floatingips is None or len(floatingips) == 0:
135 logger.debug("No floating IPs found.")
138 init_len = len(floatingips)
140 for fip in floatingips:
141 fip_id = getattr(fip, 'id')
142 fip_ip = getattr(fip, 'ip')
143 logger.debug("'%s', ID=%s " % (fip_ip, fip_id))
144 if (fip_id not in default_floatingips and
145 fip_ip not in default_floatingips.values()):
146 logger.debug("Removing floating IP %s ..." % fip_id)
147 if os_utils.delete_floating_ip(nova_client, fip_id):
148 logger.debug(" > Done!")
151 logger.error("There has been a problem removing the "
152 "floating IP %s..." % fip_id)
154 logger.debug(" > this is a default floating IP and will "
159 floatingips = os_utils.get_floating_ips(nova_client)
160 if floatingips is None or len(floatingips) == (init_len - deleted):
163 logger.debug("Waiting for floating ips to be released...")
168 def remove_networks(neutron_client, default_networks, default_routers):
169 logger.debug("Removing Neutron objects")
171 networks = os_utils.get_network_list(neutron_client)
173 logger.debug("There are no networks in the deployment. ")
175 logger.debug("Existing networks:")
176 for network in networks:
177 net_id = network['id']
178 net_name = network['name']
179 logger.debug(" '%s', ID=%s " % (net_name, net_id))
180 if (net_id in default_networks and
181 net_name in default_networks.values()):
182 logger.debug(" > this is a default network and will "
184 elif network['router:external'] is True:
185 logger.debug(" > this is an external network and will "
188 logger.debug(" > this network will be deleted.")
189 network_ids.append(net_id)
192 ports = os_utils.get_port_list(neutron_client)
194 logger.debug("There are no ports in the deployment. ")
196 remove_ports(neutron_client, ports, network_ids)
199 routers = os_utils.get_router_list(neutron_client)
201 logger.debug("There are no routers in the deployment. ")
203 remove_routers(neutron_client, routers, default_routers)
206 if network_ids is not None:
207 for net_id in network_ids:
208 logger.debug("Removing network %s ..." % net_id)
209 if os_utils.delete_neutron_net(neutron_client, net_id):
210 logger.debug(" > Done!")
212 logger.error("There has been a problem removing the "
213 "network %s..." % net_id)
216 def remove_ports(neutron_client, ports, network_ids):
218 if port['network_id'] in network_ids:
221 subnet_id = port['fixed_ips'][0]['subnet_id']
223 logger.debug(" > WARNING: Port %s does not contain fixed_ips"
226 router_id = port['device_id']
227 if len(port['fixed_ips']) == 0 and router_id == '':
228 logger.debug("Removing port %s ..." % port_id)
229 if (os_utils.delete_neutron_port(neutron_client, port_id)):
230 logger.debug(" > Done!")
232 logger.error("There has been a problem removing the "
233 "port %s ..." % port_id)
234 force_remove_port(neutron_client, port_id)
236 elif port['device_owner'] == 'network:router_interface':
237 logger.debug("Detaching port %s (subnet %s) from router %s ..."
238 % (port_id, subnet_id, router_id))
239 if os_utils.remove_interface_router(
240 neutron_client, router_id, subnet_id):
241 time.sleep(5) # leave 5 seconds to detach
242 logger.debug(" > Done!")
244 logger.error("There has been a problem removing the "
245 "interface %s from router %s..."
246 % (subnet_id, router_id))
247 force_remove_port(neutron_client, port_id)
249 force_remove_port(neutron_client, port_id)
252 def force_remove_port(neutron_client, port_id):
253 logger.debug("Clearing device_owner for port %s ..." % port_id)
254 os_utils.update_neutron_port(neutron_client, port_id,
255 device_owner='clear')
256 logger.debug("Removing port %s ..." % port_id)
257 if os_utils.delete_neutron_port(neutron_client, port_id):
258 logger.debug(" > Done!")
260 logger.error("There has been a problem removing the port %s..."
264 def remove_routers(neutron_client, routers, default_routers):
265 for router in routers:
266 router_id = router['id']
267 router_name = router['name']
268 if (router_id not in default_routers and
269 router_name not in default_routers.values()):
270 logger.debug("Checking '%s' with ID=(%s) ..." % (router_name,
272 if router['external_gateway_info'] is not None:
273 logger.debug("Router has gateway to external network."
275 if os_utils.remove_gateway_router(neutron_client, router_id):
276 logger.debug(" > Done!")
278 logger.error("There has been a problem removing "
281 logger.debug("Router is not connected to anything."
282 "Ready to remove...")
283 logger.debug("Removing router %s(%s) ..."
284 % (router_name, router_id))
285 if os_utils.delete_neutron_router(neutron_client, router_id):
286 logger.debug(" > Done!")
288 logger.error("There has been a problem removing the "
289 "router '%s'(%s)..." % (router_name, router_id))
292 def remove_security_groups(neutron_client, default_security_groups):
293 logger.debug("Removing Security groups...")
294 secgroups = os_utils.get_security_groups(neutron_client)
295 if secgroups is None or len(secgroups) == 0:
296 logger.debug("No security groups found.")
299 for secgroup in secgroups:
300 secgroup_name = secgroup['name']
301 secgroup_id = secgroup['id']
302 logger.debug("'%s', ID=%s " % (secgroup_name, secgroup_id))
303 if secgroup_id not in default_security_groups:
304 logger.debug(" Removing '%s'..." % secgroup_name)
305 if os_utils.delete_security_group(neutron_client, secgroup_id):
306 logger.debug(" > Done!")
308 logger.error("There has been a problem removing the "
309 "security group %s..." % secgroup_id)
311 logger.debug(" > this is a default security group and will NOT "
315 def remove_users(keystone_client, default_users):
316 logger.debug("Removing Users...")
317 users = os_utils.get_users(keystone_client)
319 logger.debug("There are no users in the deployment. ")
323 user_name = getattr(user, 'name')
324 user_id = getattr(user, 'id')
325 logger.debug("'%s', ID=%s " % (user_name, user_id))
326 if (user_id not in default_users and
327 user_name not in default_users.values()):
328 logger.debug(" Removing '%s'..." % user_name)
329 if os_utils.delete_user(keystone_client, user_id):
330 logger.debug(" > Done!")
332 logger.error("There has been a problem removing the "
333 "user '%s'(%s)..." % (user_name, user_id))
335 logger.debug(" > this is a default user and will "
339 def remove_tenants(keystone_client, default_tenants):
340 logger.debug("Removing Tenants...")
341 tenants = os_utils.get_tenants(keystone_client)
343 logger.debug("There are no tenants in the deployment. ")
346 for tenant in tenants:
347 tenant_name = getattr(tenant, 'name')
348 tenant_id = getattr(tenant, 'id')
349 logger.debug("'%s', ID=%s " % (tenant_name, tenant_id))
350 if (tenant_id not in default_tenants and
351 tenant_name not in default_tenants.values()):
352 logger.debug(" Removing '%s'..." % tenant_name)
353 if os_utils.delete_tenant(keystone_client, tenant_id):
354 logger.debug(" > Done!")
356 logger.error("There has been a problem removing the "
357 "tenant '%s'(%s)..." % (tenant_name, tenant_id))
359 logger.debug(" > this is a default tenant and will "
364 logger.info("Cleaning OpenStack resources...")
366 nova_client = os_utils.get_nova_client()
367 neutron_client = os_utils.get_neutron_client()
368 keystone_client = os_utils.get_keystone_client()
369 cinder_client = os_utils.get_cinder_client()
372 with open(OS_SNAPSHOT_FILE) as f:
373 snapshot_yaml = yaml.safe_load(f)
375 logger.info("The file %s does not exist. The OpenStack snapshot must"
376 " be created first. Aborting cleanup." % OS_SNAPSHOT_FILE)
379 default_images = snapshot_yaml.get('images')
380 default_instances = snapshot_yaml.get('instances')
381 default_volumes = snapshot_yaml.get('volumes')
382 default_networks = snapshot_yaml.get('networks')
383 default_routers = snapshot_yaml.get('routers')
384 default_security_groups = snapshot_yaml.get('secgroups')
385 default_floatingips = snapshot_yaml.get('floatingips')
386 default_users = snapshot_yaml.get('users')
387 default_tenants = snapshot_yaml.get('tenants')
389 if not os_utils.check_credentials():
390 logger.error("Please source the openrc credentials and run "
394 remove_instances(nova_client, default_instances)
396 remove_images(nova_client, default_images)
398 remove_volumes(cinder_client, default_volumes)
400 remove_floatingips(nova_client, default_floatingips)
402 remove_networks(neutron_client, default_networks, default_routers)
404 remove_security_groups(neutron_client, default_security_groups)
406 remove_users(keystone_client, default_users)
408 remove_tenants(keystone_client, default_tenants)
412 if __name__ == '__main__':