Move uninstall_method check to util module

Author: homebysix

pre_commit_hooks/check_munki_pkgsinfo.py

@@ -14,6 +14,7 @@
     validate_required_keys,
     validate_restart_action_key,
     validate_shebangs,
+    validate_uninstall_method,
 )
 
 
@@ -39,7 +40,7 @@ def build_argument_parser():
     )
     parser.add_argument("filenames", nargs="*", help="Filenames to check.")
     parser.add_argument(
-        "--munki-repo", default=".", help="path to local munki repo defaults to '.'"
+        "--munki-repo", default=".", help="path to local munki repo. Defaults to '.'"
     )
     parser.add_argument(
         "--warn-on-missing-icons",
@@ -117,11 +118,15 @@ def main(argv=None):
         if not validate_restart_action_key(pkginfo, filename):
             retval = 1
 
+        # Validate uninstall method.
+        if not validate_uninstall_method(pkginfo, filename):
+            retval = 1
+
         # Check for deprecated pkginfo keys.
         if not detect_deprecated_keys(pkginfo, filename):
             retval = 1
 
-        # Check for common mistakes key names.
+        # Check for common mistakes in key names.
         if not detect_typoed_keys(pkginfo, filename):
             retval = 1
 
@@ -194,21 +199,6 @@ def main(argv=None):
                 print(f"{filename}: {msg}")
                 retval = 1
 
-        # Ensure uninstall method is set correctly if uninstall_script exists.
-        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 = (
             "installcheck_script",

pre_commit_hooks/util.py

@@ -141,7 +141,7 @@ def detect_typoed_keys(input_dict, filename):
 
 
 def validate_restart_action_key(pkginfo, filename):
-    """Verifies that required_keys are present in pkginfo dictionary."""
+    """Verifies that the RestartAction key is set correctly."""
     passed = True
     allowed_values = (
         "RequireShutdown",
@@ -159,6 +159,25 @@ def validate_restart_action_key(pkginfo, filename):
     return passed
 
 
+def validate_uninstall_method(pkginfo, filename):
+    """Verifies that uninstall_method and uninstall_script is used appropriately."""
+    passed = True
+    uninst_method = pkginfo.get("uninstall_method")
+    if pkginfo.get("uninstall_script") and uninst_method != "uninstall_script":
+        print(
+            f"{filename}: has an uninstall script, but the uninstall "
+            f'method is set to "{uninst_method}"'
+        )
+        passed = False
+    elif not pkginfo.get("uninstall_script") and uninst_method == "uninstall_script":
+        print(
+            f"{filename}: uninstall_method is set to uninstall_script, "
+            'but no uninstall script is present"'
+        )
+        passed = False
+    return passed
+
+
 def validate_pkginfo_key_types(pkginfo, filename):
     """Validation of pkginfo key types.