From 7a1ec4f19cd153457ed71f7a845183a308f63238 Mon Sep 17 00:00:00 2001
From: Alexander Turenko <alexander.turenko@tarantool.org>
Date: Tue, 30 May 2023 17:37:17 +0300
Subject: [PATCH] Prettify messages about log files

The ideas behind the change:

* The log is sometimes from a tarantool instance, but a luatest based
  test may print logs from another process to stderr. Use more general
  term 'log' to don't confuse anyone.
* Replace term 'instance' with 'test-run server' due to the same
  reasons.
* Make zero size and no file situations more explicit.
* Catch and report 'no logfile property' situation (shouldn't occur, but
  was semi-handled by this code previously for some reason).
* Reduce code reusability for the sake of readability and to ease future
  modifications.
---
 lib/server.py | 34 ++++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/lib/server.py b/lib/server.py
index f56bc9fc..045543cc 100644
--- a/lib/server.py
+++ b/lib/server.py
@@ -143,17 +143,31 @@ def stop(self, silent=True):
     def restart(self):
         pass
 
-    def print_log(self, lines=None):
-        msg = ('\n{prefix} of Tarantool Log file [Instance "{instance}"]' +
-               '[{logfile}]:\n').format(
-            prefix="Last {0} lines".format(lines) if lines else "Output",
-            instance=self.name,
-            logfile=self.logfile or 'null')
-        color_stdout(msg, schema='error')
-        if os.path.exists(self.logfile):
-            print_tail_n(self.logfile, lines)
+    def print_log(self, num_lines=None):
+        """ Show information from the given log file.
+        """
+        prefix = '\n[test-run server "{instance}"] '.format(instance=self.name)
+        if not self.logfile:
+            msg = 'No log file is set (internal test-run error)\n'
+            color_stdout(prefix + msg, schema='error')
+        elif not os.path.exists(self.logfile):
+            fmt_str = 'The log file {logfile} does not exist\n'
+            msg = fmt_str.format(logfile=self.logfile)
+            color_stdout(prefix + msg, schema='error')
+        elif os.path.getsize(self.logfile) == 0:
+            fmt_str = 'The log file {logfile} has zero size\n'
+            msg = fmt_str.format(logfile=self.logfile)
+            color_stdout(prefix + msg, schema='error')
+        elif num_lines:
+            fmt_str = 'Last {num_lines} lines of the log file {logfile}:\n'
+            msg = fmt_str.format(logfile=self.logfile, num_lines=num_lines)
+            color_stdout(prefix + msg, schema='error')
+            print_tail_n(self.logfile, num_lines)
         else:
-            color_stdout("    Can't find log:\n", schema='error')
+            fmt_str = 'The log file {logfile}:\n'
+            msg = fmt_str.format(logfile=self.logfile)
+            color_stdout(msg, schema='error')
+            print_tail_n(self.logfile, num_lines)
 
     @staticmethod
     def exclude_tests(test_names, exclude_patterns):