[run-qemu] Replace jq script with a python script

embedded jq script is hard to maintain. This change does:
- call a external script instead of having it embedded within the main
  run.sh one
- convert it to python to make it easier to selectively handle how to
  format the content depending on the output (github step summary or
console).

the latter could be done by `jq` but this is becoming an escape-hell to
get the content properly passed and handle by each individual component
of the pipeline.

https://gist.github.com/chantra/fcaf4847393dc98ffda82c4ba116eb2d

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

Author: chantra

run-qemu/fixtures/test_progs.json

@@ -0,0 +1,105 @@
+#!/bin/python3
+# prints a summary of the tests to both the console and the job summary:
+# https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary
+#
+# To test the output of the GH test summary:
+# python3 run-qemu/print_test_summary.py  -j run-qemu/fixtures/test_progs.json -s /dev/stderr  > /dev/null
+# To test the output of the console:
+# python3 run-qemu/print_test_summary.py  -j run-qemu/fixtures/test_progs.json -s /dev/stderr  2> /dev/null
+
+import argparse
+import json
+
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "-j",
+        "--json-summary",
+        required=True,
+        metavar="FILE",
+        help="test_progs's json summary file",
+    )
+    parser.add_argument(
+        "-s",
+        "--step-summary",
+        required=True,
+        metavar="FILE",
+        help="Github step summary file",
+    )
+    parser.add_argument(
+        "-a", "--append", action="store_true", help="Append to github step summary file"
+    )
+    return parser.parse_args()
+
+
+def notice(text: str) -> str:
+    return f"::notice::{text}"
+
+
+def error(text: str) -> str:
+    return f"::error::{text}"
+
+
+def markdown_summary(json_summary: json):
+    return f"""- :heavy_check_mark: Success: {json_summary['success']}/{json_summary['success_subtest']}
+- :next_track_button: Skipped: ${json_summary['skipped']}
+- :x: Failed: {json_summary['failed']}"""
+
+
+def console_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}"
+    return f"""::group::{title}
+{text}
+::endgroup::"""
+
+
+def test_error_console_log(test_error: str, test_message: str) -> str:
+    error_msg = error(test_error)
+    if test_message:
+        error_msg += "\n" + test_message.strip()
+        return group(error_msg, title=test_error, error=True)
+    else:
+        return error_msg
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    step_open_mode = "a" if args.append else "w"
+    json_summary = None
+
+    with open(args.json_summary, "r") as f:
+        json_summary = json.load(f)
+
+    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"]))

run-qemu/print_test_summary.py

@@ -111,37 +111,7 @@ then
     if [ $? ]
     then
         ## Job summary
-        echo "# Tests summary" >> "${GITHUB_STEP_SUMMARY}"
-        read -r T_SUCCESS T_SUCCESS_SUBTEST T_SKIPPED T_FAILED < \
-            <(jq -r < "${KERNEL_TEST}.json" '"\(.success) \(.success_subtest) \(.skipped) \(.failed)"')
-        echo "- :heavy_check_mark: Success: ${T_SUCCESS}/${T_SUCCESS_SUBTEST}
-- :next_track_button: Skipped: ${T_SKIPPED}
-- :x: Failed: ${T_FAILED}" >> "${GITHUB_STEP_SUMMARY}"
-
-        summary_annotation="Success: ${T_SUCCESS}/${T_SUCCESS_SUBTEST}, Skipped: ${T_SKIPPED}, Failed: ${T_FAILED}"
-        echo "::notice::${summary_annotation}"
-
-        # Print failed tests to summary/annotations
-        if [ "${T_FAILED}" -gt 0 ]
-        then
-            echo "# Failed tests" >> "${GITHUB_STEP_SUMMARY}"
-            jq -r < "${KERNEL_TEST}.json" \
-                '.results | map([
-                    if .failed then "#\(.number) \(.name)" else empty end,
-                    (
-                        . as {name: $tname, number: $tnum} | .subtests | map(
-                            if .failed then "#\($tnum)/\(.number) \($tname)/\(.name)" else empty end
-                        )
-                    )
-                ]) | flatten | .[]' | \
-                while read -r line
-                do
-                    # Job summary
-                    echo "${line}" >> "${GITHUB_STEP_SUMMARY}"
-                    # Annotations
-                    echo "::error::${line}"
-                done
-        fi
+        "${GITHUB_ACTION_PATH}/print_test_summary.py" -s "${GITHUB_STEP_SUMMARY}" -j "${KERNEL_TEST}.json"
     fi
 fi
 # Final summary - Don't use a fold, keep it visible