Standardized the code (#200)

* Standardized the code

1. Added return statements in ops
2. Added docstrings for the same
3. Modified the docstrings that did not match the operation.
4. Changed class names for ops from snake_case to CamelCase.

Fixes: #172

Signed-off-by: aujjwal-redhat <[email protected]>

* added space

Signed-off-by: aujjwal-redhat <[email protected]>

Author: aujjwal-redhat

support/mixin.py

@@ -4,14 +4,13 @@
 """
 from support.rexe import Rexe
 from support.relog import Logger
-from support.ops.support_ops.io_ops import io_ops
-from support.ops.gluster_ops.peer_ops import peer_ops
+from support.ops.support_ops.io_ops import IoOps
+from support.ops.gluster_ops.peer_ops import PeerOps
 from support.ops.gluster_ops.volume_ops import VolumeOps
 from support.ops.gluster_ops.gluster_ops import GlusterOps
 
 
-# pylint: disable=W0107
-class RedantMixin(GlusterOps, VolumeOps, peer_ops, io_ops, Rexe, Logger):
+class RedantMixin(GlusterOps, VolumeOps, PeerOps, IoOps, Rexe, Logger):
     """
     A mixin class for redant project to encompass all ops and support
     modules.

support/ops/gluster_ops/gluster_ops.py

@@ -16,6 +16,15 @@ def start_glusterd(self, node, enable_retry: bool=True):
         Args:
             node (str|list): The node(s) on which the glusterd service
                              is to be started.
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
         cmd_fail = False
         error_msg = ""
@@ -43,12 +52,23 @@ def start_glusterd(self, node, enable_retry: bool=True):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def restart_glusterd(self, node: str, enable_retry: bool=True):
         """
         Restarts the glusterd service on the specified node or nodes.
         Args:
             node (str|list): The node(s) on which the glusterd service
                              is to be restarted.
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
         cmd_fail = False
         error_msg = ""
@@ -76,12 +96,23 @@ def restart_glusterd(self, node: str, enable_retry: bool=True):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def stop_glusterd(self, node):
         """
         Stops the glusterd service on the specified node(s).
         Args:
             node (str|list): The node on which the glusterd service
                         is to be stopped.
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
         cmd = "systemctl stop glusterd"
 
@@ -99,6 +130,8 @@ def stop_glusterd(self, node):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def reset_failed_glusterd(self, node) -> bool:
         """
         Glusterd has a burst limit of 5 times, hence TCs will
@@ -111,7 +144,14 @@ def reset_failed_glusterd(self, node) -> bool:
             reset-failed has to be run.
 
         Returns:
-            bool: True if successful on all servers or false.
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
         if not isinstance(node, list):
             node = [node]
@@ -128,6 +168,8 @@ def reset_failed_glusterd(self, node) -> bool:
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def is_glusterd_running(self, node: str) -> bool:
         """
         Checks the status of the glusterd service on the

support/ops/gluster_ops/peer_ops.py

@@ -1,13 +1,13 @@
 """
-This file contains one class - peer_ops which
+This file contains one class - PeerOps which
 holds APIS related to peers which will be called
 from the test case.
 """
 
 
-class peer_ops:
+class PeerOps:
     """
-    peer_ops class provides APIs to perform operations
+    PeerOps class provides APIs to perform operations
     like adding and deleting the peers,checking the status
     and list of peers in the pool.
     """

support/ops/gluster_ops/volume_ops.py

@@ -22,6 +22,16 @@ def volume_mount(self, server: str, volname: str,
             server (str): Hostname or IP address
             volname (str): Name of volume to be mounted
             path (str): The path of the mount directory(mount point)
+
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         cmd = f"mount -t glusterfs {server}:/{volname} {path}"
@@ -35,6 +45,8 @@ def volume_mount(self, server: str, volname: str,
             raise Exception(ret["error_msg"])
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
+
+        return ret
 
     def volume_unmount(self, path: str, node: str=None):
         """
@@ -45,6 +57,16 @@ def volume_unmount(self, path: str, node: str=None):
             server (str): Hostname or IP address
             volname (str): Name of volume to be mounted
             path (str): The path of the mount directory(mount point)
+        
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         cmd = f"umount {path}"
@@ -59,6 +81,7 @@ def volume_unmount(self, path: str, node: str=None):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
 
     def volume_create(self, volname: str, bricks_list: list,
                       node : str=None, force: bool = False,
@@ -84,6 +107,15 @@ def volume_create(self, volname: str, bricks_list: list,
                     - redundancy_count : (int)|None
                     - transport_type : tcp|rdma|tcp,rdma|None
                     - ...
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         replica = arbiter = stripe = disperse = disperse_data = redundancy = ''
@@ -128,16 +160,28 @@ def volume_create(self, volname: str, bricks_list: list,
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def volume_start(self, volname: str, node : str=None, force: bool = False):
         """
         Starts the gluster volume
         Args:
             node (str): Node on which cmd has to be executed.
             volname (str): volume name
+
         Kwargs:
             force (bool): If this option is set to True, then start volume
                 will get executed with force option. If it is set to False,
                 then start volume will get executed without force option
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         if force:
@@ -155,6 +199,8 @@ def volume_start(self, volname: str, node : str=None, force: bool = False):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def volume_stop(self, volname: str, node : str=None, force: bool = False):
         """
         Stops the gluster volume
@@ -165,6 +211,15 @@ def volume_stop(self, volname: str, node : str=None, force: bool = False):
             force (bool): If this option is set to True, then start volume
                 will get executed with force option. If it is set to False,
                 then start volume will get executed without force option
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         if force:
@@ -181,6 +236,7 @@ def volume_stop(self, volname: str, node : str=None, force: bool = False):
             raise Exception(ret['msg']['opErrstr'])
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
+        return ret
 
     def volume_delete(self, volname: str,node : str=None):
         """
@@ -189,6 +245,15 @@ def volume_delete(self, volname: str,node : str=None):
         Args:
             node (str): Node on which cmd has to be executed.
             volname (str): volume name
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         cmd = f"gluster volume delete {volname} --mode=script --xml"
@@ -203,6 +268,8 @@ def volume_delete(self, volname: str,node : str=None):
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
 
+        return ret
+
     def get_volume_info(self, node : str=None, volname: str = 'all') -> dict:
         """
         Gives volume information
@@ -347,6 +414,15 @@ def volume_reset(self, volname: str, node : str=None, force : bool=False):
                 then reset volume will get executed without force option
         Example:
             volume_reset("testvol",server)
+
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
         
         """  
         if force:
@@ -363,6 +439,8 @@ def volume_reset(self, volname: str, node : str=None, force : bool=False):
             raise Exception(ret['msg']['opErrstr'])
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
+
+        return ret
 
     def get_volume_status(self,node : str=None,volname : str='all',
                          service : str='',options : str='') -> dict:
@@ -520,6 +598,16 @@ def set_volume_options(self, volname : str, options : str, node : str=None):
         Example:
             options = {"user.cifs":"enable","user.smb":"enable"}
             set_volume_options("test-vol1", options, server)
+
+        Returns:
+        ret: A dictionary consisting
+            - Flag : Flag to check if connection failed
+            - msg : message
+            - error_msg: error message
+            - error_code: error code returned
+            - cmd : command that got executed
+            - node : node on which the command got executed
+
         """
 
         volume_options = options
@@ -552,6 +640,8 @@ def set_volume_options(self, volname : str, options : str, node : str=None):
                 raise Exception(ret['msg']['opErrstr'])
 
             self.logger.info(f"Successfully ran {cmd} on {node}")
+
+        return ret
 
     def reset_volume_option(self, volname : str, option : str,
                             node : str=None, force : bool=False):
@@ -567,6 +657,16 @@ def reset_volume_option(self, volname : str, option : str,
                 then reset volume will get executed without force option
         Example:
             reset_volume_option("test-vol1", "option", server)
+        
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         if force:
@@ -582,7 +682,9 @@ def reset_volume_option(self, volname : str, option : str,
             raise Exception(ret['msg']['opErrstr'])
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
-            
+        
+        return ret
+
     def volume_sync(self, hostname : str, node: str, volname : str='all'):
         """
         Sync the volume to the specified host
@@ -593,6 +695,16 @@ def volume_sync(self, hostname : str, node: str, volname : str='all'):
             volname (str): volume name. Defaults to 'all'.
         Example:
             volume_sync(volname="testvol",server)
+        
+        Returns:
+            ret: A dictionary consisting
+                - Flag : Flag to check if connection failed
+                - msg : message
+                - error_msg: error message
+                - error_code: error code returned
+                - cmd : command that got executed
+                - node : node on which the command got executed
+
         """
 
         cmd = f"gluster volume sync {hostname} {volname} --mode=script --xml"
@@ -605,3 +717,5 @@ def volume_sync(self, hostname : str, node: str, volname : str='all'):
             raise Exception(ret['msg']['opErrstr'])
 
         self.logger.info(f"Successfully ran {cmd} on {node}")
+
+        return ret