Avoid a global by placing the "global" template store in request context.

Author: albu-diku

mig/lib/templates/__init__.py

@@ -46,7 +46,6 @@
 _all_template_dirs = [
     TEMPLATES_DIR,
 ]
-_global_store = None
 
 
 def _clear_global_store():
@@ -147,15 +146,16 @@ def populated(template_dirs, cache_dir=None, context=None):
 
 
 def init_global_templates(configuration, _templates_dirs=template_dirs):
-    global _global_store
+    _context = configuration.context()
 
-    if _global_store is not None:
-        return _global_store
+    try:
+        return configuration.context(namespace='templates')
+    except KeyError as exc:
+        pass
 
-    _global_store = TemplateStore.populated(
+    store = TemplateStore.populated(
         _templates_dirs(),
         cache_dir=cache_dir(),
         context=_FormatContext(configuration)
     )
-
-    return _global_store
+    return configuration.context_set(store, namespace='templates')

mig/shared/configuration.py

@@ -716,6 +716,7 @@ def __init__(self, config_file, verbose=False, skip_log=False,
                  disable_auth_log=False):
         self.config_file = config_file
         self.mig_server_id = None
+        self._context = None
 
         configuration_options = copy.deepcopy(_CONFIGURATION_DEFAULTS)
 
@@ -727,6 +728,23 @@ def __init__(self, config_file, verbose=False, skip_log=False,
                                disable_auth_log=disable_auth_log,
                                _config_file=config_file)
 
+    def context(self, namespace=None):
+        if self._context is None:
+            self._context = {}
+        if namespace is None:
+            return self._context
+        try:
+            return self._context[namespace]
+        except KeyError:
+            raise
+
+    def context_set(self, value, namespace=None):
+        assert namespace is not None
+
+        context = self.context()
+        context[namespace] = value
+        return value
+
     def reload_config(self, verbose, skip_log=False, disable_auth_log=False,
                       _config_file=None):
         """Re-read and parse configuration file. Optional skip_log arg

tests/test_mig_shared_configuration.py

@@ -41,7 +41,7 @@ def _is_method(value):
 
 def _to_dict(obj):
     return {k: v for k, v in inspect.getmembers(obj)
-            if not (k.startswith('__') or _is_method(v))}
+            if not (k.startswith('_') or _is_method(v))}
 
 
 class MigSharedConfiguration(MigTestCase):

tests/test_mig_wsgibin.py

@@ -50,9 +50,9 @@
 
 
 def _force_test_templates(configuration):
-    from mig.lib.templates import init_global_templates, _clear_global_store
-    _clear_global_store()
+    from mig.lib.templates import init_global_templates
     test_tmpl_dir = os.path.join(TEST_DATA_DIR, 'templates')
+    # populate current context with a template store backed onto test templates
     init_global_templates(configuration, _templates_dirs=lambda: [test_tmpl_dir])