OSC Network Flavor

Implements Neutron feature of Network Flavor into OpenstackClient
This patch implements the following commands:
network flavor create
network flavor delete
network flavor list
network flavor show
network flavor set

Works with openstacksdk version 0.9.8

Change-Id: I29d7a62341010a1d067a8ca93bccb7d9b8d4c425
Partially-Implements: blueprint neutron-client-flavors
Partially-Implements: blueprint network-commands-options

1 files changed, 247 insertions, 0 deletions

diff --git a/openstackclient/network/v2/network_flavor.py b/openstackclient/network/v2/network_flavor.py
new file mode 100644
index 00000000..3a3324c0
--- /dev/null
+++ b/openstackclient/network/v2/network_flavor.py
@@ -0,0 +1,247 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+#
+
+"""Flavor action implementations"""
+
+import logging
+
+from osc_lib.command import command
+from osc_lib import exceptions
+from osc_lib import utils
+
+from openstackclient.i18n import _
+from openstackclient.identity import common as identity_common
+from openstackclient.network import sdk_utils
+
+
+LOG = logging.getLogger(__name__)
+
+
+def _get_columns(item):
+    column_map = {
+        'is_enabled': 'enabled',
+        'tenant_id': 'project_id',
+    }
+
+    return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
+
+
+def _get_attrs(client_manager, parsed_args):
+    attrs = {}
+    attrs['name'] = parsed_args.name
+    attrs['service_type'] = parsed_args.service_type
+    if parsed_args.description is not None:
+        attrs['description'] = parsed_args.description
+    if parsed_args.enable:
+        attrs['enabled'] = True
+    if parsed_args.disable:
+        attrs['enabled'] = False
+    if 'project' in parsed_args and parsed_args.project is not None:
+        identity_client = client_manager.identity
+        project_id = identity_common.find_project(
+            identity_client,
+            parsed_args.project,
+            parsed_args.project_domain,
+        ).id
+        attrs['tenant_id'] = project_id
+
+    return attrs
+
+
+# TODO(dasanind): Use the SDK resource mapped attribute names once the
+# OSC minimum requirements include SDK 1.0.
+class CreateNetworkFlavor(command.ShowOne):
+    _description = _("Create new network flavor")
+
+    def get_parser(self, prog_name):
+        parser = super(CreateNetworkFlavor, self).get_parser(prog_name)
+        parser.add_argument(
+            'name',
+            metavar="<name>",
+            help=_("Name for the flavor")
+        )
+        parser.add_argument(
+            '--service-type',
+            metavar="<service-type>",
+            required=True,
+            help=_('Service type to which the flavor applies to: e.g. VPN '
+                   '(See openstack network service provider list for loaded '
+                   'examples.)')
+        )
+        parser.add_argument(
+            '--description',
+            help=_('Description for the flavor')
+        )
+        parser.add_argument(
+            '--project',
+            metavar="<project>",
+            help=_("Owner's project (name or ID)")
+        )
+        identity_common.add_project_domain_option_to_parser(parser)
+
+        enable_group = parser.add_mutually_exclusive_group()
+        enable_group.add_argument(
+            '--enable',
+            action='store_true',
+            help=_("Enable the flavor (default)")
+        )
+        enable_group.add_argument(
+            '--disable',
+            action='store_true',
+            help=_("Disable the flavor")
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        attrs = _get_attrs(self.app.client_manager, parsed_args)
+        obj = client.create_flavor(**attrs)
+        display_columns, columns = _get_columns(obj)
+        data = utils.get_item_properties(obj, columns, formatters={})
+
+        return (display_columns, data)
+
+
+class DeleteNetworkFlavor(command.Command):
+    _description = _("Delete network flavors")
+
+    def get_parser(self, prog_name):
+        parser = super(DeleteNetworkFlavor, self).get_parser(prog_name)
+
+        parser.add_argument(
+            'flavor',
+            metavar='<flavor>',
+            nargs='+',
+            help=_('Flavor(s) to delete (name or ID)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        result = 0
+
+        for flavor in parsed_args.flavor:
+            try:
+                obj = client.find_flavor(flavor, ignore_missing=False)
+                client.delete_flavor(obj)
+            except Exception as e:
+                result += 1
+                LOG.error(_("Failed to delete flavor with "
+                            "name or ID '%(flavor)s': %(e)s"),
+                          {"flavor": flavor, "e": e})
+        if result > 0:
+            total = len(parsed_args.flavor)
+            msg = (_("%(result)s of %(total)s flavors failed "
+                     "to delete.") % {"result": result, "total": total})
+            raise exceptions.CommandError(msg)
+
+
+class ListNetworkFlavor(command.Lister):
+    _description = _("List network flavors")
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+
+        columns = (
+            'id',
+            'name',
+            'is_enabled',
+            'service_type',
+            'description'
+        )
+        column_headers = (
+            'ID',
+            'Name',
+            'Enabled',
+            'Service Type',
+            'Description'
+        )
+
+        data = client.flavors()
+        return (column_headers,
+                (utils.get_item_properties(
+                    s, columns,
+                ) for s in data))
+
+
+# TODO(dasanind): Use only the SDK resource mapped attribute names once the
+# OSC minimum requirements include SDK 1.0.
+class SetNetworkFlavor(command.Command):
+    _description = _("Set network flavor properties")
+
+    def get_parser(self, prog_name):
+        parser = super(SetNetworkFlavor, self).get_parser(prog_name)
+        parser.add_argument(
+            'flavor',
+            metavar="<flavor>",
+            help=_("Flavor to update (name or ID)")
+        )
+        parser.add_argument(
+            '--description',
+            help=_('Set network flavor description')
+        )
+        enable_group = parser.add_mutually_exclusive_group()
+        enable_group.add_argument(
+            '--disable',
+            action='store_true',
+            help=_("Disable network flavor")
+        )
+        enable_group.add_argument(
+            '--enable',
+            action='store_true',
+            help=_("Enable network flavor")
+        )
+        parser.add_argument(
+            '--name',
+            metavar="<name>",
+            help=_('Set flavor name')
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        obj = client.find_flavor(
+            parsed_args.flavor,
+            ignore_missing=False)
+        attrs = {}
+        if parsed_args.name is not None:
+            attrs['name'] = parsed_args.name
+        if parsed_args.description is not None:
+            attrs['description'] = parsed_args.description
+        if parsed_args.enable:
+            attrs['enabled'] = True
+        if parsed_args.disable:
+            attrs['enabled'] = False
+        client.update_flavor(obj, **attrs)
+
+
+class ShowNetworkFlavor(command.ShowOne):
+    _description = _("Display network flavor details")
+
+    def get_parser(self, prog_name):
+        parser = super(ShowNetworkFlavor, self).get_parser(prog_name)
+        parser.add_argument(
+            'flavor',
+            metavar='<flavor>',
+            help=_('Flavor to display (name or ID)')
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        client = self.app.client_manager.network
+        obj = client.find_flavor(parsed_args.flavor, ignore_missing=False)
+        display_columns, columns = _get_columns(obj)
+        data = utils.get_item_properties(obj, columns)
+        return display_columns, data