xolo-server 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e78577a11f1d65aba560ec5540c3a79acdfc7d6a491060e256bb9e2da5a057d9
-  data.tar.gz: 9e7e776f48e8e9e260bc41a9090603bbfc41d1dad7dd62fc00396ce9914450cb
+  metadata.gz: d27f4a3e1656ef59731865488978113bcbeb4a5ebbea8c120585371c49aad335
+  data.tar.gz: a006f5ec49ad3cfbad6ae5908e2da17b65cdc2bf8eb0c3a7133fcaa0af6db3f4
 SHA512:
-  metadata.gz: b83f99bda3666a2fd124241a26882499c393a75b3289fb503bdcb6ac994827228b5f813acc79a7a81f437f879b2e9aaca727800ddd711f17b2713d7a45a98738
-  data.tar.gz: 05bb86ec68010bf2258853983f093936ffa735c52144b6760c64177621a971bdf93823a46562a4b347c5a080d5206900a39ff8b6019e7fb1fa0cf0b400e4336e
+  metadata.gz: c47f0964d7c5f5a42ddb909a0ee6b5d8bb01ead710b6be7fe9087e882081dcf753fc9f783be8bd0e5658b49df36d012f59f956db768026c915faabc8f5d9a4a8
+  data.tar.gz: 448ec9e58919ada9612c8651f814d168d4d6117c92b3e76faa2c5bdc74eb7747298f6bdebcc1547b7c662084d97fbbd7fb018331c8424f28b79bf1114cdacba7

data/data/client/xolo

@@ -97,6 +97,7 @@ be_verbose=
 debugging_on=
 no_versions=
 show_xolo_version=
+do_recon=
 
 # arguments
 command=
@@ -155,7 +156,9 @@ Options:
                      policies, etc, from test xolo server, not the production server.
                      Setting the XOLO_TEST_MODE env. variable does the same thing.
   -r, --recon:       With 'install' or 'uninstall' run a 'jamf recon' after the
-                     operation completes successfully.
+                     operation completes successfully. With 'update', run a 'jamf recon'
+                     before the checkin. NOTE: With update, the whole process may take
+                     many minutes.
   -n, --no-versions: With the 'list-titles' and 'list-installed' commands,
                      do not show the versions available, or the version
                      installed, respectively.
@@ -190,6 +193,9 @@ Commands:
     every time this computer checks in with Jamf Pro.
     Note: this just runs the 'jamf policy' command, which will execute any pending
     Jamf policies triggered by "recurring check-in".
+    If --recon is given, a Jamf recon will run first, followed by a 1 minute pause
+    for Jamf to process the data before doing the check-in. This helps the Mac to see
+    very recently-released versions as patch updates.
 
   refresh, r
     Update xolo's information about current titles and versions.
@@ -1035,6 +1041,12 @@ function run_recon() {
 function update() {
   say "Updating installed titles, or installing newly scoped ones..."
 
+  if [[ -n "$do_recon" ]]  ; then
+    run_recon
+    say "Pausing to let Jamf Pro process recon data..."
+    sleep 60
+  fi
+
   debug "Running jamf policy..."
     if be_verbose ; then
     $JAMF policy -verbose

data/lib/xolo/core/version.rb

@@ -12,7 +12,7 @@ module Xolo
 
     module Version
 
-      VERSION = '2.3.0'.freeze
+      VERSION = '2.4.0'.freeze
 
     end
 

data/lib/xolo/server/configuration.rb

@@ -156,6 +156,7 @@ module Xolo
 
         # @!attribute server_admin_jamf_group
         #   @return [String] The name of a Jamf account-group containing users of 'xadm'
+        #     who are allowed to manage the xoloserver itself
         server_admin_jamf_group: {
           type: :string,
           desc: <<~ENDDESC

data/lib/xolo/server/helpers/autopkg.rb

@@ -35,6 +35,11 @@ module Xolo
         AUTOPKG_UPLOADED_BY = 'autopkg'
         FAIL_UNTRUSTED_RECIPES_CLI_OPT = '-k FAIL_RECIPES_WITHOUT_TRUST_INFO=yes'
 
+        # when we find a .pkg after a recipe has run, it can't be older than this many
+        # seconds, or we assume it is from some other run of the recipe, not the one we
+        # just did. Currently 20 min
+        MAX_PKG_AGE = 1200
+
         # Module Methods
         #######################
         #######################
@@ -127,7 +132,9 @@ module Xolo
           clean_old_pkgs pkgdir
 
           cmd = autopkg_run_command(title_object)
-          progress "Running AutoPkg recipe for #{title_object.title} via command: #{cmd.join(' ')}", log: :info
+          progress "Running AutoPkg recipe '#{recipe}' for #{title_object.title}..."
+
+          log_info "Running AutoPkg recipe for #{title_object.title} via command: #{cmd.join(' ')}"
 
           unlock_autopkg_user_keychain
 
@@ -135,20 +142,83 @@ module Xolo
           souterr.strip!
 
           if status.success?
-            progress "AutoPkg recipe #{recipe} for title '#{title_object.title}' completed successfully.", log: :info, alert: true
+            progress "AutoPkg recipe '#{recipe}' for title '#{title_object.title}' completed successfully.", log: :info, alert: true
             log_debug 'AutoPkg output:'
             souterr.lines.each { |l| log_debug "AutoPkg: #{l.chomp}" }
 
             pkgs = pkgdir.children.select { |c| c.extname == '.pkg' }
+            # the Pathname of the newest .pkg
             pkgs.max_by(&:mtime)
 
+          # Failure is a option
           else
-            progress "ERROR: AutoPkg recipe #{recipe} failed with status #{status.exitstatus}.", log: :error, alert: true
-            log_error 'AutoPkg output:'
-            souterr.lines.each { |l| log_error "AutoPkg: #{l.chomp}" }
+            handle_failed_recipe(
+              recipe: recipe,
+              title_object: title_object,
+              status: status,
+              souterr: souterr
+            )
+          end
+        end
+
+        # Deal with a failed recipe run
+        #
+        ###############################
+        def handle_failed_recipe(recipe:, title_object:, status:, souterr:)
+          errmsg = "ERROR: AutoPkg recipe '#{recipe}' for title '#{title_object.title}' failed with status #{status.exitstatus}. Details logged and emailed to '#{title_object.contact_email}'"
+
+          progress errmsg, log: :error, alert: true
+
+          # log the details
+          log_error 'AutoPkg output:'
+          souterr.lines.each { |l| log_error "AutoPkg: #{l.chomp}" }
+
+          # email the details to the contact addr for the title
+          email_subj = "ERROR: AutoPkg recipe FAILED for title '#{title_object.title}'"
+          email_msg = <<~ENDEMAIL
+            The autopkg recipe '#{recipe}' for title '#{title_object.title}' failed with status #{status.exitstatus}.
+
+            Please check that the recipe is up to date. If not, please update the recipe's repo by running this as the autppkg user on the xolo server:
+
+               autopkg repo-update <repo-name>
+
+            Then confirm you still trust the recipe.
+            If so, run:
+
+               autopkg update-trust-info '#{recipe}'
+
+            Then tell xolo the xolo server to re-run the recipe - the .pkg will always be assigned to the latest version.
+
+               xadm rerun-autopkg-recipe #{title_object.title}
+
+            If needed, contact your xoloserver administrator to perform the autopkg commands.
+
+            Here is the output from the failed recipe:
+            ------------------------------------------
+            #{souterr}
+          ENDEMAIL
+
+          send_email to: title_object.contact_email, subject: email_subj, msg: email_msg, html: false
+
+          raise "AutoPkg recipe #{recipe} failed."
+        end
+
+        # confirm a given autopkg package is OK to use after running a recipe
+        ###########################
+        def validate_autopkg_pkg(pkg_src)
+          if pkg_src.nil?
+            msg = 'AutoPkg recipe is enabled for this title, but no pkg was found after running the recipe. Please check the AutoPkg recipe and the server log for details.'
+            progress msg, log: :warn, alert: true
+            return false
+          end
 
-            raise "AutoPkg recipe #{recipe} failed."
+          oldest_allowed = Time.now - MAX_PKG_AGE # 20 minutes ago
+          if pkg_src.mtime < oldest_allowed
+            msg = "AutoPkg recipe is enabled for this title, and a pkg was found after running the recipe, but it was last modified at #{pkg_src.mtime}, which is more than 20 minutes ago. To avoid accidentally uploading an old pkg, the server will not upload this pkg. Please check the AutoPkg recipe and the server log for details."
+            progress msg, log: :warn, alert: true
+            return false
           end
+          true
         end
 
         # remove any existing pkgs from the given autopkg output dir

data/lib/xolo/server/helpers/maintenance.rb

@@ -334,13 +334,13 @@ module Xolo
             next unless vobj_to_release
 
             # release it
-            log_debug "Maint: About to auto-release version '#{vobj_to_release.version}' of '#{title}' which came out #{vobj_to_release.creation_date}"
+            log_debug "Maint: About to auto-release '#{title}' version '#{vobj_to_release.version}' which came out #{vobj_to_release.creation_date}"
 
             # releasing a version is done via the title obj, since it affects the status
             # of all versions.
             title_obj.release vobj_to_release.version
 
-            log_info "Maint: Auto-released version '#{vobj_to_release.version}' of '#{title}' which came out #{vobj_to_release.creation_date}", alert: true
+            log_info "Maint: Auto-released '#{title}' version '#{vobj_to_release.version}' which came out #{vobj_to_release.creation_date}", alert: true
 
             # pause for server to catch up
             sleep 60

data/lib/xolo/server/mixins/title_jamf_access.rb

@@ -1808,6 +1808,8 @@ module Xolo
           pol.self_service_description = new_desc
 
           pol.self_service_install_button_text = Xolo::Server::Title::SELF_SERVICE_INSTALL_BTN_TEXT
+          pol.self_service_reinstall_button_text = Xolo::Server::Title::SELF_SERVICE_REINSTALL_BTN_TEXT
+
           # icon already uploaded to jamf
           return if ssvc_icon_id
 
@@ -1823,13 +1825,6 @@ module Xolo
           self.ssvc_icon_id = Jamf::Policy.fetch(id: pol.id, cnx: jamf_cnx).icon.id
         end
 
-        # run the autopkg recipe if defined
-        # See Helpers::AutoPkg for more details
-        ############################
-        def run_autopkg_recipe
-          server_app_instance.run_autopkg_recipe self
-        end
-
         # Methods used by subscription stuff
         ##############################
 

data/lib/xolo/server/routes/titles.rb

@@ -288,6 +288,30 @@ module Xolo
           body data
         end
 
+        # rerun the titles autopkg recipe
+        ######################
+        post '/titles/:title/rerun_autopkg_recipe' do
+          halt_on_missing_title params[:title]
+          halt_on_locked_title params[:title]
+          title = instantiate_title params[:title]
+
+          unless title.autopkg_enabled?
+            msg = "Title '#{params[:title]}' is not configured to use AutoPkg"
+            log_debug "ERROR: #{msg}"
+            halt 409, { status: 409, error: msg }
+          end
+
+          unless title.latest_version
+            msg = "Title '#{params[:title]}' has no versions, cannot re-run the recipe"
+            log_debug "ERROR: #{msg}"
+            halt 404, { status: 404, error: msg }
+          end
+
+          with_streaming do
+            title.rerun_autopkg_recipe
+          end
+        end
+
       end # Titles
 
     end #  Routes

data/lib/xolo/server/title.rb

@@ -120,6 +120,7 @@ module Xolo
       JPAPI_PATCH_REPORT_RSRC = 'patch-report'
 
       SELF_SERVICE_INSTALL_BTN_TEXT = 'Install'
+      SELF_SERVICE_REINSTALL_BTN_TEXT = 'Re-Install'
 
       # Class Methods
       ######################
@@ -1144,6 +1145,27 @@ module Xolo
         unlock
       end
 
+      # run the autopkg recipe if defined
+      # See Helpers::AutoPkg for more details
+      ############################
+      def run_autopkg_recipe
+        server_app_instance.run_autopkg_recipe self
+      end
+
+      # Re run the autopkg recipe
+      # and re-upload the pkg
+      ############################
+      def rerun_autopkg_recipe
+        pkg_src = server_app_instance.run_autopkg_recipe self
+
+        return unless server_app_instance.validate_autopkg_pkg pkg_src
+
+        latest_version_obj = version_object latest_version
+        latest_version_obj.pkg_is_from_autopkg = true
+
+        server_app_instance.process_and_upload_autopkg_pkg title, latest_version_obj, pkg_src
+      end
+
       # Is this title locked for updates?
       #############################
       def locked?

data/lib/xolo/server/version.rb

@@ -748,18 +748,7 @@ module Xolo
 
         pkg_src = title_object.run_autopkg_recipe
 
-        if pkg_src.nil?
-          msg = 'AutoPkg recipe is enabled for this title, but no pkg was found after running the recipe. Please check the AutoPkg recipe and the server log for details.'
-          progress msg, log: :warn, alert: true
-          return
-        end
-
-        oldest_allowed = Time.now - 1200 # 20 minutes ago
-        if pkg_src.mtime < oldest_allowed
-          msg = "AutoPkg recipe is enabled for this title, and a pkg was found after running the recipe, but it was last modified at #{pkg_src.mtime}, which is more than 20 minutes ago. To avoid accidentally uploading an old pkg, the server will not upload this pkg. Please check the AutoPkg recipe and the server log for details."
-          progress msg, log: :warn, alert: true
-          return
-        end
+        return unless server_app_instance.validate_autopkg_pkg pkg_src
 
         # this lets future code know that the pkg we're working with came from autopkg
         self.pkg_is_from_autopkg = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xolo-server
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Lasell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-04 00:00:00.000000000 Z
+date: 2026-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday