Improve output for "os security group show"

rtheis · rtheis · commit 0e38ef84844b · 2015-12-23T13:44:22.000-06:00
Improve the security group rules output when running the
"os security group show" command. Each security group rule
is now displayed on a separate line.

Current output example:
$ openstack security group show default
+-------------+------------------------- ... ---+
| Field       | Value                    ...    |
+-------------+------------------------- ... ---+
| description | Default security group   ...    |
| id          | 048a5fc3-3be1-407d-ae47-9...    |
| name        | default                  ...    |
| project_id  | 3b96bb2020c1459da76963f9e...    |
| rules       | [u"id='5d812367-9829-4340...t"] |
+-------------+------------------------- ... ---+

New output example:
+-------------+------------------------- ... ---+
| Field       | Value                    ...    |
+-------------+------------------------- ... ---+
| description | Default security group   ...    |
| id          | 048a5fc3-3be1-407d-ae47-9...    |
| name        | default                  ...    |
| project_id  | 3b96bb2020c1459da76963f9e...    |
| rules       | id='5d812367-9829-4340-95...lt' |
|             | id='ee451d1c-ade3-4975-8e...lt' |
+-------------+------------------------- ... ---+

Change-Id: I1386075310896c58a2b776e2bbec3603bd00eff1
Partial-Bug: #1519511
Related-To: blueprint neutron-client
diff --git a/openstackclient/common/utils.py b/openstackclient/common/utils.py
@@ -154,14 +154,15 @@ def format_dict(data):
     return output[:-2]
 
 
-def format_list(data):
+def format_list(data, separator=', '):
     """Return a formatted strings
 
     :param data: a list of strings
-    :rtype: a string formatted to a,b,c
+    :param separator: the separator to use between strings (default: ', ')
+    :rtype: a string formatted based on separator
     """
 
-    return ', '.join(sorted(data))
+    return separator.join(sorted(data))
 
 
 def get_field(item, field):
diff --git a/openstackclient/compute/v2/security_group.py b/openstackclient/compute/v2/security_group.py
@@ -390,7 +390,7 @@ def take_action(self, parsed_args):
 
         # Format rules into a list of strings
         info.update(
-            {'rules': rules}
+            {'rules': utils.format_list(rules, separator='\n')}
         )
         # Map 'tenant_id' column to 'project_id'
         info.update(
diff --git a/openstackclient/tests/common/test_utils.py b/openstackclient/tests/common/test_utils.py
@@ -347,3 +347,10 @@ def test_format_list(self):
         expected = 'a, b, c'
         self.assertEqual(expected, utils.format_list(['a', 'b', 'c']))
         self.assertEqual(expected, utils.format_list(['c', 'b', 'a']))
+
+    def test_format_list_separator(self):
+        expected = 'a\nb\nc'
+        actual_pre_sorted = utils.format_list(['a', 'b', 'c'], separator='\n')
+        actual_unsorted = utils.format_list(['c', 'b', 'a'], separator='\n')
+        self.assertEqual(expected, actual_pre_sorted)
+        self.assertEqual(expected, actual_unsorted)

Original file line number	Diff line number	Diff line change
`@@ -390,7 +390,7 @@ def take_action(self, parsed_args):`
`390`	`390`
`391`	`391`	`# Format rules into a list of strings`
`392`	`392`	`info.update(`
`393`		`- {'rules': rules}`
	`393`	`+ {'rules': utils.format_list(rules, separator='\n')}`
`394`	`394`	`)`
`395`	`395`	`# Map 'tenant_id' column to 'project_id'`
`396`	`396`	`info.update(`