Add required keys and uninstall_method check to AutoPkg munki recipes

Author: homebysix

CHANGELOG.md

@@ -12,9 +12,15 @@ All notable changes to this project will be documented in this file. This projec
 
 ## [Unreleased]
 
+### Added
+
+- `check-autopkg-recipes` requires Munki recipe `pkginfo` dicts to contain at least `name` and `description`.
+- `check-autopkg-recipes` now validates that `uninstall_method` and `uninstall_script` are set appropriately in Munki recipes.
+
 ### Changed
 
-- Add jamf-upload as an AutoPkg recipe type, and updated processors included in jamf/jamf-upload recipe convention.
+- `check-autopkg-recipes` includes jamf-upload as an AutoPkg recipe type, and updated processors included in jamf/jamf-upload recipe convention.
+- `check-munki-pkgsinfo` requires a `version` key in addition to `name` and `description`.
 
 ## [1.18.0] - 2025-01-04
 

pre_commit_hooks/check_autopkg_recipes.py

@@ -16,6 +16,7 @@
     validate_pkginfo_key_types,
     validate_required_keys,
     validate_restart_action_key,
+    validate_uninstall_method,
 )
 
 
@@ -580,6 +581,7 @@ def main(argv=None):
         #     recipe_text = openfile.read()
 
         # Top level keys that all AutoPkg recipes should contain.
+        # TODO: Make required recipe keys configurable.
         required_keys = ["Identifier"]
         if not validate_required_keys(recipe, filename, required_keys):
             retval = 1
@@ -615,12 +617,30 @@ def main(argv=None):
         # If the Input key contains a pkginfo dict, make a best effort to validate its contents.
         input_key = recipe.get("Input", recipe.get("input", recipe.get("INPUT")))
         if input_key and "pkginfo" in input_key:
+
+            # Check for presence of required pkginfo keys.
+            # TODO: Make required pkginfo keys within a recipe configurable.
+            req_keys = ["name", "description"]
+            if not validate_required_keys(input_key["pkginfo"], filename, req_keys):
+                retval = 1
+
+            # Ensure pkginfo keys have expected types.
             if not validate_pkginfo_key_types(input_key["pkginfo"], filename):
                 retval = 1
+
+            # Validate RestartAction key.
             if not validate_restart_action_key(input_key["pkginfo"], filename):
                 retval = 1
+
+            # Validate uninstall method.
+            if not validate_uninstall_method(input_key["pkginfo"], filename):
+                retval = 1
+
+            # Check for deprecated pkginfo keys.
             if not detect_deprecated_keys(input_key["pkginfo"], filename):
                 retval = 1
+
+            # Check for common mistakes in key names.
             if not detect_typoed_keys(input_key["pkginfo"], filename):
                 retval = 1