Add validation of AutoPkg processor input variables (arguments)

Author: homebysix

README.md

@@ -52,7 +52,7 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
 
 - __check-autopkg-recipes__
 
-    This hook checks AutoPkg recipes to ensure they meet various requirements.
+    This hook checks AutoPkg recipes to ensure they meet various requirements and conventions.
 
     - Optionally specify your preferred AutoPkg recipe and/or override prefix, if you wish to enforce them:
         `args: ['--override-prefix=com.yourcompany.autopkg.']`  
@@ -65,7 +65,7 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
         (default: `1.0.0`)  
         Specifying `0.1.0` will not ignore any MinimumVersion mismatches.
 
-    - If you're a purist, you can also enable strict mode. This enforces recipe type conventions, all processor/MinimumVersion mismatches, and forbids `<!-- -->` style comments.  
+    - If you're a purist, you can also enable strict mode. This enforces recipe type conventions, all processor/MinimumVersion mismatches, forbids `<!-- -->` style comments, and ensures all processor input variables (arguments) are valid.  
         `args: ['--strict']`  
         (default: False)
 

pre_commit_hooks/check_autopkg_recipes.py

@@ -4,7 +4,10 @@
 requirements."""
 
 import argparse
+import os
 import plistlib
+import sys
+from contextlib import contextmanager
 from distutils.version import LooseVersion
 from xml.parsers.expat import ExpatError
 
@@ -15,6 +18,29 @@
 )
 
 
+# Import AutoPkg libraries, but ignore any warnings generated by the import.
+@contextmanager
+def suppress_stdout():
+    with open(os.devnull, "w") as devnull:
+        old_stdout = sys.stdout
+        sys.stdout = devnull
+        try:
+            yield
+        finally:
+            sys.stdout = old_stdout
+
+
+sys.path.append("/Library/AutoPkg")
+try:
+    with suppress_stdout():
+        from autopkglib import get_processor, processor_names
+
+    HAS_AUTOPKGLIB = True
+except ImportError:
+    # Silently skip checks that require autopkglib.
+    HAS_AUTOPKGLIB = False
+
+
 def build_argument_parser():
     """Build and return the argument parser."""
 
@@ -388,6 +414,56 @@ def validate_required_proc_for_types(process, filename):
     return passed
 
 
+def validate_proc_args(process, filename):
+    """Warn if invalid processor arguments are used."""
+
+    passed = True
+
+    # List of argument names (lowercase) that will not be flagged as invalid.
+    ignored_args = ("note", "notes", "comment", "comments")
+
+    # Create dictionary of AutoPkg core processors and their inputs.
+    core_procs = {}
+    for proc in processor_names():
+        if hasattr(get_processor(proc), "input_variables"):
+            core_procs[proc] = get_processor(proc).input_variables
+        else:
+            core_procs[proc] = {}
+
+    for proc in process:
+        if proc["Processor"] not in core_procs:
+            # Skip input variable validation for non-core processors.
+            continue
+        for arg in proc.get("Arguments", {}):
+            if arg.lower() in ignored_args:
+                # Skip args in ignored list above.
+                continue
+
+            if not core_procs[proc["Processor"]]:
+                print(
+                    "{}: Unknown argument {} for processor {}, "
+                    "which does not accept any arguments.".format(
+                        filename,
+                        arg,
+                        proc["Processor"],
+                    )
+                )
+                passed = False
+            elif arg not in core_procs[proc["Processor"]]:
+                print(
+                    "{}: Unknown argument {} for processor {}. "
+                    "Allowed arguments are: {}".format(
+                        filename,
+                        arg,
+                        proc["Processor"],
+                        ", ".join(core_procs[proc["Processor"]]),
+                    )
+                )
+                passed = False
+
+    return passed
+
+
 def main(argv=None):
     """Main process."""
 
@@ -507,6 +583,10 @@ def main(argv=None):
                 if not validate_required_proc_for_types(process, filename):
                     retval = 1
 
+                if HAS_AUTOPKGLIB:
+                    if not validate_proc_args(process, filename):
+                        retval = 1
+
     return retval