Network: Add tag support for floating ip

Change-Id: I7a500a4ff6cec2442b4050df26c0b017d9f71903
Closes-Bug: #1750985

Author: hellochosen

doc/source/cli/command-objects/floating-ip.rst

@@ -20,6 +20,7 @@ Create floating IP
         [--description <description>]
         [--qos-policy <qos-policy>]
         [--project <project> [--project-domain <project-domain>]]
+        [--tag <tag> | --no-tag]
         <network>
 
 .. option:: --subnet <subnet>
@@ -66,6 +67,18 @@ Create floating IP
 
     *Network version 2 only*
 
+.. option:: --tag <tag>
+
+    Tag to be added to the floating IP (repeat option to set multiple tags)
+
+    *Network version 2 only*
+
+.. option:: --no-tag
+
+    No tags associated with the floating IP
+
+    *Network version 2 only*
+
 .. describe:: <network>
 
     Network to allocate floating IP from (name or ID)
@@ -100,6 +113,8 @@ List floating IP(s)
         [--status <status>]
         [--project <project> [--project-domain <project-domain>]]
         [--router <router>]
+        [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
+        [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
 
 .. option:: --network <network>
 
@@ -150,6 +165,30 @@ List floating IP(s)
 
     *Network version 2 only*
 
+.. option:: --tags <tag>[,<tag>,...]
+
+    List floating IP(s) which have all given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --any-tags <tag>[,<tag>,...]
+
+    List floating IP(s) which have any given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --not-tags <tag>[,<tag>,...]
+
+    Exclude floating IP(s) which have all given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --not-any-tags <tag>[,<tag>,...]
+
+    Exclude floating IP(s) which have any given tag(s)
+
+    *Network version 2 only*
+
 floating ip set
 ---------------
 
@@ -162,6 +201,7 @@ Set floating IP properties
         --port <port>
         [--fixed-ip-address <ip-address>]
         [--qos-policy <qos-policy> | --no-qos-policy]
+        [--tag <tag>] [--no-tag]
         <floating-ip>
 
 .. option:: --port <port>
@@ -180,6 +220,15 @@ Set floating IP properties
 
     Remove the QoS policy attached to the floating IP
 
+.. option:: --tag <tag>
+
+    Tag to be added to the floating IP (repeat option to set multiple tags)
+
+.. option:: --no-tag
+
+    Clear tags associated with the floating IP. Specify both --tag
+    and --no-tag to overwrite current tags
+
 .. _floating_ip_set-floating-ip:
 .. describe:: <floating-ip>
 
@@ -210,6 +259,7 @@ Unset floating IP Properties
     openstack floating ip unset
         --port
         --qos-policy
+        [--tag <tag> | --all-tag]
         <floating-ip>
 
 .. option:: --port
@@ -220,6 +270,15 @@ Unset floating IP Properties
 
     Remove the QoS policy attached to the floating IP
 
+.. option:: --tag <tag>
+
+    Tag to be removed from the floating IP
+    (repeat option to remove multiple tags)
+
+.. option:: --all-tag
+
+    Clear all tags associated with the floating IP
+
 .. _floating_ip_unset-floating-ip:
 .. describe:: <floating-ip>
 

openstackclient/network/v2/floating_ip.py

@@ -22,6 +22,7 @@
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
 from openstackclient.network import sdk_utils
+from openstackclient.network.v2 import _tag
 
 
 def _get_network_columns(item):
@@ -139,11 +140,14 @@ def update_parser_network(self, parser):
             help=_("Owner's project (name or ID)")
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        _tag.add_tag_option_to_parser_for_create(parser, _('floating IP'))
         return parser
 
     def take_action_network(self, client, parsed_args):
         attrs = _get_attrs(self.app.client_manager, parsed_args)
         obj = client.create_ip(**attrs)
+        # tags cannot be set when created, so tags need to be set later.
+        _tag.update_tags_for_set(client, obj, parsed_args)
         display_columns, columns = _get_network_columns(obj)
         data = utils.get_item_properties(obj, columns)
         return (display_columns, data)
@@ -280,6 +284,7 @@ def update_parser_network(self, parser):
             help=_("List floating IP(s) according to "
                    "given router (name or ID)")
         )
+        _tag.add_tag_filtering_option_to_parser(parser, _('floating IP'))
 
         return parser
 
@@ -308,11 +313,13 @@ def take_action_network(self, client, parsed_args):
                 'router_id',
                 'status',
                 'description',
+                'tags',
             )
             headers = headers + (
                 'Router',
                 'Status',
                 'Description',
+                'Tags',
             )
 
         query = {}
@@ -342,6 +349,8 @@ def take_action_network(self, client, parsed_args):
                                                 ignore_missing=False)
             query['router_id'] = router.id
 
+        _tag.get_tag_filtering_args(parsed_args, query)
+
         data = client.ips(**query)
 
         return (headers,
@@ -431,6 +440,9 @@ def get_parser(self, prog_name):
             action='store_true',
             help=_("Remove the QoS policy attached to the floating IP")
         )
+
+        _tag.add_tag_option_to_parser_for_set(parser, _('floating IP'))
+
         return parser
 
     def take_action(self, parsed_args):
@@ -453,7 +465,11 @@ def take_action(self, parsed_args):
         if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
             attrs['qos_policy_id'] = None
 
-        client.update_ip(obj, **attrs)
+        if attrs:
+            client.update_ip(obj, **attrs)
+
+        # tags is a subresource and it needs to be updated separately.
+        _tag.update_tags_for_set(client, obj, parsed_args)
 
 
 class ShowFloatingIP(common.NetworkAndComputeShowOne):
@@ -528,6 +544,8 @@ def get_parser(self, prog_name):
             default=False,
             help=_("Remove the QoS policy attached to the floating IP")
         )
+        _tag.add_tag_option_to_parser_for_unset(parser, _('floating IP'))
+
         return parser
 
     def take_action(self, parsed_args):
@@ -544,3 +562,6 @@ def take_action(self, parsed_args):
 
         if attrs:
             client.update_ip(obj, **attrs)
+
+        # tags is a subresource and it needs to be updated separately.
+        _tag.update_tags_for_unset(client, obj, parsed_args)

openstackclient/tests/unit/network/v2/fakes.py

@@ -1379,6 +1379,7 @@ def create_one_floating_ip(attrs=None):
             'tenant_id': 'project-id-' + uuid.uuid4().hex,
             'description': 'floating-ip-description-' + uuid.uuid4().hex,
             'qos_policy_id': 'qos-policy-id-' + uuid.uuid4().hex,
+            'tags': [],
         }
 
         # Overwrite default attributes.