clean/fip: Add new clean command

* Remove refs between floating-ip-pool and floatinip (which do not exist
  anymore).

Author: rasta-rocket

contrail_api_cli_extra/clean/fip.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from contrail_api_cli.command import Option
+from contrail_api_cli.utils import printo
+from contrail_api_cli.exceptions import ResourceNotFound
+
+from ..utils import CassandraCommand, CheckCommand, PathCommand
+from refs import CleanRefs
+
+class CleanFipRefs(CassandraCommand, CheckCommand, PathCommand):
+    """Clean broken references related to floating IPs.
+
+    Broken refs related to FIP can be found with gremlin (floating-ip-pool <->
+    floating-ip).
+
+    The command will take all existing floating-ip-pool and checks the existence
+    of each floating-ip it points to and removes the reference if that latter
+    does not exist.
+
+    You can run the command by putting the floating-ip-pool path to be more
+    precise or you can run it without any resources path, in that case it will
+    iterates over all floating-ip-pool.
+
+    You can also specify the floating-ip uuids refs list you want to clean,
+    and it will remove those floating-ip references only for the floating-ip-pool
+    where the floating-ip is linked to.
+
+    """
+    description = "Clean broken references related to floating IPs"
+
+    refs = Option(help="list of floating IP UUIDs", nargs="*", default=[])
+
+    @property
+    def resource_type(self):
+        return "floating-ip-pool"
+
+    def _clean_refs(self, pool, fip, **kwargs):
+        try:
+            fip.fetch()
+        except ResourceNotFound:
+            CleanRefs(ref_type="children",
+                      target_type="floating_ip",
+                      paths=[pool.uuid, fip.uuid],
+                      **kwargs)
+
+    def __call__(self, refs, **kwargs):
+        super(CleanFipRefs, self).__call__(**kwargs)
+        for pool in self.resources:
+            try:
+                pool.fetch()
+                if refs:
+                    fip_list = [fip for fip in pool.children.floating_ip if
+                                fip.uuid in refs]
+                else:
+                    fip_list = pool.children.floating_ip
+
+                for fip in fip_list:
+                    # TODO: clean also refs between project and fip by using
+                    #       projects = Collection('project',
+                    #                             fetch=True,
+                    #                             back_refs_uuid=['2f20ee42-c69a-4521-800c-d0a151bdf93d'])
+                    self._clean_refs(pool, fip, **kwargs)
+
+            except ResourceNotFound as e:
+                printo(e)

contrail_api_cli_extra/clean/refs.py

@@ -8,10 +8,10 @@
 from contrail_api_cli.command import Option, Arg
 from contrail_api_cli.utils import printo
 
-from ..utils import server_type, CheckCommand
+from ..utils import server_type, CheckCommand, CassandraCommand
 
 
-class CleanRefs(CheckCommand):
+class CleanRefs(CheckCommand, CassandraCommand):
     """Clean references in Contrail DB.
 
     Broken refs can be found with gremlin.
@@ -57,18 +57,13 @@ class CleanRefs(CheckCommand):
     target_type = Option(help="resource type of the target",
                          required=True)
 
-    cassandra_servers = Option(help="cassandra server list' (default: %(default)s)",
-                               nargs='+',
-                               type=server_type,
-                               default=['localhost:9160'])
-
     def _remove_refs(self, paths):
         if len(paths) == 0:
             return
         source, target = paths[:2]
         # when the parent doesn't exists anymore,
         # we don't need to keep the source
-        if not self.check:
+        if not self.check and not self.dry_run:
             if self.ref_type == "parent":
                 self.uuid_cf.remove(target)
                 self.uuid_cf.remove(source)
@@ -85,9 +80,9 @@ def _read_file(self, resources_file):
             paths = paths + l.split()
         return paths
 
-    def __call__(self, paths=None, resources_file=None, ref_type=None, target_type=None, cassandra_servers=None, **kwargs):
+    def __call__(self, paths=None, resources_file=None, ref_type=None, target_type=None, **kwargs):
         super(CleanRefs, self).__call__(**kwargs)
-        pool = ConnectionPool('config_db_uuid', server_list=cassandra_servers)
+        pool = ConnectionPool('config_db_uuid', server_list=self.cassandra_servers)
         self.uuid_cf = ColumnFamily(pool, 'obj_uuid_table')
         self.ref_type = ref_type
         self.target_type = target_type

contrail_api_cli_extra/utils.py

@@ -220,6 +220,21 @@ def __call__(self, zk_server=None, **kwargs):
         super(ZKCommand, self).__call__(**kwargs)
 
 
+class CassandraCommand(Command):
+    """Inherit from this class to add `--cassandra-servers` options.
+
+    Cassandra servers list value is stored in `self.cassandra_servers`.
+    """
+    cassandra_servers = Option(help="cassandra server list' (default: %(default)s)",
+                               nargs='+',
+                               type=server_type,
+                               default=['localhost:9160'])
+
+    def __call__(self, cassandra_servers=None, **kwargs):
+        self.cassandra_servers = cassandra_servers
+        super(CassandraCommand, self).__call__(**kwargs)
+
+
 class CheckCommand(Command):
     """Inherit from this class to add `--check` and `--dry-run` options.
 

setup.py

@@ -98,6 +98,7 @@
             'clean-si-scheduling = contrail_api_cli_extra.clean.si:CleanSIScheduling',
             'clean-subnet = contrail_api_cli_extra.clean.subnet:CleanSubnet',
             'clean-refs = contrail_api_cli_extra.clean.refs:CleanRefs',
+            'clean-fip-refs = contrail_api_cli_extra.clean.fip:CleanFipRefs',
         ]
     },
     classifiers=[