Allow to send extra attributes in Neutron related commands

To deprecate and drop support for neutronclient CLI and use only
OSC we need feature parity between OSC and neutronclient.
Last missing piece here is possibility to send in POST/PUT requests
unknown parameters to the Neutron server.
This patch adds such possibility to the OSC.

Change-Id: Iba09297c2be9fb9fa0be1b3dc65755277b79230e

Author: slawqo

lower-constraints.txt

@@ -38,7 +38,7 @@ msgpack-python==0.4.0
 munch==2.1.0
 netaddr==0.7.18
 netifaces==0.10.4
-openstacksdk==0.53.0
+openstacksdk==0.56.0
 os-client-config==2.1.0
 os-service-types==1.7.0
 osc-lib==2.3.0

openstackclient/network/common.py

@@ -16,10 +16,12 @@
 import logging
 
 import openstack.exceptions
+from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
 
 from openstackclient.i18n import _
+from openstackclient.network import utils
 
 
 LOG = logging.getLogger(__name__)
@@ -75,7 +77,6 @@ def _network_type(self):
         """
         # Have we set it up yet for this command?
         if not hasattr(self, '_net_type'):
-            # import pdb; pdb.set_trace()
             try:
                 if self.app.client_manager.is_network_endpoint_enabled():
                     net_type = _NET_TYPE_NEUTRON
@@ -255,3 +256,74 @@ def take_action(self, parsed_args):
             if exc.details:
                 msg += ", " + str(exc.details)
             raise exceptions.CommandError(msg)
+
+
+class NeutronCommandWithExtraArgs(command.Command):
+    """Create and Update commands with additional extra properties.
+
+    Extra properties can be passed to the command and are then send to the
+    Neutron as given to the command.
+    """
+
+    # dict of allowed types
+    _allowed_types_dict = {
+        'bool': utils.str2bool,
+        'dict': utils.str2dict,
+        'list': utils.str2list,
+        'int': int,
+        'str': str,
+    }
+
+    def _get_property_converter(self, _property):
+        if 'type' not in _property:
+            converter = str
+        else:
+            converter = self._allowed_types_dict.get(_property['type'])
+
+        if not converter:
+            raise exceptions.CommandError(
+                _("Type {property_type} of property {name} "
+                  "is not supported").format(
+                      property_type=_property['type'],
+                      name=_property['name']))
+        return converter
+
+    def _parse_extra_properties(self, extra_properties):
+        result = {}
+        if extra_properties:
+            for _property in extra_properties:
+                converter = self._get_property_converter(_property)
+                result[_property['name']] = converter(_property['value'])
+        return result
+
+    def get_parser(self, prog_name):
+        parser = super(NeutronCommandWithExtraArgs, self).get_parser(prog_name)
+        parser.add_argument(
+            '--extra-property',
+            metavar='type=<property_type>,name=<property_name>,'
+                    'value=<property_value>',
+            dest='extra_properties',
+            action=parseractions.MultiKeyValueAction,
+            required_keys=['name', 'value'],
+            optional_keys=['type'],
+            help=_("Additional parameters can be passed using this property. "
+                   "Default type of the extra property is string ('str'), but "
+                   "other types can be used as well. Available types are: "
+                   "'dict', 'list', 'str', 'bool', 'int'. "
+                   "In case of 'list' type, 'value' can be "
+                   "semicolon-separated list of values. "
+                   "For 'dict' value is semicolon-separated list of the "
+                   "key:value pairs.")
+        )
+        return parser
+
+
+class NeutronUnsetCommandWithExtraArgs(NeutronCommandWithExtraArgs):
+
+    def _parse_extra_properties(self, extra_properties):
+        result = {}
+        if extra_properties:
+            for _property in extra_properties:
+                result[_property['name']] = None
+
+        return result

openstackclient/network/utils.py

@@ -11,6 +11,10 @@
 #   under the License.
 #
 
+from osc_lib import exceptions
+
+from openstackclient.i18n import _
+
 
 # Transform compute security group rule for display.
 def transform_compute_security_group_rule(sg_rule):
@@ -39,3 +43,41 @@ def transform_compute_security_group_rule(sg_rule):
     else:
         info['remote_security_group'] = ''
     return info
+
+
+def str2bool(strbool):
+    if strbool is None:
+        return None
+    return strbool.lower() == 'true'
+
+
+def str2list(strlist):
+    result = []
+    if strlist:
+        result = strlist.split(';')
+    return result
+
+
+def str2dict(strdict):
+    """Convert key1:value1;key2:value2;... string into dictionary.
+
+    :param strdict: string in the form of key1:value1;key2:value2
+    """
+    result = {}
+    if not strdict:
+        return result
+    i = 0
+    kvlist = []
+    for kv in strdict.split(';'):
+        if ':' in kv:
+            kvlist.append(kv)
+            i += 1
+        elif i == 0:
+            msg = _("missing value for key '%s'")
+            raise exceptions.CommandError(msg % kv)
+        else:
+            kvlist[i - 1] = "%s;%s" % (kvlist[i - 1], kv)
+    for kv in kvlist:
+        key, sep, value = kv.partition(':')
+        result[key] = value
+    return result

openstackclient/network/v2/address_group.py

@@ -22,6 +22,7 @@
 
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
+from openstackclient.network import common
 from openstackclient.network import sdk_utils
 
 
@@ -57,7 +58,7 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-class CreateAddressGroup(command.ShowOne):
+class CreateAddressGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new Address Group")
 
     def get_parser(self, prog_name):
@@ -93,6 +94,9 @@ def take_action(self, parsed_args):
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
 
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
+
         obj = client.create_address_group(**attrs)
         display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters={})
@@ -191,7 +195,7 @@ def take_action(self, parsed_args):
                 ) for s in data))
 
 
-class SetAddressGroup(command.Command):
+class SetAddressGroup(common.NeutronCommandWithExtraArgs):
     _description = _("Set address group properties")
 
     def get_parser(self, prog_name):
@@ -231,6 +235,9 @@ def take_action(self, parsed_args):
             attrs['name'] = parsed_args.name
         if parsed_args.description is not None:
             attrs['description'] = parsed_args.description
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
+
         if attrs:
             client.update_address_group(obj, **attrs)
         if parsed_args.address:

openstackclient/network/v2/address_scope.py

@@ -21,6 +21,7 @@
 
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
+from openstackclient.network import common
 from openstackclient.network import sdk_utils
 
 
@@ -57,7 +58,7 @@ def _get_attrs(client_manager, parsed_args):
 
 # TODO(rtheis): Use the SDK resource mapped attribute names once the
 # OSC minimum requirements include SDK 1.0.
-class CreateAddressScope(command.ShowOne):
+class CreateAddressScope(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new Address Scope")
 
     def get_parser(self, prog_name):
@@ -98,6 +99,8 @@ def get_parser(self, prog_name):
     def take_action(self, parsed_args):
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
         obj = client.create_address_scope(**attrs)
         display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters={})
@@ -226,7 +229,7 @@ def take_action(self, parsed_args):
 
 # TODO(rtheis): Use the SDK resource mapped attribute names once the
 # OSC minimum requirements include SDK 1.0.
-class SetAddressScope(command.Command):
+class SetAddressScope(common.NeutronCommandWithExtraArgs):
     _description = _("Set address scope properties")
 
     def get_parser(self, prog_name):
@@ -267,6 +270,8 @@ def take_action(self, parsed_args):
             attrs['shared'] = True
         if parsed_args.no_share:
             attrs['shared'] = False
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
         client.update_address_scope(obj, **attrs)
 
 

openstackclient/network/v2/floating_ip.py

@@ -13,7 +13,6 @@
 
 """IP Floating action implementations"""
 
-from osc_lib.command import command
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
@@ -94,7 +93,8 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-class CreateFloatingIP(common.NetworkAndComputeShowOne):
+class CreateFloatingIP(common.NetworkAndComputeShowOne,
+                       common.NeutronCommandWithExtraArgs):
     _description = _("Create floating IP")
 
     def update_parser_common(self, parser):
@@ -175,6 +175,8 @@ def update_parser_network(self, parser):
 
     def take_action_network(self, client, parsed_args):
         attrs = _get_attrs(self.app.client_manager, parsed_args)
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
         with common.check_missing_extension_if_error(
                 self.app.client_manager.network, attrs):
             obj = client.create_ip(**attrs)
@@ -390,7 +392,7 @@ def take_action_compute(self, client, parsed_args):
                 ) for s in data))
 
 
-class SetFloatingIP(command.Command):
+class SetFloatingIP(common.NeutronCommandWithExtraArgs):
     _description = _("Set floating IP Properties")
 
     def get_parser(self, prog_name):
@@ -456,6 +458,9 @@ def take_action(self, parsed_args):
         if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
             attrs['qos_policy_id'] = None
 
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
+
         if attrs:
             client.update_ip(obj, **attrs)
 
@@ -490,7 +495,7 @@ def take_action_compute(self, client, parsed_args):
         return (columns, data)
 
 
-class UnsetFloatingIP(command.Command):
+class UnsetFloatingIP(common.NeutronCommandWithExtraArgs):
     _description = _("Unset floating IP Properties")
 
     def get_parser(self, prog_name):
@@ -526,6 +531,8 @@ def take_action(self, parsed_args):
             attrs['port_id'] = None
         if parsed_args.qos_policy:
             attrs['qos_policy_id'] = None
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
 
         if attrs:
             client.update_ip(obj, **attrs)

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -19,6 +19,7 @@
 from osc_lib import utils
 
 from openstackclient.i18n import _
+from openstackclient.network import common
 from openstackclient.network import sdk_utils
 
 
@@ -32,7 +33,8 @@ def _get_columns(item):
     return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
 
 
-class CreateFloatingIPPortForwarding(command.ShowOne):
+class CreateFloatingIPPortForwarding(command.ShowOne,
+                                     common.NeutronCommandWithExtraArgs):
     _description = _("Create floating IP port forwarding")
 
     def get_parser(self, prog_name):
@@ -122,6 +124,9 @@ def take_action(self, parsed_args):
         if parsed_args.description is not None:
             attrs['description'] = parsed_args.description
 
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
+
         obj = client.create_floating_ip_port_forwarding(
             floating_ip.id,
             **attrs
@@ -258,7 +263,7 @@ def take_action(self, parsed_args):
                 ) for s in data))
 
 
-class SetFloatingIPPortForwarding(command.Command):
+class SetFloatingIPPortForwarding(common.NeutronCommandWithExtraArgs):
     _description = _("Set floating IP Port Forwarding Properties")
 
     def get_parser(self, prog_name):
@@ -352,6 +357,9 @@ def take_action(self, parsed_args):
         if parsed_args.description is not None:
             attrs['description'] = parsed_args.description
 
+        attrs.update(
+            self._parse_extra_properties(parsed_args.extra_properties))
+
         client.update_floating_ip_port_forwarding(
             floating_ip.id, parsed_args.port_forwarding_id, **attrs)