Skip to content

Commit 07f5498

Browse files
amotokiamotoki
committed
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: If478fccd867a4bcd7c86e283c5aaf67a667cc080
1 parent bcf2abe commit 07f5498

25 files changed

Lines changed: 398 additions & 360 deletions

‎openstackclient/network/v2/ip_availability.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
"""IP Availability Info implementations"""
1515

16+
from osc_lib.cli import format_columns
1617
from osc_lib.command import command
1718
from osc_lib import utils
1819

@@ -21,7 +22,7 @@
2122
from openstackclient.network import sdk_utils
2223

2324
_formatters = {
24-
'subnet_ip_availability': utils.format_list_of_dicts,
25+
'subnet_ip_availability': format_columns.ListDictColumn,
2526
}
2627

2728

‎openstackclient/network/v2/network.py‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
"""Network action implementations"""
1515

16+
from cliff import columns as cliff_columns
17+
from osc_lib.cli import format_columns
1618
from osc_lib.command import command
1719
from osc_lib import utils
1820

@@ -23,24 +25,26 @@
2325
from openstackclient.network.v2 import _tag
2426

2527

26-
def _format_admin_state(item):
27-
return 'UP' if item else 'DOWN'
28+
class AdminStateColumn(cliff_columns.FormattableColumn):
29+
def human_readable(self):
30+
return 'UP' if self._value else 'DOWN'
2831

2932

30-
def _format_router_external(item):
31-
return 'External' if item else 'Internal'
33+
class RouterExternalColumn(cliff_columns.FormattableColumn):
34+
def human_readable(self):
35+
return 'External' if self._value else 'Internal'
3236

3337

3438
_formatters = {
35-
'subnets': utils.format_list,
36-
'subnet_ids': utils.format_list,
37-
'admin_state_up': _format_admin_state,
38-
'is_admin_state_up': _format_admin_state,
39-
'router:external': _format_router_external,
40-
'is_router_external': _format_router_external,
41-
'availability_zones': utils.format_list,
42-
'availability_zone_hints': utils.format_list,
43-
'tags': utils.format_list,
39+
'subnets': format_columns.ListColumn,
40+
'subnet_ids': format_columns.ListColumn,
41+
'admin_state_up': AdminStateColumn,
42+
'is_admin_state_up': AdminStateColumn,
43+
'router:external': RouterExternalColumn,
44+
'is_router_external': RouterExternalColumn,
45+
'availability_zones': format_columns.ListColumn,
46+
'availability_zone_hints': format_columns.ListColumn,
47+
'tags': format_columns.ListColumn,
4448
}
4549

4650

‎openstackclient/network/v2/network_agent.py‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
import logging
1717

18+
from cliff import columns as cliff_columns
19+
from osc_lib.cli import format_columns
1820
from osc_lib.command import command
1921
from osc_lib import exceptions
2022
from osc_lib import utils
@@ -26,19 +28,22 @@
2628
LOG = logging.getLogger(__name__)
2729

2830

29-
def _format_alive(alive):
30-
return ":-)" if alive else "XXX"
31+
class AliveColumn(cliff_columns.FormattableColumn):
32+
def human_readable(self):
33+
return ":-)" if self._value else "XXX"
3134

3235

33-
def _format_admin_state(state):
34-
return 'UP' if state else 'DOWN'
36+
class AdminStateColumn(cliff_columns.FormattableColumn):
37+
def human_readable(self):
38+
return 'UP' if self._value else 'DOWN'
39+
3540

3641
_formatters = {
37-
'is_alive': _format_alive,
38-
'alive': _format_alive,
39-
'admin_state_up': _format_admin_state,
40-
'is_admin_state_up': _format_admin_state,
41-
'configurations': utils.format_dict,
42+
'is_alive': AliveColumn,
43+
'alive': AliveColumn,
44+
'admin_state_up': AdminStateColumn,
45+
'is_admin_state_up': AdminStateColumn,
46+
'configurations': format_columns.DictColumn,
4247
}
4348

4449

‎openstackclient/network/v2/port.py‎

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
import json
1919
import logging
2020

21+
from cliff import columns as cliff_columns
22+
from osc_lib.cli import format_columns
2123
from osc_lib.cli import parseractions
2224
from osc_lib.command import command
2325
from osc_lib import exceptions
@@ -32,23 +34,24 @@
3234
LOG = logging.getLogger(__name__)
3335

3436

35-
def _format_admin_state(state):
36-
return 'UP' if state else 'DOWN'
37+
class AdminStateColumn(cliff_columns.FormattableColumn):
38+
def human_readable(self):
39+
return 'UP' if self._value else 'DOWN'
3740

3841

3942
_formatters = {
40-
'admin_state_up': _format_admin_state,
41-
'is_admin_state_up': _format_admin_state,
42-
'allowed_address_pairs': utils.format_list_of_dicts,
43-
'binding_profile': utils.format_dict,
44-
'binding_vif_details': utils.format_dict,
45-
'binding:profile': utils.format_dict,
46-
'binding:vif_details': utils.format_dict,
47-
'dns_assignment': utils.format_list_of_dicts,
48-
'extra_dhcp_opts': utils.format_list_of_dicts,
49-
'fixed_ips': utils.format_list_of_dicts,
50-
'security_group_ids': utils.format_list,
51-
'tags': utils.format_list,
43+
'admin_state_up': AdminStateColumn,
44+
'is_admin_state_up': AdminStateColumn,
45+
'allowed_address_pairs': format_columns.ListDictColumn,
46+
'binding_profile': format_columns.DictColumn,
47+
'binding_vif_details': format_columns.DictColumn,
48+
'binding:profile': format_columns.DictColumn,
49+
'binding:vif_details': format_columns.DictColumn,
50+
'dns_assignment': format_columns.ListDictColumn,
51+
'extra_dhcp_opts': format_columns.ListDictColumn,
52+
'fixed_ips': format_columns.ListDictColumn,
53+
'security_group_ids': format_columns.ListColumn,
54+
'tags': format_columns.ListColumn,
5255
}
5356

5457

‎openstackclient/network/v2/router.py‎

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
import json
1919
import logging
2020

21+
from cliff import columns as cliff_columns
22+
from osc_lib.cli import format_columns
2123
from osc_lib.cli import parseractions
2224
from osc_lib.command import command
2325
from osc_lib import exceptions
@@ -32,33 +34,36 @@
3234
LOG = logging.getLogger(__name__)
3335

3436

35-
def _format_admin_state(state):
36-
return 'UP' if state else 'DOWN'
37+
class AdminStateColumn(cliff_columns.FormattableColumn):
38+
def human_readable(self):
39+
return 'UP' if self._value else 'DOWN'
3740

3841

39-
def _format_external_gateway_info(info):
40-
try:
41-
return json.dumps(info)
42-
except (TypeError, KeyError):
43-
return ''
42+
class ExternalGatewayInfoColumn(cliff_columns.FormattableColumn):
43+
def human_readable(self):
44+
try:
45+
return json.dumps(self._value)
46+
except (TypeError, KeyError):
47+
return ''
4448

4549

46-
def _format_routes(routes):
47-
# Map the route keys to match --route option.
48-
for route in routes:
49-
if 'nexthop' in route:
50-
route['gateway'] = route.pop('nexthop')
51-
return utils.format_list_of_dicts(routes)
50+
class RoutesColumn(cliff_columns.FormattableColumn):
51+
def human_readable(self):
52+
# Map the route keys to match --route option.
53+
for route in self._value:
54+
if 'nexthop' in route:
55+
route['gateway'] = route.pop('nexthop')
56+
return utils.format_list_of_dicts(self._value)
5257

5358

5459
_formatters = {
55-
'admin_state_up': _format_admin_state,
56-
'is_admin_state_up': _format_admin_state,
57-
'external_gateway_info': _format_external_gateway_info,
58-
'availability_zones': utils.format_list,
59-
'availability_zone_hints': utils.format_list,
60-
'routes': _format_routes,
61-
'tags': utils.format_list,
60+
'admin_state_up': AdminStateColumn,
61+
'is_admin_state_up': AdminStateColumn,
62+
'external_gateway_info': ExternalGatewayInfoColumn,
63+
'availability_zones': format_columns.ListColumn,
64+
'availability_zone_hints': format_columns.ListColumn,
65+
'routes': RoutesColumn,
66+
'tags': format_columns.ListColumn,
6267
}
6368

6469

‎openstackclient/network/v2/security_group.py‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
import argparse
1717

18+
from cliff import columns as cliff_columns
1819
from osc_lib import utils
1920
import six
2021

@@ -63,13 +64,23 @@ def _format_compute_security_group_rules(sg_rules):
6364
return utils.format_list(rules, separator='\n')
6465

6566

67+
class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
68+
def human_readable(self):
69+
return _format_network_security_group_rules(self._value)
70+
71+
72+
class ComputeSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
73+
def human_readable(self):
74+
return _format_compute_security_group_rules(self._value)
75+
76+
6677
_formatters_network = {
67-
'security_group_rules': _format_network_security_group_rules,
78+
'security_group_rules': NetworkSecurityGroupRulesColumn,
6879
}
6980

7081

7182
_formatters_compute = {
72-
'rules': _format_compute_security_group_rules,
83+
'rules': ComputeSecurityGroupRulesColumn,
7384
}
7485

7586

‎openstackclient/network/v2/subnet.py‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
import copy
1717
import logging
1818

19+
from cliff import columns as cliff_columns
20+
from osc_lib.cli import format_columns
1921
from osc_lib.cli import parseractions
2022
from osc_lib.command import command
2123
from osc_lib import exceptions
@@ -40,23 +42,27 @@ def _update_arguments(obj_list, parsed_args_list, option):
4042
raise exceptions.CommandError(msg)
4143

4244

43-
def _format_allocation_pools(data):
44-
pool_formatted = ['%s-%s' % (pool.get('start', ''), pool.get('end', ''))
45-
for pool in data]
46-
return ','.join(pool_formatted)
45+
class AllocationPoolsColumn(cliff_columns.FormattableColumn):
46+
def human_readable(self):
47+
pool_formatted = ['%s-%s' % (pool.get('start', ''),
48+
pool.get('end', ''))
49+
for pool in self._value]
50+
return ','.join(pool_formatted)
4751

4852

49-
def _format_host_routes(data):
50-
# Map the host route keys to match --host-route option.
51-
return utils.format_list_of_dicts(convert_entries_to_gateway(data))
53+
class HostRoutesColumn(cliff_columns.FormattableColumn):
54+
def human_readable(self):
55+
# Map the host route keys to match --host-route option.
56+
return utils.format_list_of_dicts(
57+
convert_entries_to_gateway(self._value))
5258

5359

5460
_formatters = {
55-
'allocation_pools': _format_allocation_pools,
56-
'dns_nameservers': utils.format_list,
57-
'host_routes': _format_host_routes,
58-
'service_types': utils.format_list,
59-
'tags': utils.format_list,
61+
'allocation_pools': AllocationPoolsColumn,
62+
'dns_nameservers': format_columns.ListColumn,
63+
'host_routes': HostRoutesColumn,
64+
'service_types': format_columns.ListColumn,
65+
'tags': format_columns.ListColumn,
6066
}
6167

6268

‎openstackclient/network/v2/subnet_pool.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import copy
1717
import logging
1818

19+
from osc_lib.cli import format_columns
1920
from osc_lib.cli import parseractions
2021
from osc_lib.command import command
2122
from osc_lib import exceptions
@@ -42,8 +43,8 @@ def _get_columns(item):
4243

4344

4445
_formatters = {
45-
'prefixes': utils.format_list,
46-
'tags': utils.format_list,
46+
'prefixes': format_columns.ListColumn,
47+
'tags': format_columns.ListColumn,
4748
}
4849

4950

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

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,13 @@ def test_tag_operation(self):
6262
self._set_resource_and_tag_check('unset', name1, '--all-tag', [])
6363
self._set_resource_and_tag_check('set', name2, '--no-tag', [])
6464

65-
def _assertTagsEqual(self, expected, actual):
66-
# TODO(amotoki): Should migrate to cliff format columns.
67-
# At now, unit test assert method needs to be replaced
68-
# to handle format columns, so format_list() is used.
69-
# NOTE: The order of tag is undeterminestic.
70-
actual_tags = filter(bool, actual.split(', '))
71-
self.assertEqual(set(expected), set(actual_tags))
72-
7365
def _list_tag_check(self, project_id, expected):
7466
cmd_output = json.loads(self.openstack(
7567
'{} list --long --project {} -f json'.format(self.base_command,
7668
project_id)))
7769
for name, tags in expected:
7870
net = [n for n in cmd_output if n['Name'] == name][0]
79-
self._assertTagsEqual(tags, net['Tags'])
71+
self.assertEqual(set(tags), set(net['Tags']))
8072

8173
def _create_resource_for_tag_test(self, name, args):
8274
return json.loads(self.openstack(
@@ -89,7 +81,7 @@ def _create_resource_and_tag_check(self, args, expected):
8981
self.addCleanup(
9082
self.openstack, '{} delete {}'.format(self.base_command, name))
9183
self.assertIsNotNone(cmd_output["id"])
92-
self._assertTagsEqual(expected, cmd_output['tags'])
84+
self.assertEqual(set(expected), set(cmd_output['tags']))
9385
return name
9486

9587
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):
10092
cmd_output = json.loads(self.openstack(
10193
'{} show -f json {}'.format(self.base_command, name)
10294
))
103-
self._assertTagsEqual(expected, cmd_output['tags'])
95+
self.assertEqual(set(expected), set(cmd_output['tags']))

0 commit comments

Comments
 (0)