From ada06362dc400f272f1726988738cab2b6593baf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Bargull?= <andre.bargull@gmail.com>
Date: Tue, 17 Dec 2024 17:09:14 +0100
Subject: [PATCH] Add linter for parseTestRecord

---
 tools/lint/lib/checks/parsetestrecord.py | 92 ++++++++++++++++++++++++
 tools/lint/lib/frontmatter.py            |  3 +-
 tools/lint/lint.py                       |  2 +
 3 files changed, 96 insertions(+), 1 deletion(-)
 create mode 100644 tools/lint/lib/checks/parsetestrecord.py

diff --git a/tools/lint/lib/checks/parsetestrecord.py b/tools/lint/lib/checks/parsetestrecord.py
new file mode 100644
index 00000000000..d79f324bd08
--- /dev/null
+++ b/tools/lint/lib/checks/parsetestrecord.py
@@ -0,0 +1,92 @@
+import os
+import sys
+from ..check import Check
+
+
+def load_module_2(dirname, module_name):
+    import imp
+
+    f = None
+    try:
+        (f, pathname, description) = imp.find_module(module_name, [dirname])
+        module = imp.load_module(module_name, f, pathname, description)
+        return module
+    except:
+        raise ImportError("Can't load " + module_name)
+    finally:
+        if f:
+            f.close()
+
+
+def load_module_3(dirname, module_name):
+    import importlib.machinery
+    import importlib.util
+
+    # Create a FileFinder to load Python source files.
+    loader_details = (
+        importlib.machinery.SourceFileLoader,
+        importlib.machinery.SOURCE_SUFFIXES,
+    )
+    finder = importlib.machinery.FileFinder(dirname, loader_details)
+
+    # Find the module spec.
+    spec = finder.find_spec(module_name)
+    if spec is None:
+        raise RuntimeError("Can't load " + module_name)
+
+    # Create and execute the module.
+    module = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(module)
+
+    # Return the executed module
+    return module
+
+
+def load_parse_test_record():
+    checks_dir = os.path.dirname(os.path.realpath(__file__))
+    packing_dir = os.path.join(checks_dir, "../../../packaging")
+    module_name = "parseTestRecord"
+
+    # The "imp" module is deprecated in Python 3.4 and will be removed in
+    # Python 3.12. Use it only if the current Python version is too old to use
+    # the "importlib" module.
+    if sys.version_info < (3, 4):
+        return load_module_2(packing_dir, module_name)
+
+    return load_module_3(packing_dir, module_name)
+
+
+parse_test_record = load_parse_test_record().parseTestRecord
+
+
+class CheckParseTestRecord(Check):
+    '''Ensure tests can be parsed using parseTestRecord.py'''
+    ID = 'ParseTestRecord'
+
+    def run(self, name, meta, source):
+        # Skip if not a test file.
+        if not meta:
+            return None
+
+        errors = []
+        test_rec = parse_test_record(source, name, lambda e: errors.append(e))
+
+        # Return if parse_test_record encountered errors.
+        if errors:
+            return "\n".join(errors)
+
+        # Ensure all flags in `test_rec` are consistent with `meta`.
+        if "flags" in meta:
+            if "flags" not in test_rec:
+                return "Flags not present in parseTestRecord"
+
+            if meta["flags"] != test_rec["flags"]:
+                return "Flags don't match parseTestRecord"
+
+            for flag in meta["flags"]:
+                if flag not in test_rec:
+                    return "Flag not present in parseTestRecord: " + flag
+        elif "flags" in test_rec:
+            return "Unexpected flags present in parseTestRecord"
+
+        return None
diff --git a/tools/lint/lib/frontmatter.py b/tools/lint/lib/frontmatter.py
index 0f20dc62e20..2bfc9aea463 100644
--- a/tools/lint/lib/frontmatter.py
+++ b/tools/lint/lib/frontmatter.py
@@ -28,6 +28,7 @@ def parse(src):
         return None
 
     try:
-        return Result(yaml.load(match.group(1), MyLoader), MyLoader.events)
+        # NB: Call strip() to match parseTestRecord.
+        return Result(yaml.load(match.group(1).strip(), MyLoader), MyLoader.events)
     except (yaml.scanner.ScannerError, yaml.parser.ParserError):
         return None
diff --git a/tools/lint/lint.py b/tools/lint/lint.py
index b8eaa86e868..61ddf22d349 100755
--- a/tools/lint/lint.py
+++ b/tools/lint/lint.py
@@ -41,6 +41,7 @@
 from lib.checks.nopadding import CheckNoPadding
 from lib.checks.flags import CheckFlags
 from lib.checks.posix import CheckPosix
+from lib.checks.parsetestrecord import CheckParseTestRecord
 from lib.eprint import eprint
 import lib.frontmatter
 import lib.exceptions
@@ -70,6 +71,7 @@ def checks(features):
         CheckNoPadding(),
         CheckFlags(),
         CheckPosix(),
+        CheckParseTestRecord(),
     ]
 
 def lint(file_names, features):