SDK Refactor: Prepare subnet commands

Prepare the OSC "subnet" commands for the SDK refactor.
See [1] for details.

[1] https://etherpad.openstack.org/p/osc-network-command-sdk-support

Partially-Implements: blueprint network-command-sdk-support
Change-Id: I5d58b189e822b2ee61c9c95ccf909113ff59de46

Author: abhiraut

openstackclient/network/v2/subnet.py

@@ -23,6 +23,7 @@
 
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
+from openstackclient.network import sdk_utils
 
 
 LOG = logging.getLogger(__name__)
@@ -117,11 +118,12 @@ def _get_common_parse_arguments(parser, is_create=True):
 
 
 def _get_columns(item):
-    columns = list(item.keys())
-    if 'tenant_id' in columns:
-        columns.remove('tenant_id')
-        columns.append('project_id')
-    return tuple(sorted(columns))
+    column_map = {
+        'is_dhcp_enabled': 'enable_dhcp',
+        'subnet_pool_id': 'subnetpool_id',
+        'tenant_id': 'project_id',
+    }
+    return sdk_utils.get_osc_show_columns_for_sdk_resource(item, column_map)
 
 
 def convert_entries_to_nexthop(entries):
@@ -217,6 +219,8 @@ def _get_attrs(client_manager, parsed_args, is_create=True):
     return attrs
 
 
+# TODO(abhiraut): Use the SDK resource mapped attribute names once the
+# OSC minimum requirements include SDK 1.0.
 class CreateSubnet(command.ShowOne):
     _description = _("Create a subnet")
 
@@ -323,9 +327,9 @@ def take_action(self, parsed_args):
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
         obj = client.create_subnet(**attrs)
-        columns = _get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters=_formatters)
-        return (columns, data)
+        return (display_columns, data)
 
 
 class DeleteSubnet(command.Command):
@@ -362,6 +366,8 @@ def take_action(self, parsed_args):
             raise exceptions.CommandError(msg)
 
 
+# TODO(abhiraut): Use only the SDK resource mapped attribute names once the
+# OSC minimum requirements include SDK 1.0.
 class ListSubnet(command.Lister):
     _description = _("List subnets")
 
@@ -443,8 +449,10 @@ def take_action(self, parsed_args):
             filters['ip_version'] = parsed_args.ip_version
         if parsed_args.dhcp:
             filters['enable_dhcp'] = True
+            filters['is_dhcp_enabled'] = True
         elif parsed_args.no_dhcp:
             filters['enable_dhcp'] = False
+            filters['is_dhcp_enabled'] = False
         if parsed_args.service_types:
             filters['service_types'] = parsed_args.service_types
         if parsed_args.project:
@@ -454,6 +462,7 @@ def take_action(self, parsed_args):
                 parsed_args.project_domain,
             ).id
             filters['tenant_id'] = project_id
+            filters['project_id'] = project_id
         if parsed_args.network:
             network_id = network_client.find_network(parsed_args.network,
                                                      ignore_missing=False).id
@@ -472,7 +481,7 @@ def take_action(self, parsed_args):
             headers += ('Project', 'DHCP', 'Name Servers',
                         'Allocation Pools', 'Host Routes', 'IP Version',
                         'Gateway', 'Service Types')
-            columns += ('tenant_id', 'enable_dhcp', 'dns_nameservers',
+            columns += ('project_id', 'is_dhcp_enabled', 'dns_nameservers',
                         'allocation_pools', 'host_routes', 'ip_version',
                         'gateway_ip', 'service_types')
 
@@ -483,6 +492,8 @@ def take_action(self, parsed_args):
                 ) for s in data))
 
 
+# TODO(abhiraut): Use the SDK resource mapped attribute names once the
+# OSC minimum requirements include SDK 1.0.
 class SetSubnet(command.Command):
     _description = _("Set subnet properties")
 
@@ -564,9 +575,9 @@ def get_parser(self, prog_name):
     def take_action(self, parsed_args):
         obj = self.app.client_manager.network.find_subnet(parsed_args.subnet,
                                                           ignore_missing=False)
-        columns = _get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters=_formatters)
-        return (columns, data)
+        return (display_columns, data)
 
 
 class UnsetSubnet(command.Command):

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

@@ -1064,6 +1064,8 @@ def create_one_subnet(attrs=None):
                                     loaded=True)
 
         # Set attributes with special mappings in OpenStack SDK.
+        subnet.is_dhcp_enabled = subnet_attrs['enable_dhcp']
+        subnet.subnet_pool_id = subnet_attrs['subnetpool_id']
         subnet.project_id = subnet_attrs['tenant_id']
 
         return subnet

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

@@ -636,7 +636,7 @@ def test_subnet_list_dhcp(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        filters = {'enable_dhcp': True}
+        filters = {'enable_dhcp': True, 'is_dhcp_enabled': True}
 
         self.network.subnets.assert_called_once_with(**filters)
         self.assertEqual(self.columns, columns)
@@ -652,7 +652,7 @@ def test_subnet_list_no_dhcp(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        filters = {'enable_dhcp': False}
+        filters = {'enable_dhcp': False, 'is_dhcp_enabled': False}
 
         self.network.subnets.assert_called_once_with(**filters)
         self.assertEqual(self.columns, columns)
@@ -685,7 +685,7 @@ def test_subnet_list_project(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        filters = {'tenant_id': project.id}
+        filters = {'tenant_id': project.id, 'project_id': project.id}
 
         self.network.subnets.assert_called_once_with(**filters)
         self.assertEqual(self.columns, columns)
@@ -723,7 +723,7 @@ def test_subnet_list_project_domain(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        filters = {'tenant_id': project.id}
+        filters = {'tenant_id': project.id, 'project_id': project.id}
 
         self.network.subnets.assert_called_once_with(**filters)
         self.assertEqual(self.columns, columns)