Merge "Add direction and protocol options to os security group rule list cmd"

Author: Jenkins

doc/source/command-objects/security-group-rule.rst

@@ -133,6 +133,8 @@ List security group rules
 
     os security group rule list
         [--all-projects]
+        [--protocol <protocol>]
+        [--ingress | --egress]
         [--long]
         [<group>]
 
@@ -149,6 +151,28 @@ List security group rules
 
     *Compute version 2 does not have additional fields to display.*
 
+
+.. option:: --protocol
+
+    List rules by the IP protocol (ah, dhcp, egp, esp, gre, icmp, igmp,
+    ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt,ipv6-opts, ipv6-route,
+    ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp and integer
+    representations [0-255])
+
+    *Network version 2*
+
+.. option:: --ingress
+
+    List rules applied to incoming network traffic
+
+    *Network version 2 only*
+
+.. option:: --egress
+
+    List rules applied to outgoing network traffic
+
+    *Network version 2 only*
+
 .. describe:: <group>
 
     List all rules in this security group (name or ID)

openstackclient/network/v2/security_group_rule.py

@@ -387,6 +387,28 @@ def update_parser_network(self, parser):
             default=False,
             help=argparse.SUPPRESS
         )
+        parser.add_argument(
+            '--protocol',
+            metavar='<protocol>',
+            type=_convert_to_lowercase,
+            help=_("List rules by the IP protocol ("
+                   "ah, dhcp, egp, esp, gre, icmp, igmp, "
+                   "ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, "
+                   "ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, "
+                   "udp, udplite, vrrp and integer representations [0-255])."
+                   )
+        )
+        direction_group = parser.add_mutually_exclusive_group()
+        direction_group.add_argument(
+            '--ingress',
+            action='store_true',
+            help=_("List rules applied to incoming network traffic")
+        )
+        direction_group.add_argument(
+            '--egress',
+            action='store_true',
+            help=_("List rules applied to outgoing network traffic")
+        )
         parser.add_argument(
             '--long',
             action='store_true',
@@ -451,6 +473,14 @@ def take_action_network(self, client, parsed_args):
             query = {'security_group_id': security_group_id}
         else:
             columns = columns + ('security_group_id',)
+
+        if parsed_args.ingress:
+            query['direction'] = 'ingress'
+        if parsed_args.egress:
+            query['direction'] = 'egress'
+        if parsed_args.protocol is not None:
+            query['protocol'] = parsed_args.protocol
+
         rules = list(client.security_group_rules(**query))
 
         # Reformat the rules to display a port range instead

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

@@ -971,6 +971,60 @@ def test_list_with_ignored_options(self):
         self.assertEqual(self.expected_columns_no_group, columns)
         self.assertEqual(self.expected_data_no_group, list(data))
 
+    def test_list_with_protocol(self):
+        self._security_group_rule_tcp.port_range_min = 80
+        arglist = [
+            '--protocol', 'tcp',
+        ]
+        verifylist = [
+            ('protocol', 'tcp'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network.security_group_rules.assert_called_once_with(**{
+            'protocol': 'tcp',
+        })
+        self.assertEqual(self.expected_columns_no_group, columns)
+        self.assertEqual(self.expected_data_no_group, list(data))
+
+    def test_list_with_ingress(self):
+        self._security_group_rule_tcp.port_range_min = 80
+        arglist = [
+            '--ingress',
+        ]
+        verifylist = [
+            ('ingress', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network.security_group_rules.assert_called_once_with(**{
+            'direction': 'ingress',
+        })
+        self.assertEqual(self.expected_columns_no_group, columns)
+        self.assertEqual(self.expected_data_no_group, list(data))
+
+    def test_list_with_wrong_egress(self):
+        self._security_group_rule_tcp.port_range_min = 80
+        arglist = [
+            '--egress',
+        ]
+        verifylist = [
+            ('egress', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network.security_group_rules.assert_called_once_with(**{
+            'direction': 'egress',
+        })
+        self.assertEqual(self.expected_columns_no_group, columns)
+        self.assertEqual(self.expected_data_no_group, list(data))
+
 
 class TestListSecurityGroupRuleCompute(TestSecurityGroupRuleCompute):
 

releasenotes/notes/bug-1613533-93279179c6f70117.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add ``--ingress``, ``--egress`` and ``--protocol`` options to
+    ``security group rule list`` command.
+    [Bug `1613533 <https://bugs.launchpad.net/bugs/1613533>`_]