Merge pull request #84 from homebysix/dev

1.18.0 merge to main

Author: homebysix

.pre-commit-hooks.yaml

@@ -71,7 +71,7 @@
 
 - id: check-munkiadmin-scripts
   name: Check MunkiAdmin Scripts
-  description: This hook ensures MunkiAdmin scripts are executable.
+  description: This hook ensures MunkiAdmin scripts are named properly and executable.
   entry: check-munkiadmin-scripts
   language: python
   files: "^MunkiAdmin/scripts/"

CHANGELOG.md

@@ -14,6 +14,15 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.18.0] - 2025-01-04
+
+### 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
 
 ### Added
@@ -383,7 +392,8 @@ Nothing yet.
 
 - Initial release
 
-[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.17.0...HEAD
+[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.18.0...HEAD
+[1.18.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.17.0...v1.18.0
 [1.17.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.16.2...v1.17.0
 [1.16.2]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.16.1...v1.16.2
 [1.16.1]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.15.0...v1.16.1

README.md

@@ -15,7 +15,7 @@ For any hook in this repo you wish to use, add the following to your pre-commit
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.17.0
+    rev: v1.18.0
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -144,7 +144,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.17.0
+    rev: v1.18.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -154,7 +154,7 @@ But if you also use the `--categories` argument, you would move the trailing `--
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.17.0
+    rev: v1.18.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -166,7 +166,7 @@ If it looks better to your eye, feel free to use a multi-line list for long argu
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.17.0
+    rev: v1.18.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

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:
@@ -202,12 +194,19 @@ def main(argv=None):
                 retval = 1
 
         # Ensure uninstall method is set correctly if uninstall_script exists.
-        if "uninstall_script" in pkginfo:
-            if pkginfo.get("uninstall_method") != "uninstall_script":
-                print(
-                    f'{filename}: has uninstall script, but the uninstall method is set to "{pkginfo.get("uninstall_method")}"'
-                )
-                retval = 1
+        uninst_method = pkginfo.get("uninstall_method")
+        if "uninstall_script" in pkginfo and uninst_method != "uninstall_script":
+            print(
+                f"{filename}: has an uninstall script, but the uninstall "
+                f'method is set to "{uninst_method}"'
+            )
+            retval = 1
+        elif "uninstall_script" not in pkginfo and uninst_method == "uninstall_script":
+            print(
+                f"{filename}: uninstall_method is set to uninstall_script, "
+                'but no uninstall script is present"'
+            )
+            retval = 1
 
         # Ensure all pkginfo scripts have a proper shebang.
         script_types = (

pre_commit_hooks/check_munkiadmin_scripts.py

@@ -27,6 +27,15 @@ def main(argv=None):
     retval = 0
     for filename in args.filenames:
 
+        # Ensure scripts are named properly.
+        # https://github.com/hjuutilainen/munkiadmin/blob/4f4e96da1f1c7a4dfe7da59d88f1ef68ee02b8f2/MunkiAdmin/Singletons/MAMunkiRepositoryManager.m#L23
+        prefixes = ["manifest", "pkginfo", "repository"]
+        actions = ["custom", "postopen", "postsave", "presave"]
+        ma_script_prefixes = [f"{p}-{a}" for p in prefixes for a in actions]
+        if not any(filename.startswith(prefix) for prefix in ma_script_prefixes):
+            print(f"{filename}: does not start with a valid MunkiAdmin script prefix")
+            retval = 1
+
         # Ensure scripts are executable
         if not os.access(filename, os.X_OK):
             print(f"{filename}: not executable")

pre_commit_hooks/check_munkipkg_buildinfo.py

@@ -4,7 +4,6 @@
 import argparse
 import json
 import plistlib
-import sys
 from xml.parsers.expat import ExpatError
 
 import ruamel.yaml
@@ -32,25 +31,21 @@ def build_argument_parser():
 def validate_buildinfo_key_types(buildinfo, filename):
     """Ensure build-info files contain the proper types."""
 
-    # Remap string type to support unicode in both Python 2 and 3
-    # DEPRECATED: Python 2 support will be removed in the future
-    string = basestring if sys.version_info.major == 2 else str
-
     # Pkginfo keys and their known types. Omitted keys are left unvalidated.
     # Source: https://github.com/munki/munki-pkg
     # Last updated 2019-06-27.
     buildinfo_types = {
         "distribution_style": bool,
-        "identifier": string,
-        "install_location": string,
-        "name": string,
-        "ownership": string,
-        "postinstall_action": string,
+        "identifier": str,
+        "install_location": str,
+        "name": str,
+        "ownership": str,
+        "postinstall_action": str,
         "preserve_xattr": bool,
-        "product id": string,
+        "product id": str,
         "signing_info": dict,
         "suppress_bundle_relocation": bool,
-        "version": string,
+        "version": str,
     }
 
     passed = True

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
@@ -121,35 +184,34 @@ def validate_pkginfo_key_types(pkginfo, filename):
         "forced_uninstall": bool,
         "icon_name": str,
         "installable_condition": str,
+        "installcheck_script": str,
         "installed_size": int,
+        "installer_choices_xml": list,
+        "installer_environment": dict,
         "installer_item_hash": str,
         "installer_item_location": str,
         "installer_item_size": int,
         "installer_type": str,
         "installs": list,
         "items_to_copy": list,
-        "installer_choices_xml": list,
-        "installer_environment": dict,
         "localized_strings": dict,
+        "maximum_os_version": str,
         "minimum_munki_version": str,
         "minimum_os_version": str,
-        "maximum_os_version": str,
         "name": str,
         "notes": str,
+        "OnDemand": bool,
+        "package_path": str,
         "PackageCompleteURL": str,
         "PackageURL": str,
-        "package_path": str,
-        "installcheck_script": str,
-        "uninstallcheck_script": str,
-        "OnDemand": bool,
         "postinstall_script": str,
         "postuninstall_script": str,
         "precache": bool,
         "preinstall_alert": dict,
-        "preuninstall_alert": dict,
-        "preupgrade_alert": dict,
         "preinstall_script": str,
+        "preuninstall_alert": dict,
         "preuninstall_script": str,
+        "preupgrade_alert": dict,
         "receipts": list,
         "requires": list,
         "RestartAction": str,
@@ -159,8 +221,9 @@ def validate_pkginfo_key_types(pkginfo, filename):
         "unattended_uninstall": bool,
         "uninstall_method": str,
         "uninstall_script": str,
-        "uninstaller_item_location": str,
         "uninstallable": bool,
+        "uninstallcheck_script": str,
+        "uninstaller_item_location": str,
         "update_for": list,
         "version": str,
     }

setup.py

@@ -6,7 +6,7 @@
     name="pre-commit-macadmin",
     description="Pre-commit hooks for Mac admins, client engineers, and IT consultants.",
     url="https://github.com/homebysix/pre-commit-macadmin",
-    version="1.17.0",
+    version="1.18.0",
     author="Elliot Jordan",
     author_email="[email protected]",
     packages=["pre_commit_hooks"],