Merge "Network: Add tag support for security group"

Author: Zuul

doc/source/cli/command-objects/security-group.rst

@@ -19,6 +19,7 @@ Create a new security group
     openstack security group create
         [--description <description>]
         [--project <project> [--project-domain <project-domain>]]
+        [--tag <tag> | --no-tag]
         <name>
 
 .. option:: --description <description>
@@ -38,6 +39,18 @@ Create a new security group
 
     *Network version 2 only*
 
+.. option:: --tag <tag>
+
+    Tag to be added to the security group (repeat option to set multiple tags)
+
+    *Network version 2 only*
+
+.. option:: --no-tag
+
+    No tags associated with the security group
+
+    *Network version 2 only*
+
 .. describe:: <name>
 
     New security group name
@@ -68,6 +81,8 @@ List security groups
     openstack security group list
         [--all-projects]
         [--project <project> [--project-domain <project-domain>]]
+        [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]]
+        [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
 
 .. option:: --all-projects
 
@@ -89,6 +104,30 @@ List security groups
 
     *Network version 2 only*
 
+.. option:: --tags <tag>[,<tag>,...]
+
+    List security groups which have all given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --any-tags <tag>[,<tag>,...]
+
+    List security groups which have any given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --not-tags <tag>[,<tag>,...]
+
+    Exclude security groups which have all given tag(s)
+
+    *Network version 2 only*
+
+.. option:: --not-any-tags <tag>[,<tag>,...]
+
+    Exclude security groups which have any given tag(s)
+
+    *Network version 2 only*
+
 security group set
 ------------------
 
@@ -100,6 +139,7 @@ Set security group properties
     openstack security group set
         [--name <new-name>]
         [--description <description>]
+        [--tag <tag>] [--no-tag]
         <group>
 
 .. option:: --name <new-name>
@@ -110,6 +150,15 @@ Set security group properties
 
     New security group description
 
+.. option:: --tag <tag>
+
+    Tag to be added to the security group (repeat option to set multiple tags)
+
+.. option:: --no-tag
+
+    Clear tags associated with the security group. Specify both --tag
+    and --no-tag to overwrite current tags
+
 .. describe:: <group>
 
     Security group to modify (name or ID)
@@ -128,3 +177,28 @@ Display security group details
 .. describe:: <group>
 
     Security group to display (name or ID)
+
+security group unset
+--------------------
+
+Unset security group properties
+
+.. program:: security group unset
+.. code:: bash
+
+    openstack security group unset
+        [--tag <tag> | --all-tag]
+        <group>
+
+.. option:: --tag <tag>
+
+    Tag to be removed from the security group
+    (repeat option to remove multiple tags)
+
+.. option:: --all-tag
+
+    Clear all tags associated with the security group
+
+.. describe:: <group>
+
+    Security group to modify (name or ID)

openstackclient/network/v2/security_group.py

@@ -15,6 +15,7 @@
 
 import argparse
 
+from osc_lib.command import command
 from osc_lib import utils
 import six
 
@@ -23,6 +24,7 @@
 from openstackclient.network import common
 from openstackclient.network import sdk_utils
 from openstackclient.network import utils as network_utils
+from openstackclient.network.v2 import _tag
 
 
 def _format_network_security_group_rules(sg_rules):
@@ -106,6 +108,7 @@ 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, _('security group'))
         return parser
 
     def _get_description(self, parsed_args):
@@ -130,6 +133,8 @@ def take_action_network(self, client, parsed_args):
 
         # Create the security group and display the results.
         obj = client.create_security_group(**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, property_columns = _get_columns(obj)
         data = utils.get_item_properties(
             obj,
@@ -198,6 +203,7 @@ def update_parser_network(self, parser):
                    "(name or ID)")
         )
         identity_common.add_project_domain_option_to_parser(parser)
+        _tag.add_tag_filtering_option_to_parser(parser, _('security group'))
         return parser
 
     def update_parser_compute(self, parser):
@@ -220,19 +226,23 @@ def take_action_network(self, client, parsed_args):
             ).id
             filters['tenant_id'] = project_id
             filters['project_id'] = project_id
+
+        _tag.get_tag_filtering_args(parsed_args, filters)
         data = client.security_groups(**filters)
 
         columns = (
             "ID",
             "Name",
             "Description",
-            "Project ID"
+            "Project ID",
+            "tags"
         )
         column_headers = (
             "ID",
             "Name",
             "Description",
-            "Project"
+            "Project",
+            "Tags"
         )
         return (column_headers,
                 (utils.get_item_properties(
@@ -282,6 +292,10 @@ def update_parser_common(self, parser):
         )
         return parser
 
+    def update_parser_network(self, parser):
+        _tag.add_tag_option_to_parser_for_set(parser, _('security group'))
+        return parser
+
     def take_action_network(self, client, parsed_args):
         obj = client.find_security_group(parsed_args.group,
                                          ignore_missing=False)
@@ -295,6 +309,9 @@ def take_action_network(self, client, parsed_args):
         # the update.
         client.update_security_group(obj, **attrs)
 
+        # tags is a subresource and it needs to be updated separately.
+        _tag.update_tags_for_set(client, obj, parsed_args)
+
     def take_action_compute(self, client, parsed_args):
         data = client.api.security_group_find(parsed_args.group)
 
@@ -344,3 +361,25 @@ def take_action_compute(self, client, parsed_args):
             formatters=_formatters_compute
         )
         return (display_columns, data)
+
+
+class UnsetSecurityGroup(command.Command):
+    _description = _("Unset security group properties")
+
+    def get_parser(self, prog_name):
+        parser = super(UnsetSecurityGroup, self).get_parser(prog_name)
+        parser.add_argument(
+            'group',
+            metavar="<group>",
+            help=_("Security group to modify (name or ID)")
+        )
+        _tag.add_tag_option_to_parser_for_unset(parser, _('security group'))
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        obj = client.find_security_group(parsed_args.group,
+                                         ignore_missing=False)
+
+        # 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

@@ -1132,6 +1132,7 @@ def create_one_security_group(attrs=None):
             'description': 'security-group-description-' + uuid.uuid4().hex,
             'project_id': 'project-id-' + uuid.uuid4().hex,
             'security_group_rules': [],
+            'tags': []
         }
 
         # Overwrite default attributes.