|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +# [MISE] description="Make sure the BOM has all necessary modules" |
| 4 | + |
| 5 | +import difflib |
| 6 | +import re |
| 7 | +import sys |
| 8 | +from fnmatch import fnmatch |
| 9 | +from pathlib import Path |
| 10 | +from typing import List |
| 11 | + |
| 12 | +ROOT = Path(__file__).resolve().parents[2] # repo root (.. from .mise/tasks) |
| 13 | +IGNORE_DIRS = {"prometheus-metrics-parent"} |
| 14 | +MODULE_PREFIX = "prometheus-metrics" |
| 15 | +BOM_POM = ROOT / "prometheus-metrics-bom" / "pom.xml" |
| 16 | + |
| 17 | + |
| 18 | +def first_artifact_id(pom_file: Path) -> str: |
| 19 | + """Return the second <artifactId> value from the given pom.xml (matches original script). |
| 20 | +
|
| 21 | + The original shell function greps all <artifactId> lines and returns the second one |
| 22 | + (head -n 2 | tail -n 1). We replicate that behavior exactly. |
| 23 | + """ |
| 24 | + if not pom_file.is_file(): |
| 25 | + raise FileNotFoundError(f"File {pom_file} does not exist.") |
| 26 | + |
| 27 | + text = pom_file.read_text(encoding="utf-8") |
| 28 | + matches = re.findall(r"<artifactId>\s*(.*?)\s*</artifactId>", text) |
| 29 | + if len(matches) < 2: |
| 30 | + return "" |
| 31 | + return matches[1].strip() |
| 32 | + |
| 33 | + |
| 34 | +def add_dir(dir_path: Path, want: List[str]): |
| 35 | + if not dir_path.is_dir(): |
| 36 | + raise FileNotFoundError(f"Directory {dir_path} does not exist.") |
| 37 | + |
| 38 | + if any(dir_path.name == ig for ig in IGNORE_DIRS): |
| 39 | + print(f"Skipping {dir_path}") |
| 40 | + return |
| 41 | + |
| 42 | + pom = dir_path / "pom.xml" |
| 43 | + if not pom.is_file(): |
| 44 | + raise FileNotFoundError(f"File {pom} does not exist.") |
| 45 | + |
| 46 | + artifact_id = first_artifact_id(pom) |
| 47 | + if not artifact_id: |
| 48 | + raise RuntimeError(f"No artifactId found in {pom}") |
| 49 | + |
| 50 | + print(f"Found artifactId '{artifact_id}' in {pom}") |
| 51 | + want.append(artifact_id) |
| 52 | + |
| 53 | + |
| 54 | +def collect_want(root: Path) -> List[str]: |
| 55 | + want: List[str] = [] |
| 56 | + # top-level prometheus-metrics* |
| 57 | + for entry in sorted(root.iterdir()): |
| 58 | + if entry.is_dir() and fnmatch(entry.name, f"{MODULE_PREFIX}*"): |
| 59 | + add_dir(entry, want) |
| 60 | + |
| 61 | + # prometheus-metrics-tracer/prometheus-metrics* |
| 62 | + tracer_dir = root / "prometheus-metrics-tracer" |
| 63 | + if tracer_dir.is_dir(): |
| 64 | + for entry in sorted(tracer_dir.iterdir()): |
| 65 | + if entry.is_dir() and fnmatch(entry.name, f"{MODULE_PREFIX}*"): |
| 66 | + add_dir(entry, want) |
| 67 | + |
| 68 | + # deduplicate and sort |
| 69 | + want_unique = sorted(set(want)) |
| 70 | + return want_unique |
| 71 | + |
| 72 | + |
| 73 | +def collect_have(bom_pom: Path) -> List[str]: |
| 74 | + if not bom_pom.is_file(): |
| 75 | + raise FileNotFoundError(f"BOM file {bom_pom} does not exist.") |
| 76 | + |
| 77 | + text = bom_pom.read_text(encoding="utf-8") |
| 78 | + # find artifactId values that start with MODULE_PREFIX |
| 79 | + matches = re.findall( |
| 80 | + r"<artifactId>\s*(%s[^<\s]*)\s*</artifactId>" % re.escape(MODULE_PREFIX), text |
| 81 | + ) |
| 82 | + return sorted(matches) |
| 83 | + |
| 84 | + |
| 85 | +def main() -> int: |
| 86 | + try: |
| 87 | + want = collect_want(ROOT) |
| 88 | + have = collect_have(BOM_POM) |
| 89 | + |
| 90 | + want_text = "\n".join(want) |
| 91 | + have_text = "\n".join(have) |
| 92 | + |
| 93 | + if want_text != have_text: |
| 94 | + print( |
| 95 | + "The BOM file prometheus-metrics-bom/bom.xml does not match the current directory contents." |
| 96 | + ) |
| 97 | + print("Expected:") |
| 98 | + print(want_text) |
| 99 | + print("Found:") |
| 100 | + print(have_text) |
| 101 | + print() |
| 102 | + diff = difflib.unified_diff( |
| 103 | + have_text.splitlines(keepends=True), |
| 104 | + want_text.splitlines(keepends=True), |
| 105 | + fromfile="found", |
| 106 | + tofile="expected", |
| 107 | + ) |
| 108 | + sys.stdout.writelines(diff) |
| 109 | + return 1 |
| 110 | + else: |
| 111 | + print("BOM file is up to date.") |
| 112 | + return 0 |
| 113 | + |
| 114 | + except Exception as e: |
| 115 | + print(e, file=sys.stderr) |
| 116 | + return 1 |
| 117 | + |
| 118 | + |
| 119 | +if __name__ == "__main__": |
| 120 | + sys.exit(main()) |
0 commit comments