Merge pull request #94 from homebysix/dev

1.20.0 merge to main

Author: homebysix

.coveragerc

@@ -0,0 +1,7 @@
+[run]
+include = pre_commit_hooks/*
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if __name__ == .__main__.:

.gitignore

@@ -1,2 +1,15 @@
+# macOS
 .DS_Store
+
+# Compiled Python
 *.pyc
+
+# Unittest
+__pycache__/
+.coverage
+coverage.xml
+htmlcov/
+
+# Virtual environments
+.venv/
+venv/

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: pyupgrade
         args: ['--py36-plus']
   - repo: https://github.com/pycqa/flake8
-    rev: 7.2.0
+    rev: 7.3.0
     hooks:
       - id: flake8
   - repo: https://github.com/pycqa/isort

CHANGELOG.md

@@ -14,6 +14,20 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.20.0] - 2025-08-09
+
+### Added
+
+- `check-autopkg-recipes` and `check-munki-pkgsinfo` now validates that `supported_architectures` values are set appropriately.
+- In anticipation of Munki 7, `check-munki-pkgsinfo` validates that `version_script` is a string starting with a script shebang.
+- `check-munki-pkgsinfo` now checks for specific deprecated `installer_type` and `uninstall_method` values, most of which are detailed [here](https://github.com/munki/munki/wiki/Deprecation-Notes).
+- Added new FindAndReplace core processor version requirements for AutoPkg recipes.
+
+### Changed
+
+- Improvements to `check-preference-manifests` hook. (#91, thanks to @relgit)
+- `check-autopkg-recipes` ignores `supported_architectures` values within Munki pkginfo dictionaries that appear to be AutoPkg recipe substitution variables (e.g. `%ARCH%`).
+
 ## [1.19.0] - 2025-01-16
 
 ### 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.19.0
+    rev: v1.20.0
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -147,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.19.0
+    rev: v1.20.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -157,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.19.0
+    rev: v1.20.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -169,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.19.0
+    rev: v1.20.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

RELEASING.md

@@ -2,6 +2,10 @@
 
 1. Update the versions in __README.md__ and __setup.py__.
 
+1. Check unit tests:
+
+        .venv/bin/python -m coverage run -m unittest discover -vs tests
+
 1. Update the change log.
 
 1. Merge development branch to main.

pre_commit_hooks/__init__.py

@@ -0,0 +1 @@
+# This file is intentionally left blank.

pre_commit_hooks/check_autopkg_recipes.py

@@ -16,6 +16,7 @@
     validate_pkginfo_key_types,
     validate_required_keys,
     validate_restart_action_key,
+    validate_supported_architectures,
     validate_uninstall_method,
 )
 
@@ -197,6 +198,7 @@ def validate_minimumversion(process, min_vers, ignore_min_vers_before, filename)
         "FileCreator": "0.0",
         "FileFinder": "0.2.3",
         "FileMover": "0.2.9",
+        "FindAndReplace": "2.7.6",
         "FlatPkgPacker": "0.2.4",
         "FlatPkgUnpacker": "0.1.0",
         "GitHubReleasesInfoProvider": "0.5.0",
@@ -636,6 +638,12 @@ def main(argv=None):
             if not validate_uninstall_method(input_key["pkginfo"], filename):
                 retval = 1
 
+            # Validate supported architectures.
+            if not validate_supported_architectures(
+                input_key["pkginfo"], filename, recipe_mode=True
+            ):
+                retval = 1
+
             # Check for deprecated pkginfo keys.
             if not detect_deprecated_keys(input_key["pkginfo"], filename):
                 retval = 1

pre_commit_hooks/check_munki_pkgsinfo.py

@@ -14,6 +14,7 @@
     validate_required_keys,
     validate_restart_action_key,
     validate_shebangs,
+    validate_supported_architectures,
     validate_uninstall_method,
 )
 
@@ -103,6 +104,7 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
+        pkginfo = {}
         try:
             with open(filename, "rb") as openfile:
                 pkginfo = plistlib.load(openfile)
@@ -128,6 +130,10 @@ def main(argv=None):
         if not validate_uninstall_method(pkginfo, filename):
             retval = 1
 
+        # Validate supported architectures.
+        if not validate_supported_architectures(pkginfo, filename, recipe_mode=False):
+            retval = 1
+
         # Check for deprecated pkginfo keys.
         if not detect_deprecated_keys(pkginfo, filename):
             retval = 1
@@ -136,6 +142,36 @@ def main(argv=None):
         if not detect_typoed_keys(pkginfo, filename):
             retval = 1
 
+        # Check for deprecated installer_type values.
+        depr_installer_types = (
+            "AdobeAcrobatUpdater",
+            "AdobeCCPInstaller",
+            "AdobeCS5AAMEEPackage",
+            "AdobeCS5PatchInstaller",
+            "AdobeSetup",
+            "AdobeUberInstaller",
+            "appdmg",
+            "apple_update_metadata",
+            "profile",
+            "startosinstall",
+        )
+        if pkginfo.get("installer_type") in depr_installer_types:
+            print(
+                f"{filename}: WARNING: installer_type '{pkginfo.get('installer_type')}' is deprecated"
+            )
+
+        # Check for deprecated uninstall_method values.
+        depr_uninstall_methods = (
+            "AdobeCCPUninstaller",
+            "AdobeCS5AAMEEPackage",
+            "AdobeSetup",
+            "AdobeUberUninstaller",
+        )
+        if pkginfo.get("uninstall_method") in depr_uninstall_methods:
+            print(
+                f"{filename}: WARNING: uninstall_method '{pkginfo.get('uninstall_method')}' is deprecated"
+            )
+
         # Check for rogue categories.
         if args.categories and pkginfo.get("category") not in args.categories:
             print(
@@ -219,6 +255,7 @@ def main(argv=None):
             "preinstall_script",
             "preuninstall_script",
             "uninstall_script",
+            "version_script",
         )
         for s_type in script_types:
             if s_type in pkginfo:

pre_commit_hooks/util.py

@@ -32,7 +32,7 @@
     "#!/usr/bin/python3",
     "#!/usr/bin/python",  # removed since macOS 12.3
     "#!/usr/bin/ruby",
-    "#!/usr/local/munki/munki-python",
+    "#!/usr/local/munki/munki-python",  # removed in Munki 7
     "#!/usr/local/munki/Python.framework/Versions/Current/bin/python3",
 ]
 
@@ -177,6 +177,27 @@ def validate_uninstall_method(pkginfo, filename):
     return passed
 
 
+def validate_supported_architectures(pkginfo, filename, recipe_mode=False):
+    """Verifies that supported_architectures values are valid.
+
+    recipe_mode: Allow values wrapped in '%' which are typically substitution variables
+    in AutoPkg recipes. Defaults to False.
+    """
+    passed = True
+    allowed_values = ("arm64", "x86_64")
+    if "supported_architectures" in pkginfo:
+        for arch in pkginfo["supported_architectures"]:
+            if recipe_mode and arch.startswith("%") and arch.endswith("%"):
+                # Skip values that are substituted during AutoPkg recipe runs
+                continue
+            if arch not in allowed_values:
+                print(
+                    f"{filename}: supported_architectures contains unexpected value: {arch}"
+                )
+                passed = False
+    return passed
+
+
 def validate_pkginfo_key_types(pkginfo, filename):
     """Validation of pkginfo key types.
 
@@ -244,6 +265,7 @@ def validate_pkginfo_key_types(pkginfo, filename):
         "uninstaller_item_location": str,
         "update_for": list,
         "version": str,
+        "version_script": str,
     }
 
     passed = True