[run-qemu][print_test_summary] change script to generate logs and later

write them

This makes just easier to separate the file operations from the
generation of the content, and therefore, easier to test.

Signed-off-by: Manu Bretelle <[email protected]>

Author: chantra

run-qemu/print_test_summary.py

@@ -10,6 +10,8 @@
 import argparse
 import json
 
+from typing import Tuple
+
 
 def parse_args():
     parser = argparse.ArgumentParser()
@@ -47,18 +49,10 @@ def markdown_summary(json_summary: json):
 - :x: Failed: {json_summary['failed']}"""
 
 
-def console_summary(json_summary: json):
+def log_summary(json_summary: json):
     return f"Success: {json_summary['success']}/{json_summary['success_subtest']}, Skipped: {json_summary['skipped']}, Failed: {json_summary['failed']}"
 
 
-def log_gh_summary(file, text: str):
-    print(text, file=file)
-
-
-def log_console(text: str):
-    print(text)
-
-
 def group(text: str, title: str = "", error: bool = False) -> str:
     if error and title:
         title = f"\033[1;31mError:\033[0m {title}"
@@ -76,6 +70,33 @@ def test_error_console_log(test_error: str, test_message: str) -> str:
         return error_msg
 
 
+def build_summaries(json_summary) -> Tuple[str, str]:
+    gh_summary = ["# Tests summary"]
+    gh_summary.append(markdown_summary(json_summary))
+
+    console_summary = [notice(log_summary(json_summary))]
+
+    for test in json_summary["results"]:
+        test_name = test["name"]
+        test_number = test["number"]
+        if test["failed"]:
+            test_log = f"#{test_number} {test_name}"
+            gh_summary.append(test_log)
+            console_summary.append(test_error_console_log(test_log, test["message"]))
+
+        for subtest in test["subtests"]:
+            if subtest["failed"]:
+                subtest_log = (
+                    f"#{test_number}/{subtest['number']} {test_name}/{subtest['name']}"
+                )
+                gh_summary.append(subtest_log)
+                console_summary.append(
+                    test_error_console_log(subtest_log, subtest["message"])
+                )
+
+    return "\n".join(gh_summary), "\n".join(console_summary)
+
+
 if __name__ == "__main__":
     args = parse_args()
     step_open_mode = "a" if args.append else "w"
@@ -84,22 +105,7 @@ def test_error_console_log(test_error: str, test_message: str) -> str:
     with open(args.json_summary, "r") as f:
         json_summary = json.load(f)
 
+    gh_summary, console_summary = build_summaries(json_summary)
     with open(args.step_summary, step_open_mode) as f:
-        log_gh_summary(f, "# Tests summary")
-        log_gh_summary(f, markdown_summary(json_summary))
-
-        log_console(notice(console_summary(json_summary)))
-
-        for test in json_summary["results"]:
-            test_name = test["name"]
-            test_number = test["number"]
-            if test["failed"]:
-                test_log = f"#{test_number} {test_name}"
-                log_gh_summary(f, test_log)
-                log_console(test_error_console_log(test_log, test["message"]))
-
-            for subtest in test["subtests"]:
-                if subtest["failed"]:
-                    subtest_log = f"#{test_number}/{subtest['number']} {test_name}/{subtest['name']}"
-                    log_gh_summary(f, subtest_log)
-                    log_console(test_error_console_log(subtest_log, subtest["message"]))
+        print(gh_summary, file=f)
+        print(console_summary)