Merge "Always display direction for security group rules"

Author: Zuul

openstackclient/network/v2/security_group_rule.py

@@ -474,7 +474,7 @@ def update_parser_network(self, parser):
             action='store_true',
             default=False,
             help=self.enhance_help_neutron(
-                _("List additional fields in output"))
+                _("**Deprecated** This argument is no longer needed"))
         )
         return parser
 
@@ -504,26 +504,29 @@ def _get_column_headers(self, parsed_args):
             'Ethertype',
             'IP Range',
             'Port Range',
+            'Direction',
+            'Remote Security Group',
         )
-        if parsed_args.long:
-            column_headers = column_headers + ('Direction',)
-        column_headers = column_headers + ('Remote Security Group',)
         if parsed_args.group is None:
             column_headers = column_headers + ('Security Group',)
         return column_headers
 
     def take_action_network(self, client, parsed_args):
+        if parsed_args.long:
+            self.log.warning(_(
+                "The --long option has been deprecated and is no longer needed"
+            ))
+
         column_headers = self._get_column_headers(parsed_args)
         columns = (
             'id',
             'protocol',
             'ether_type',
             'remote_ip_prefix',
             'port_range',
+            'direction',
+            'remote_group_id',
         )
-        if parsed_args.long:
-            columns = columns + ('direction',)
-        columns = columns + ('remote_group_id',)
 
         # Get the security group rules using the requested query.
         query = {}

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

@@ -362,6 +362,7 @@ class TestListSecurityGroupRuleCompute(TestSecurityGroupRuleCompute):
         'Ethertype',
         'IP Range',
         'Port Range',
+        'Direction',
         'Remote Security Group',
     )
     expected_columns_no_group = \

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

@@ -870,7 +870,7 @@ class TestListSecurityGroupRuleNetwork(TestSecurityGroupRuleNetwork):
     _security_group_rules = [_security_group_rule_tcp,
                              _security_group_rule_icmp]
 
-    expected_columns_with_group_and_long = (
+    expected_columns_with_group = (
         'ID',
         'IP Protocol',
         'Ethertype',
@@ -885,14 +885,15 @@ class TestListSecurityGroupRuleNetwork(TestSecurityGroupRuleNetwork):
         'Ethertype',
         'IP Range',
         'Port Range',
+        'Direction',
         'Remote Security Group',
         'Security Group',
     )
 
-    expected_data_with_group_and_long = []
+    expected_data_with_group = []
     expected_data_no_group = []
     for _security_group_rule in _security_group_rules:
-        expected_data_with_group_and_long.append((
+        expected_data_with_group.append((
             _security_group_rule.id,
             _security_group_rule.protocol,
             _security_group_rule.ether_type,
@@ -909,6 +910,7 @@ class TestListSecurityGroupRuleNetwork(TestSecurityGroupRuleNetwork):
             _security_group_rule.remote_ip_prefix,
             security_group_rule._format_network_port_range(
                 _security_group_rule),
+            _security_group_rule.direction,
             _security_group_rule.remote_group_id,
             _security_group_rule.security_group_id,
         ))
@@ -935,14 +937,12 @@ def test_list_default(self):
         self.assertEqual(self.expected_columns_no_group, columns)
         self.assertEqual(self.expected_data_no_group, list(data))
 
-    def test_list_with_group_and_long(self):
+    def test_list_with_group(self):
         self._security_group_rule_tcp.port_range_min = 80
         arglist = [
-            '--long',
             self._security_group.id,
         ]
         verifylist = [
-            ('long', True),
             ('group', self._security_group.id),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -952,8 +952,8 @@ def test_list_with_group_and_long(self):
         self.network.security_group_rules.assert_called_once_with(**{
             'security_group_id': self._security_group.id,
         })
-        self.assertEqual(self.expected_columns_with_group_and_long, columns)
-        self.assertEqual(self.expected_data_with_group_and_long, list(data))
+        self.assertEqual(self.expected_columns_with_group, columns)
+        self.assertEqual(self.expected_data_with_group, list(data))
 
     def test_list_with_ignored_options(self):
         self._security_group_rule_tcp.port_range_min = 80

releasenotes/notes/always-show-direction-for-sg-rule-130efc39bf67d79a.yaml

@@ -0,0 +1,10 @@
+---
+features:
+  - |
+    By default listing security group rules now shows the direction.
+    The ``--long`` argument is now redundant and is now ignored as it
+    was only used to display the direction.
+deprecations:
+  - |
+    Deprecate the ``--long`` option for the ``security group list``
+    command. This is no longer needed to display all columns.