Manually merge PR94 to address PR77 regression in auth.log init in the simplest possible way. Adds a new disable_auth_log argument and corresponding docs to let unit tests disable auth.log init while preserving it for all real sites.

git-svn-id: svn+ssh://svn.code.sf.net/p/migrid/code/trunk@6103 b75ad72c-e7d7-11dd-a971-7dbc132099af

Author: jonasbardino

mig/shared/conf.py

@@ -4,7 +4,7 @@
 # --- BEGIN_HEADER ---
 #
 # conf - Server configuration handling
-# Copyright (C) 2003-2017  The MiG Project lead by Brian Vinter
+# Copyright (C) 2003-2024  The MiG Project lead by Brian Vinter
 #
 # This file is part of MiG.
 #
@@ -26,6 +26,7 @@
 #
 
 """Configuration functions"""
+
 from __future__ import absolute_import
 
 import os
@@ -34,9 +35,11 @@
 from mig.shared.fileio import unpickle
 
 
-def get_configuration_object(config_file=None, skip_log=False):
+def get_configuration_object(config_file=None, skip_log=False,
+                             disable_auth_log=False):
     """Simple helper to call the general configuration init. Optional skip_log
-    argument is passed on to allow skipping the default log initialization.
+    and disable_auth_log arguments are passed on to allow skipping the default
+    log initialization and disabling auth log for unit tests.
     """
     from mig.shared.configuration import Configuration
     if config_file:
@@ -50,7 +53,8 @@ def get_configuration_object(config_file=None, skip_log=False):
         else:
             _config_file = os.path.join(app_dir, '..', 'server',
                     'MiGserver.conf')
-    configuration = Configuration(_config_file, False, skip_log)
+    configuration = Configuration(_config_file, False, skip_log,
+                                  disable_auth_log)
     return configuration
 
 

mig/shared/configuration.py

@@ -685,15 +685,21 @@ class Configuration:
 
     # constructor
 
-    def __init__(self, config_file, verbose=False, skip_log=False):
+    def __init__(self, config_file, verbose=False, skip_log=False,
+                 disable_auth_log=False):
         self.config_file = config_file
-        self.reload_config(verbose, skip_log)
-
-    def reload_config(self, verbose, skip_log=False):
-        """Re-read and parse configuration file. Optional skip_log
-        initializes default logger to use the NullHandler in order to avoid
-        uninitialized log while not really touching log files or causing stdio
-        output.
+        self.reload_config(verbose, skip_log, disable_auth_log)
+
+    def reload_config(self, verbose, skip_log=False, disable_auth_log=False):
+        """Re-read and parse configuration file. Optional skip_log arg
+        initializes default logger(s) to use the NullHandler in order to
+        avoid uninitialized log while not really touching log files or causing
+        stdio output. It is mainly used to disable logging to mig.log from
+        grid_X daemons, which already set up their own per-daemon log for the
+        purpose.
+        The optional disable_auth_log is a workaround ONLY to be used inside a
+        few unit tests where auth.log is really only in the way. It should
+        NEVER be set in code used for production.
         """
 
         try:
@@ -2486,17 +2492,14 @@ def reload_config(self, verbose, skip_log=False):
 
         # Init auth logger
 
-        auth_logger_logfile = None
-        if skip_log:
-            auth_logger_logfile = None
-        else:
-            auth_logger_logfile = self.user_auth_log
+        if disable_auth_log:
+            self.user_auth_log = None
 
         if self.auth_logger_obj:
             self.auth_logger_obj.reopen()
         else:
             self.auth_logger_obj = Logger(
-                self.loglevel, logfile=auth_logger_logfile, app='main-auth')
+                self.loglevel, logfile=self.user_auth_log, app='main-auth')
         self.auth_logger = self.auth_logger_obj.logger
 
         # cert and key for generating a default proxy for nordugrid/ARC

mig/unittest/testcore.py

@@ -78,7 +78,8 @@ def main(_exit=sys.exit):
     config_global_values = _assert_local_config_global_values(config)
 
     from mig.shared.conf import get_configuration_object
-    configuration = get_configuration_object(_TEST_CONF_FILE, skip_log=True)
+    configuration = get_configuration_object(_TEST_CONF_FILE, skip_log=True,
+                                             disable_auth_log=True)
     logging.basicConfig(filename=None, level=logging.INFO,
                         format="%(asctime)s %(levelname)s %(message)s")
     configuration.logger = logging