Migrate 'server event *' commands to SDK

This one is tricky since the ServerAction resources includes a nested
ServerActionEvent resource which requires a custom formatter in order
for things to render as expected.

Change-Id: I3d24851303222af9efcee8d7e1565278b1018efd
Co-authored-by: Stephen Finucane <stephenfin@redhat.com>

Author: huda-irs

openstackclient/compute/v2/server_event.py

@@ -17,8 +17,10 @@
 
 import logging
 
+from cliff import columns
 import iso8601
-from novaclient import api_versions
+from openstack import exceptions as sdk_exceptions
+from openstack import utils as sdk_utils
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -30,6 +32,51 @@
 LOG = logging.getLogger(__name__)
 
 
+class ServerActionEventColumn(columns.FormattableColumn):
+    """Custom formatter for server action events.
+
+    Format the :class:`~openstack.compute.v2.server_action.ServerActionEvent`
+    objects as we'd like.
+    """
+
+    def _format_event(self, event):
+        column_map = {}
+        hidden_columns = ['id', 'name', 'location']
+        _, columns = utils.get_osc_show_columns_for_sdk_resource(
+            event,
+            column_map,
+            hidden_columns,
+        )
+        data = utils.get_item_properties(
+            event,
+            columns,
+        )
+        return dict(zip(columns, data))
+
+    def human_readable(self):
+        events = [self._format_event(event) for event in self._value]
+        return utils.format_list_of_dicts(events)
+
+    def machine_readable(self):
+        events = [self._format_event(event) for event in self._value]
+        return events
+
+
+def _get_server_event_columns(item, client):
+    column_map = {}
+    hidden_columns = ['name', 'server_id', 'links', 'location']
+
+    if not sdk_utils.supports_microversion(client, '2.58'):
+        # updated_at was introduced in 2.58
+        hidden_columns.append('updated_at')
+
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item,
+        column_map,
+        hidden_columns,
+    )
+
+
 class ListServerEvent(command.Lister):
     """List recent events of a server.
 
@@ -38,7 +85,7 @@ class ListServerEvent(command.Lister):
     """
 
     def get_parser(self, prog_name):
-        parser = super(ListServerEvent, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
             metavar='<server>',
@@ -90,30 +137,33 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
         kwargs = {}
 
         if parsed_args.marker:
-            if compute_client.api_version < api_versions.APIVersion('2.58'):
+            if not sdk_utils.supports_microversion(compute_client, '2.58'):
                 msg = _(
                     '--os-compute-api-version 2.58 or greater is required to '
                     'support the --marker option'
                 )
                 raise exceptions.CommandError(msg)
+
             kwargs['marker'] = parsed_args.marker
 
         if parsed_args.limit:
-            if compute_client.api_version < api_versions.APIVersion('2.58'):
+            if not sdk_utils.supports_microversion(compute_client, '2.58'):
                 msg = _(
                     '--os-compute-api-version 2.58 or greater is required to '
                     'support the --limit option'
                 )
                 raise exceptions.CommandError(msg)
+
             kwargs['limit'] = parsed_args.limit
+            kwargs['paginated'] = False
 
         if parsed_args.changes_since:
-            if compute_client.api_version < api_versions.APIVersion('2.58'):
+            if not sdk_utils.supports_microversion(compute_client, '2.58'):
                 msg = _(
                     '--os-compute-api-version 2.58 or greater is required to '
                     'support the --changes-since option'
@@ -129,7 +179,7 @@ def take_action(self, parsed_args):
             kwargs['changes_since'] = parsed_args.changes_since
 
         if parsed_args.changes_before:
-            if compute_client.api_version < api_versions.APIVersion('2.66'):
+            if not sdk_utils.supports_microversion(compute_client, '2.66'):
                 msg = _(
                     '--os-compute-api-version 2.66 or greater is required to '
                     'support the --changes-before option'
@@ -145,10 +195,11 @@ def take_action(self, parsed_args):
             kwargs['changes_before'] = parsed_args.changes_before
 
         try:
-            server_id = utils.find_resource(
-                compute_client.servers, parsed_args.server,
+            server_id = compute_client.find_server(
+                parsed_args.server,
+                ignore_missing=False
             ).id
-        except exceptions.CommandError:
+        except sdk_exceptions.ResourceNotFound:
             # If we fail to find the resource, it is possible the server is
             # deleted. Try once more using the <server> arg directly if it is a
             # UUID.
@@ -157,11 +208,11 @@ def take_action(self, parsed_args):
             else:
                 raise
 
-        data = compute_client.instance_action.list(server_id, **kwargs)
+        data = compute_client.server_actions(server_id, **kwargs)
 
         columns = (
             'request_id',
-            'instance_uuid',
+            'server_id',
             'action',
             'start_time',
         )
@@ -200,7 +251,7 @@ class ShowServerEvent(command.ShowOne):
     """
 
     def get_parser(self, prog_name):
-        parser = super(ShowServerEvent, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
             metavar='<server>',
@@ -214,13 +265,14 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
 
         try:
-            server_id = utils.find_resource(
-                compute_client.servers, parsed_args.server,
+            server_id = compute_client.find_server(
+                parsed_args.server,
+                ignore_missing=False,
             ).id
-        except exceptions.CommandError:
+        except sdk_exceptions.ResourceNotFound:
             # If we fail to find the resource, it is possible the server is
             # deleted. Try once more using the <server> arg directly if it is a
             # UUID.
@@ -229,8 +281,19 @@ def take_action(self, parsed_args):
             else:
                 raise
 
-        action_detail = compute_client.instance_action.get(
-            server_id, parsed_args.request_id
+        server_action = compute_client.get_server_action(
+            parsed_args.request_id, server_id,
+        )
+
+        column_headers, columns = _get_server_event_columns(
+            server_action, compute_client,
         )
 
-        return zip(*sorted(action_detail.to_dict().items()))
+        return (
+            column_headers,
+            utils.get_item_properties(
+                server_action,
+                columns,
+                formatters={'events': ServerActionEventColumn},
+            ),
+        )

openstackclient/tests/functional/compute/v2/test_server_event.py

@@ -50,7 +50,6 @@ def test_server_event_list_and_show(self):
             'server event show ' + self.server_name + ' ' + request_id,
             parse_output=True,
         )
-        self.assertEqual(self.server_id, cmd_output.get('instance_uuid'))
         self.assertEqual(request_id, cmd_output.get('request_id'))
         self.assertEqual('create', cmd_output.get('action'))
         self.assertIsNotNone(cmd_output.get('events'))
@@ -78,8 +77,6 @@ def test_server_event_list_and_show(self):
             'server event show ' + self.server_name + ' ' + request_id,
             parse_output=True,
         )
-
-        self.assertEqual(self.server_id, cmd_output.get('instance_uuid'))
         self.assertEqual(request_id, cmd_output.get('request_id'))
         self.assertEqual('reboot', cmd_output.get('action'))
         self.assertIsNotNone(cmd_output.get('events'))
@@ -116,7 +113,6 @@ def test_server_event_list_and_show_deleted_server(self):
             'server event show ' + server_id + ' ' + request_id,
             parse_output=True,
         )
-        self.assertEqual(server_id, cmd_output.get('instance_uuid'))
         self.assertEqual(request_id, cmd_output.get('request_id'))
         self.assertEqual('delete', cmd_output.get('action'))
         self.assertIsNotNone(cmd_output.get('events'))

openstackclient/tests/unit/compute/v2/fakes.py

@@ -23,6 +23,7 @@
 from openstack.compute.v2 import hypervisor as _hypervisor
 from openstack.compute.v2 import migration as _migration
 from openstack.compute.v2 import server as _server
+from openstack.compute.v2 import server_action as _server_action
 from openstack.compute.v2 import server_group as _server_group
 from openstack.compute.v2 import server_interface as _server_interface
 from openstack.compute.v2 import server_migration as _server_migration
@@ -593,45 +594,45 @@ def get_servers(servers=None, count=2):
         return mock.Mock(side_effect=servers)
 
 
-class FakeServerEvent(object):
-    """Fake one or more server event."""
+def create_one_server_action(attrs=None):
+    """Create a fake server action.
 
-    @staticmethod
-    def create_one_server_event(attrs=None):
-        """Create a fake server event.
-
-        :param attrs:
-            A dictionary with all attributes
-        :return:
-            A FakeResource object, with id and other attributes
-        """
-        attrs = attrs or {}
-
-        # Set default attributes
-        server_event_info = {
-            "instance_uuid": "server-event-" + uuid.uuid4().hex,
-            "user_id": "user-id-" + uuid.uuid4().hex,
-            "start_time": "2017-02-27T07:47:13.000000",
-            "request_id": "req-" + uuid.uuid4().hex,
-            "action": "create",
-            "message": None,
-            "project_id": "project-id-" + uuid.uuid4().hex,
-            "events": [{
-                "finish_time": "2017-02-27T07:47:25.000000",
-                "start_time": "2017-02-27T07:47:15.000000",
-                "traceback": None,
-                "event": "compute__do_build_and_run_instance",
-                "result": "Success"
-            }]
-        }
-        # Overwrite default attributes
-        server_event_info.update(attrs)
+    :param attrs: A dictionary with all attributes
+    :return: A fake openstack.compute.v2.server_action.ServerAction object
+    """
+    attrs = attrs or {}
 
-        server_event = fakes.FakeResource(
-            info=copy.deepcopy(server_event_info),
-            loaded=True,
-        )
-        return server_event
+    # Set default attributes
+    server_action_info = {
+        "server_id": "server-event-" + uuid.uuid4().hex,
+        "user_id": "user-id-" + uuid.uuid4().hex,
+        "start_time": "2017-02-27T07:47:13.000000",
+        "request_id": "req-" + uuid.uuid4().hex,
+        "action": "create",
+        "message": None,
+        "project_id": "project-id-" + uuid.uuid4().hex,
+        "events": [{
+            "finish_time": "2017-02-27T07:47:25.000000",
+            "start_time": "2017-02-27T07:47:15.000000",
+            "traceback": None,
+            "event": "compute__do_build_and_run_instance",
+            "result": "Success"
+        }]
+    }
+    # Overwrite default attributes
+    server_action_info.update(attrs)
+
+    # We handle events separately since they're nested resources
+    events = [
+        _server_action.ServerActionEvent(**event)
+        for event in server_action_info.pop('events')
+    ]
+
+    server_action = _server_action.ServerAction(
+        **server_action_info,
+        events=events,
+    )
+    return server_action
 
 
 class FakeService(object):