Fix internal logging and problem matching

There were two problems with the recently merged internal logging
improvements:

1. I assumed that print_yellow() was only called when warning but it is
   also used for informational prints.
2. The regex did not work.

Simplify the regex by avoiding brackets and just using a simple ERROR:
and WARNING: prefix to the message.

Introduce new logging functions: die() to print a message and exit with
error code 1, warn() to print a warning, and info() to print
information. Use these consistently throughout the scripts. Adjust
certain messages so that they will be caught by the new problem matcher.

Signed-off-by: Nathan Chancellor <[email protected]>

Author: nathanchance

.github/problem-matchers/internal.json

@@ -5,8 +5,8 @@
             "owner": "internal",
             "pattern": [
                 {
-                    "__comment_regexp1": "[CI ERROR] Build is not finished on TuxSuite's side!",
-                    "regexp": "^\\[CI (WARNING|ERROR)\\]\\s+(.*)$",
+                    "__comment_regexp1": "ERROR: Build is not finished on TuxSuite's side!",
+                    "regexp": "^(WARNING|ERROR):\\s+(.*)$",
                     "severity": 1,
                     "message": 2
                 }

generator/generate_workflow.py

@@ -6,7 +6,7 @@
 import sys
 import yaml
 
-from utils import CI_ROOT, LLVM_TOT_VERSION, disable_subsys_werror_configs, get_config_from_generator, get_llvm_versions, get_repo_ref, patch_series_flag, print_red
+from utils import CI_ROOT, LLVM_TOT_VERSION, disable_subsys_werror_configs, get_config_from_generator, get_llvm_versions, get_repo_ref, patch_series_flag, die
 
 
 def parse_args(trees):
@@ -279,8 +279,8 @@ def get_cron_schedule(schedules, tree_name, llvm_version):
         if item["name"] == tree_name and \
            item["llvm_version"] == llvm_version:
             return item["schedule"]
-    print_red(f"Could not find schedule for {tree_name} clang-{llvm_version}?")
-    sys.exit(1)
+    return die(
+        f"Could not find schedule for {tree_name} clang-{llvm_version}?")
 
 
 def print_builds(config, tree_name, llvm_version):

scripts/check-logs.py

@@ -10,12 +10,12 @@
 import time
 import urllib.request
 
-from utils import CI_ROOT, get_build, get_image_name, get_requested_llvm_version, print_red, print_yellow, get_cbl_name, show_builds
+from utils import CI_ROOT, get_build, get_image_name, get_requested_llvm_version, print_red, get_cbl_name, show_builds, die, warn, info
 
 
 def _fetch(title, url, dest):
     current_time = time.strftime("%H:%M:%S", time.localtime())
-    print_yellow(f"{current_time}: fetching {title} from: {url}")
+    info(f"{current_time}: fetching {title} from: {url}")
     retries = 0
     max_retries = 7
     retry_codes = [404, 500, 504]
@@ -27,26 +27,22 @@ def _fetch(title, url, dest):
             urllib.request.urlretrieve(url, dest)
             break
         except ConnectionResetError as err:
-            print_yellow(f"{title} download error ('{err}'), retrying...")
+            warn(f"{title} download error ('{err}'), retrying...")
         except urllib.error.HTTPError as err:
             if err.code in retry_codes:
-                print_yellow(
-                    f"{title} download error ({err.code}), retrying...")
+                warn(f"{title} download error ({err.code}), retrying...")
             else:
-                print_red(f"{err.code} error trying to download {title}")
-                sys.exit(1)
+                die(f"{err.code} error trying to download {title}")
         except urllib.error.URLError as err:
-            print_yellow(f"{title} download error ('{err}'), retrying...")
+            warn(f"{title} download error ('{err}'), retrying...")
 
     if retries == max_retries:
-        print_red(f"Unable to download {title} after {max_retries} tries")
-        sys.exit(1)
+        die(f"Unable to download {title} after {max_retries} tries")
 
     if dest.exists():
-        print_yellow(f"Filesize: {dest.stat().st_size}")
+        info(f"Filesize: {dest.stat().st_size}")
     else:
-        print_red(f"Unable to download {title}")
-        sys.exit(1)
+        die(f"Unable to download {title}")
 
 
 def verify_build():
@@ -60,8 +56,7 @@ def verify_build():
     while retries < max_retries:
         # build never started
         if (build_status := build['tuxbuild_status']) == 'error':
-            print_red(f"msg from tuxsuite: {build['status_message']}")
-            sys.exit(1)
+            die(f"msg from tuxsuite: {build['status_message']}")
         # build is finished
         elif build_status == "complete":
             break
@@ -78,16 +73,14 @@ def verify_build():
     print(json.dumps(build, indent=4))
 
     if retries == max_retries:
-        print_red("Build is not finished on TuxSuite's side!")
-        sys.exit(1)
+        die("Build is not finished on TuxSuite's side!")
 
     if "Build Timed Out" in build["status_message"]:
-        print_red(build["status_message"])
-        sys.exit(1)
+        die(build["status_message"])
 
     if build["status_message"] == "Unable to apply kernel patch":
         print_red(
-            "Patch failed to apply to current kernel tree, does it need to be removed or updated?"
+            "ERROR: Patch failed to apply to current kernel tree, does it need to be removed or updated?"
         )
         fetch_logs(build)
         sys.exit(1)
@@ -106,7 +99,7 @@ def check_log(build):
     warnings_count = build["warnings_count"]
     errors_count = build["errors_count"]
     if warnings_count + errors_count > 0:
-        print_yellow(f"{warnings_count} warnings, {errors_count} errors")
+        info(f"{warnings_count} warnings, {errors_count} errors")
         fetch_logs(build)
 
 
@@ -159,12 +152,12 @@ def check_built_config(build):
             elif line.startswith("# CONFIG_"):
                 name, state = line.split(" ", 2)[1:]
                 if state != "is not set":
-                    print_yellow(
+                    warn(
                         f"Could not parse '{name}' from .config line '{line}'!?"
                     )
                 state = 'n'
             elif not line.startswith("#"):
-                print_yellow(f"Could not parse .config line '{line}'!?")
+                warn(f"Could not parse .config line '{line}'!?")
             configs[name] = state
 
     # Compare requested configs against the loaded dictionary.
@@ -175,7 +168,7 @@ def check_built_config(build):
         name, state = config.split('=')
         # If a config is missing from the dictionary, it is considered 'n'.
         if state != configs.get(name, 'n'):
-            print_red(f"FAIL: {config} not found in .config!")
+            print_red(f"ERROR: {config} not found in .config!")
             fail = True
         else:
             print(f"ok: {name}={state}")
@@ -195,7 +188,7 @@ def print_clang_info(build):
     url = build["download_url"] + metadata_file.name
     _fetch(metadata_file, url, metadata_file)
     metadata_json = json.loads(metadata_file.read_text(encoding='utf-8'))
-    print_yellow("Printing clang-nightly checkout date and hash")
+    info("Printing clang-nightly checkout date and hash")
     parse_cmd = [
         Path(CI_ROOT, "scripts/parse-debian-clang.py"), "--print-info",
         "--version-string", metadata_json["compiler"]["version_full"]
@@ -243,8 +236,7 @@ def run_boot(build):
             boot_cmd += ["-t", "10m"]
         if "CONFIG_KASAN_KUNIT_TEST=y" in build["kconfig"] or \
            "CONFIG_KCSAN_KUNIT_TEST=y" in build["kconfig"]:
-            print_yellow(
-                "Disabling Oops problem matcher under Sanitizer KUnit build")
+            info("Disabling Oops problem matcher under Sanitizer KUnit build")
             print("::remove-matcher owner=linux-kernel-oopses::")
 
     # Before spawning a process with potentially different IO buffering,
@@ -256,19 +248,17 @@ def run_boot(build):
         subprocess.run(boot_cmd, check=True)
     except subprocess.CalledProcessError as err:
         if err.returncode == 124:
-            print_red("Image failed to boot")
+            print_red("ERROR: Image failed to boot")
         raise err
 
 
 def boot_test(build):
     if build["result"] == "unknown":
-        print_red("unknown build result, skipping boot")
-        sys.exit(1)
+        die("unknown build result, skipping boot")
     if build["result"] == "fail":
-        print_red("fatal build errors encountered during build, skipping boot")
-        sys.exit(1)
+        die("fatal build errors encountered during build, skipping boot")
     if "BOOT" in os.environ and os.environ["BOOT"] == "0":
-        print_yellow("boot test disabled via config, skipping boot")
+        info("boot test disabled via config, skipping boot")
         return
     fetch_kernel_image(build)
     fetch_dtb(build)
@@ -282,11 +272,11 @@ def boot_test(build):
             missing.append(var)
     if missing:
         for var in missing:
-            print_red(f"${var} must be specified")
+            print_red(f"ERROR: ${var} must be specified")
         show_builds()
         sys.exit(1)
     verified_build = verify_build()
-    print_yellow("Register clang error/warning problem matchers")
+    info("Register clang error/warning problem matchers")
     for problem_matcher in glob.glob(".github/problem-matchers/*.json"):
         print(f"::add-matcher::{problem_matcher}")
     print_clang_info(verified_build)

utils.py

@@ -13,6 +13,11 @@
 LLVM_TOT_VERSION = Path(GENERATOR_ROOT, 'LLVM_TOT_VERSION')
 
 
+def die(msg):
+    print_red(f"ERROR: {msg}")
+    sys.exit(1)
+
+
 # Certain subsystems have more targeted -Werror configurations. If we have
 # CONFIG_WERROR=n, it means we are explicitly opting out of -Werror for some
 # reason, so all other known subsystem specific configurations should be
@@ -30,7 +35,7 @@ def disable_subsys_werror_configs(configs):
 def get_config_from_generator():
     if not (all_generator_files := sorted(
             Path(GENERATOR_ROOT, 'yml').glob('*.yml'))):
-        raise FileNotFoundError('No generator files could not be found?')
+        return die('No generator files could not be found?')
 
     generator_pieces = []
     for file in all_generator_files:
@@ -131,18 +136,17 @@ def get_cbl_name():
         return unique_defconfigs[base_config]
     if "defconfig" in base_config or "virtconfig" in base_config:
         return "x86" if arch == "i386" else arch
-    raise RuntimeError("unknown CBL name")
+    return die("unknown CBL name")
 
 
 def _read_builds():
     file = "mock.builds.json" if os.environ.get("MOCK") else "builds.json"
     try:
         if (builds := Path(CI_ROOT, file)).stat().st_size == 0:
-            raise RuntimeError(f"{file} is zero sized?")
+            return die(f"{file} is zero sized?")
         builds_json = json.loads(builds.read_text(encoding='utf-8'))
-    except FileNotFoundError as err:
-        print_red(f"Unable to find {file}. Artifact not saved?")
-        raise err
+    except FileNotFoundError:
+        return die(f"Unable to find {file}. Artifact not saved?")
     return builds_json["builds"].values()
 
 
@@ -157,6 +161,10 @@ def get_requested_llvm_version():
     return f"korg-clang-{ver}"
 
 
+def info(msg):
+    print_yellow(f"INFO: {msg}")
+
+
 def show_builds():
     print_yellow("Available builds:")
     for build in _read_builds():
@@ -177,7 +185,7 @@ def get_build():
            build["toolchain"] == llvm_version and \
            build["kconfig"] == configs:
             return build
-    print_red("Unable to find build")
+    print_red("ERROR: Unable to find build")
     show_builds()
     sys.exit(1)
 
@@ -186,7 +194,7 @@ def get_repo_ref(config, tree_name):
     for tree in config["trees"]:
         if tree["name"] == tree_name:
             return tree["git_repo"], tree["git_ref"]
-    raise RuntimeError(f"Could not find git repo and ref for {tree_name}?")
+    return die(f"Could not find git repo and ref for {tree_name}?")
 
 
 def get_llvm_versions(config, tree_name):
@@ -290,16 +298,20 @@ def update_repository_variable(
 
 
 def print_red(msg):
-    print(f"\033[91m[CI ERROR] {msg}\033[0m", file=sys.stderr)
+    print(f"\033[91m{msg}\033[0m", file=sys.stderr)
     sys.stderr.flush()
 
 
 def print_yellow(msg):
-    print(f"\033[93m[CI WARNING] {msg}\033[0m", file=sys.stdout)
+    print(f"\033[93m{msg}\033[0m", file=sys.stdout)
     sys.stdout.flush()
 
 
 def patch_series_flag(tree):
     patches_folder = Path('patches', tree)
     patch_files = list(Path(CI_ROOT, patches_folder).glob('*.patch'))
     return f"--patch-series {patches_folder} " if patch_files else ""
+
+
+def warn(msg):
+    print_yellow(f"WARNING: {msg}")