#1230 added tag cleanup command

Author: allmightyspiff

SoftLayer/CLI/core.py

@@ -158,6 +158,7 @@ def cli(env,
 
     logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
     env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
+    env.vars['verbose'] = verbose
     env.client.transport = env.vars['_timings']
 
 

SoftLayer/CLI/routes.py

@@ -291,6 +291,7 @@
     ('subnet:lookup', 'SoftLayer.CLI.subnet.lookup:cli'),
 
     ('tags', 'SoftLayer.CLI.tags'),
+    ('tags:cleanup', 'SoftLayer.CLI.tags.cleanup:cli'),
     ('tags:list', 'SoftLayer.CLI.tags.list:cli'),
     ('tags:set', 'SoftLayer.CLI.tags.set:cli'),
     ('tags:details', 'SoftLayer.CLI.tags.details:cli'),

SoftLayer/CLI/tags/cleanup.py

@@ -0,0 +1,33 @@
+"""Removes unused Tags"""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.exceptions import SoftLayerAPIError
+from SoftLayer.managers.tags import TagManager
+from SoftLayer import utils
+
+from pprint import pprint as pp
+# pylint: disable=unnecessary-lambda
+
+
+@click.command()
+@click.option('--dry-run', '-d', is_flag=True, default=False,
+              help="Don't delete, just show what will be deleted.")
+@environment.pass_env
+def cli(env, dry_run):
+    """Removes all empty tags."""
+
+    tag_manager = TagManager(env.client)
+    empty_tags = tag_manager.get_unattached_tags()
+    
+    for tag in empty_tags:
+        if dry_run:
+            click.secho("(Dry Run) Removing {}".format(tag.get('name')), fg='yellow')
+        else:
+            result = tag_manager.delete_tag(tag.get('name'))
+            color = 'green' if result else 'red'
+            click.secho("Removing {}".format(tag.get('name')), fg=color)
+

SoftLayer/CLI/tags/list.py

@@ -66,13 +66,11 @@ def simple_table(tag_manager):
 
 def get_resource_name(tag_manager, resource_id, tag_type):
     """Returns a string to identify a resource"""
+    name = None
     try:
         resource = tag_manager.reference_lookup(resource_id, tag_type)
-        if tag_type == 'NETWORK_VLAN_FIREWALL':
-            resource_row = resource.get('primaryIpAddress')
-        else:
-            resource_row = resource.get('fullyQualifiedDomainName')
+        name = tag_manager.get_resource_name(resource, tag_type)
     except SoftLayerAPIError as exception:
-        resource_row = "{}".format(exception.reason)
-    return resource_row
+        name = "{}".format(exception.reason)
+    return name
 

SoftLayer/CLI/tags/taggable.py

@@ -23,22 +23,6 @@ def cli(env):
         for resource in resources:
             table.add_row([
                 resource['resource']['id'],
-                get_resource_name(resource['resource'], tag_type['keyName'])
+                tag_manager.get_resource_name(resource['resource'], tag_type['keyName'])
             ])
         env.fout(table)
-
-
-def get_resource_name(resource, tag_type):
-    """Returns a string that names a resource"""
-    if tag_type == 'NETWORK_VLAN_FIREWALL':
-        return resource.get('primaryIpAddress')
-    elif tag_type == 'NETWORK_VLAN':
-        return "{} ({})".format(resource.get('vlanNumber'), resource.get('name'))
-    elif tag_type == 'IMAGE_TEMPLATE' or tag_type == 'APPLICATION_DELIVERY_CONTROLLER':
-        return resource.get('name')
-    elif tag_type == 'TICKET':
-        return resource.get('subjet')
-    elif tag_type == 'NETWORK_SUBNET':
-        return resource.get('networkIdentifier')
-    else:
-        return resource.get('fullyQualifiedDomainName')

SoftLayer/managers/tags.py

@@ -99,7 +99,6 @@ def reference_lookup(self, resource_table_id, tag_type):
         service = self.type_to_service(tag_type)
         if service is None:
             raise SoftLayerAPIError(404, "Unable to lookup {} types".format(tag_type))
-        # return {}
         return self.client.call(service, 'getObject', id=resource_table_id)
 
     def delete_tag(self, name):
@@ -182,6 +181,26 @@ def type_to_service(tag_type):
             service = re.sub(r'(^[a-z]|\_[a-z])', lambda x: x.group().upper(), tag_type)
         return service
 
+    @staticmethod
+    def get_resource_name(resource, tag_type):
+        """Returns a string that names a resource
+
+        :param dict resource: A SoftLayer datatype for the given tag_type
+        :param string tag_type: Key name for the tag_type
+        """
+        if tag_type == 'NETWORK_VLAN_FIREWALL':
+            return resource.get('primaryIpAddress')
+        elif tag_type == 'NETWORK_VLAN':
+            return "{} ({})".format(resource.get('vlanNumber'), resource.get('name'))
+        elif tag_type == 'IMAGE_TEMPLATE' or tag_type == 'APPLICATION_DELIVERY_CONTROLLER':
+            return resource.get('name')
+        elif tag_type == 'TICKET':
+            return resource.get('subjet')
+        elif tag_type == 'NETWORK_SUBNET':
+            return resource.get('networkIdentifier')
+        else:
+            return resource.get('fullyQualifiedDomainName')
+
     # @staticmethod
     # def type_to_datatype(tag_type):
     #     """Returns the SoftLayer datatye for the given tag_type"""