result from merge with gerrit

secop subdir only

Change-Id: I65ab7049719b374ae3ec0259483e7e7d16aafcd1

secop/lib/__init__.py

@@ -30,57 +30,95 @@ import traceback
 from configparser import ConfigParser
 from os import environ, path
 
-CONFIG = {}
-unset_value = object()
 
+class GeneralConfig:
 
-def getGeneralConfig(confdir=None):
-    global CONFIG  # pylint: disable=global-statement
+    def __init__(self):
+        self._config = None
+        self.defaults = {}  #: default values. may be set before or after :meth:`init`
 
-    if CONFIG:
-        if confdir:
-            raise ValueError('getGeneralConfig with argument must be called first')
-    else:
+    def init(self, configfile=None):
+        cfg = {}
+        mandatory = 'piddir', 'logdir', 'confdir'
         repodir = path.abspath(path.join(path.dirname(__file__), '..', '..'))
+        # create default paths
         if path.splitext(sys.executable)[1] == ".exe" and not path.basename(sys.executable).startswith('python'):
             # special MS windows environment
-            CONFIG = {
-                'piddir': './',
-                'logdir': './log',
-                'confdir': './',
-            }
-        elif not path.exists(path.join(repodir, '.git')):
-            CONFIG = {
-                'piddir': '/var/run/secop',
-                'logdir': '/var/log',
-                'confdir': '/etc/secop',
-            }
+            cfg.update(piddir='./', logdir='./log', confdir='./')
+        elif path.exists(path.join(repodir, '.git')):
+            # running from git repo
+            cfg['confdir'] = path.join(repodir, 'cfg')
+            # take logdir and piddir from <repodir>/cfg/generalConfig.cfg
         else:
-            CONFIG = {
-                'piddir': path.join(repodir, 'pid'),
-                'logdir': path.join(repodir, 'log'),
-                'confdir': path.join(repodir, 'cfg'),
-            }
-        gen_config_path = confdir or environ.get('FRAPPY_CONFIG_FILE',
-                                                 path.join(CONFIG['confdir'], 'generalConfig.cfg'))
-        if gen_config_path and path.exists(gen_config_path):
+            # running on installed system (typically with systemd)
+            cfg.update(piddir='/var/run/frappy', logdir='/var/log', confdir='/etc/frappy')
+        if configfile is None:
+            configfile = environ.get('FRAPPY_CONFIG_FILE',
+                                     path.join(cfg['confdir'], 'generalConfig.cfg'))
+        if configfile and path.exists(configfile):
             parser = ConfigParser()
             parser.optionxform = str
-            parser.read([gen_config_path])
-            CONFIG = {}
+            parser.read([configfile])
+            # mandatory in a general config file:
+            cfg['logdir'] = cfg['piddir'] = None
+            cfg['confdir'] = path.dirname(configfile)
             # only the FRAPPY section is relevant, other sections might be used by others
             for key, value in parser['FRAPPY'].items():
                 if value.startswith('./'):
-                    CONFIG[key] = path.abspath(path.join(repodir, value))
+                    cfg[key] = path.abspath(path.join(repodir, value))
                 else:
                     # expand ~ to username, also in path lists separated with ':'
-                    CONFIG[key] = ':'.join(path.expanduser(v) for v in value.split(':'))
+                    cfg[key] = ':'.join(path.expanduser(v) for v in value.split(':'))
         else:
-            for dirname in CONFIG:
-                CONFIG[dirname] = environ.get('SECOP_%s' % dirname.upper(), CONFIG[dirname])
+            for key in mandatory:
+                cfg[key] = environ.get('FRAPPY_%s' % key.upper(), cfg[key])
+        missing_keys = [key for key in mandatory if cfg[key] is None]
+        if missing_keys:
+            if path.exists(configfile):
+                raise KeyError('missing value for %s in %s' % (' and '.join(missing_keys), configfile))
+            raise FileNotFoundError(configfile)
         # this is not customizable
-        CONFIG['basedir'] = repodir
-    return CONFIG
+        cfg['basedir'] = repodir
+        self._config = cfg
+
+    def __getitem__(self, key):
+        try:
+            return self._config[key]
+        except KeyError:
+            return self.defaults[key]
+        except TypeError:
+            if key in self.defaults:
+                # accept retrieving defaults before init
+                # e.g. 'lazy_number_validation' in secop.datatypes
+                return self.defaults[key]
+            raise TypeError('generalConfig.init() has to be called first') from None
+
+    def get(self, key, default=None):
+        try:
+            return self.__getitem__(key)
+        except KeyError:
+            return default
+
+    def getint(self, key, default=None):
+        try:
+            return int(self.__getitem__(key))
+        except KeyError:
+            return default
+
+    def __getattr__(self, key):
+        """goodie: use generalConfig.<key> instead of generalConfig.get('<key>')"""
+        return self.get(key)
+
+    @property
+    def initialized(self):
+        return bool(self._config)
+
+    def testinit(self, **kwds):
+        """for test purposes"""
+        self._config = kwds
+
+
+generalConfig = GeneralConfig()
 
 
 class lazy_property:
@@ -289,4 +327,4 @@ class UniqueObject:
         self.name = name
 
     def __repr__(self):
-        return 'UniqueObject(%r)' % self.name
+        return self.name