Updated comments

AMWA-TV · May 3, 2024 · ee57347 · ee57347
1 parent ddb1e7f
commit ee57347
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 7 deletions.
diff --git a/nmostesting/suites/IS1201Test.py b/nmostesting/suites/IS1201Test.py
@@ -29,7 +29,9 @@
 
 
 class IS1201Test(MS0501Test):
-
+    """
+    Runs Tests covering MS-05 and IS-12
+    """
     def __init__(self, apis, **kwargs):
         self.is12_utils = IS12Utils(apis)
         MS0501Test.__init__(self, apis, self.is12_utils, **kwargs)

diff --git a/nmostesting/suites/IS1202Test.py b/nmostesting/suites/IS1202Test.py
@@ -18,7 +18,9 @@
 
 
 class IS1202Test(MS0502Test):
-
+    """
+    Runs Invasive Tests covering MS-05 and IS-12
+    """
     def __init__(self, apis, **kwargs):
         self.is12_utils = IS12Utils(apis)
         MS0502Test.__init__(self, apis, self.is12_utils, **kwargs)

diff --git a/nmostesting/suites/IS1401Test.py b/nmostesting/suites/IS1401Test.py
@@ -19,7 +19,7 @@
 
 class IS1401Test(MS0501Test):
     """
-    Runs IS-04-01-Test
+    Runs Tests covering MS-05 and IS-14
     """
     def __init__(self, apis, **kwargs):
         MS0501Test.__init__(self, apis, IS14Utils(apis), **kwargs)

diff --git a/nmostesting/suites/IS1402Test.py b/nmostesting/suites/IS1402Test.py
@@ -18,7 +18,7 @@
 
 class IS1402Test(MS0502Test):
     """
-    Runs IS-04-01-Test
+    Runs Invasive Tests covering MS-05 and IS-12
     """
     def __init__(self, apis, **kwargs):
         MS0502Test.__init__(self, apis, IS14Utils(apis), **kwargs)

diff --git a/nmostesting/suites/MS0501Test.py b/nmostesting/suites/MS0501Test.py
@@ -19,7 +19,7 @@
     NcMethodStatus, NcObjectProperties, StandardClassIds
 from ..TestResult import Test
 
-# Note: this test suite is used by the IS12 and IS14 test suites
+# Note: this test suite is a base class for the IS1201Test and IS1401Test test suites
 # where there are common MS-05 tests.  The test suite is not configured and
 # instantiated in the same way as the other test suites.  This is
 # explicitly instantiated by the IS-12 and IS-14 test suites
@@ -29,7 +29,9 @@
 
 
 class MS0501Test(GenericTest):
-
+    """
+    Runs Tests covering MS-05
+    """
     def __init__(self, apis, utils, **kwargs):
         # Remove the RAML key to prevent this test suite from auto-testing IS-04 API
         apis[NODE_API_KEY].pop("raml", None)

diff --git a/nmostesting/suites/MS0502Test.py b/nmostesting/suites/MS0502Test.py
@@ -28,9 +28,16 @@
 MS05_API_KEY = "controlframework"
 FEATURE_SETS_KEY = "featuresets"
 
+# Note: this test suite is a base class for the IS1202Test and IS1402Test test suites
+# where there are common MS-05 tests.  The test suite is not configured and
+# instantiated in the same way as the other test suites.  This is
+# explicitly instantiated by the IS-12 and IS-14 test suites
 
-class MS0502Test(ControllerTest):
 
+class MS0502Test(ControllerTest):
+    """
+    Runs Invasive Tests covering MS-05
+    """
     def __init__(self, apis, utils, **kwargs):
         ControllerTest.__init__(self, apis, **kwargs)
         self.ms05_utils = utils