Add support for adding request contextual data to configuration objects.

mig/shared/configuration.py

@@ -1,3 +1,3 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
@@ -20,7 +20,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 # -- END_HEADER ---
 #
@@ -31,12 +31,12 @@
 from __future__ import print_function
 from future import standard_library
 from builtins import range
 from builtins import object
 
 import base64
 import copy
 import datetime
 import functools
 import os
 import pwd
 import re
@@ -68,7 +68,7 @@
         valid_filter_methods, default_twofactor_auth_apps, \
         mig_conf_section_dirname
     from mig.shared.logger import Logger, SYSLOG_GDP
     from mig.shared.htmlgen import menu_items, vgrid_items
     from mig.shared.fileio import read_file, load_json, write_file
 except ImportError as ioe:
     print("could not import migrid modules")
@@ -130,7 +130,7 @@
         return val
     # logger.debug("expand any ENV and FILE content in %r" % val)
     env_pattern = "[a-zA-Z][a-zA-Z0-9_]+"
     cache_pattern = file_pattern = "[^ ]+"
     expanded = val
     expand_pairs = [(keyword_env, env_pattern), (keyword_file, file_pattern)]
     for (key, pattern) in expand_pairs:
@@ -158,7 +158,7 @@
                     #    "reading conf content from file in %r" % cache)
                     content = read_file(path, logger)
                     if cache and content:
                         # logger.debug("caching conf content salt in %r" % cache)
                         write_file(content, cache, logger)
                 if not content:
                     logger.warning("salt file not found or empty: %s" % path)
@@ -179,7 +179,7 @@
     return expanded
 
 
 def fix_missing(config_file, verbose=True):
     """Add missing configuration options - used by checkconf script"""
 
     config = ConfigParser()
@@ -232,7 +232,7 @@
         'server_home': '~/state/server_home/',
         'webserver_home': '~/state/webserver_home/',
         'sessid_to_mrsl_link_home': '~/state/sessid_to_mrsl_link_home/',
         'sessid_to_jupyter_mount_link_home': '~/state/sessid_to_jupyter_mount_link_home/',
         'mig_system_files': '~/state/mig_system_files/',
         'mig_system_storage': '~/state/mig_system_storage',
         'mig_system_run': '~/state/mig_system_run/',
@@ -371,7 +371,7 @@
         'architectures': 'X86 AMD64 IA64 SPARC SPARC64 ITANIUM SUN4U SPARC-T1',
         'scriptlanguages': 'sh python java',
         'jobtypes': 'batch interactive bulk all',
         'lrmstypes': 'Native Native-execution-leader Batch Batch-execution-leader',
     }
     scheduler_section = {'algorithm': 'FairFit',
                          'expire_after': '99999999999',
@@ -409,7 +409,7 @@
         'QUOTA': quota_section,
     }
     for section in defaults:
         if not section in config.sections():
             config.add_section(section)
 
     modified = False
@@ -423,7 +423,7 @@
                 modified = True
     if modified:
         backup_path = '%s.%d' % (config_file, time.time())
         print('Backing up existing configuration to %s as update removes all comments'
               % backup_path)
         fd = open(config_file, 'r')
         backup_fd = open(backup_path, 'w')
@@ -711,7 +711,7 @@
                        'VERIFYFILES', 'VGRID', 'SANDBOX'],
     'job_cond_yellow': ['DISK', 'MEMORY', 'CPUTIME'],
     'job_cond_orange': ['CPUCOUNT', 'NODECOUNT'],
     'job_cond_red': ['EXECUTABLES', 'INPUTFILES', 'REGISTERED', 'SEEN_WITHIN_X'],
     'enable_suggest': False,
     'suggest_threshold': 'GREEN',
 
@@ -755,12 +755,13 @@
     def __init__(self, config_file, verbose=False, skip_log=False,
                  disable_auth_log=False):
         self.config_file = config_file
         self.mig_server_id = None
         # Explicitly init a few helpers hot-plugged and used in ways where it's
         # less obvious if they are always guaranteed to already be initialized.
         self.default_page = None
         self.auth_logger_obj = None
         self.gdp_logger_obj = None
+        self._context = None
 
         configuration_options = copy.deepcopy(_CONFIGURATION_DEFAULTS)
 
@@ -772,6 +773,26 @@
                                disable_auth_log=disable_auth_log,
                                _config_file=config_file)
 
+    def context(self, namespace=None):
+        """Retrieve the context or a previously registered namespace.
+        """
+
+        if self._context is None:
+            self._context = {}
+        if namespace is None:
+            return self._context
+        # allow the KeyError to escape if the registered namespace is missing
+        return self._context[namespace]
+
+    def context_set(self, value, namespace=None):
+        """Attach a value as named namespace within the active congifuration.
+        """
+        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
@@ -791,7 +812,7 @@
         try:
             if self.logger:
                 self.logger.info('reloading configuration and reopening log')
         except:
             pass
 
         try:
@@ -826,7 +847,7 @@
             self.log_dir = config.get('GLOBAL', 'log_dir')
             self.logfile = config.get('GLOBAL', 'logfile')
             self.loglevel = config.get('GLOBAL', 'loglevel')
         except:
 
             # Fall back to file in current dir
 
@@ -936,7 +957,7 @@
         # Mandatory options first
 
         try:
             self.mig_server_id = config.get('GLOBAL', 'mig_server_id')
             self.mrsl_files_dir = config.get('GLOBAL', 'mrsl_files_dir')
             self.re_files_dir = config.get('GLOBAL', 're_files_dir')
             self.re_pending_dir = config.get('GLOBAL', 're_pending_dir')
@@ -976,7 +997,7 @@
             self.jobtypes = config.get('GLOBAL', 'jobtypes').split()
             self.lrmstypes = config.get('GLOBAL', 'lrmstypes').split()
             self.sessid_to_mrsl_link_home = config.get('GLOBAL',
                                                        'sessid_to_mrsl_link_home')
             self.mig_system_files = config.get('GLOBAL',
                                                'mig_system_files')
             self.mig_system_storage = config.get('GLOBAL',

tests/test_mig_shared_configuration.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 #
 # --- BEGIN_HEADER ---
@@ -42,7 +42,7 @@
 
 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):