Make sure that install tools log

When any log message is emitted before IPA install tools logging is
configured, it may break and leave install tools log empty. This
happens for example when

ipa-server-install --ip-address=$IP_ADDRESS

is run.

This patch makes sure that logging is right in these cases.

https://fedorahosted.org/freeipa/ticket/2214

5 files changed, 48 insertions, 0 deletions

diff --git a/install/tools/ipa-ca-install b/install/tools/ipa-ca-install
index 445b06214..c813659f3 100755
--- a/install/tools/ipa-ca-install
+++ b/install/tools/ipa-ca-install
@@ -70,6 +70,7 @@ def get_dirman_password():
     return installutils.read_password("Directory Manager (existing master)", confirm=False, validate=False)
 
 def main():
+    installutils.bootstrap_logging()
     safe_options, options, filename = parse_options()
     installutils.standard_logging_setup("/var/log/ipareplica-ca-install.log", options.debug)
     logging.debug('%s was invoked with argument "%s" and options: %s' % (sys.argv[0], filename, safe_options))
diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install
index d81b6a2e8..25c1bb0ca 100755
--- a/install/tools/ipa-dns-install
+++ b/install/tools/ipa-dns-install
@@ -82,6 +82,7 @@ def parse_options():
     return safe_options, options
 
 def main():
+    bootstrap_logging()
     safe_options, options = parse_options()
 
     if os.getegid() != 0:
diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install
index dbc736764..7310d2862 100755
--- a/install/tools/ipa-replica-install
+++ b/install/tools/ipa-replica-install
@@ -286,6 +286,7 @@ def check_bind():
         sys.exit(1)
 
 def main():
+    installutils.bootstrap_logging()
     safe_options, options, filename = parse_options()
     installutils.standard_logging_setup("/var/log/ipareplica-install.log", options.debug)
     logging.debug('%s was invoked with argument "%s" and options: %s' % (sys.argv[0], filename, safe_options))
diff --git a/install/tools/ipa-server-install b/install/tools/ipa-server-install
index 8f156e8dd..755f27727 100755
--- a/install/tools/ipa-server-install
+++ b/install/tools/ipa-server-install
@@ -562,6 +562,8 @@ def main():
     global installation_cleanup
     ds = None
 
+    bootstrap_logging()
+
     safe_options, options = parse_options()
 
     if os.getegid() != 0:
diff --git a/ipaserver/install/installutils.py b/ipaserver/install/installutils.py
index 0a36c354e..d0f611c61 100644
--- a/ipaserver/install/installutils.py
+++ b/ipaserver/install/installutils.py
@@ -314,7 +314,47 @@ def port_available(port):
 
     return rv
 
+class BufferingHandler(logging.Handler):
+    log_queue = []
+
+    def __init__(self):
+        logging.Handler.__init__(self)
+        self.level = logging.DEBUG
+
+    def emit(self, record):
+        self.log_queue.append(record)
+
+    def flush(self):
+        pass
+
+def bootstrap_logging():
+    """
+    Bootstrap logging and create special handler which will buffer any log
+    emitted before standard_logging_setup is called. These will be later
+    processed when the logging is set up.
+    """
+    root_logger = logging.getLogger()
+    root_logger.setLevel(logging.DEBUG)
+    root_logger.addHandler(BufferingHandler())
+
 def standard_logging_setup(log_filename, debug=False, filemode='w'):
+    """
+    Set up logging. bootstrap_logging() should be called earlier if there
+    is a chance that a log is emitted before this setup.
+    """
+    root_logger = logging.getLogger()
+    log_queue = []
+
+    if root_logger.handlers:
+        # Remove any handlers that may have been set and which may cause
+        # problems with logging in install utils
+        handler_list = list(logging.getLogger().handlers)
+
+        for handler in handler_list:
+            if isinstance(handler, BufferingHandler):
+                log_queue.extend(handler.log_queue)
+            root_logger.removeHandler(handler)
+
     old_umask = os.umask(077)
     # Always log everything (i.e., DEBUG) to the log
     # file.
@@ -335,6 +375,9 @@ def standard_logging_setup(log_filename, debug=False, filemode='w'):
     console.setFormatter(formatter)
     logging.getLogger('').addHandler(console)
 
+    for log_record in log_queue:
+        root_logger.handle(log_record)
+
 def get_password(prompt):
     if os.isatty(sys.stdin.fileno()):
         return getpass.getpass(prompt)