CI: Add hook to validate header dependencies

.github/workflows/static_checks.yml

@@ -16,6 +16,11 @@ jobs:
         with:
           fetch-depth: 2
 
+      - name: Style checks via pre-commit
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --hook-stage manual -a check-dependencies
+
       - name: Install APT dependencies
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:

.pre-commit-config.yaml

@@ -195,6 +195,15 @@ repos:
         language: python
         entry: python misc/scripts/dotnet_format.py
         types_or: [c#]
+
+      - id: check-dependencies
+        name: check-dependencies
+        language: python
+        entry: python misc/scripts/check_dependencies.py
+        files: \.(h|hpp|hh|hxx|inc)$
+        pass_filenames: true
+        require_serial: true
+        stages: [manual]
 #
 # End of upstream Godot pre-commit hooks.
 #

misc/scripts/check_dependencies.py

@@ -0,0 +1,90 @@
+#!/usr/bin/env python3
+
+from __future__ import annotations
+
+import argparse
+import os
+import re
+import sys
+from pathlib import Path
+from typing import Final, NoReturn, cast
+
+SCONSCRIPT_RE: Final[re.Pattern[str]] = re.compile(r'(?:^\s*SConscript\("?)(.*?)(?:"?\))', re.MULTILINE)
+INCLUDE_RE: Final[re.Pattern[str]] = re.compile(r'(?:^#include ")(?!\bthirdparty\b)(.*?)(?:")', re.MULTILINE)
+ROOT_DIR: Final[Path] = Path(__file__).parent.parent.parent
+IS_CI: Final[bool] = bool(os.environ.get("CI"))
+
+
+def print_warning(content: str) -> None:
+    if IS_CI:
+        print(f"::warning::{content}", file=sys.stderr)
+    else:
+        print(f"WARNING: {content}", file=sys.stderr)
+
+
+def print_error(content: str) -> None:
+    if IS_CI:
+        print(f"::error::{content}", file=sys.stderr)
+    else:
+        print(f"ERROR: {content}", file=sys.stderr)
+
+
+def build_header_tree(header_tree: list[Path], path: Path) -> None:
+    path_dir = path.parent
+    header_tree.append(path_dir)
+
+    with open(path, encoding="utf-8") as file:
+        matches = cast(list[str], SCONSCRIPT_RE.findall(file.read()))
+
+    for match in matches:
+        if " " in match:
+            # TODO: Can't handle non-generic strings *at all*, maybe SCons can give this info natively?
+            # Ehh, just workaround for now, it's a proof-of-concept anyway.
+            for child in ((path_dir / "platform") if (path_dir / "platform").exists() else path_dir).iterdir():
+                if child.is_dir() and (sub := child / "SCsub").exists():
+                    build_header_tree(header_tree, sub)
+            continue
+        build_header_tree(header_tree, path_dir / match)
+
+
+def parse_header(header: Path, header_tree: list[Path]) -> None:
+    if (header_dir := header.parent.resolve()) not in header_tree:
+        print_warning(f'"{header}" not found in header tree')
+        return
+    header_index = header_tree.index(header_dir)
+
+    with open(header, encoding="utf-8") as file:
+        matches = [Path(header) for header in INCLUDE_RE.findall(file.read())]
+
+    for match in matches:
+        if (match_dir := match.parent.resolve()) not in header_tree:
+            # Could be relative
+            if (match_dir := (header_dir / match.parent).resolve()) not in header_tree:
+                print_warning(f'"{header}" dependency "{match}" not found in header tree')
+                continue
+        if header_tree.index(match_dir) > header_index:
+            print_error(f'"{header}" has invalid dependency: "{match}"')
+            continue
+
+
+def main() -> NoReturn:
+    parser = argparse.ArgumentParser(
+        prog="check_dependencies",
+        description="Ensure that header files only include scripts at or below their dependency level.",
+    )
+    parser.add_argument("headers", nargs="+", help="A list of header files to validate.", type=Path)
+    args = parser.parse_args()
+
+    header_tree: list[Path] = []
+    build_header_tree(header_tree, ROOT_DIR / "SConstruct")
+    # print([header.as_posix() for header in header_tree])
+
+    for header in cast(list[Path], args.headers):
+        parse_header(header, header_tree)
+
+    # Force fail
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()