qa/cephfs: add log entries for caps_helper.py

The intention is to make logs contain some information of what's being
done by caps_helper.py regardless of which test/method is calling it.
This should make logs more understandable and also add hints for
future debugging.

Signed-off-by: Rishabh Dave <ridave@redhat.com>

diff --git a/qa/tasks/cephfs/caps_helper.py b/qa/tasks/cephfs/caps_helper.py
index 64cec67fcecf5421b17bd1e8c3dcd7c9f1c4eca7..2eeb49a8dba9be893644e80dd019bc9f3047e10b 100644 (file)
--- a/qa/tasks/cephfs/caps_helper.py
+++ b/qa/tasks/cephfs/caps_helper.py
@@ -2,12 +2,16 @@
 Helper methods to test that MON and MDS caps are enforced properly.
 """
 from os.path import join as os_path_join
+from logging import getLogger
 
 from tasks.cephfs.cephfs_test_case import CephFSTestCase
 
 from teuthology.orchestra.run import Raw
 
 
+log = getLogger(__name__)
+
+
 class CapTester(CephFSTestCase):
     """
     Test that MON and MDS caps are enforced.
@@ -48,6 +52,8 @@ class CapTester(CephFSTestCase):
             testpath = ''
 
         for mount_x in mounts:
+            log.info(f'creating test file on FS {mount_x.cephfs_name} '
+                     f'mounted at {mount_x.mountpoint}...')
             dirpath = os_path_join(mount_x.hostfs_mntpt, testpath, dirname)
             mount_x.run_shell(f'mkdir {dirpath}')
             filepath = os_path_join(dirpath, filename)
@@ -62,6 +68,7 @@ class CapTester(CephFSTestCase):
                         f'hostfs_mntpt = {mount_x.hostfs_mntpt}')
             mount_x.write_file(filepath, filedata)
             self.test_set.append((mount_x, filepath, filedata))
+            log.info('test file created at {path} with data "{data}.')
 
     def run_cap_tests(self, perm, mntpt=None):
         # TODO
@@ -109,12 +116,23 @@ class CapTester(CephFSTestCase):
 
         fsls = get_cluster_cmd_op(
             args=f'fs ls --id {client_id} -k {keyring_path}')
+        log.info(f'output of fs ls cmd run by client.{client_id} -\n{fsls}')
 
         if 'fsname=' not in moncap:
+            log.info('no FS name is mentioned in moncap, client has '
+                     'permission to list all files. moncap -\n{moncap}')
+            log.info('testing for presence of all FS names in output of '
+                     '"fs ls" command run by client.')
+
             fsls_admin = get_cluster_cmd_op(args='fs ls')
+            log.info('output of fs ls cmd run by admin -\n{fsls_admin}')
+
             self.assertEqual(fsls, fsls_admin)
             return
 
+        log.info('FS names are mentioned in moncap. moncap -\n{moncap}')
+        log.info('testing for presence of these FS names in output of '
+                 '"fs ls" command run by client.')
         for fsname in self._get_fsnames_from_moncap(moncap):
             self.assertIn('name: ' + fsname, fsls)
 
@@ -144,14 +162,22 @@ class CapTester(CephFSTestCase):
 
     def conduct_pos_test_for_read_caps(self):
         for mount, path, data in self.test_set:
+            log.info(f'test read perm: read file {path} and expect data '
+                     f'"{data}"')
             contents = mount.read_file(path)
             self.assertEqual(data, contents)
+            log.info(f'read perm was tested successfully: "{data}" was '
+                     f'successfully read from path {path}')
 
     def conduct_pos_test_for_write_caps(self):
         for mount, path, data in self.test_set:
+            log.info(f'test write perm: try writing data "{data}" to '
+                     f'file {path}.')
             mount.write_file(path=path, data=data)
             contents = mount.read_file(path=path)
             self.assertEqual(data, contents)
+            log.info(f'write perm was tested was successfully: data '
+                     f'"{data}" was successfully written to file "{path}".')
 
     def conduct_neg_test_for_write_caps(self):
         possible_errmsgs = ('permission denied', 'operation not permitted')
@@ -159,6 +185,8 @@ class CapTester(CephFSTestCase):
 
         # don't use data, cmd args to write are set already above.
         for mount, path, data in self.test_set:
+            log.info('test absence of write perm: expect failure '
+                     f'writing data to file {path}.')
             cmdargs.append(path)
             mount.negtestcmd(args=cmdargs, retval=1, errmsgs=possible_errmsgs)
             cmdargs.pop(-1)