Merge branch 'main' into dev

# Conflicts:
#	.pre-commit-config.yaml

Author: homebysix

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     rev: 6.0.1
     hooks:
       - id: isort
-  - repo: https://github.com/python/black
+  - repo: https://github.com/psf/black
     rev: 25.1.0
     hooks:
       - id: black

CHANGELOG.md

@@ -12,8 +12,14 @@ All notable changes to this project will be documented in this file. This projec
 
 ## [Unreleased]
 
+Nothing yet.
+
+## [1.19.0] - 2025-01-16
+
 ### Added
 
+- Added `--warn-on-missing-installer-items` flag that makes missing Munki install/uninstall items a warning instead of a failure. (#86, thanks to @haircut)
+- Apply the same checks to `uninstaller_item_location` that were previously applied to `installer_item_location`.
 - `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.
 - `check-autopkg-recipes` and `check-munki-pkgsinfo` now validates that `supported_architectures` values are set appropriately.
@@ -23,6 +29,11 @@ All notable changes to this project will be documented in this file. This projec
 - `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`.
 
+### Fixed
+
+- Bug fix in `check-munkiadmin-scripts` that prevented script names from processing correctly.
+- Bug fix in `check-munki-pkgsinfo` that prevented `--warn-on-duplicate-imports` flag from working correctly.
+
 ## [1.18.0] - 2025-01-04
 
 ### Added

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.18.0
+    rev: v1.19.0
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -120,6 +120,9 @@ After adding a hook to your pre-commit config, it's not a bad idea to run `pre-c
     - Choose to just warn if icons referenced in pkginfo files are missing (this will allow pre-commit checks to pass if no other issues exist):
         `args: ['--warn-on-missing-icons]`
 
+    - Choose to just warn if installer/uninstaller items (`installer_item_location` or `uninstaller_item_location`) referenced in pkginfo files are missing (this will allow pre-commit checks to pass if no other issues exist):
+        `args: ['--warn-on-missing-installer-items]`
+
     - Choose to just warn if pkg/pkginfo files with __1 (or similar) suffixes are detected (this will allow pre-commit checks to pass if no other issues exist):
         `args: ['--warn-on-duplicate-imports]`
 
@@ -144,7 +147,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.18.0
+    rev: v1.19.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -154,7 +157,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.18.0
+    rev: v1.19.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -166,7 +169,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.18.0
+    rev: v1.19.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

pre_commit_hooks/check_jamf_json_manifests.py

@@ -9,21 +9,21 @@
 import json
 from datetime import datetime
 
-from pre_commit_hooks.util import PLIST_TYPES, validate_required_keys
+from pre_commit_hooks.util import validate_required_keys
 
 # Types found in the Jamf JSON manifests
-MANIFEST_TYPES = (
-    "array",
-    "boolean",
-    "data",
-    "date",
-    "float",
-    "integer",
-    "number",
-    "object",
-    "real",
-    "string",
-)
+MANIFEST_TYPES = {
+    "array": list,
+    "boolean": bool,
+    "data": str,
+    "date": datetime,
+    "float": float,
+    "integer": int,
+    "number": int,
+    "object": dict,
+    "real": float,
+    "string": str,
+}
 
 # List keys and their expected item types
 MANIFEST_LIST_TYPES = {
@@ -132,9 +132,9 @@ def validate_default(name, prop, type_found, filename):
                 actual_type = str
             else:
                 actual_type = type(prop[test_key])
-            if actual_type != PLIST_TYPES.get(type_found):
+            if actual_type != MANIFEST_TYPES.get(type_found):
                 print(
-                    f"{filename}: {test_key} value for {name} should be {PLIST_TYPES.get(type_found)}, not {type(prop[test_key])}"
+                    f"{filename}: {test_key} value for {name} should be {MANIFEST_TYPES.get(type_found)}, not {type(prop[test_key])}"
                 )
                 passed = False
 

pre_commit_hooks/check_munki_pkgsinfo.py

@@ -49,6 +49,12 @@ def build_argument_parser():
         action="store_true",
         default=False,
     )
+    parser.add_argument(
+        "--warn-on-missing-installer-items",
+        help="If added, this will only warn on missing installer items.",
+        action="store_true",
+        default=False,
+    )
     parser.add_argument(
         "--warn-on-duplicate-imports",
         help="If added, this will only warn if pkginfo/pkg files end with a __1 suffix.",
@@ -149,29 +155,6 @@ def main(argv=None):
                     print(f'{filename}: catalog "{catalog}" is not in approved list')
                     retval = 1
 
-        # Check for missing or case-conflicted installer items
-        if not _check_case_sensitive_path(
-            os.path.join(
-                args.munki_repo, "pkgs", pkginfo.get("installer_item_location", "")
-            )
-        ):
-            print(
-                f"{filename}: installer item does not exist or path is not case sensitive"
-            )
-            retval = 1
-
-        # Check for pkg filenames showing signs of duplicate imports.
-        if pkginfo.get("installer_item_location", "").endswith(tuple(dupe_suffixes)):
-            installer_item_location = pkginfo["installer_item_location"]
-            msg = (
-                f"installer item '{installer_item_location}' may be a duplicate import"
-            )
-            if args.warn_on_missing_icons:
-                print(f"{filename}: WARNING: {msg}")
-            else:
-                print(f"{filename}: {msg}")
-                retval = 1
-
         # Checking for the absence of blocking_applications for pkg installers.
         # If a pkg doesn't require blocking_applications, use empty "<array/>" in pkginfo.
         if args.require_pkg_blocking_apps and all(
@@ -187,6 +170,34 @@ def main(argv=None):
             )
             retval = 1
 
+        # Begin checks that apply to both installers and uninstallers
+        for i_type in ("installer", "uninstaller"):
+
+            # Check for missing or case-conflicted installer or uninstaller items
+            if not _check_case_sensitive_path(
+                os.path.join(
+                    args.munki_repo, "pkgs", pkginfo.get(f"{i_type}_item_location", "")
+                )
+            ):
+                msg = f"{i_type} item does not exist or path is not case sensitive"
+                if args.warn_on_missing_installer_items:
+                    print(f"{filename}: WARNING: {msg}")
+                else:
+                    print(f"{filename}: {msg}")
+                    retval = 1
+
+            # Check for pkg filenames showing signs of duplicate imports.
+            if pkginfo.get(f"{i_type}_item_location", "").endswith(
+                tuple(dupe_suffixes)
+            ):
+                item_loc = pkginfo[f"{i_type}_item_location"]
+                msg = f"{i_type} item '{item_loc}' may be a duplicate import"
+                if args.warn_on_duplicate_imports:
+                    print(f"{filename}: WARNING: {msg}")
+                else:
+                    print(f"{filename}: {msg}")
+                    retval = 1
+
         # Ensure an icon exists for the item.
         if not any(
             (

pre_commit_hooks/check_munkiadmin_scripts.py

@@ -32,7 +32,10 @@ def main(argv=None):
         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):
+        if not any(
+            os.path.basename(filename).startswith(prefix)
+            for prefix in ma_script_prefixes
+        ):
             print(f"{filename}: does not start with a valid MunkiAdmin script prefix")
             retval = 1
 

pre_commit_hooks/check_preference_manifests.py

@@ -184,7 +184,9 @@ def validate_pfm_type_strings(subkey, filename):
         print(f'{filename}: WARNING: Subkey type "{subkey["pfm_type"]}" is deprecated')
         # passed = False
     elif subkey["pfm_type"] not in PLIST_TYPES:
-        print(f'{filename}: Unexpected subkey type "{subkey["pfm_type"]}"')
+        print(
+            f'{filename}: Unexpected subkey type {subkey["pfm_type"]} for {subkey.get("pfm_name")}'
+        )
         passed = False
 
     return passed
@@ -282,7 +284,7 @@ def validate_pfm_default(subkey, filename):
                 #         continue
                 # else:
                 desired_type = PLIST_TYPES[subkey["pfm_type"]]
-                if isinstance(subkey[test_key], desired_type):
+                if not isinstance(subkey[test_key], desired_type):
                     print(
                         f"{filename}: {test_key} value for {subkey.get('pfm_name')} should be type "
                         f"{PLIST_TYPES[subkey['pfm_type']]}, not type {type(subkey[test_key])}"
@@ -333,6 +335,7 @@ def validate_platforms(subkey, filename):
 def validate_subkeys(subkeys, filename):
     """Given a list of subkeys, run validation on their contents."""
     passed = True
+    type_passed = True
 
     for subkey in subkeys:
 
@@ -355,6 +358,7 @@ def validate_subkeys(subkeys, filename):
         # Check for rogue pfm_type strings and deprecated keys.
         if not validate_pfm_type_strings(subkey, filename):
             passed = False
+            type_passed = False
 
         # TODO: Suggest adding a title if one is missing
         # if "pfm_title" not in subkey:
@@ -378,7 +382,7 @@ def validate_subkeys(subkeys, filename):
             passed = False
 
         # Check default values to ensure consistent type
-        if not validate_pfm_default(subkey, filename):
+        if type_passed and not validate_pfm_default(subkey, filename):
             passed = False
 
         # Validate URLs

pre_commit_hooks/util.py

@@ -17,7 +17,6 @@
     "integer": int,
     "array": list,
     "data": None,  # TODO: How to represent this?
-    "float": float,
     "real": float,
     "date": datetime,
 }

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.18.0",
+    version="1.19.0",
     author="Elliot Jordan",
     author_email="elliot@elliotjordan.com",
     packages=["pre_commit_hooks"],