Manually merge PR152 to make checkconf helper useful again e.g. for docker-migrid self-tests

jonasbardino · jonasbardino · commit 5b84ac4f9fae · 2024-11-19T16:01:20.000Z
git-svn-id: svn+ssh://svn.code.sf.net/p/migrid/code/trunk@6166 b75ad72c-e7d7-11dd-a971-7dbc132099af
diff --git a/mig/install/MiGserver-template.conf b/mig/install/MiGserver-template.conf
@@ -119,9 +119,7 @@ events_home = %(state_path)s/events_home/
 twofactor_home = %(state_path)s/twofactor_home/
 gdp_home = %(state_path)s/gdp_home/
 workflows_home = %(state_path)s/workflows_home/
-workflows_db_home = %(workflows_home)sworkflows_db_home/
-workflows_db = %(workflows_db_home)sworkflows_db.pickle
-workflows_db_lock = %(workflows_db_home)sworkflows_db.lock
+workflows_db_home = %(state_path)s/workflows_db_home/
 notify_home = %(state_path)s/notify_home/
 quota_home = %(state_path)s/quota_home/
 
@@ -164,8 +162,8 @@ vgrid_monitor = monitor
 public_key_file = ~/.ssh/id_rsa.pub
 
 # x.509 certificate and key used for interserver communication
-server_cert = %(certs_path)s/MiGservercert.pem
-server_key = %(certs_path)s/MiGserverkey.pem
+server_cert = %(certs_path)s/combined.pem
+server_key = %(certs_path)s/combined.pem
 ca_cert = %(certs_path)s/cacert.pem
 sss_home = %(state_path)s/sss_home/
 
diff --git a/mig/java-bin/README b/mig/java-bin/README
@@ -0,0 +1 @@
+The contents of this folder is by the java sandbox resources.
diff --git a/mig/server/checkconf.py b/mig/server/checkconf.py
@@ -4,7 +4,7 @@
 # --- BEGIN_HEADER ---
 #
 # checkconf - check MiGserver.conf file
-# Copyright (C) 2003-2021  The MiG Project lead by Brian Vinter
+# Copyright (C) 2003-2024  The MiG Project lead by Brian Vinter
 #
 # This file is part of MiG.
 #
@@ -25,14 +25,17 @@
 # -- END_HEADER ---
 #
 
-"""Check MiGserver.conf or specified MiG server conf file:
-Currently only checks that files and dirs exist, but could be
-extended to include other variable checks.
+"""Check MiGserver.conf either in specified path, pointed to in MIG_CONF or in
+default mig/server/ location.
+Currently mainly checks that required files and dirs exist, but may be extended
+to include other variable checks.
 """
 
 from __future__ import print_function
 from __future__ import absolute_import
 
+from builtins import input
+from past.builtins import basestring
 import os
 import re
 import sys
@@ -56,7 +59,7 @@ def usage():
 def ask_reply(question):
     """Read user input"""
 
-    return raw_input(question)
+    return input(question)
 
 
 def ask_confirm(question, allow_always=False):
@@ -79,135 +82,163 @@ def touch_file(path):
     open(path, 'w').close()
 
 
-argc = len(sys.argv)
-if argc == 1:
-
-    # Change CWD to ../mig/server/ to allow relative paths
-
-    server_dir = os.path.dirname(os.path.abspath(sys.argv[0]))
-    conf_file = server_dir + os.sep + 'MiGserver.conf'
-elif argc == 2:
-    conf_file = sys.argv[1]
-else:
-    print(usage())
-    sys.exit(2)
-
-conf = None
-if not os.path.isfile(conf_file):
-    if YES == ask_confirm('Configuration file %s does not exist! %s'
-                          % (conf_file, 'create it? [Y/n] ')):
-        try:
-            touch_file(conf_file)
-            print('created empty configuration file: %s' % conf_file)
-        except Exception as err:
-            print('could not create %s: %s' % (conf_file, err))
+def check_conf(conf_file):
+    """Verify conf_file to be complete and have all referenced paths"""
+    conf = None
+    if not os.path.isfile(conf_file):
+        if YES == ask_confirm('Configuration file %s does not exist! %s' %
+                              (conf_file, 'create it? [Y/n] ')):
+            try:
+                touch_file(conf_file)
+                print('created empty configuration file: %s' % conf_file)
+            except Exception as err:
+                print('could not create %s: %s' % (conf_file, err))
+        else:
+            return 2
     else:
-        sys.exit(1)
-else:
-    try:
-        conf = Configuration(conf_file)
-    except Exception as err:
-        print('configuration file %s is incomplete! %s' % (conf_file,
-                                                           err))
-
-if not conf:
-    if YES == ask_confirm('Add missing configuration options? [Y/n] '):
-        fix_missing(conf_file)
         try:
             conf = Configuration(conf_file)
         except Exception as err:
-            print('configuration file %s is still incomplete! %s'
-                  % (conf_file, err))
-            sys.exit(1)
+            print('configuration file %s is incomplete! %s' % (conf_file, err))
+
+    if not conf:
+        if YES == ask_confirm('Add missing configuration options? [Y/n] '):
+            fix_missing(conf_file)
+            try:
+                conf = Configuration(conf_file)
+            except Exception as err:
+                print('configuration file %s is still incomplete! %s' %
+                      (conf_file, err))
+            return 1
+        else:
+            return 2
+
+    # Search object attributes for possible paths
+
+    attrs = []
+    ignore_attrs = ['__class__', '__doc__', '__module__']
+    path_re = re.compile('(' + os.sep + "[\w\._-]*)+$")
+
+    _logger = conf.logger
+    _logger.info('Checking configuration paths in %s ...', conf_file)
+    print('Checking configuration paths in %s ...' % conf_file)
+    warnings = 0
+    missing_paths = []
+    conf_parser = ConfigParser()
+    conf_parser.read([conf_file])
+    for (name, val) in conf_parser.items('GLOBAL'):
+        if not isinstance(val, basestring):
+
+            # ignore non-string values
+
+            continue
+        elif not val:
+
+            # ignore empty string values
+
+            continue
+        elif name.endswith('_url') or val.find('://') != -1:
+
+            # ignore url values
+
+            continue
+        elif val.find('/emailAddress=') != -1:
+
+            # ignore x509 DN values
+
+            continue
+        elif path_re.match(val):
+            path = os.path.normpath(val)
+            if os.path.isdir(path):
+                _logger.info('%s OK: %s is a dir', name, val)
+            elif os.path.isfile(path):
+                _logger.info('%s OK: %s is a file', name, val)
+            elif os.path.exists(path):
+                _logger.info('%s OK: %s exists', name, val)
+            else:
+                _logger.warning('%s: %s does not exist!', name, val)
+                print('* WARNING *: %s: %s does not exist!' % (name, val))
+                if not path in missing_paths:
+                    missing_paths.append(path)
+                warnings += 1
+
+    _logger.info('Found %d configuration problem(s)', warnings)
+    print('Found %d configuration problem(s)' % warnings)
+
+    if warnings > 0:
+        answer = ask_confirm('Add missing path(s)? [Y/n/a]: ',
+                             allow_always=True)
+        if answer != NO:
+
+            # Sort missing paths to avoid overlaps resulting in errors
+
+            missing_paths.sort()
+
+            for path in missing_paths:
+                if ALWAYS == answer:
+
+                    # 'always' answer reults in default type for all missing entries
+
+                    path_type = None
+                elif YES == answer:
+                    path_type = \
+                        ask_reply('Create %s as a (d)irectory, (f)ile or (p)ipe? [D/f/p] '
+                                  % path)
+                if not path_type or 'D' == path_type.upper():
+                    try:
+                        os.makedirs(path)
+                        print('created directory %s' % path)
+                    except Exception as err:
+                        print('could not create directory %s: %s' %
+                              (path, err))
+                elif 'F' == path_type.upper():
+                    try:
+                        dirname = os.path.dirname(path)
+                        if dirname and not os.path.exists(dirname):
+                            os.makedirs(dirname)
+                            print('created directory %s' % dirname)
+                        touch_file(path)
+                        print('created file %s' % path)
+                    except Exception as err:
+                        print('could not create file %s: %s' % (path, err))
+                elif 'P' == path_type.upper():
+                    try:
+                        dirname = os.path.dirname(path)
+                        if dirname and not os.path.exists(dirname):
+                            os.makedirs(dirname)
+                            print('created directory %s' % dirname)
+                        os.mkfifo(path)
+                        print('created pipe %s' % path)
+                    except Exception as err:
+                        print('could not create file %s: %s' % (path, err))
+    print('completed check of %s: %d warning(s)' % (conf_file, warnings))
+    return warnings
+
+
+if __name__ == "__main__":
+    if sys.argv[1:]:
+        file_list = sys.argv[1:]
     else:
-        sys.exit(1)
-
-# Search object attributes for possible paths
-
-attrs = []
-ignore_attrs = ['__class__', '__doc__', '__module__']
-path_re = re.compile('(' + os.sep + "\w+)+")
-
-conf.logger.info('Checking configuration paths in %s ...', conf_file)
-print('Checking configuration paths in %s ...' % conf_file)
-warnings = 0
-missing_paths = []
-conf_parser = ConfigParser()
-conf_parser.read([conf_file])
-for (name, val) in conf_parser.items('GLOBAL'):
-    if not isinstance(val, basestring):
-
-        # ignore non-string values
-
-        continue
-    elif not val:
-
-        # ignore empty string values
-
-        continue
-    elif path_re.match(val):
-        path = os.path.normpath(val)
-        if os.path.isdir(path):
-            conf.logger.info('%s OK: %s is a dir', name, val)
-        elif os.path.isfile(path):
-            conf.logger.info('%s OK: %s is a file', name, val)
-        elif os.path.exists(path):
-            conf.logger.info('%s OK: %s exists', name, val)
+        env_conf = os.environ.get('MIG_CONF', '')
+        if env_conf:
+            conf_file = env_conf
         else:
-            conf.logger.warning('%s: %s does not exist!', name, val)
-            print('* WARNING *: %s: %s does not exist!' % (name, val))
-            if not path in missing_paths:
-                missing_paths.append(path)
-            warnings += 1
-
-conf.logger.info('Found %d configuration problem(s)', warnings)
-print('Found %d configuration problem(s)' % warnings)
-
-if warnings > 0:
-    answer = ask_confirm('Add missing path(s)? [Y/n/a]: ',
-                         allow_always=True)
-    if answer != NO:
-
-        # Sort missing paths to avoid overlaps resulting in errors
-
-        missing_paths.sort()
-
-        for path in missing_paths:
-            if ALWAYS == answer:
-
-                # 'always' answer reults in default type for all missing entries
-
-                path_type = None
-            elif YES == answer:
-                path_type = \
-                    ask_reply('Create %s as a (d)irectory, (f)ile or (p)ipe? [D/f/p] '
-                              % path)
-            if not path_type or 'D' == path_type.upper():
-                try:
-                    os.makedirs(path)
-                    print('created directory %s' % path)
-                except Exception as err:
-                    print('could not create directory %s: %s' % (path,
-                                                                 err))
-            elif 'F' == path_type.upper():
-                try:
-                    dirname = os.path.dirname(path)
-                    if dirname and not os.path.exists(dirname):
-                        os.makedirs(dirname)
-                        print('created directory %s' % dirname)
-                    touch_file(path)
-                    print('created file %s' % path)
-                except Exception as err:
-                    print('could not create file %s: %s' % (path, err))
-            elif 'P' == path_type.upper():
-                try:
-                    dirname = os.path.dirname(path)
-                    if dirname and not os.path.exists(dirname):
-                        os.makedirs(dirname)
-                        print('created directory %s' % dirname)
-                    os.mkfifo(path)
-                    print('created pipe %s' % path)
-                except Exception as err:
-                    print('could not create file %s: %s' % (path, err))
-
-sys.exit(0)
+            # We may be called from MIG_ROOT/mig/server or from MIG_ROOT/bin
+            current_dir = os.path.dirname(os.path.abspath(sys.argv[0]))
+            parent_dir = os.path.dirname(current_dir)
+            if os.path.basename(current_dir) == 'bin':
+                base_dir = parent_dir
+            else:
+                base_dir = os.path.dirname(parent_dir)
+
+            conf_file = os.path.join(base_dir, "mig", "server",
+                                     'MiGserver.conf')
+        if not os.path.isfile(conf_file):
+            print(usage())
+            sys.exit(2)
+        file_list = [conf_file]
+
+    retval = 0
+    for conf_file in file_list:
+        retval += check_conf(conf_file)
+    sys.exit(retval)
diff --git a/mig/shared/configuration.py b/mig/shared/configuration.py
@@ -201,7 +201,7 @@ def fix_missing(config_file, verbose=True):
         'twofactor_home': '~/state/twofactor_home/',
         'gdp_home': '~/state/gdp_home/',
         'workflows_home': '~/state/workflows_home/',
-        'workflows_db_home': '~/state/workflows_home/workflows_db_home/',
+        'workflows_db_home': '~/state/workflows_db_home/',
         'notify_home': '~/state/notify_home',
         'site_vgrid_links': 'files web tracker workflows monitor',
         'site_vgrid_creators': 'distinguished_name:.*',
diff --git a/state/workflows_db_home/.placeholder b/state/workflows_db_home/.placeholder
diff --git a/tests/fixture/confs-stdlocal/MiGserver.conf b/tests/fixture/confs-stdlocal/MiGserver.conf
@@ -119,9 +119,7 @@ events_home = %(state_path)s/events_home/
 twofactor_home = %(state_path)s/twofactor_home/
 gdp_home = %(state_path)s/gdp_home/
 workflows_home = %(state_path)s/workflows_home/
-workflows_db_home = %(workflows_home)sworkflows_db_home/
-workflows_db = %(workflows_db_home)sworkflows_db.pickle
-workflows_db_lock = %(workflows_db_home)sworkflows_db.lock
+workflows_db_home = %(state_path)s/workflows_db_home/
 notify_home = %(state_path)s/notify_home/
 quota_home = %(state_path)s/quota_home/
 
@@ -164,8 +162,8 @@ vgrid_monitor = monitor
 public_key_file = ~/.ssh/id_rsa.pub
 
 # x.509 certificate and key used for interserver communication
-server_cert = %(certs_path)s/MiGservercert.pem
-server_key = %(certs_path)s/MiGserverkey.pem
+server_cert = %(certs_path)s/combined.pem
+server_key = %(certs_path)s/combined.pem
 ca_cert = %(certs_path)s/cacert.pem
 sss_home = %(state_path)s/sss_home/
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+The contents of this folder is by the java sandbox resources.`