Add server list -n and --no-name-lookup arguments

boris-42 · Boris Pavlovic · commit 2c57f7bfb2dc · 2017-07-10T16:20:45.000-07:00
Remove translation of Image ID and Flavor ID to Image and Flavor names

In large environments amount of images can be very large (thousands)
Which requires ~hundreds of requests to Glance to get all images
(by default client request only 20 images)
As a result listing even few servers is going to take minutes

This patch allows to avoid these queries by not doing translation,
which allows one to get information about servers in seconds.

Change-Id: I4ae00e6324a41c4c79bf5b620179dae99aea5431
diff --git a/doc/source/cli/command-objects/server.rst b/doc/source/cli/command-objects/server.rst
@@ -330,6 +330,7 @@ List servers
         [--all-projects]
         [--project <project> [--project-domain <project-domain>]]
         [--long]
+        [-n | --no-name-lookup]
         [--marker <server>]
         [--limit <num-servers>]
         [--deleted]
@@ -397,6 +398,10 @@ List servers
 
     List additional fields in output
 
+.. option:: --no-name-lookup
+
+    Skips image and flavor names lookup
+
 .. option:: --marker <server>
 
     The last server of the previous page. Display list of servers
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
@@ -921,6 +921,12 @@ def get_parser(self, prog_name):
             default=False,
             help=_('List additional fields in output'),
         )
+        parser.add_argument(
+            '-n', '--no-name-lookup',
+            action='store_true',
+            default=False,
+            help=_('Skip flavor and image name lookup.'),
+        )
         parser.add_argument(
             '--marker',
             metavar='<server>',
@@ -1054,21 +1060,26 @@ def take_action(self, parsed_args):
                 'OS-EXT-AZ:availability_zone',
                 'OS-EXT-SRV-ATTR:host',
             ]
-        else:
+        elif parsed_args.no_name_lookup:
             columns = (
                 'ID',
                 'Name',
                 'Status',
-                'Networks',
-                'Image Name',
+                'Image ID',
+                'Flavor ID',
             )
-            column_headers = (
+            column_headers = tuple(columns)
+            mixed_case_fields = []
+
+        else:
+            columns = (
                 'ID',
                 'Name',
                 'Status',
                 'Networks',
                 'Image Name',
             )
+            column_headers = tuple(columns)
             mixed_case_fields = []
 
         marker_id = None
@@ -1084,23 +1095,25 @@ def take_action(self, parsed_args):
         # Create a dict that maps image_id to image object.
         # Needed so that we can display the "Image Name" column.
         # "Image Name" is not crucial, so we swallow any exceptions.
-        try:
-            images_list = self.app.client_manager.image.images.list()
-            for i in images_list:
-                images[i.id] = i
-        except Exception:
-            pass
+        if not parsed_args.no_name_lookup:
+            try:
+                images_list = self.app.client_manager.image.images.list()
+                for i in images_list:
+                    images[i.id] = i
+            except Exception:
+                pass
 
         flavors = {}
         # Create a dict that maps flavor_id to flavor object.
         # Needed so that we can display the "Flavor Name" column.
         # "Flavor Name" is not crucial, so we swallow any exceptions.
-        try:
-            flavors_list = compute_client.flavors.list()
-            for i in flavors_list:
-                flavors[i.id] = i
-        except Exception:
-            pass
+        if not parsed_args.no_name_lookup:
+            try:
+                flavors_list = compute_client.flavors.list()
+                for i in flavors_list:
+                    flavors[i.id] = i
+            except Exception:
+                pass
 
         # Populate image_name, image_id, flavor_name and flavor_id attributes
         # of server objects so that we can display those columns.
diff --git a/openstackclient/tests/unit/compute/v2/test_server.py b/openstackclient/tests/unit/compute/v2/test_server.py
@@ -395,6 +395,8 @@ def test_server_create_minimal(self):
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist(), data)
+        self.assertFalse(self.images_mock.called)
+        self.assertFalse(self.flavors_mock.called)
 
     def test_server_create_with_options(self):
         arglist = [
@@ -1457,6 +1459,14 @@ class TestServerList(TestServer):
         'Properties',
     )
 
+    columns_no_name_lookup = (
+        'ID',
+        'Name',
+        'Status',
+        'Image ID',
+        'Flavor ID',
+    )
+
     def setUp(self):
         super(TestServerList, self).setUp()
 
@@ -1515,6 +1525,7 @@ def setUp(self):
         # Prepare data returned by fake Nova API.
         self.data = []
         self.data_long = []
+        self.data_no_name_lookup = []
 
         Image = collections.namedtuple('Image', 'id name')
         self.images_mock.list.return_value = [
@@ -1553,6 +1564,13 @@ def setUp(self):
                 getattr(s, 'OS-EXT-SRV-ATTR:host'),
                 s.Metadata,
             ))
+            self.data_no_name_lookup.append((
+                s.id,
+                s.name,
+                s.status,
+                s.image['id'],
+                s.flavor['id']
+            ))
 
     def test_server_list_no_option(self):
         arglist = []
@@ -1585,6 +1603,38 @@ def test_server_list_long_option(self):
         self.assertEqual(self.columns_long, columns)
         self.assertEqual(tuple(self.data_long), tuple(data))
 
+    def test_server_list_no_name_lookup_option(self):
+        arglist = [
+            '--no-name-lookup',
+        ]
+        verifylist = [
+            ('all_projects', False),
+            ('no_name_lookup', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.servers_mock.list.assert_called_with(**self.kwargs)
+        self.assertEqual(self.columns_no_name_lookup, columns)
+        self.assertEqual(tuple(self.data_no_name_lookup), tuple(data))
+
+    def test_server_list_n_option(self):
+        arglist = [
+            '-n',
+        ]
+        verifylist = [
+            ('all_projects', False),
+            ('no_name_lookup', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.servers_mock.list.assert_called_with(**self.kwargs)
+        self.assertEqual(self.columns_no_name_lookup, columns)
+        self.assertEqual(tuple(self.data_no_name_lookup), tuple(data))
+
     def test_server_list_with_image(self):
 
         arglist = [
