Add functional tests for OSC User Messages

Change-Id: I61be877428abd7787b8f9f52f93b7d522dc1fbd4
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>

manilaclient/tests/functional/osc/base.py

@@ -145,7 +145,8 @@ class OSCClientTestBase(base.ClientTestBase):
                      snapshot_id=None, properties=None, share_network=None,
                      description=None, public=False, share_type=None,
                      availability_zone=None, share_group=None,
-                     add_cleanup=True, client=None):
+                     add_cleanup=True, client=None,
+                     wait_for_status='available'):
 
         name = name or data_utils.rand_name('autotest_share_name')
         # share_type = dhss_false until we have implemented
@@ -176,7 +177,7 @@ class OSCClientTestBase(base.ClientTestBase):
 
         share_object = self.dict_result('share', cmd, client=client)
         self._wait_for_object_status(
-            'share', share_object['id'], 'available')
+            'share', share_object['id'], wait_for_status)
 
         if add_cleanup:
             self.addCleanup(

manilaclient/tests/functional/osc/test_messages.py

@@ -0,0 +1,103 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+
+from manilaclient.tests.functional.osc import base
+
+
+class MessagesCLITest(base.OSCClientTestBase):
+
+    def setUp(self):
+        super(MessagesCLITest, self).setUp()
+        # cause a user message by using an invalid share type for provisioning
+        st = self.create_share_type(extra_specs={'fake_key': 'fake_value'})
+        self.share = self.create_share(share_type=st['name'],
+                                       wait_for_status='error',
+                                       client=self.user_client)
+
+    def test_list_and_show_messages(self):
+        # Get all messages
+        messages = self.listing_result(
+            'share', 'message list', client=self.user_client)
+        # We must have at least one message
+        self.assertTrue(len(messages) > 0)
+        self.assertTableStruct(messages, [
+            'ID',
+            'Resource Type',
+            'Resource ID',
+            'Action ID',
+            'User Message',
+            'Detail ID',
+            'Created At',
+        ])
+
+        # grab the message we created
+        message = [msg for msg in messages
+                   if msg['Resource ID'] == self.share['id']]
+        self.assertEqual(1, len(message))
+
+        show_message = self.dict_result('share',
+                                        f'message show {message[0]["ID"]}')
+        self.addCleanup(self.openstack,
+                        f'share message delete {show_message["id"]}')
+        self.assertEqual(message[0]['ID'], show_message['id'])
+        expected_keys = (
+            'id', 'action_id', 'resource_id', 'detail_id', 'resource_type',
+            'created_at', 'expires_at', 'message_level', 'user_message',
+            'request_id',
+        )
+        for key in expected_keys:
+            self.assertIn(key, show_message)
+
+        # filtering by dates
+        since = show_message['created_at']
+        before = show_message['expires_at']
+        filtered_messages = self.listing_result(
+            'share',
+            f'message list --since {since} --before {before}',
+            client=self.user_client)
+        self.assertTrue(len(filtered_messages) > 0)
+        self.assertIn(show_message['id'],
+                      [m['ID'] for m in filtered_messages])
+
+        # filtering by message level
+        filtered_messages = self.listing_result(
+            'share',
+            f'message list --message-level {show_message["message_level"]}',
+            client=self.user_client)
+        self.assertTrue(len(filtered_messages) > 0)
+        self.assertIn(show_message['id'],
+                      [m['ID'] for m in filtered_messages])
+
+        # filtering by Resource ID
+        filtered_messages = self.listing_result(
+            'share',
+            f'message list --resource-id {self.share["id"]}',
+            client=self.user_client)
+        self.assertEqual(1, len(filtered_messages))
+        self.assertEqual(show_message['resource_id'], self.share["id"])
+
+    def test_delete_message(self):
+        messages = self.listing_result(
+            'share', 'message list', client=self.user_client)
+        message = [msg for msg in messages
+                   if msg['Resource ID'] == self.share['id']]
+        self.assertEqual(1, len(message))
+        message = message[0]
+
+        self.openstack(f'share message delete {message["ID"]}')
+
+        messages = self.listing_result(
+            'share', 'message list', client=self.user_client)
+        messages = [msg for msg in messages
+                    if msg['ID'] == message["ID"]]
+        self.assertEqual(0, len(messages))