OpenStack cleanup script

This is needed in case any test case doesn't clean what it creates in openstack.
(This has been happening sometimes for Tempest, for example)

This script will remove:
- nova instances
- glance images
- cinder volumes
- networks/subnets/ports
- routers
- floating ips
- security groups
- users and tenants (not admin)

It won't remove the defaults.

Change-Id: Ie09a5ad481fc3d1b92f124362aea6906665a1629
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

3 files changed, 559 insertions, 1 deletions

diff --git a/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py b/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py
new file mode 100644
index 000000000..45617c5ba
--- /dev/null
+++ b/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py
@@ -0,0 +1,331 @@
+#!/usr/bin/env python
+#
+# Description:
+#   Cleans possible leftovers after running functest tests:
+#       - Nova instances
+#       - Glance images
+#       - Cinder volumes
+#       - Floating IPs
+#       - Neutron networks, subnets and ports
+#       - Routers
+#       - Users and tenants
+#
+# Author:
+#    jose.lausuch@ericsson.com
+#
+
+import argparse
+import logging
+import os
+import re
+import sys
+import time
+
+import novaclient.v2.client as novaclient
+from neutronclient.v2_0 import client as neutronclient
+from keystoneclient.v2_0 import client as keystoneclient
+from cinderclient import client as cinderclient
+
+parser = argparse.ArgumentParser()
+parser.add_argument("repo_path", help="Path to the repository")
+parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
+args = parser.parse_args()
+
+
+""" logging configuration """
+logger = logging.getLogger('clean_openstack')
+logger.setLevel(logging.DEBUG)
+
+ch = logging.StreamHandler()
+if args.debug:
+    ch.setLevel(logging.DEBUG)
+else:
+    ch.setLevel(logging.INFO)
+
+sys.path.append(args.repo_path + "testcases/")
+import functest_utils
+
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+ch.setFormatter(formatter)
+logger.addHandler(ch)
+
+default_images = ['TestVM']
+default_networks = ['net04', 'net04_ext']
+default_routers = ['router04']
+default_users = ["heat", "heat-cfn", "cinder", "nova", "swift", "glance",
+                 "neutron", "admin", "fuel_stats_user"]
+default_tenants = ["admin", "services"]
+default_security_groups = ['default']
+
+def separator():
+    print("-------------------------------------------")
+
+def remove_instances(nova_client):
+    logger.info("Removing Nova instances...")
+    instances = functest_utils.get_instances(nova_client)
+    if len(instances) == 0:
+        logger.debug("No instances found.")
+        return
+
+    for instance in instances:
+        instance_name = getattr(instance, 'name')
+        instance_id = getattr(instance, 'id')
+        logger.debug("Removing instance '%s', ID=%s ..." % (instance_name,instance_id))
+        if functest_utils.delete_instance(nova_client, instance_id):
+            logger.debug("  > Done!")
+        else:
+            logger.info("  > ERROR: There has been a problem removing the "
+                        "instance %s..." % instance_id)
+
+
+def remove_images(nova_client):
+    logger.info("Removing Glance images...")
+    images = functest_utils.get_images(nova_client)
+    if len(images) == 0:
+        logger.debug("No images found.")
+        return
+
+    for image in images:
+        image_name = getattr(image, 'name')
+        image_id = getattr(image, 'id')
+        logger.debug("'%s', ID=%s " %(image_name,image_id))
+        if image_name not in default_images:
+            logger.debug("Removing image '%s', ID=%s ..." % (image_name,image_id))
+            if functest_utils.delete_glance_image(nova_client, image_id):
+                logger.debug("  > Done!")
+            else:
+                logger.info("  > ERROR: There has been a problem removing the"
+                            "image %s..." % image_id)
+        else:
+            logger.debug("   > this is a default image and will NOT be deleted.")
+
+
+def remove_volumes(cinder_client, nova_client):
+    logger.info("Removing Cinder volumes...")
+
+    timeout = 50
+    while timeout > 0:
+        instances = functest_utils.get_instances(nova_client)
+        if len(instances) == 0:
+            break
+        else:
+            logger.debug("Waiting for instances to be terminated...")
+            timeout -= 1
+            time.sleep(1)
+
+    volumes = functest_utils.get_volumes(cinder_client)
+    if len(volumes) == 0:
+        logger.debug("No volumes found.")
+        return
+
+    for volume in volumes:
+        volume_id = getattr(volume, 'id')
+        logger.debug("Removing cinder volume %s ..." % volume_id)
+        if functest_utils.delete_volume(cinder_client, volume_id):
+            logger.debug("  > Done!")
+        else:
+            logger.info("  > ERROR: There has been a problem removing the "
+                        "volume %s..." % volume_id)
+
+
+def remove_floatingips(nova_client):
+    logger.info("Removing floating IPs...")
+    floatingips = functest_utils.get_floating_ips(nova_client)
+    if len(floatingips) == 0:
+        logger.debug("No floating IPs found.")
+        return
+
+    for fip in floatingips:
+        fip_id = getattr(fip, 'id')
+        logger.debug("Removing floating IP %s ..." % fip_id)
+        if functest_utils.delete_floating_ip(nova_client, fip_id):
+            logger.debug("  > Done!")
+        else:
+            logger.info("  > ERROR: There has been a problem removing the "
+                        "floating IP %s..." % fip_id)
+
+
+def remove_networks(neutron_client):
+    logger.info("Removing Neutron objects")
+    network_ids = []
+    networks = functest_utils.get_network_list(neutron_client)
+    logger.debug("Existing networks:")
+    for network in networks:
+        net_id = network['id']
+        net_name = network['name']
+        logger.debug(" '%s', ID=%s " %(net_name,net_id))
+        if net_name not in default_networks:
+            logger.debug("    > this is not a default network and will be deleted.")
+            network_ids.append(net_id)
+        else:
+            logger.debug("   > this is a default network and will NOT be deleted.")
+
+
+    #remove interfaces router and delete ports
+    ports = functest_utils.get_port_list(neutron_client)
+    for port in ports:
+        if port['network_id'] in network_ids:
+            port_id = port['id']
+            subnet_id = port['fixed_ips'][0]['subnet_id']
+            router_id = port['device_id']
+            if port['device_owner'] == 'network:router_interface':
+                logger.debug("Detaching port %s (subnet %s) from router %s ..."
+                             % (port_id,subnet_id,router_id))
+                if functest_utils.remove_interface_router(neutron_client,
+                                                          router_id, subnet_id):
+                    time.sleep(5) # leave 5 seconds to detach before doing anything else
+                    logger.debug("  > Done!")
+                else:
+                    logger.info("  > ERROR: There has been a problem removing the "
+                                "interface %s from router %s..." %(subnet_id,router_id))
+                    #print port
+            else:
+                logger.debug("Removing port %s ..." % port_id)
+                if functest_utils.delete_neutron_port(neutron_client, port_id):
+                    logger.debug("  > Done!")
+                else:
+                    logger.info("  > ERROR: There has been a problem removing the "
+                                "port %s ..." %port_id)
+                    #print port
+
+    #remove routers
+    routers = functest_utils.get_router_list(neutron_client)
+    for router in routers:
+        router_id = router['id']
+        router_name = router['name']
+        if router_name not in default_routers:
+            logger.debug("Checking '%s' with ID=(%s) ..." % (router_name,router_id))
+            if router['external_gateway_info'] != None:
+                logger.debug("Router has gateway to external network. Removing link...")
+                if functest_utils.remove_gateway_router(neutron_client, router_id):
+                    logger.debug("  > Done!")
+                else:
+                    logger.info("  > ERROR: There has been a problem removing "
+                                "the gateway...")
+                    #print router
+
+            else:
+                logger.debug("Router is not connected to anything. Ready to remove...")
+            logger.debug("Removing router %s(%s) ..." % (router_name,router_id))
+            if functest_utils.delete_neutron_router(neutron_client, router_id):
+                logger.debug("  > Done!")
+            else:
+                logger.info("  > ERROR: There has been a problem removing the "
+                            "router '%s'(%s)..." % (router_name,router_id))
+
+
+    #remove networks
+    for net_id in network_ids:
+        logger.debug("Removing network %s ..." % net_id)
+        if functest_utils.delete_neutron_net(neutron_client, net_id):
+            logger.debug("  > Done!")
+        else:
+            logger.info("  > ERROR: There has been a problem removing the "
+                        "network %s..." % net_id)
+
+
+def remove_security_groups(neutron_client):
+    logger.info("Removing Security groups...")
+    secgroups = functest_utils.get_security_groups(neutron_client)
+    if len(secgroups) == 0:
+        logger.debug("No security groups found.")
+        return
+
+    for secgroup in secgroups:
+        secgroup_name = secgroup['name']
+        secgroup_id = secgroup['id']
+        logger.debug("'%s', ID=%s " %(secgroup_name,secgroup_id))
+        if secgroup_name not in default_security_groups:
+            logger.debug(" Removing '%s'..." % secgroup_name)
+            if functest_utils.delete_security_group(neutron_client, secgroup_id):
+                logger.debug("  > Done!")
+            else:
+                logger.info("  > ERROR: There has been a problem removing the "
+                            "security group %s..." % secgroup_id)
+        else:
+            logger.debug("   > this is a default security group and will NOT "
+                         "be deleted.")
+
+
+def remove_users(keystone_client):
+    logger.info("Removing Users...")
+    users = functest_utils.get_users(keystone_client)
+    for user in users:
+        user_name = getattr(user, 'name')
+        user_id = getattr(user, 'id')
+        logger.debug("'%s', ID=%s " %(user_name,user_id))
+        if user_name not in default_users:
+            logger.debug(" Removing '%s'..." % user_name)
+            if functest_utils.delete_user(keystone_client,user_id):
+                logger.debug("  > Done!")
+            else:
+                logger.info("  > ERROR: There has been a problem removing the "
+                            "user '%s'(%s)..." % (user_name,user_id))
+        else:
+            logger.debug("   > this is a default user and will NOT be deleted.")
+
+
+def remove_tenants(keystone_client):
+    logger.info("Removing Tenants...")
+    tenants = functest_utils.get_tenants(keystone_client)
+    for tenant in tenants:
+        tenant_name=getattr(tenant, 'name')
+        tenant_id = getattr(tenant, 'id')
+        logger.debug("'%s', ID=%s " %(tenant_name,tenant_id))
+        if tenant_name not in default_tenants:
+            logger.debug(" Removing '%s'..." % tenant_name)
+            if functest_utils.delete_tenant(keystone_client,tenant_id):
+                logger.debug("  > Done!")
+            else:
+                logger.info("  > ERROR: There has been a problem removing the "
+                            "tenant '%s'(%s)..." % (tenant_name,tenant_id))
+        else:
+            logger.debug("   > this is a default tenant and will NOT be deleted.")
+
+
+
+def main():
+    creds_nova = functest_utils.get_credentials("nova")
+    nova_client = novaclient.Client(**creds_nova)
+
+    creds_neutron = functest_utils.get_credentials("neutron")
+    neutron_client = neutronclient.Client(**creds_neutron)
+
+    creds_keystone = functest_utils.get_credentials("keystone")
+    keystone_client = keystoneclient.Client(**creds_keystone)
+
+    creds_cinder = functest_utils.get_credentials("cinder")
+    #cinder_client = cinderclient.Client(**creds_cinder)
+    cinder_client = cinderclient.Client('1',creds_cinder['username'],
+                                        creds_cinder['api_key'],
+                                        creds_cinder['project_id'],
+                                        creds_cinder['auth_url'],
+                                        service_type="volume")
+
+    if not functest_utils.check_credentials():
+        logger.error("Please source the openrc credentials and run the script again.")
+        exit(-1)
+
+
+    remove_instances(nova_client)
+    separator()
+    remove_images(nova_client)
+    separator()
+    remove_volumes(cinder_client, nova_client)
+    separator()
+    remove_floatingips(nova_client)
+    separator()
+    remove_networks(neutron_client)
+    separator()
+    remove_security_groups(neutron_client)
+    separator()
+    remove_users(keystone_client)
+    separator()
+    remove_tenants(keystone_client)
+    separator()
+
+    exit(0)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/testcases/VIM/OpenStack/CI/libraries/test_openstack.sh b/testcases/VIM/OpenStack/CI/libraries/test_openstack.sh
new file mode 100755
index 000000000..7225796c5
--- /dev/null
+++ b/testcases/VIM/OpenStack/CI/libraries/test_openstack.sh
@@ -0,0 +1,111 @@
+#
+# Script to test clean_openstack.py
+#
+# Author:
+#    jose.lausuch@ericsson.com
+#
+
+if [ -z $OS_AUTH_URL ]; then
+    echo "Source credentials first"
+    exit 1
+fi
+
+echo "Using following credentials:"
+env | grep OS
+
+#################################
+echo "Creating keystone stuff.."
+#################################
+keystone tenant-create --name tenant_test1
+keystone tenant-create --name tenant_test2
+tenant1_id=$(keystone tenant-list | grep tenant_test1 | awk '{print $2}')
+tenant2_id=$(keystone tenant-list | grep tenant_test2 | awk '{print $2}')
+keystone user-create --name user_test11 --tenant $tenant1_id
+keystone user-create --name user_test12 --tenant $tenant1_id
+keystone user-create --name user_test13 --tenant $tenant1_id
+keystone user-create --name user_test21 --tenant $tenant2_id
+keystone user-create --name user_test22 --tenant $tenant2_id
+
+
+#################################
+echo "Creating glance stuff.."
+#################################
+wget http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img
+glance image-create --name image_test1 --disk-format qcow2 --container-format bare < cirros-0.3.4-x86_64-disk.img
+glance image-create --name image_test2 --disk-format qcow2 --container-format bare < cirros-0.3.4-x86_64-disk.img
+#glance image-create --name test --visibility public --disk-format qcow2 --container-format bare --file cirros-0.3.4-x86_64-disk.img
+
+
+#################################
+echo "Creating cinder stuff.."
+#################################
+cinder create --display_name volume-test1 1
+cinder create --display_name volume-test2 2
+
+
+#################################
+echo "Creating NEUTRON stuff.."
+#################################
+echo "1. Create Networks."
+neutron net-create net-test1
+neutron net-create net-test2
+
+echo "2. Create subnets."
+neutron subnet-create --name subnet-test11 --allocation-pool start=10.7.0.2,end=10.7.0.253 --gateway 10.7.0.254 net-test1 10.7.0.0/24
+neutron subnet-create --name subnet-test21 --allocation-pool start=10.6.0.2,end=10.6.0.253 --gateway 10.6.0.254 net-test2 10.6.0.0/24
+
+echo "3. Create Ports."
+neutron port-create --name port-test11 --fixed-ip ip_address=10.7.0.10 net-test1
+neutron port-create --name port-test21 --fixed-ip ip_address=10.6.0.60 net-test2
+
+
+echo "4. Create Routers."
+neutron router-create router-test1
+neutron router-create router-test2
+router1_id=$(neutron router-list | grep router-test1 | awk '{print $2}')
+router1_id=$(neutron router-list | grep router-test2 | awk '{print $2}')
+
+neutron router-gateway-set router-test1 net04_ext
+neutron router-gateway-set router-test2 net04_ext
+
+neutron router-interface-add router-test1 subnet-test11
+neutron router-interface-add router-test2 subnet-test21
+
+echo "5. Floating IPs."
+neutron floatingip-create net04_ext
+neutron floatingip-create net04_ext
+neutron floatingip-create net04_ext
+neutron floatingip-create net04_ext
+
+floating_ip1_id=$(neutron floatingip-list | awk 'FNR == 4 {print}' | awk '{print $2}')
+floating_ip2_id=$(neutron floatingip-list | awk 'FNR == 5 {print}' | awk '{print $2}')
+floating_ip3_id=$(neutron floatingip-list | awk 'FNR == 6 {print}' | awk '{print $2}')
+floating_ip4_id=$(neutron floatingip-list | awk 'FNR == 7 {print}' | awk '{print $2}')
+
+floating_ip1=$(neutron floatingip-list | awk 'FNR == 4 {print}' | awk '{print $5}')
+floating_ip2=$(neutron floatingip-list | awk 'FNR == 5 {print}' | awk '{print $5}')
+floating_ip3=$(neutron floatingip-list | awk 'FNR == 6 {print}' | awk '{print $5}')
+floating_ip4=$(neutron floatingip-list | awk 'FNR == 7 {print}' | awk '{print $5}')
+
+#################################
+echo "Creating NOVA stuff.."
+#################################
+net1_id=$(neutron net-list | grep net-test1 | awk '{print $2}')
+net2_id=$(neutron net-list | grep net-test2 | awk '{print $2}')
+
+nova boot --flavor 2 --image image_test1 --nic net-id=$net1_id nova-test11
+nova boot --flavor 2 --image image_test1 --nic net-id=$net1_id nova-test12
+nova boot --flavor 2 --image image_test2 --nic net-id=$net2_id nova-test21
+nova boot --flavor 2 --image image_test2 --nic net-id=$net2_id nova-test22
+
+vm1_id=$(nova list | grep nova-test11 | awk '{print $2}')
+vm2_id=$(nova list | grep nova-test12 | awk '{print $2}')
+vm3_id=$(nova list | grep nova-test21 | awk '{print $2}')
+vm4_id=$(nova list | grep nova-test22 | awk '{print $2}')
+
+nova floating-ip-associate $vm1_id $floating_ip1
+nova floating-ip-associate $vm2_id $floating_ip2
+nova floating-ip-associate $vm3_id $floating_ip3
+nova floating-ip-associate $vm4_id $floating_ip4
+
+#neutron floatingip-associate  --fixed-ip-address $floating_ip2 <PORT>
diff --git a/testcases/functest_utils.py b/testcases/functest_utils.py
index 7dce96da1..a0d91357d 100644
--- a/testcases/functest_utils.py
+++ b/testcases/functest_utils.py
@@ -60,6 +60,13 @@ def get_credentials(service):
 
 
 # ################ NOVA #################
+def get_instances(nova_client):
+    try:
+        instances = nova_client.servers.list(search_opts={'all_tenants': 1})
+        return instances
+    except:
+        return None
+
 def get_instance_status(nova_client, instance):
     try:
         instance = nova_client.servers.get(instance.id)
@@ -67,7 +74,6 @@ def get_instance_status(nova_client, instance):
     except:
         return None
 
-
 def get_instance_by_name(nova_client, instance_name):
     try:
         instance = nova_client.servers.find(name=instance_name)
@@ -76,6 +82,7 @@ def get_instance_by_name(nova_client, instance_name):
         return None
 
 
+
 def get_flavor_id(nova_client, flavor_name):
     flavors = nova_client.flavors.list(detailed=True)
     id = ''
@@ -96,6 +103,31 @@ def get_flavor_id_by_ram_range(nova_client, min_ram, max_ram):
     return id
 
 
+def delete_instance(nova_client, instance_id):
+    try:
+        nova_client.servers.force_delete(instance_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return False
+
+
+def get_floating_ips(nova_client):
+    try:
+        floating_ips = nova_client.floating_ips.list()
+        return floating_ips
+    except:
+        return None
+
+def delete_floating_ip(nova_client, floatingip_id):
+    try:
+        nova_client.floating_ips.delete(floatingip_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return None
+
+
 # ################ NEUTRON #################
 def create_neutron_net(neutron_client, name):
     json_body = {'network': {'name': name,
@@ -178,6 +210,14 @@ def remove_interface_router(neutron_client, router_id, subnet_id):
         print "Error:", sys.exc_info()[0]
         return False
 
+def remove_gateway_router(neutron_client, router_id):
+    try:
+        neutron_client.remove_gateway_router(router_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return False
+
 
 def create_neutron_port(neutron_client, name, network_id, ip):
     json_body = {'port': {
@@ -229,6 +269,22 @@ def get_network_list(neutron_client):
         return network_list
 
 
+def get_router_list(neutron_client):
+    router_list = neutron_client.list_routers()['routers']
+    if len(router_list) == 0:
+        return None
+    else:
+        return router_list
+
+def get_port_list(neutron_client):
+    port_list = neutron_client.list_ports()['ports']
+    if len(port_list) == 0:
+        return None
+    else:
+        return port_list
+
+
+
 def get_external_net(neutron_client):
     for network in neutron_client.list_networks()['networks']:
         if network['router:external']:
@@ -262,6 +318,12 @@ def get_private_net(neutron_client):
     return None
 
 # ################ GLANCE #################
+def get_images(nova_client):
+    try:
+        images = nova_client.images.list()
+        return images
+    except:
+        return None
 
 
 def get_image_id(glance_client, image_name):
@@ -286,8 +348,56 @@ def create_glance_image(glance_client, image_name, file_path, is_public=True):
     except:
         return False
 
+def delete_glance_image(nova_client, image_id):
+    try:
+        nova_client.images.delete(image_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return False
+
+# ################ CINDER #################
+def get_volumes(cinder_client):
+    try:
+        volumes = cinder_client.volumes.list(search_opts={'all_tenants': 1})
+        return volumes
+    except:
+        return None
+
+def delete_volume(cinder_client, volume_id):
+    try:
+        cinder_client.volumes.delete(volume_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return False
+
+# ################ CINDER #################
+def get_security_groups(neutron_client):
+    try:
+        security_groups = neutron_client.list_security_groups()['security_groups']
+        return security_groups
+    except:
+        return None
+
+def delete_security_group(neutron_client, secgroup_id):
+    try:
+        neutron_client.delete_security_group(secgroup_id)
+        return True
+    except:
+        print "Error:", sys.exc_info()[0]
+        return False
+
 
 # ################ KEYSTONE #################
+def get_tenants(keystone_client):
+    try:
+        tenants = keystone_client.tenants.list()
+        return tenants
+    except:
+        return None
+
+
 def get_tenant_id(keystone_client, tenant_name):
     tenants = keystone_client.tenants.list()
     id = ''
@@ -297,6 +407,12 @@ def get_tenant_id(keystone_client, tenant_name):
             break
     return id
 
+def get_users(keystone_client):
+    try:
+        users = keystone_client.users.list()
+        return users
+    except:
+        return None
 
 def get_role_id(keystone_client, role_name):
     roles = keystone_client.roles.list()