Merge pull request #56 from homebysix/pfm-names

v1.12.2 merge to main

Author: homebysix

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+select = B,C,E,F,P,W,B9
+max-line-length = 88
+ignore = E127, E128, E203, E265, E266, E402, E501, E722, P207, P208, W503, F405, F403

.isort.cfg

@@ -0,0 +1,6 @@
+[settings]
+force_grid_wrap=0
+include_trailing_comma=True
+line_length=88
+multi_line_output=3
+use_parentheses=True

CHANGELOG.md

@@ -14,6 +14,14 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.12.2] - 2022-02-27
+
+### Changed
+
+- Adjusted preference manifest checks to require `pfm_name` for every preference key except immediate descendants of keys whose `pfm_type` is `array` (#54).
+- Improved preference manifest output to more accurately specify which key or subkey is failing `pfm_name` or `pfm_type` checks.
+- Continued development work on a hook that checks Jamf JSON schema manifests.
+
 ## [1.12.1] - 2021-12-22
 
 ### Changed

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.12.1
+    rev: v1.12.2
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -121,7 +121,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.12.1
+    rev: v1.12.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -131,7 +131,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.12.1
+    rev: v1.12.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -143,7 +143,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.12.1
+    rev: v1.12.2
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

pre_commit_hooks/check_jamf_json_manifests.py

@@ -140,13 +140,13 @@ def validate_default(name, property, type_found, filename):
                 actual_type = str
             else:
                 actual_type = type(property[test_key])
-            if actual_type != PLIST_TYPES[type_found]:
+            if actual_type != PLIST_TYPES.get(type_found):
                 print(
                     "{}: {} value for {} should be {}, not {}".format(
                         filename,
                         test_key,
                         name,
-                        PLIST_TYPES[type_found],
+                        PLIST_TYPES.get(type_found),
                         type(property[test_key]),
                     )
                 )

pre_commit_hooks/check_preference_manifests.py

@@ -52,7 +52,7 @@ def validate_required_keys(input_dict, required_keys, dict_name, filename):
 def validate_manifest_key_types(manifest, filename):
     """Validation of manifest key types."""
 
-    # manifest keys and their known types. Omitted keys are left unvalidated.
+    # manifest keys and their known types. Omitted keys are left un-validated.
     # Last updated 2021-12-03.
     key_types = {
         "pfm_conditionals": list,
@@ -164,6 +164,23 @@ def validate_list_item_types(manifest, filename):
     return passed
 
 
+def validate_required_subkeys(subkey, req_keys, filename):
+    """Ensure specific keys are defined in subkeys."""
+    passed = True
+
+    for subsubkey in subkey.get("pfm_subkeys", []):
+        if subsubkey.get("pfm_name"):
+            display_name = subsubkey["pfm_name"]
+        elif subkey.get("pfm_name"):
+            display_name = subkey["pfm_name"] + " subkey"
+        else:
+            display_name = "<unnamed key> subkey"
+        if not validate_required_keys(subsubkey, req_keys, display_name, filename):
+            passed = False
+
+    return passed
+
+
 def validate_pfm_type_strings(subkey, filename):
     """Ensure subkey pfm_type strings are as expected."""
     passed = True
@@ -326,11 +343,19 @@ def validate_subkeys(subkeys, filename):
 
     for subkey in subkeys:
 
-        # Check for presence of required keys.
-        required_keys = ("pfm_type",)
-        if not validate_required_keys(
-            subkey, required_keys, subkey.get("pfm_name", "<unnamed key>"), filename
-        ):
+        # Check for presence of required subkeys
+        # (Not calling validate_required_keys() directly because the output would not be
+        # specific enough to indicate *where* in the manifest the problem exists.)
+        # Example of validate_required_keys() output:
+        #   menu.nomad.NoMADPro.plist: <unnamed key> missing required key pfm_type
+        # Example of validate_required_subkeys() output:
+        #   menu.nomad.NoMADPro.plist: ChangePasswordItem subkey missing required key pfm_type
+        if subkey["pfm_type"] != "array":
+            # pfm_name is required only if the pfm_type is not array
+            required_keys = ("pfm_type", "pfm_name")
+        else:
+            required_keys = ("pfm_type",)
+        if not validate_required_subkeys(subkey, required_keys, filename):
             passed = False
             break  # No need to continue checking this list of subkeys
 

setup.py

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