Use cliff formattable columns in network commands

Use cliff formattable columns not to convert complex fields
into a string when a machine readable format like JSON or YAML
is requested.

Partial-Bug: #1687955
Partially implement blueprint osc-formattable-columns

Change-Id: I9878f327e39f56852cc0fb6e4eee9105b7141da9

Author: amotoki

openstackclient/network/v2/ip_availability.py

@@ -13,6 +13,7 @@
 
 """IP Availability Info implementations"""
 
+from osc_lib.cli import format_columns
 from osc_lib.command import command
 from osc_lib import utils
 
@@ -21,7 +22,7 @@
 from openstackclient.network import sdk_utils
 
 _formatters = {
-    'subnet_ip_availability': utils.format_list_of_dicts,
+    'subnet_ip_availability': format_columns.ListDictColumn,
 }
 
 

openstackclient/network/v2/network.py

@@ -13,6 +13,8 @@
 
 """Network action implementations"""
 
+from cliff import columns as cliff_columns
+from osc_lib.cli import format_columns
 from osc_lib.command import command
 from osc_lib import utils
 
@@ -23,24 +25,26 @@
 from openstackclient.network.v2 import _tag
 
 
-def _format_admin_state(item):
-    return 'UP' if item else 'DOWN'
+class AdminStateColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return 'UP' if self._value else 'DOWN'
 
 
-def _format_router_external(item):
-    return 'External' if item else 'Internal'
+class RouterExternalColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return 'External' if self._value else 'Internal'
 
 
 _formatters = {
-    'subnets': utils.format_list,
-    'subnet_ids': utils.format_list,
-    'admin_state_up': _format_admin_state,
-    'is_admin_state_up': _format_admin_state,
-    'router:external': _format_router_external,
-    'is_router_external': _format_router_external,
-    'availability_zones': utils.format_list,
-    'availability_zone_hints': utils.format_list,
-    'tags': utils.format_list,
+    'subnets': format_columns.ListColumn,
+    'subnet_ids': format_columns.ListColumn,
+    'admin_state_up': AdminStateColumn,
+    'is_admin_state_up': AdminStateColumn,
+    'router:external': RouterExternalColumn,
+    'is_router_external': RouterExternalColumn,
+    'availability_zones': format_columns.ListColumn,
+    'availability_zone_hints': format_columns.ListColumn,
+    'tags': format_columns.ListColumn,
 }
 
 

openstackclient/network/v2/network_agent.py

@@ -15,6 +15,8 @@
 
 import logging
 
+from cliff import columns as cliff_columns
+from osc_lib.cli import format_columns
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -26,19 +28,22 @@
 LOG = logging.getLogger(__name__)
 
 
-def _format_alive(alive):
-    return ":-)" if alive else "XXX"
+class AliveColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return ":-)" if self._value else "XXX"
 
 
-def _format_admin_state(state):
-    return 'UP' if state else 'DOWN'
+class AdminStateColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return 'UP' if self._value else 'DOWN'
+
 
 _formatters = {
-    'is_alive': _format_alive,
-    'alive': _format_alive,
-    'admin_state_up': _format_admin_state,
-    'is_admin_state_up': _format_admin_state,
-    'configurations': utils.format_dict,
+    'is_alive': AliveColumn,
+    'alive': AliveColumn,
+    'admin_state_up': AdminStateColumn,
+    'is_admin_state_up': AdminStateColumn,
+    'configurations': format_columns.DictColumn,
 }
 
 

openstackclient/network/v2/port.py

@@ -18,6 +18,8 @@
 import json
 import logging
 
+from cliff import columns as cliff_columns
+from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -33,23 +35,24 @@
 LOG = logging.getLogger(__name__)
 
 
-def _format_admin_state(state):
-    return 'UP' if state else 'DOWN'
+class AdminStateColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return 'UP' if self._value else 'DOWN'
 
 
 _formatters = {
-    'admin_state_up': _format_admin_state,
-    'is_admin_state_up': _format_admin_state,
-    'allowed_address_pairs': utils.format_list_of_dicts,
-    'binding_profile': utils.format_dict,
-    'binding_vif_details': utils.format_dict,
-    'binding:profile': utils.format_dict,
-    'binding:vif_details': utils.format_dict,
-    'dns_assignment': utils.format_list_of_dicts,
-    'extra_dhcp_opts': utils.format_list_of_dicts,
-    'fixed_ips': utils.format_list_of_dicts,
-    'security_group_ids': utils.format_list,
-    'tags': utils.format_list,
+    'admin_state_up': AdminStateColumn,
+    'is_admin_state_up': AdminStateColumn,
+    'allowed_address_pairs': format_columns.ListDictColumn,
+    'binding_profile': format_columns.DictColumn,
+    'binding_vif_details': format_columns.DictColumn,
+    'binding:profile': format_columns.DictColumn,
+    'binding:vif_details': format_columns.DictColumn,
+    'dns_assignment': format_columns.ListDictColumn,
+    'extra_dhcp_opts': format_columns.ListDictColumn,
+    'fixed_ips': format_columns.ListDictColumn,
+    'security_group_ids': format_columns.ListColumn,
+    'tags': format_columns.ListColumn,
 }
 
 

openstackclient/network/v2/router.py

@@ -18,6 +18,8 @@
 import json
 import logging
 
+from cliff import columns as cliff_columns
+from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -32,33 +34,36 @@
 LOG = logging.getLogger(__name__)
 
 
-def _format_admin_state(state):
-    return 'UP' if state else 'DOWN'
+class AdminStateColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return 'UP' if self._value else 'DOWN'
 
 
-def _format_router_info(info):
-    try:
-        return json.dumps(info)
-    except (TypeError, KeyError):
-        return ''
+class RouterInfoColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        try:
+            return json.dumps(self._value)
+        except (TypeError, KeyError):
+            return ''
 
 
-def _format_routes(routes):
-    # Map the route keys to match --route option.
-    for route in routes:
-        if 'nexthop' in route:
-            route['gateway'] = route.pop('nexthop')
-    return utils.format_list_of_dicts(routes)
+class RoutesColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        # Map the route keys to match --route option.
+        for route in self._value:
+            if 'nexthop' in route:
+                route['gateway'] = route.pop('nexthop')
+        return utils.format_list_of_dicts(self._value)
 
 
 _formatters = {
-    'admin_state_up': _format_admin_state,
-    'is_admin_state_up': _format_admin_state,
-    'external_gateway_info': _format_router_info,
-    'availability_zones': utils.format_list,
-    'availability_zone_hints': utils.format_list,
-    'routes': _format_routes,
-    'tags': utils.format_list,
+    'admin_state_up': AdminStateColumn,
+    'is_admin_state_up': AdminStateColumn,
+    'external_gateway_info': RouterInfoColumn,
+    'availability_zones': format_columns.ListColumn,
+    'availability_zone_hints': format_columns.ListColumn,
+    'routes': RoutesColumn,
+    'tags': format_columns.ListColumn,
 }
 
 
@@ -720,7 +725,7 @@ def take_action(self, parsed_args):
 
         setattr(obj, 'interfaces_info', interfaces_info)
         display_columns, columns = _get_columns(obj)
-        _formatters['interfaces_info'] = _format_router_info
+        _formatters['interfaces_info'] = RouterInfoColumn
         data = utils.get_item_properties(obj, columns, formatters=_formatters)
 
         return (display_columns, data)

openstackclient/network/v2/security_group.py

@@ -15,6 +15,7 @@
 
 import argparse
 
+from cliff import columns as cliff_columns
 from osc_lib.command import command
 from osc_lib import utils
 import six
@@ -65,13 +66,23 @@ def _format_compute_security_group_rules(sg_rules):
     return utils.format_list(rules, separator='\n')
 
 
+class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return _format_network_security_group_rules(self._value)
+
+
+class ComputeSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        return _format_compute_security_group_rules(self._value)
+
+
 _formatters_network = {
-    'security_group_rules': _format_network_security_group_rules,
+    'security_group_rules': NetworkSecurityGroupRulesColumn,
 }
 
 
 _formatters_compute = {
-    'rules': _format_compute_security_group_rules,
+    'rules': ComputeSecurityGroupRulesColumn,
 }
 
 

openstackclient/network/v2/subnet.py

@@ -16,6 +16,8 @@
 import copy
 import logging
 
+from cliff import columns as cliff_columns
+from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -40,23 +42,27 @@ def _update_arguments(obj_list, parsed_args_list, option):
             raise exceptions.CommandError(msg)
 
 
-def _format_allocation_pools(data):
-    pool_formatted = ['%s-%s' % (pool.get('start', ''), pool.get('end', ''))
-                      for pool in data]
-    return ','.join(pool_formatted)
+class AllocationPoolsColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        pool_formatted = ['%s-%s' % (pool.get('start', ''),
+                                     pool.get('end', ''))
+                          for pool in self._value]
+        return ','.join(pool_formatted)
 
 
-def _format_host_routes(data):
-    # Map the host route keys to match --host-route option.
-    return utils.format_list_of_dicts(convert_entries_to_gateway(data))
+class HostRoutesColumn(cliff_columns.FormattableColumn):
+    def human_readable(self):
+        # Map the host route keys to match --host-route option.
+        return utils.format_list_of_dicts(
+            convert_entries_to_gateway(self._value))
 
 
 _formatters = {
-    'allocation_pools': _format_allocation_pools,
-    'dns_nameservers': utils.format_list,
-    'host_routes': _format_host_routes,
-    'service_types': utils.format_list,
-    'tags': utils.format_list,
+    'allocation_pools': AllocationPoolsColumn,
+    'dns_nameservers': format_columns.ListColumn,
+    'host_routes': HostRoutesColumn,
+    'service_types': format_columns.ListColumn,
+    'tags': format_columns.ListColumn,
 }
 
 

openstackclient/network/v2/subnet_pool.py

@@ -15,6 +15,7 @@
 
 import logging
 
+from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -41,8 +42,8 @@ def _get_columns(item):
 
 
 _formatters = {
-    'prefixes': utils.format_list,
-    'tags': utils.format_list,
+    'prefixes': format_columns.ListColumn,
+    'tags': format_columns.ListColumn,
 }
 
 

openstackclient/tests/functional/network/v2/common.py

@@ -62,21 +62,13 @@ def test_tag_operation(self):
         self._set_resource_and_tag_check('unset', name1, '--all-tag', [])
         self._set_resource_and_tag_check('set', name2, '--no-tag', [])
 
-    def _assertTagsEqual(self, expected, actual):
-        # TODO(amotoki): Should migrate to cliff format columns.
-        # At now, unit test assert method needs to be replaced
-        # to handle format columns, so format_list() is used.
-        # NOTE: The order of tag is undeterminestic.
-        actual_tags = filter(bool, actual.split(', '))
-        self.assertEqual(set(expected), set(actual_tags))
-
     def _list_tag_check(self, project_id, expected):
         cmd_output = json.loads(self.openstack(
             '{} list --long --project {} -f json'.format(self.base_command,
                                                          project_id)))
         for name, tags in expected:
             net = [n for n in cmd_output if n['Name'] == name][0]
-            self._assertTagsEqual(tags, net['Tags'])
+            self.assertEqual(set(tags), set(net['Tags']))
 
     def _create_resource_for_tag_test(self, name, args):
         return json.loads(self.openstack(
@@ -89,7 +81,7 @@ def _create_resource_and_tag_check(self, args, expected):
         self.addCleanup(
             self.openstack, '{} delete {}'.format(self.base_command, name))
         self.assertIsNotNone(cmd_output["id"])
-        self._assertTagsEqual(expected, cmd_output['tags'])
+        self.assertEqual(set(expected), set(cmd_output['tags']))
         return name
 
     def _set_resource_and_tag_check(self, command, name, args, expected):
@@ -100,4 +92,4 @@ def _set_resource_and_tag_check(self, command, name, args, expected):
         cmd_output = json.loads(self.openstack(
             '{} show -f json {}'.format(self.base_command, name)
         ))
-        self._assertTagsEqual(expected, cmd_output['tags'])
+        self.assertEqual(set(expected), set(cmd_output['tags']))