Add security groups options to "port create/set/unset"

This patch adds '--security-group' and '--no-security-group'
options to "port create", "port set" and "port unset" commands.

Change-Id: Iff60d8f29227017b0a3966efca6cdecba69abcea
Partial-Bug: #1612136
Partially-Implements: blueprint network-commands-options

Author: annp1987

doc/source/command-objects/port.rst

@@ -26,6 +26,7 @@ Create new port
         [--host <host-id>]
         [--enable | --disable]
         [--mac-address <mac-address>]
+        [--security-group <security-group> | --no-security-group]
         [--project <project> [--project-domain <project-domain>]]
         <name>
 
@@ -75,6 +76,15 @@ Create new port
 
     MAC address of this port
 
+.. option:: --security-group <security-group>
+
+    Security group to associate with this port (name or ID)
+    (repeat option to set multiple security groups)
+
+.. option::  --no-security-group
+
+    Associate no security groups with this port
+
 .. option:: --project <project>
 
     Owner's project (name or ID)
@@ -154,6 +164,8 @@ Set port properties
         [--host <host-id>]
         [--enable | --disable]
         [--name <name>]
+        [--security-group <security-group>]
+        [--no-security-group]
         <port>
 
 .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
@@ -210,6 +222,15 @@ Set port properties
 
     Set port name
 
+.. option:: --security-group <security-group>
+
+    Security group to associate with this port (name or ID)
+    (repeat option to set multiple security groups)
+
+.. option::  --no-security-group
+
+    Clear existing security groups associated with this port
+
 .. _port_set-port:
 .. describe:: <port>
 
@@ -242,6 +263,7 @@ Unset port properties
     os port unset
         [--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]]
         [--binding-profile <binding-profile-key> [...]]
+        [--security-group <security-group> [...]]
         <port>
 
 .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
@@ -255,6 +277,11 @@ Unset port properties
     Desired key which should be removed from binding-profile
     (repeat option to unset multiple binding:profile data)
 
+.. option:: --security-group <security-group>
+
+    Security group which should be removed from this port (name or ID)
+    (repeat option to unset multiple security groups)
+
 .. _port_unset-port:
 .. describe:: <port>
 

openstackclient/network/v2/port.py

@@ -281,7 +281,23 @@ def get_parser(self, prog_name):
             help=_("Name of this port")
         )
         # TODO(singhj): Add support for extended options:
-        # qos,security groups,dhcp, address pairs
+        # qos,dhcp, address pairs
+        secgroups = parser.add_mutually_exclusive_group()
+        secgroups.add_argument(
+            '--security-group',
+            metavar='<security-group>',
+            action='append',
+            dest='security_groups',
+            help=_("Security group to associate with this port (name or ID) "
+                   "(repeat option to set multiple security groups)")
+        )
+        secgroups.add_argument(
+            '--no-security-group',
+            dest='no_security_group',
+            action='store_true',
+            help=_("Associate no security groups with this port")
+        )
+
         return parser
 
     def take_action(self, parsed_args):
@@ -291,6 +307,14 @@ def take_action(self, parsed_args):
         parsed_args.network = _network.id
         _prepare_fixed_ips(self.app.client_manager, parsed_args)
         attrs = _get_attrs(self.app.client_manager, parsed_args)
+
+        if parsed_args.security_groups:
+            attrs['security_groups'] = [client.find_security_group(
+                                        sg, ignore_missing=False).id
+                                        for sg in parsed_args.security_groups]
+        if parsed_args.no_security_group:
+            attrs['security_groups'] = []
+
         obj = client.create_port(**attrs)
         columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters=_formatters)
@@ -463,6 +487,21 @@ def get_parser(self, prog_name):
             metavar="<port>",
             help=_("Port to modify (name or ID)")
         )
+        parser.add_argument(
+            '--security-group',
+            metavar='<security-group>',
+            action='append',
+            dest='security_groups',
+            help=_("Security group to associate with this port (name or ID) "
+                   "(repeat option to set multiple security groups)")
+        )
+        parser.add_argument(
+            '--no-security-group',
+            dest='no_security_group',
+            action='store_true',
+            help=_("Clear existing security groups associated with this port")
+        )
+
         return parser
 
     def take_action(self, parsed_args):
@@ -490,6 +529,17 @@ def take_action(self, parsed_args):
                 attrs['fixed_ips'] += [ip for ip in obj.fixed_ips if ip]
         elif parsed_args.no_fixed_ip:
             attrs['fixed_ips'] = []
+        if parsed_args.security_groups and parsed_args.no_security_group:
+            attrs['security_groups'] = [client.find_security_group(sg,
+                                        ignore_missing=False).id
+                                        for sg in parsed_args.security_groups]
+        elif parsed_args.security_groups:
+            attrs['security_groups'] = obj.security_groups
+            for sg in parsed_args.security_groups:
+                sg_id = client.find_security_group(sg, ignore_missing=False).id
+                attrs['security_groups'].append(sg_id)
+        elif parsed_args.no_security_group:
+            attrs['security_groups'] = []
 
         client.update_port(obj, **attrs)
 
@@ -535,6 +585,15 @@ def get_parser(self, prog_name):
             action='append',
             help=_("Desired key which should be removed from binding:profile"
                    "(repeat option to unset multiple binding:profile data)"))
+        parser.add_argument(
+            '--security-group',
+            metavar='<security-group>',
+            action='append',
+            dest='security_groups',
+            help=_("Security group which should be removed this port (name "
+                   "or ID) (repeat option to unset multiple security groups)")
+        )
+
         parser.add_argument(
             'port',
             metavar="<port>",
@@ -550,6 +609,7 @@ def take_action(self, parsed_args):
         # Unset* classes
         tmp_fixed_ips = copy.deepcopy(obj.fixed_ips)
         tmp_binding_profile = copy.deepcopy(obj.binding_profile)
+        tmp_secgroups = copy.deepcopy(obj.security_groups)
         _prepare_fixed_ips(self.app.client_manager, parsed_args)
         attrs = {}
         if parsed_args.fixed_ip:
@@ -568,5 +628,16 @@ def take_action(self, parsed_args):
                 msg = _("Port does not contain binding-profile %s") % key
                 raise exceptions.CommandError(msg)
             attrs['binding:profile'] = tmp_binding_profile
+        if parsed_args.security_groups:
+            try:
+                for sg in parsed_args.security_groups:
+                    sg_id = client.find_security_group(
+                        sg, ignore_missing=False).id
+                    tmp_secgroups.remove(sg_id)
+            except ValueError:
+                msg = _("Port does not contain security group %s") % sg
+                raise exceptions.CommandError(msg)
+            attrs['security_groups'] = tmp_secgroups
+
         if attrs:
             client.update_port(obj, **attrs)