From 52c55486024fae660a2a1a1e260d56af1b88f8dd Mon Sep 17 00:00:00 2001
From: Marcin Juszkiewicz <marcin.juszkiewicz+kolla@linaro.org>
Date: Thu, 14 Apr 2022 15:32:47 +0200
Subject: [PATCH] enable logging to file for quiet mode

We have 'quiet' mode where only minimal data is printed to the console.
But there were no logs at all then.

This change generates log files (if 'logs-dir' argument is used) during
quiet build.

Also enables 'quiet' mode for CI so Zuul will not have to parse 29MB
JSON file each time.

Change-Id: If7d5c2807f0947a8bbbc1ceb8531c9b9c9287c1f
(cherry picked from commit 0cf5b1d4e6e871562c0ca0f48a21594f8d197471)
---
 kolla/common/utils.py                         | 34 +++++++++++++------
 ...quiet-mode-with-logs-0abafc07923945ac.yaml |  6 ++++
 tests/playbooks/run.yml                       |  1 +
 3 files changed, 30 insertions(+), 11 deletions(-)
 create mode 100644 releasenotes/notes/quiet-mode-with-logs-0abafc07923945ac.yaml

diff --git a/kolla/common/utils.py b/kolla/common/utils.py
index 68996e4b1a..4ee80768f2 100644
--- a/kolla/common/utils.py
+++ b/kolla/common/utils.py
@@ -21,21 +21,33 @@ def make_a_logger(conf=None, image_name=None):
         log = logging.getLogger(".".join([__name__, image_name]))
     else:
         log = logging.getLogger(__name__)
+
+    if conf is not None and conf.debug:
+        loglevel = logging.DEBUG
+    else:
+        loglevel = logging.INFO
+
     if not log.handlers:
-        if conf is None or not conf.logs_dir or not image_name:
-            handler = logging.StreamHandler(sys.stderr)
-            log.propagate = False
+        stream_handler = logging.StreamHandler(sys.stderr)
+        stream_handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
+        # NOTE(hrw): quiet mode matters only on console
+        if conf is not None and conf.quiet:
+            stream_handler.setLevel(logging.CRITICAL)
         else:
+            stream_handler.setLevel(loglevel)
+        log.addHandler(stream_handler)
+        log.propagate = False
+
+        if conf is not None and conf.logs_dir and image_name:
             filename = os.path.join(conf.logs_dir, "%s.log" % image_name)
             handler = logging.FileHandler(filename, delay=True)
-        handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
-        log.addHandler(handler)
-    if conf is not None and conf.debug:
-        log.setLevel(logging.DEBUG)
-    elif conf is not None and conf.quiet and image_name:
-        log.setLevel(logging.CRITICAL)
-    else:
-        log.setLevel(logging.INFO)
+            # NOTE(hrw): logfile will be INFO or DEBUG
+            handler.setLevel(loglevel)
+            handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
+            log.addHandler(handler)
+
+    # NOTE(hrw): needs to be high, handlers have own levels
+    log.setLevel(logging.DEBUG)
     return log
 
 
diff --git a/releasenotes/notes/quiet-mode-with-logs-0abafc07923945ac.yaml b/releasenotes/notes/quiet-mode-with-logs-0abafc07923945ac.yaml
new file mode 100644
index 0000000000..1b8e67855a
--- /dev/null
+++ b/releasenotes/notes/quiet-mode-with-logs-0abafc07923945ac.yaml
@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Quiet mode (enabled with ``--quiet`` argument) can be combined with
+    ``--logs-dir`` option now. Console output will be quiet as expected while
+    building output will be stored in separate log files.
diff --git a/tests/playbooks/run.yml b/tests/playbooks/run.yml
index 0142c08070..4ae9635531 100644
--- a/tests/playbooks/run.yml
+++ b/tests/playbooks/run.yml
@@ -8,6 +8,7 @@
       DEFAULT:
         debug: true
         logs_dir: "{{ kolla_build_logs_dir }}"
+        quiet: true
         base: "{{ base_distro }}"
         install_type: "{{ install_type }}"
         template_override: /etc/kolla/template_overrides.j2