Add JamfPatchTitleVersioner processor and ReadMe

JamfUploaderProcessors/JamfPatchTitleVersioner.py

@@ -0,0 +1,139 @@
+#!/usr/local/autopkg/python
+
+"""
+JamfPatchTitleVersioner processor for finding the latest software version number for a Patch Title from Jamf Pro using AutoPkg
+    assembled by Anthony Reimer using code from JamfPatchUploader (by Marcel Keßler based on G Pugh's great work)
+"""
+
+import os.path
+import sys
+
+import xml.etree.ElementTree as ET
+
+from time import sleep
+from autopkglib import ProcessorError  # pylint: disable=import-error
+
+# to use a base module in AutoPkg we need to add this path to the sys.path.
+# this violates flake8 E402 (PEP8 imports) but is unavoidable, so the following
+# imports require noqa comments for E402
+sys.path.insert(0, os.path.dirname(__file__))
+
+from JamfUploaderLib.JamfUploaderBase import JamfUploaderBase  # noqa: E402
+
+__all__ = ["JamfPatchUploader"]
+
+
+class JamfPatchTitleVersioner(JamfUploaderBase):
+    """Determines the latest software version being reported by a Jamf Pro Patch Management Title."""
+
+    input_variables = {
+        "JSS_URL": {
+            "required": True,
+            "description": "URL to a Jamf Pro server that the API user has write access "
+            "to, optionally set as a key in the com.github.autopkg "
+            "preference file.",
+        },
+        "API_USERNAME": {
+            "required": True,
+            "description": "Username of account with appropriate access to "
+            "jss, optionally set as a key in the com.github.autopkg "
+            "preference file.",
+        },
+        "API_PASSWORD": {
+            "required": True,
+            "description": "Password of api user, optionally set as a key in "
+            "the com.github.autopkg preference file.",
+        },
+        "patch_softwaretitle": {
+            "required": True,
+            "description": (
+                "Name of the patch software title (e.g. 'Mozilla Firefox') used in Jamf. "
+            ),
+            "default": "",
+        },
+    }
+
+    output_variables = {
+        "latest_patch_version": {
+            "description": "The latest version number of the software reported by the Patch Title."
+        },
+    }
+
+    def latest_patch_version(
+        self,
+        jamf_url,
+        patch_softwaretitle_id,
+        enc_creds="",
+        token="",
+    ) -> str:
+        """Returns the newest software version number for the Patch Title ID passed"""
+        self.output("Looking up latest version from patch software title (by ID)...")
+
+        # Get current software title
+        object_type = "patch_software_title"
+        url = "{}/{}/id/{}".format(
+            jamf_url, self.api_endpoints(object_type), patch_softwaretitle_id
+        )
+
+        # "GET" patch title feed.
+        r = self.curl(
+            request="GET", url=url, enc_creds=enc_creds, token=token, force_xml=True
+        )
+
+        if r.status_code != 200:
+            raise ProcessorError("ERROR: Could not fetch patch software title.")
+
+        # Parse response as xml
+        try:
+            patch_softwaretitle_xml = ET.fromstring(r.output)
+        except ET.ParseError as xml_error:
+            raise ProcessorError from xml_error
+
+        # Get first match of all the versions listed in the
+        # software title to report the 'latest version'.
+        latest_version = patch_softwaretitle_xml.find("versions/version/software_version").text
+        return latest_version
+
+    def main(self):
+        """Do the main thing here"""
+        self.jamf_url = self.env.get("JSS_URL")
+        self.jamf_user = self.env.get("API_USERNAME")
+        self.jamf_password = self.env.get("API_PASSWORD")
+        self.patch_softwaretitle = self.env.get("patch_softwaretitle")
+
+        self.output(
+            f"Checking for existing '{self.patch_softwaretitle}' on {self.jamf_url}"
+        )
+
+        # obtain the relevant credentials
+        token, send_creds, _ = self.handle_classic_auth(
+            self.jamf_url, self.jamf_user, self.jamf_password
+        )
+
+        # Find the ID for the Patch Title
+        obj_type = "patch_software_title"
+        obj_name = self.patch_softwaretitle
+        self.patch_softwaretitle_id = self.get_api_obj_id_from_name(
+            self.jamf_url, obj_name, obj_type, enc_creds=send_creds, token=token,
+        )
+
+        if not self.patch_softwaretitle_id:
+            raise ProcessorError(
+                f"ERROR: Couldn't find patch software title with name '{self.patch_softwaretitle}'.",
+            )
+        self.env["patch_softwaretitle_id"] = self.patch_softwaretitle_id
+
+        # fetch the latest version reported by the Patch Title
+        self.patch_version = self.latest_patch_version(
+            self.jamf_url,
+            self.patch_softwaretitle_id,
+            send_creds,
+            token,
+        )
+
+        # Set Output Variable
+        self.env["latest_patch_version"] = self.patch_version
+
+if __name__ == "__main__":
+    PROCESSOR = JamfPatchUploader()
+    PROCESSOR.execute_shell()

JamfUploaderProcessors/READMEs/JamfPatchTitleVersioner.md

@@ -0,0 +1,24 @@
+# JamfPatchTitleVersioner
+## Description
+
+Determines the latest software version being reported by a Jamf Pro Patch Management Title.
+
+## Input variables
+
+- **JSS_URL:**
+  - **required:** True
+  - **description:** URL to a Jamf Pro server that the API user has write access to, optionally set as a key in the com.github.autopkg preference file.
+- **API_USERNAME:**
+  - **required:** True
+  - **description:** Username of account with appropriate access to jss, optionally set as a key in the com.github.autopkg preference file.
+- **API_PASSWORD:**
+  - **required:** True
+  - **description:** Password of api user, optionally set as a key in the com.github.autopkg preference file.
+- **patch_softwaretitle**:
+  - **required**: True
+  - **description**: Name of the patch softwaretitle (e.g. 'Mozilla Firefox') used in Jamf.
+
+## Output variables
+
+- **latest_patch_version:**
+  - **description:** The latest version number of the software reported by the Patch Title.