Renamed support to common and handled the imports and md file referen…

…ces (gluster#215) * Renamed support to common * Modified imports in various files * Modified references in .md files Fixes : gluster#213 Signed-off-by: aujjwal-redhat <[email protected]>
nishith-vihar · Apr 22, 2021 · b3625b9 · b3625b9
1 parent 1c3dc3c
commit b3625b9
Show file tree

Hide file tree

Showing 22 changed files with 33 additions and 33 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -15,7 +15,7 @@ Contributing Conventions:
 
 1. Include descriptive PR titles with [<component-name>] prepended.
 2. Build and test your changes before submitting a PR. 
-3. If logging then check the logging.md file in ops/support_ops
+3. If logging then check the logging.md file in common/
 4. Remember to check the linting issues beforehand as well to prevent your checks from failing.
 5. Remember to sign-off your commits
 

diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -28,6 +28,6 @@ jobs:
       - name: Lint with Pylint
         run: |
           pylint $(pwd)/core/
-          pylint $(pwd)/support/
+          pylint $(pwd)/common/
           pylint $(pwd)/tests/
 
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ Design Doc Link : [Gluster-test Design-doc](https://docs.google.com/document/d/1
 ### Structure:
 
 core: contains the core redant framework which includes parsing,test_list_builder,test_runner,runner_thread and redant_main.<br>
-support: consists of the libs and ops that will help in running the test cases and the mixin class.<br>
+common: consists of the libs and ops that will help in running the test cases and the mixin class.<br>
 tests: holds the test cases as performace and functional tests and includes parent test. Add any new test cases here.<br>
 
 ### To start Working:

diff --git a/support/__init__.py → common/__init__.py b/support/__init__.py → common/__init__.py
diff --git a/support/logging.md → common/logging.md b/support/logging.md → common/logging.md
diff --git a/support/mixin.md → common/mixin.md b/support/mixin.md → common/mixin.md
@@ -69,9 +69,9 @@ Once the above support library is created, one needs to add the module inside th
 let the `mixin` class inherit from this newly added class.
 
 ```
-from support.ops.support_ops.rexe import Rexe
-from support.ops.gluster_ops.sample_ops1 import sample_ops_class # the newly added module
-from support.ops.gluster_ops.sample_ops2 import sample_ops2_class 
+from common.ops.support_ops.rexe import Rexe
+from common.ops.gluster_ops.sample_ops1 import sample_ops_class # the newly added module
+from common.ops.gluster_ops.sample_ops2 import sample_ops2_class 
 
 class mixin(Rexe, sample_ops_class, sample_ops2_class):
 	pass

diff --git a/common/mixin.py b/common/mixin.py
@@ -0,0 +1,18 @@
+"""
+    Module Name:
+    Purpose: Refer to the redhat_mixin.md for more information
+"""
+from common.rexe import Rexe
+from common.relog import Logger
+from common.ops.support_ops.io_ops import IoOps
+from common.ops.gluster_ops.peer_ops import PeerOps
+from common.ops.gluster_ops.volume_ops import VolumeOps
+from common.ops.gluster_ops.gluster_ops import GlusterOps
+
+
+class RedantMixin(GlusterOps, VolumeOps, PeerOps, IoOps, Rexe, Logger):
+    """
+    A mixin class for redant project to encompass all ops and support
+    modules.
+    """
+    pass
diff --git a/support/ops/OPS_README.md → common/ops/OPS_README.md b/support/ops/OPS_README.md → common/ops/OPS_README.md
diff --git a/support/ops/__init__.py → common/ops/__init__.py b/support/ops/__init__.py → common/ops/__init__.py
diff --git a/support/ops/abstract_ops.py → common/ops/abstract_ops.py b/support/ops/abstract_ops.py → common/ops/abstract_ops.py
diff --git a/support/ops/gluster_ops/__init__.py → common/ops/gluster_ops/__init__.py b/support/ops/gluster_ops/__init__.py → common/ops/gluster_ops/__init__.py
diff --git a/support/ops/gluster_ops/gluster_ops.py → common/ops/gluster_ops/gluster_ops.py b/support/ops/gluster_ops/gluster_ops.py → common/ops/gluster_ops/gluster_ops.py
@@ -3,7 +3,7 @@
 operations on the glusterd service on the server
 or the client.
 """
-from support.ops.abstract_ops import AbstractOps
+from common.ops.abstract_ops import AbstractOps
 
 
 class GlusterOps(AbstractOps):

diff --git a/support/ops/gluster_ops/peer_ops.py → common/ops/gluster_ops/peer_ops.py b/support/ops/gluster_ops/peer_ops.py → common/ops/gluster_ops/peer_ops.py
@@ -5,7 +5,7 @@
 """
 
 import socket
-from support.ops.abstract_ops import AbstractOps
+from common.ops.abstract_ops import AbstractOps
 
 class PeerOps(AbstractOps):
     """

diff --git a/support/ops/gluster_ops/volume_ops.py → common/ops/gluster_ops/volume_ops.py b/support/ops/gluster_ops/volume_ops.py → common/ops/gluster_ops/volume_ops.py
@@ -3,7 +3,7 @@
 holds volume related APIs which will be called
 from the test case.
 """
-from support.ops.abstract_ops import AbstractOps
+from common.ops.abstract_ops import AbstractOps
 
 
 class VolumeOps(AbstractOps):

diff --git a/support/ops/support_ops/__init__.py → common/ops/support_ops/__init__.py b/support/ops/support_ops/__init__.py → common/ops/support_ops/__init__.py
diff --git a/support/ops/support_ops/io_ops.py → common/ops/support_ops/io_ops.py b/support/ops/support_ops/io_ops.py → common/ops/support_ops/io_ops.py
@@ -2,7 +2,7 @@
 This file contains one class - IoOps which
 holds API for running all the IO commands.
 """
-from support.ops.abstract_ops import AbstractOps
+from common.ops.abstract_ops import AbstractOps
 
 
 class IoOps(AbstractOps):

diff --git a/support/relog.py → common/relog.py b/support/relog.py → common/relog.py
diff --git a/support/rexe.py → common/rexe.py b/support/rexe.py → common/rexe.py
diff --git a/core/redant_main.py b/core/redant_main.py
@@ -72,7 +72,7 @@ def main():
 
     # Creating log dirs.
     sys.path.insert(1, ".")
-    from support.relog import Logger
+    from common.relog import Logger
     args.log_dir = f'{args.log_dir}/{datetime.datetime.now()}'
     Logger.log_dir_creation(args.log_dir, test_cases_component,
                             test_cases_dict)

diff --git a/support/mixin.py b/support/mixin.py
diff --git a/tests/parent_test.py b/tests/parent_test.py
@@ -1,6 +1,6 @@
 import traceback
 import abc
-from support.mixin import RedantMixin
+from common.mixin import RedantMixin
 from datetime import datetime
 
 

diff --git a/tools/linting.sh b/tools/linting.sh
@@ -10,9 +10,9 @@ perform_linting () {
         pylint -j 4 --rcfile=.pylintrc ./tests/example/sample_component
         pylint -j 4 --rcfile=.pylintrc ./tests/functional
         pylint -j 4 --rcfile=.pylintrc ./tests/functional/glusterd
-        pylint -j 4 --rcfile=.pylintrc ./support
-        pylint -j 4 --rcfile=.pylintrc ./support/ops/gluster_ops
-        pylint -j 4 --rcfile=.pylintrc ./support/ops/support_ops
+        pylint -j 4 --rcfile=.pylintrc ./common
+        pylint -j 4 --rcfile=.pylintrc ./common/ops/gluster_ops
+        pylint -j 4 --rcfile=.pylintrc ./common/ops/support_ops
     else
         pylint -j 4 --rcfile=.pylintrc $FILEPATH
     fi