volume: Migrate 'volume message *' to SDK

Change-Id: I174e1789eb4bc4b6dc7507e89ad0d63cb75fbc90
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/tests/unit/volume/v3/fakes.py

@@ -666,64 +666,6 @@ def create_one_sdk_volume(attrs=None):
     return _volume.Volume(**volume_info)
 
 
-def create_one_volume_message(attrs=None):
-    """Create a fake message.
-
-    :param attrs: A dictionary with all attributes of message
-    :return: A FakeResource object with id, name, status, etc.
-    """
-    attrs = attrs or {}
-
-    # Set default attribute
-    message_info = {
-        'created_at': '2016-02-11T11:17:37.000000',
-        'event_id': f'VOLUME_{random.randint(1, 999999):06d}',
-        'guaranteed_until': '2016-02-11T11:17:37.000000',
-        'id': uuid.uuid4().hex,
-        'message_level': 'ERROR',
-        'request_id': f'req-{uuid.uuid4().hex}',
-        'resource_type': 'VOLUME',
-        'resource_uuid': uuid.uuid4().hex,
-        'user_message': f'message-{uuid.uuid4().hex}',
-    }
-
-    # Overwrite default attributes if there are some attributes set
-    message_info.update(attrs)
-
-    return fakes.FakeResource(None, message_info, loaded=True)
-
-
-def create_volume_messages(attrs=None, count=2):
-    """Create multiple fake messages.
-
-    :param attrs: A dictionary with all attributes of message
-    :param count: The number of messages to be faked
-    :return: A list of FakeResource objects
-    """
-    messages = []
-    for n in range(0, count):
-        messages.append(create_one_volume_message(attrs))
-
-    return messages
-
-
-def get_volume_messages(messages=None, count=2):
-    """Get an iterable MagicMock object with a list of faked messages.
-
-    If messages list is provided, then initialize the Mock object with the
-    list. Otherwise create one.
-
-    :param messages: A list of FakeResource objects faking messages
-    :param count: The number of messages to be faked
-    :return An iterable Mock object with side_effect set to a list of faked
-        messages
-    """
-    if messages is None:
-        messages = create_volume_messages(count)
-
-    return mock.Mock(side_effect=messages)
-
-
 def create_one_volume_attachment(attrs=None):
     """Create a fake volume attachment.
 

openstackclient/tests/unit/volume/v3/test_volume_message.py

@@ -12,34 +12,24 @@
 
 from unittest.mock import call
 
+from openstack.block_storage.v3 import message as _message
+from openstack.test import fakes as sdk_fakes
 from osc_lib import exceptions
 
 from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
 from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
 from openstackclient.volume.v3 import volume_message
 
 
-class TestVolumeMessage(volume_fakes.TestVolume):
-    def setUp(self):
-        super().setUp()
-
-        self.projects_mock = self.identity_client.projects
-        self.projects_mock.reset_mock()
-
-        self.volume_messages_mock = self.volume_client.messages
-        self.volume_messages_mock.reset_mock()
-
-
-class TestVolumeMessageDelete(TestVolumeMessage):
-    fake_messages = volume_fakes.create_volume_messages(count=2)
+class TestVolumeMessageDelete(volume_fakes.TestVolume):
+    fake_messages = list(
+        sdk_fakes.generate_fake_resources(_message.Message, count=2)
+    )
 
     def setUp(self):
         super().setUp()
 
-        self.volume_messages_mock.get = volume_fakes.get_volume_messages(
-            self.fake_messages,
-        )
-        self.volume_messages_mock.delete.return_value = None
+        self.volume_sdk_client.delete_message.return_value = None
 
         # Get the command object to mock
         self.cmd = volume_message.DeleteMessage(self.app, None)
@@ -57,8 +47,8 @@ def test_message_delete(self):
 
         result = self.cmd.take_action(parsed_args)
 
-        self.volume_messages_mock.delete.assert_called_with(
-            self.fake_messages[0].id
+        self.volume_sdk_client.delete_message.assert_called_with(
+            self.fake_messages[0].id, ignore_missing=False
         )
         self.assertIsNone(result)
 
@@ -78,8 +68,8 @@ def test_message_delete_multiple_messages(self):
 
         calls = []
         for m in self.fake_messages:
-            calls.append(call(m.id))
-        self.volume_messages_mock.delete.assert_has_calls(calls)
+            calls.append(call(m.id, ignore_missing=False))
+        self.volume_sdk_client.delete_message.assert_has_calls(calls)
         self.assertIsNone(result)
 
     def test_message_delete_multiple_messages_with_exception(self):
@@ -95,8 +85,8 @@ def test_message_delete_multiple_messages_with_exception(self):
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
-        self.volume_messages_mock.delete.side_effect = [
-            self.fake_messages[0],
+        self.volume_sdk_client.delete_message.side_effect = [
+            None,
             exceptions.CommandError,
         ]
 
@@ -105,12 +95,14 @@ def test_message_delete_multiple_messages_with_exception(self):
         )
         self.assertEqual('Failed to delete 1 of 2 messages.', str(exc))
 
-        self.volume_messages_mock.delete.assert_any_call(
-            self.fake_messages[0].id
+        self.volume_sdk_client.delete_message.assert_any_call(
+            self.fake_messages[0].id, ignore_missing=False
+        )
+        self.volume_sdk_client.delete_message.assert_any_call(
+            'invalid_message', ignore_missing=False
         )
-        self.volume_messages_mock.delete.assert_any_call('invalid_message')
 
-        self.assertEqual(2, self.volume_messages_mock.delete.call_count)
+        self.assertEqual(2, self.volume_sdk_client.delete_message.call_count)
 
     def test_message_delete_pre_v33(self):
         self.set_volume_api_version('3.2')
@@ -131,9 +123,11 @@ def test_message_delete_pre_v33(self):
         )
 
 
-class TestVolumeMessageList(TestVolumeMessage):
+class TestVolumeMessageList(volume_fakes.TestVolume):
     fake_project = identity_fakes.FakeProject.create_one_project()
-    fake_messages = volume_fakes.create_volume_messages(count=3)
+    fake_messages = list(
+        sdk_fakes.generate_fake_resources(_message.Message, count=3)
+    )
 
     columns = (
         'ID',
@@ -165,8 +159,8 @@ class TestVolumeMessageList(TestVolumeMessage):
     def setUp(self):
         super().setUp()
 
-        self.projects_mock.get.return_value = self.fake_project
-        self.volume_messages_mock.list.return_value = self.fake_messages
+        self.identity_client.projects.get.return_value = self.fake_project
+        self.volume_sdk_client.messages.return_value = self.fake_messages
         # Get the command to test
         self.cmd = volume_message.ListMessages(self.app, None)
 
@@ -183,11 +177,8 @@ def test_message_list(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, data = self.cmd.take_action(parsed_args)
 
-        search_opts = {
-            'project_id': None,
-        }
-        self.volume_messages_mock.list.assert_called_with(
-            search_opts=search_opts,
+        self.volume_sdk_client.messages.assert_called_once_with(
+            project_id=None,
             marker=None,
             limit=None,
         )
@@ -214,11 +205,8 @@ def test_message_list_with_options(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
         columns, data = self.cmd.take_action(parsed_args)
 
-        search_opts = {
-            'project_id': self.fake_project.id,
-        }
-        self.volume_messages_mock.list.assert_called_with(
-            search_opts=search_opts,
+        self.volume_sdk_client.messages.assert_called_once_with(
+            project_id=self.fake_project.id,
             marker=self.fake_messages[0].id,
             limit=3,
         )
@@ -245,19 +233,19 @@ def test_message_list_pre_v33(self):
         )
 
 
-class TestVolumeMessageShow(TestVolumeMessage):
-    fake_message = volume_fakes.create_one_volume_message()
+class TestVolumeMessageShow(volume_fakes.TestVolume):
+    fake_message = sdk_fakes.generate_fake_resource(_message.Message)
 
     columns = (
-        'created_at',
-        'event_id',
-        'guaranteed_until',
-        'id',
-        'message_level',
-        'request_id',
-        'resource_type',
-        'resource_uuid',
-        'user_message',
+        'Created At',
+        'Event ID',
+        'Guaranteed Until',
+        'ID',
+        'Message Level',
+        'Request ID',
+        'Resource Type',
+        'Resource UUID',
+        'User Message',
     )
     data = (
         fake_message.created_at,
@@ -274,7 +262,7 @@ class TestVolumeMessageShow(TestVolumeMessage):
     def setUp(self):
         super().setUp()
 
-        self.volume_messages_mock.get.return_value = self.fake_message
+        self.volume_sdk_client.get_message.return_value = self.fake_message
         # Get the command object to test
         self.cmd = volume_message.ShowMessage(self.app, None)
 
@@ -286,7 +274,9 @@ def test_message_show(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        self.volume_messages_mock.get.assert_called_with(self.fake_message.id)
+        self.volume_sdk_client.get_message.assert_called_once_with(
+            self.fake_message.id
+        )
 
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)