#490: In CommandLogHandler suffixed newline, flushed logfile and added timestamp (#499)

Added timestamp & newline for each invocation of handle_log_line() and flushed the log file. Added unit tests for timestamp & newline.

Author: sgn4sangar

exasol_integration_test_docker_environment/lib/logging/command_log_handler.py

@@ -1,4 +1,8 @@
 import pathlib
+from datetime import (
+    datetime,
+    timezone,
+)
 
 from exasol_integration_test_docker_environment.lib.logging.abstract_log_handler import (
     AbstractLogHandler,
@@ -15,8 +19,11 @@ def __init__(self, log_file_path: pathlib.Path, logger, description: str):
         self._description = description
 
     def handle_log_line(self, log_line, error: bool = False):
-        self._log_file.write(log_line)
-        self._complete_log.append(log_line)
+        cur_time = datetime.now(timezone.utc)
+        log_time = cur_time.strftime("%H.%M.%S.%f")
+        self._log_file.write(f"{log_time}: {log_line}\n")
+        self._log_file.flush()
+        self._complete_log.append(f"{log_time}: {log_line}\n")
         if error:
             self._error_message = log_line
 

test/unit/test_log_newline.py

@@ -0,0 +1,30 @@
+import os
+import platform
+from pathlib import Path
+from test.matchers import regex_matcher
+
+import pytest
+
+from exasol_integration_test_docker_environment.lib.logging.command_log_handler import (
+    CommandLogHandler,
+)
+
+
+def test_new_line(tmp_path):
+    log_file_path = Path(tmp_path, "test_cmd_log_handler.log")
+    with CommandLogHandler(log_file_path, None, "test for multi lines") as log_handler:
+        log_handler.handle_log_line("log line 1")
+        log_handler.handle_log_line("log line 2")
+        with open(log_file_path) as log_file:
+            line_count = sum(1 for line in log_file)
+            assert line_count > 1
+
+
+def test_timestamp(tmp_path):
+    log_file_path = Path(tmp_path, "test_cmd_log_handler.log")
+    with CommandLogHandler(log_file_path, None, "test for multi lines") as log_handler:
+        log_handler.handle_log_line("log line 1")
+    with open(log_file_path) as log_file:
+        first_line = log_file.readline()
+        # pattern is, 0 padded hh.mm.ss.6-digits-usecs
+        assert first_line == regex_matcher(r"^\d{2}.\d{2}.\d{2}\.\d{6}")