Allow ports filtering with device_id

Hongbin Lu · hongbin · commit 5fdd0730c88b · 2018-01-03T21:11:02.000Z
Right now, if a neutron port is owned by a container powered by
Kuryr, there is no way to list and filter those ports because
OSC assumed a neutron port is owned by either a server or router.
This patch adds support for that by introducing an option '--device-id'
to the 'port list' command.

Change-Id: Ib1fd27e8d843a99fb02ccabd8a12a24ac27cec9c
diff --git a/doc/source/cli/command-objects/port.rst b/doc/source/cli/command-objects/port.rst
@@ -170,7 +170,7 @@ List ports
 
     openstack port list
         [--device-owner <device-owner>]
-        [--router <router> | --server <server>]
+        [--router <router> | --server <server> | --device-id <device-id>]
         [--network <network>]
         [--mac-address <mac-address>]
         [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
@@ -192,6 +192,10 @@ List ports
 
     List only ports attached to this server (name or ID)
 
+.. option:: --device-id <device-id>
+
+    List only ports with the specified device ID
+
 .. option:: --network <network>
 
     List only ports attached to this network (name or ID)
diff --git a/openstackclient/network/v2/port.py b/openstackclient/network/v2/port.py
@@ -499,6 +499,11 @@ def get_parser(self, prog_name):
             metavar='<server>',
             help=_("List only ports attached to this server (name or ID)"),
         )
+        device_group.add_argument(
+            '--device-id',
+            metavar='<device-id>',
+            help=_("List only ports with the specified device ID")
+        )
         parser.add_argument(
             '--mac-address',
             metavar='<mac-address>',
@@ -553,6 +558,8 @@ def take_action(self, parsed_args):
             column_headers += ('Security Groups', 'Device Owner', 'Tags')
         if parsed_args.device_owner is not None:
             filters['device_owner'] = parsed_args.device_owner
+        if parsed_args.device_id is not None:
+            filters['device_id'] = parsed_args.device_id
         if parsed_args.router:
             _router = network_client.find_router(parsed_args.router,
                                                  ignore_missing=False)
diff --git a/openstackclient/tests/unit/network/v2/test_port.py b/openstackclient/tests/unit/network/v2/test_port.py
@@ -759,6 +759,25 @@ def test_port_list_with_server_option(self, mock_find):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, list(data))
 
+    def test_port_list_device_id_opt(self):
+        arglist = [
+            '--device-id', self._ports[0].device_id,
+        ]
+
+        verifylist = [
+            ('device_id', self._ports[0].device_id)
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.network.ports.assert_called_once_with(**{
+            'device_id': self._ports[0].device_id
+        })
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, list(data))
+
     def test_port_list_device_owner_opt(self):
         arglist = [
             '--device-owner', self._ports[0].device_owner,
diff --git a/releasenotes/notes/add-device_id-to-port-list-0c658db51ce43c9e.yaml b/releasenotes/notes/add-device_id-to-port-list-0c658db51ce43c9e.yaml
@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Add ``--device-id`` option to the ``port list`` command.

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +---
 +features:
 +  - |
 +    Add ``--device-id`` option to the ``port list`` command.