appease checks on CI by reworking some code for pylint's benefit alone

Author: albu-diku

mig/shared/conf.py

@@ -257,8 +257,3 @@ def get_all_store_vgrids(unique_resource_name):
     store_vgrids = dict([(store['name'], store['vgrid'])
                         for store in store_units])
     return store_vgrids
-
-
-def is_configuration_like(obj):
-    """Does the given object quack like a MiG Configuration."""
-    return Configuration.is_configuration_like(obj)

tests/support/__init__.py

@@ -210,10 +210,11 @@ def _reset_logging(self, stream):
     @staticmethod
     def _make_configuration_instance(testcase, configuration_to_make):
         from mig.shared.conf import RuntimeConfiguration, \
-                                    get_configuration_object, \
-                                    is_configuration_like
-        if is_configuration_like(configuration_to_make):
-            return configuration_to_make
+                                    get_configuration_object
+        if configuration_to_make == 'preexisting':
+            configuration = testcase._configuration
+            assert isinstance(configuration, RuntimeConfiguration)
+            return configuration
         elif configuration_to_make == 'fakeconfig':
             fake_configuration = FakeConfiguration(logger=testcase.logger)
             return RuntimeConfiguration(fake_configuration)
@@ -233,14 +234,17 @@ def _provide_configuration(self):
     def configuration(self):
         """Init a fake configuration if not already done"""
 
-        if self._configuration is not None:
-            return self._configuration
-
         configuration_to_make = self._provide_configuration()
 
         if configuration_to_make == 'unspecified':
             raise AssertionError(
                 "configuration access but testcase did not request it")
+        elif configuration_to_make == 'preexisting':
+            # unconditionally proceed so as to be certain that a valid
+            # configuration has been supplied and get it instrumented
+            pass
+        elif self._configuration is not None:
+            return self._configuration
 
         configuration_instance = self._make_configuration_instance(
             self, configuration_to_make)

tests/support/fakes.py

@@ -30,6 +30,10 @@
 
 """Fake implementations of various assistant functionality used by MiG logic."""
 
+
+__INSTRUMENTED_MARKER = "__" + __name__
+
+
 class FakeSendEmail:
     def __init__(self):
         self.calls = []
@@ -112,8 +116,14 @@ def instrument_test_case(mig_test_case=None, mig_configuration=None):
     assert inspect.ismethod(getattr(mig_configuration, 'context_set', None)), \
             "supplied configuration must be usable at runtime"
 
+    maybe_marker = getattr(mig_configuration, __INSTRUMENTED_MARKER, None)
+    if maybe_marker is __INSTRUMENTED_MARKER:
+        return
+
     fakes_by_context_key = {
         'notifier': make_fake_notifier(mig_test_case=mig_test_case),
     }
     for content_key, context_value in fakes_by_context_key.items():
         mig_configuration.context_set(content_key, context_value)
+
+    setattr(mig_configuration, __INSTRUMENTED_MARKER, __INSTRUMENTED_MARKER)

tests/test_mig_lib_templates.py

@@ -28,10 +28,7 @@ def before_each(self):
 
         # allow the dummy plugin to be loaded
         sys.path.append(TEST_DATA_DIR)
-
-    def after_each(self):
-        # undo changes to path for dummy plugin
-        sys.path.pop()
+        self._register_check(lambda: sys.path.pop())
 
     def _provide_configuration(self):
         return 'testconfig'
@@ -131,12 +128,12 @@ class TestMigSharedTemplates_cli(MigTestCase):
     def before_each(self):
         self.test_conf_file = os.path.join(
             TEST_DATA_DIR, 'MiGserver--templates.conf')
+
         # allow the dummy plugin to be loaded
         sys.path.append(TEST_DATA_DIR)
+        self._register_check(lambda: sys.path.pop())
 
     def after_each(self):
-        # undo changes to path for dummy plugin
-        sys.path.pop()
         # clean up the configuration file specified cache directory
         shutil.rmtree(DUMMY_CACHE_DIR, ignore_errors=True)
 

tests/test_mig_shared_functionality_tmplinterface.py

@@ -74,13 +74,16 @@ class MigSharedFunctionalityTmplInterface__basics(MigTestCase, SnapshotAssertMix
     TEST_CONF_FILE = os.path.join(TEST_DATA_DIR, 'MiGserver--templates.conf')
 
     def _provide_configuration(self):
-        return get_configuration_object(
-            self.TEST_CONF_FILE, skip_log=True, disable_auth_log=True)
+        return 'preexisting'
 
     def before_each(self):
+        self._configuration = get_configuration_object(
+            self.TEST_CONF_FILE, skip_log=True, disable_auth_log=True)
+
         # clean up the configuration file specified cache directory
         shutil.rmtree(DUMMY_CACHE_DIR, ignore_errors=True)
 
+        # allow the dummy plugin to be loaded
         sys.path.append(TEST_DATA_DIR)
         self._register_check(lambda: sys.path.pop())
 

tests/test_mig_wsgibin.py

@@ -285,6 +285,7 @@ def _arrange_use_of_testplugin(self):
         # provision template directories
         os.makedirs(TEST_TEMPLATE_CACHE_DIR)
 
+        # allow the dummy plugin to be loaded
         sys.path.append(TEST_DATA_DIR)
         self._register_check(lambda: sys.path.pop())