Add check for deprecated pkginfo keys, expand typo checks

Author: homebysix

CHANGELOG.md

@@ -15,6 +15,8 @@ All notable changes to this project will be documented in this file. This projec
 ### Added
 
 - `check-munki-pkgsinfo` now produces an error if `uninstall_method` is set to `uninstall_script` but no uninstall script is present in the pkginfo.
+- `check-munki-pkgsinfo` now checks for deprecated pkginfo keys.
+- `check-munki-pkgsinfo` now includes checks for many possible pkginfo key typos, not just `minimum_os_version` and `maximum_os_version`. Suggestions welcome if you think of more.
 - `check-munkiadmin-scripts` now checks whether scripts are named correctly, not just executable.
 
 ## [1.17.0] - 2024-12-22

pre_commit_hooks/check_autopkg_recipes.py

@@ -10,6 +10,8 @@
 from packaging.version import Version
 
 from pre_commit_hooks.util import (
+    detect_deprecated_keys,
+    detect_typoed_keys,
     load_autopkg_recipe,
     validate_pkginfo_key_types,
     validate_required_keys,
@@ -611,24 +613,10 @@ def main(argv=None):
                 retval = 1
             if not validate_restart_action_key(input_key["pkginfo"], filename):
                 retval = 1
-
-            # Check for common mistakes in min/max OS version keys
-            os_vers_corrections = {
-                "min_os": "minimum_os_version",
-                "max_os": "maximum_os_version",
-                "min_os_vers": "minimum_os_version",
-                "max_os_vers": "maximum_os_version",
-                "minimum_os": "minimum_os_version",
-                "maximum_os": "maximum_os_version",
-                "minimum_os_vers": "minimum_os_version",
-                "maximum_os_vers": "maximum_os_version",
-            }
-            for os_vers_key in os_vers_corrections:
-                if os_vers_key in input_key["pkginfo"]:
-                    print(
-                        f"{filename}: You used {os_vers_key} when you probably meant {os_vers_corrections[os_vers_key]}."
-                    )
-                    retval = 1
+            if not detect_deprecated_keys(input_key["pkginfo"], filename):
+                retval = 1
+            if not detect_typoed_keys(input_key["pkginfo"], filename):
+                retval = 1
 
             # TODO: Additional pkginfo checks here.
 

pre_commit_hooks/check_munki_pkgsinfo.py

@@ -8,6 +8,8 @@
 from xml.parsers.expat import ExpatError
 
 from pre_commit_hooks.util import (
+    detect_deprecated_keys,
+    detect_typoed_keys,
     validate_pkginfo_key_types,
     validate_required_keys,
     validate_restart_action_key,
@@ -114,23 +116,13 @@ def main(argv=None):
         if not validate_restart_action_key(pkginfo, filename):
             retval = 1
 
-        # Check for common mistakes in min/max OS version keys.
-        os_vers_corrections = {
-            "min_os": "minimum_os_version",
-            "max_os": "maximum_os_version",
-            "min_os_vers": "minimum_os_version",
-            "max_os_vers": "maximum_os_version",
-            "minimum_os": "minimum_os_version",
-            "maximum_os": "maximum_os_version",
-            "minimum_os_vers": "minimum_os_version",
-            "maximum_os_vers": "maximum_os_version",
-        }
-        for os_vers_key in os_vers_corrections:
-            if os_vers_key in pkginfo:
-                print(
-                    f"{filename}: You used {os_vers_key} when you probably meant {os_vers_corrections[os_vers_key]}."
-                )
-                retval = 1
+        # Check for deprecated pkginfo keys.
+        if not detect_deprecated_keys(pkginfo, filename):
+            retval = 1
+
+        # Check for common mistakes key names.
+        if not detect_typoed_keys(pkginfo, filename):
+            retval = 1
 
         # Check for rogue categories.
         if args.categories and pkginfo.get("category") not in args.categories:

pre_commit_hooks/util.py

@@ -77,6 +77,69 @@ def validate_required_keys(input_dict, filename, required_keys):
     return passed
 
 
+def detect_deprecated_keys(input_dict, filename):
+    """Verifies that no deprecated keys are present in dictionary."""
+    # List from: https://github.com/munki/munki/wiki/Supported-Pkginfo-Keys
+    deprecated_keys = (
+        "suppress_bundle_relocation",
+        "forced_install",
+        "forced_uninstall",
+    )
+    passed = True
+    for dep_key in deprecated_keys:
+        if input_dict.get(dep_key):
+            print(f"{filename}: {dep_key} key is deprecated")
+            passed = False
+    return passed
+
+
+def detect_typoed_keys(input_dict, filename):
+    """Verifies that specific key name typos are not present in dictionary."""
+    key_corrections = {
+        "appleitem": "apple_item",
+        "blocking_apps": "blocking_applications",
+        "blockingapplications": "blocking_applications",
+        "choices_xml": "installer_choices_xml",
+        "icon": "icon_name",
+        "install_check_script": "installcheck_script",
+        "installer_choices": "installer_choices_xml",
+        "max_os_vers": "maximum_os_version",
+        "max_os": "maximum_os_version",
+        "maximum_os_vers": "maximum_os_version",
+        "maximum_os": "maximum_os_version",
+        "min_munki_vers": "minimum_munki_version",
+        "min_munki": "minimum_munki_version",
+        "min_os_vers": "minimum_os_version",
+        "min_os": "minimum_os_version",
+        "minimum_munki_vers": "minimum_munki_version",
+        "minimum_munki": "minimum_munki_version",
+        "minimum_os_vers": "minimum_os_version",
+        "minimum_os": "minimum_os_version",
+        "on_demand": "OnDemand",
+        "post_install_script": "postinstall_script",
+        "post_uninstall_script": "postuninstall_script",
+        "pre_cache": "precache",
+        "pre_install_alert": "preinstall_alert",
+        "pre_install_script": "preinstall_script",
+        "pre_uninstall_alert": "preuninstall_alert",
+        "pre_uninstall_script": "preuninstall_script",
+        "pre_upgrade_alert": "preupgrade_alert",
+        "receipt": "receipts",
+        "require": "requires",
+        "supported_architecture": "supported_architectures",
+        "uninstall_check_script": "uninstallcheck_script",
+    }
+    passed = True
+    for found_key, expected_key in key_corrections.items():
+        if found_key in input_dict:
+            print(
+                f"{filename}: You used {found_key} when you "
+                f"probably meant {expected_key}."
+            )
+            passed = False
+    return passed
+
+
 def validate_restart_action_key(pkginfo, filename):
     """Verifies that required_keys are present in pkginfo dictionary."""
     passed = True