testcases/VIM/OpenStack/CI/libraries/clean_openstack.py

   1 #!/usr/bin/env python
   2 #
   3 # Description:
   4 #   Cleans possible leftovers after running functest tests:
   5 #       - Nova instances
   6 #       - Glance images
   7 #       - Cinder volumes
   8 #       - Floating IPs
   9 #       - Neutron networks, subnets and ports
  10 #       - Routers
  11 #       - Users and tenants
  12 #
  13 # Author:
  14 #    jose.lausuch@ericsson.com
  15 #
  16
  17 import argparse
  18 import logging
  19 import os
  20 import re
  21 import sys
  22 import time
  23
  24 import novaclient.v2.client as novaclient
  25 from neutronclient.v2_0 import client as neutronclient
  26 from keystoneclient.v2_0 import client as keystoneclient
  27 from cinderclient import client as cinderclient
  28
  29 parser = argparse.ArgumentParser()
  30 parser.add_argument("repo_path", help="Path to the repository")
  31 parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
  32 args = parser.parse_args()
  33
  34
  35 """ logging configuration """
  36 logger = logging.getLogger('clean_openstack')
  37 logger.setLevel(logging.DEBUG)
  38
  39 ch = logging.StreamHandler()
  40 if args.debug:
  41     ch.setLevel(logging.DEBUG)
  42 else:
  43     ch.setLevel(logging.INFO)
  44
  45 sys.path.append(args.repo_path + "testcases/")
  46 import functest_utils
  47
  48 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
  49 ch.setFormatter(formatter)
  50 logger.addHandler(ch)
  51
  52 default_images = ['TestVM']
  53 default_networks = ['net04', 'net04_ext']
  54 default_routers = ['router04']
  55 default_users = ["heat", "heat-cfn", "cinder", "nova", "swift", "glance",
  56                  "neutron", "admin", "fuel_stats_user"]
  57 default_tenants = ["admin", "services"]
  58 default_security_groups = ['default']
  59
  60 def separator():
  61     print("-------------------------------------------")
  62
  63 def remove_instances(nova_client):
  64     logger.info("Removing Nova instances...")
  65     instances = functest_utils.get_instances(nova_client)
  66     if len(instances) == 0:
  67         logger.debug("No instances found.")
  68         return
  69
  70     for instance in instances:
  71         instance_name = getattr(instance, 'name')
  72         instance_id = getattr(instance, 'id')
  73         logger.debug("Removing instance '%s', ID=%s ..." % (instance_name,instance_id))
  74         if functest_utils.delete_instance(nova_client, instance_id):
  75             logger.debug("  > Done!")
  76         else:
  77             logger.info("  > ERROR: There has been a problem removing the "
  78                         "instance %s..." % instance_id)
  79
  80
  81 def remove_images(nova_client):
  82     logger.info("Removing Glance images...")
  83     images = functest_utils.get_images(nova_client)
  84     if len(images) == 0:
  85         logger.debug("No images found.")
  86         return
  87
  88     for image in images:
  89         image_name = getattr(image, 'name')
  90         image_id = getattr(image, 'id')
  91         logger.debug("'%s', ID=%s " %(image_name,image_id))
  92         if image_name not in default_images:
  93             logger.debug("Removing image '%s', ID=%s ..." % (image_name,image_id))
  94             if functest_utils.delete_glance_image(nova_client, image_id):
  95                 logger.debug("  > Done!")
  96             else:
  97                 logger.info("  > ERROR: There has been a problem removing the"
  98                             "image %s..." % image_id)
  99         else:
 100             logger.debug("   > this is a default image and will NOT be deleted.")
 101
 102
 103 def remove_volumes(cinder_client, nova_client):
 104     logger.info("Removing Cinder volumes...")
 105
 106     timeout = 50
 107     while timeout > 0:
 108         instances = functest_utils.get_instances(nova_client)
 109         if len(instances) == 0:
 110             break
 111         else:
 112             logger.debug("Waiting for instances to be terminated...")
 113             timeout -= 1
 114             time.sleep(1)
 115
 116     volumes = functest_utils.get_volumes(cinder_client)
 117     if len(volumes) == 0:
 118         logger.debug("No volumes found.")
 119         return
 120
 121     for volume in volumes:
 122         volume_id = getattr(volume, 'id')
 123         logger.debug("Removing cinder volume %s ..." % volume_id)
 124         if functest_utils.delete_volume(cinder_client, volume_id):
 125             logger.debug("  > Done!")
 126         else:
 127             logger.info("  > ERROR: There has been a problem removing the "
 128                         "volume %s..." % volume_id)
 129
 130
 131 def remove_floatingips(nova_client):
 132     logger.info("Removing floating IPs...")
 133     floatingips = functest_utils.get_floating_ips(nova_client)
 134     if len(floatingips) == 0:
 135         logger.debug("No floating IPs found.")
 136         return
 137
 138     for fip in floatingips:
 139         fip_id = getattr(fip, 'id')
 140         logger.debug("Removing floating IP %s ..." % fip_id)
 141         if functest_utils.delete_floating_ip(nova_client, fip_id):
 142             logger.debug("  > Done!")
 143         else:
 144             logger.info("  > ERROR: There has been a problem removing the "
 145                         "floating IP %s..." % fip_id)
 146
 147
 148 def remove_networks(neutron_client):
 149     logger.info("Removing Neutron objects")
 150     network_ids = []
 151     networks = functest_utils.get_network_list(neutron_client)
 152     if networks == None:
 153         logger.debug("There are no networks in the deployment. ")
 154         return
 155
 156     logger.debug("Existing networks:")
 157     for network in networks:
 158         net_id = network['id']
 159         net_name = network['name']
 160         logger.debug(" '%s', ID=%s " %(net_name,net_id))
 161         if net_name not in default_networks:
 162             logger.debug("    > this is not a default network and will be deleted.")
 163             network_ids.append(net_id)
 164         else:
 165             logger.debug("   > this is a default network and will NOT be deleted.")
 166
 167
 168     #remove interfaces router and delete ports
 169     ports = functest_utils.get_port_list(neutron_client)
 170     for port in ports:
 171         if port['network_id'] in network_ids:
 172             port_id = port['id']
 173             subnet_id = port['fixed_ips'][0]['subnet_id']
 174             router_id = port['device_id']
 175             if port['device_owner'] == 'network:router_interface':
 176                 logger.debug("Detaching port %s (subnet %s) from router %s ..."
 177                              % (port_id,subnet_id,router_id))
 178                 if functest_utils.remove_interface_router(neutron_client,
 179                                                           router_id, subnet_id):
 180                     time.sleep(5) # leave 5 seconds to detach before doing anything else
 181                     logger.debug("  > Done!")
 182                 else:
 183                     logger.info("  > ERROR: There has been a problem removing the "
 184                                 "interface %s from router %s..." %(subnet_id,router_id))
 185                     #print port
 186             else:
 187                 logger.debug("Removing port %s ..." % port_id)
 188                 if functest_utils.delete_neutron_port(neutron_client, port_id):
 189                     logger.debug("  > Done!")
 190                 else:
 191                     logger.info("  > ERROR: There has been a problem removing the "
 192                                 "port %s ..." %port_id)
 193                     #print port
 194
 195     #remove routers
 196     routers = functest_utils.get_router_list(neutron_client)
 197     for router in routers:
 198         router_id = router['id']
 199         router_name = router['name']
 200         if router_name not in default_routers:
 201             logger.debug("Checking '%s' with ID=(%s) ..." % (router_name,router_id))
 202             if router['external_gateway_info'] != None:
 203                 logger.debug("Router has gateway to external network. Removing link...")
 204                 if functest_utils.remove_gateway_router(neutron_client, router_id):
 205                     logger.debug("  > Done!")
 206                 else:
 207                     logger.info("  > ERROR: There has been a problem removing "
 208                                 "the gateway...")
 209                     #print router
 210
 211             else:
 212                 logger.debug("Router is not connected to anything. Ready to remove...")
 213             logger.debug("Removing router %s(%s) ..." % (router_name,router_id))
 214             if functest_utils.delete_neutron_router(neutron_client, router_id):
 215                 logger.debug("  > Done!")
 216             else:
 217                 logger.info("  > ERROR: There has been a problem removing the "
 218                             "router '%s'(%s)..." % (router_name,router_id))
 219
 220
 221     #remove networks
 222     for net_id in network_ids:
 223         logger.debug("Removing network %s ..." % net_id)
 224         if functest_utils.delete_neutron_net(neutron_client, net_id):
 225             logger.debug("  > Done!")
 226         else:
 227             logger.info("  > ERROR: There has been a problem removing the "
 228                         "network %s..." % net_id)
 229
 230
 231 def remove_security_groups(neutron_client):
 232     logger.info("Removing Security groups...")
 233     secgroups = functest_utils.get_security_groups(neutron_client)
 234     if len(secgroups) == 0:
 235         logger.debug("No security groups found.")
 236         return
 237
 238     for secgroup in secgroups:
 239         secgroup_name = secgroup['name']
 240         secgroup_id = secgroup['id']
 241         logger.debug("'%s', ID=%s " %(secgroup_name,secgroup_id))
 242         if secgroup_name not in default_security_groups:
 243             logger.debug(" Removing '%s'..." % secgroup_name)
 244             if functest_utils.delete_security_group(neutron_client, secgroup_id):
 245                 logger.debug("  > Done!")
 246             else:
 247                 logger.info("  > ERROR: There has been a problem removing the "
 248                             "security group %s..." % secgroup_id)
 249         else:
 250             logger.debug("   > this is a default security group and will NOT "
 251                          "be deleted.")
 252
 253
 254 def remove_users(keystone_client):
 255     logger.info("Removing Users...")
 256     users = functest_utils.get_users(keystone_client)
 257     if users == None:
 258         logger.debug("There are no users in the deployment. ")
 259         return
 260
 261     for user in users:
 262         user_name = getattr(user, 'name')
 263         user_id = getattr(user, 'id')
 264         logger.debug("'%s', ID=%s " %(user_name,user_id))
 265         if user_name not in default_users:
 266             logger.debug(" Removing '%s'..." % user_name)
 267             if functest_utils.delete_user(keystone_client,user_id):
 268                 logger.debug("  > Done!")
 269             else:
 270                 logger.info("  > ERROR: There has been a problem removing the "
 271                             "user '%s'(%s)..." % (user_name,user_id))
 272         else:
 273             logger.debug("   > this is a default user and will NOT be deleted.")
 274
 275
 276 def remove_tenants(keystone_client):
 277     logger.info("Removing Tenants...")
 278     tenants = functest_utils.get_tenants(keystone_client)
 279     if tenants == None:
 280         logger.debug("There are no tenants in the deployment. ")
 281         return
 282
 283     for tenant in tenants:
 284         tenant_name=getattr(tenant, 'name')
 285         tenant_id = getattr(tenant, 'id')
 286         logger.debug("'%s', ID=%s " %(tenant_name,tenant_id))
 287         if tenant_name not in default_tenants:
 288             logger.debug(" Removing '%s'..." % tenant_name)
 289             if functest_utils.delete_tenant(keystone_client,tenant_id):
 290                 logger.debug("  > Done!")
 291             else:
 292                 logger.info("  > ERROR: There has been a problem removing the "
 293                             "tenant '%s'(%s)..." % (tenant_name,tenant_id))
 294         else:
 295             logger.debug("   > this is a default tenant and will NOT be deleted.")
 296
 297
 298
 299 def main():
 300     creds_nova = functest_utils.get_credentials("nova")
 301     nova_client = novaclient.Client(**creds_nova)
 302
 303     creds_neutron = functest_utils.get_credentials("neutron")
 304     neutron_client = neutronclient.Client(**creds_neutron)
 305
 306     creds_keystone = functest_utils.get_credentials("keystone")
 307     keystone_client = keystoneclient.Client(**creds_keystone)
 308
 309     creds_cinder = functest_utils.get_credentials("cinder")
 310     #cinder_client = cinderclient.Client(**creds_cinder)
 311     cinder_client = cinderclient.Client('1',creds_cinder['username'],
 312                                         creds_cinder['api_key'],
 313                                         creds_cinder['project_id'],
 314                                         creds_cinder['auth_url'],
 315                                         service_type="volume")
 316
 317     if not functest_utils.check_credentials():
 318         logger.error("Please source the openrc credentials and run the script again.")
 319         exit(-1)
 320
 321
 322     remove_instances(nova_client)
 323     separator()
 324     remove_images(nova_client)
 325     separator()
 326     remove_volumes(cinder_client, nova_client)
 327     separator()
 328     remove_floatingips(nova_client)
 329     separator()
 330     remove_networks(neutron_client)
 331     separator()
 332     remove_security_groups(neutron_client)
 333     separator()
 334     remove_users(keystone_client)
 335     separator()
 336     remove_tenants(keystone_client)
 337     separator()
 338
 339     exit(0)
 340
 341
 342 if __name__ == '__main__':
 343     main()