add linter command

Scan the patches, settings, and plugins for things that may be misnamed.

Author: dhellmann

src/fromager/__main__.py

@@ -202,6 +202,7 @@ def main(
         variant=variant,
         network_isolation=network_isolation,
         max_jobs=jobs,
+        settings_dir=settings_dir,
     )
     wkctx.setup()
     ctx.obj = wkctx

src/fromager/commands/__init__.py

@@ -5,6 +5,7 @@
     canonicalize,
     download_sequence,
     graph,
+    lint,
     list_overrides,
     migrate_config,
     server,
@@ -17,6 +18,7 @@
     build.build_sequence,
     build_order.build_order,
     graph.graph,
+    lint.lint,
     list_overrides.list_overrides,
     migrate_config.migrate_config,
     step.step,

src/fromager/commands/lint.py

@@ -0,0 +1,65 @@
+import logging
+
+import click
+
+from .. import context, overrides
+
+logger = logging.getLogger(__name__)
+
+
+@click.command()
+@click.pass_obj
+def lint(
+    wkctx: context.WorkContext,
+) -> None:
+    """Review existing settings and overrides for potential configuration errors."""
+    errors = 0
+
+    logger.info(f"Checking patches in {wkctx.settings.patches_dir}...")
+    for entry in wkctx.settings.patches_dir.glob("*"):
+        logger.debug(entry)
+        if "-" in entry.name:
+            actual_package_name, _, version_str = entry.name.rpartition("-")
+            expected_package_name = overrides.pkgname_to_override_module(
+                actual_package_name
+            )
+            if actual_package_name != expected_package_name:
+                errors += 1
+                logger.error(
+                    f"ERROR: Patch directory {entry.name} should be {expected_package_name}-{version_str}"
+                )
+        else:
+            expected_package_name = overrides.pkgname_to_override_module(entry.name)
+            if actual_package_name != expected_package_name:
+                errors += 1
+                logger.error(
+                    f"ERROR: Patch directory {entry.name} should be {expected_package_name}"
+                )
+
+    if wkctx.settings_dir is not None:
+        logger.info(f"Checking settings files in {wkctx.settings_dir}...")
+        for entry in wkctx.settings_dir.glob("*"):
+            logger.debug(entry)
+            if entry.suffix != ".yaml":
+                errors += 1
+                logger.error(
+                    f"ERROR: settings file {entry.name} should use extension '.yaml'"
+                )
+            expected_package_name = overrides.pkgname_to_override_module(entry.stem)
+            if entry.stem != expected_package_name:
+                errors += 1
+                logger.error(
+                    f"ERROR: Settings file {entry.name} should be {expected_package_name}.yaml"
+                )
+
+    logger.info("Checking entry points...")
+    exts = overrides._get_extensions()
+    for name in exts.names():
+        logger.debug(name)
+        expected_name = overrides.pkgname_to_override_module(name)
+        if name != expected_name:
+            errors += 1
+            logger.error(f"ERROR: plugin name {name} should be {expected_name}")
+
+    if errors:
+        raise SystemExit(f"Found {errors} errors")

src/fromager/context.py

@@ -37,6 +37,7 @@ def __init__(
         variant: str = "cpu",
         network_isolation: bool = False,
         max_jobs: int | None = None,
+        settings_dir: pathlib.Path | None = None,
     ):
         if active_settings is None:
             active_settings = packagesettings.Settings(
@@ -67,6 +68,7 @@ def __init__(
         self.cleanup = cleanup
         self.variant = variant
         self.network_isolation = network_isolation
+        self.settings_dir = settings_dir
 
         self._build_order_filename = self.work_dir / "build-order.json"
         self._constraints_filename = self.work_dir / "constraints.txt"