diff --git a/spinnaker_testbase/base_test_case.py b/spinnaker_testbase/base_test_case.py index 2a9cac6..b4e9c5f 100644 --- a/spinnaker_testbase/base_test_case.py +++ b/spinnaker_testbase/base_test_case.py @@ -23,6 +23,9 @@ class BaseTestCase(RootTestCase): + """ + This extends unittest.TestCase to offer extra functions as needed. + """ def setUp(self): self._setUp(sys.modules[self.__module__].__file__) diff --git a/spinnaker_testbase/root_script_builder.py b/spinnaker_testbase/root_script_builder.py index 7c60dee..5f84247 100644 --- a/spinnaker_testbase/root_script_builder.py +++ b/spinnaker_testbase/root_script_builder.py @@ -24,6 +24,9 @@ class RootScriptBuilder(object): + """ + Looks for example scripts that can be made into Integeration tests. + """ def add_script(self, test_file, name, local_path, skip_imports): """ diff --git a/spinnaker_testbase/root_test_case.py b/spinnaker_testbase/root_test_case.py index c5bde22..756b6d8 100644 --- a/spinnaker_testbase/root_test_case.py +++ b/spinnaker_testbase/root_test_case.py @@ -29,6 +29,10 @@ class RootTestCase(unittest.TestCase): + """ + This holds the code shared by the all test and script checkers + + """ def _setUp(self, script): # Remove random effect for testing diff --git a/spinnaker_testbase/script_checker.py b/spinnaker_testbase/script_checker.py index 625f435..52b3378 100644 --- a/spinnaker_testbase/script_checker.py +++ b/spinnaker_testbase/script_checker.py @@ -32,6 +32,9 @@ def mockshow(): class ScriptChecker(RootTestCase): + """ + Will run a script. Typically as part of Integration Tests. + """ def script_path(self, script): class_file = sys.modules[self.__module__].__file__ diff --git a/spinnaker_testbase/test_no_job_destroy.py b/spinnaker_testbase/test_no_job_destroy.py index e426ccb..f8ec21f 100644 --- a/spinnaker_testbase/test_no_job_destroy.py +++ b/spinnaker_testbase/test_no_job_destroy.py @@ -18,6 +18,10 @@ class TestNoJobDestory(BaseTestCase): + """ + Used by Jenkins to check if a job was destroyed or something else wrote + to the error file. + """ def test_no_destory_file(self): if os.path.exists(self.error_file()):