xolo-admin 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b88b4836493ad597c2417b6c83f5ed5526a71e1b434ef391ccfe3cc46bfbd6
-  data.tar.gz: b6647511a33dfcdf8812be9dc615c7134df5b8ce989b766c6fd6f33886b188d3
+  metadata.gz: 1fd62597c79441981462fc6c5a3b6443cec817807eaef28805fdc341e23aa8f5
+  data.tar.gz: 5e8fd59f9b5e502be666667e21899054c70aac36c917af0dd1c7f2a6011f3235
 SHA512:
-  metadata.gz: 7e797fdfa95678ab2f6811f44f860a0b5018c72fce7654bb11260d35b176dd19ef84c7d1c250f414dd26d643f21596624cf97cff498fd2c27f005845b5dec330
-  data.tar.gz: de7997dd22b4c59149e1d8b9c565628e959b0636130699997dbb3e339a7debdadc12ac6f5d592eeb188e493b8a7b10d178f7118c6dc798fd839c742a8919b5b8
+  metadata.gz: c1c342061a5e4b49636ebc4cceccbaf41e136b10724ca381ebe6051e89cf3924d8f9f0a07b54c8632c3fe8d7b9b3057472d8ee6ff779b7cbeb9b813b4b2eb8d2
+  data.tar.gz: e7a67216e1a51588cb58acff908e5180ef1d8ef77d615a8e4b532563e02141e2f9b066b9afe908ec7f2e7b7e11473d857357aac500114cf563799657fc688773

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/admin/options.rb

@@ -158,6 +158,8 @@ module Xolo
       FREEZE_TITLE_CMD = 'freeze'
       THAW_TITLE_CMD = 'thaw'
       LIST_FROZEN_CMD = 'list-frozen'
+      RERUN_AUTOPKG_RECIPE_CMD = 'rerun-autopkg'
+      RERUN_SUBSCRIPTION_CMD = 'rerun-sub'
 
       LIST_VERSIONS_CMD = 'list-versions'
       ADD_VERSION_CMD = 'add-version'
@@ -382,6 +384,10 @@ module Xolo
         }
       }.freeze
 
+      DEPLOY_RELEASED = 'released'
+      DEPLOY_LATEST = 'latest'
+      DEPLOY_SPECIAL_VERSIONS = [DEPLOY_RELEASED, DEPLOY_LATEST].freeze
+
       DEPLOY_VERSION_OPTIONS = {
         groups: {
           label: 'Computer group whose computers will be targeted',
@@ -518,17 +524,6 @@ module Xolo
           confirmation: true
         },
 
-        # SUBSCRIBE_CMD => {
-        #   desc: 'Subscribe to a software title from a Patch Source defined in Jamf Pro',
-        #   display: "#{SUBSCRIBE_CMD} title",
-        #   opts: Xolo::Admin::Title.subscribe_cli_opts,
-        #   walkthru_header: "Subscribing to Xolo Title '#{TARGET_TITLE_PLACEHOLDER}'",
-        #   target: :title,
-        #   process_method: :subscribe_title,
-        #   streamed_response: true,
-        #   confirmation: true
-        # },
-
         EDIT_TITLE_CMD => {
           desc: 'Edit an exising software title',
           display: "#{EDIT_TITLE_CMD} title",
@@ -605,6 +600,32 @@ module Xolo
           process_method: :list_versions
         },
 
+        RERUN_AUTOPKG_RECIPE_CMD => {
+          desc: 'Run the AutoPkg recipe for this title again, and re-upload the new pkg.',
+          display: "#{RERUN_AUTOPKG_RECIPE_CMD} title",
+          long_desc: <<~ENDLONG,
+            The recipe will be run immediately, and the resulting .pkg will be re-uploaded for the latest version of the title.
+          ENDLONG
+          opts: {},
+          target: :title,
+          process_method: :rerun_autopkg_recipe,
+          streamed_response: true,
+          confirmation: true
+        },
+
+        RERUN_SUBSCRIPTION_CMD => {
+          desc: 'Re-add the latest version for this title as if a subscription update just happened.',
+          display: "#{RERUN_SUBSCRIPTION_CMD} title",
+          long_desc: <<~ENDLONG,
+            The most recent version of the title, if 'pilot' or 'pending', is deleted and the subscription update process is triggered again to re-create it.  Useful when the process had some error the previous time it ran.
+          ENDLONG
+          opts: {},
+          target: :title,
+          process_method: :rerun_subscription_update,
+          streamed_response: true,
+          confirmation: true
+        },
+
         ADD_VERSION_CMD => {
           desc: 'Add a new version to a title, making it available for piloting',
           display: "#{ADD_VERSION_CMD} title version",
@@ -667,6 +688,8 @@ module Xolo
             Computers in any excluded-groups for the target will be removed from the list of targets
             before the MDM command is sent.
 
+            You can use the words '#{DEPLOY_RELEASED}' or '#{DEPLOY_LATEST}' as the version, or a specific one.
+
             Computers can be specified by name, serial number, or Jamf ID. Groups can be specified by
             name.
 

data/lib/xolo/admin/processing.rb

@@ -513,6 +513,42 @@ module Xolo
         handle_processing_error e
       end
 
+      # Re run the autopkg recipe
+      ################################
+      def rerun_autopkg_recipe
+        return unless confirmed? "Re-run the AutoPkg recipe for '#{cli_cmd.title}' and re-upload the new pkg"
+
+        title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
+        response_data = title.rerun_autopkg_recipe server_cnx
+
+        show_debug "response_data: #{response_data}"
+
+        display_progress response_data[:progress_stream_url_path]
+
+        speak "Recipe has run for '#{cli_cmd.title}'. Please wait up to 15 minutes for a new pkg to be available."
+      rescue StandardError => e
+        handle_processing_error e
+      end
+
+      #
+      ###########################
+      def rerun_subscription_update
+        unless confirmed? "Delete and re-create the latest version of '#{cli_cmd.title}' via the subscription process?"
+          return
+        end
+
+        title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
+        response_data = title.rerun_subscription_update server_cnx
+
+        show_debug "response_data: #{response_data}"
+
+        display_progress response_data[:progress_stream_url_path]
+
+        speak "Subscription update for latest version of '#{cli_cmd.title}' has been triggered."
+      rescue StandardError => e
+        handle_processing_error e
+      end
+
       # List all versions of a title in Xolo
       #
       # @return [void]
@@ -648,7 +684,23 @@ module Xolo
       # @return [void]
       ###############################
       def deploy_version
-        return unless confirmed? "Deploy Version '#{cli_cmd.version}' of Title '#{cli_cmd.title}' via MDM?"
+        # If version is 'latest' or 'released', figure out the actual version to deploy
+        if Xolo::Admin::Options::DEPLOY_SPECIAL_VERSIONS.include? cli_cmd.version
+          title = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
+          vers_display =
+            case cli_cmd.version
+            when Xolo::Admin::Options::DEPLOY_RELEASED
+              cli_cmd.version = title.released_version
+              "#{cli_cmd.version} (#{Xolo::Admin::Options::DEPLOY_RELEASED})"
+            when Xolo::Admin::Options::DEPLOY_LATEST
+              cli_cmd.version = title.version_order.first
+              "#{cli_cmd.version} (#{Xolo::Admin::Options::DEPLOY_LATEST})"
+            else
+              cli_cmd.version
+            end
+        end
+
+        return unless confirmed? "Deploy Version '#{vers_display}' of Title '#{cli_cmd.title}' via MDM?"
 
         unless json? || quiet?
           puts "Deploying Version '#{cli_cmd.version}' of Title '#{cli_cmd.title}' to computers: #{ARGV.join(', ')}"
@@ -966,7 +1018,7 @@ module Xolo
             next
           end
 
-          vers = Gem::Version.new(d[:version])
+          vers = d[:version]
           version_counts[vers] ||= 0
           version_counts[vers] += 1
         end

data/lib/xolo/admin/title.rb

@@ -216,6 +216,22 @@ module Xolo
         resp.body
       end
 
+      # Rerun the autopkg recipe for this title
+      # @param cnx [Faraday::Connection] The connection to use, must be logged in already
+      # @return [Hash] the response data
+      #########################
+      def rerun_autopkg_recipe(cnx = self.cnx)
+        resp = cnx.post "#{SERVER_ROUTE}/#{title}/rerun_autopkg_recipe", {}
+        resp.body
+      end
+
+      #
+      #########################
+      def rerun_subscription_update(cnx = self.cnx)
+        resp = cnx.post "#{SERVER_ROUTE}/#{title}/rerun-subscription", {}
+        resp.body
+      end
+
       # Fetch the frozen computers for this title
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash{String => String}] computer name => user name

data/lib/xolo/admin/validate.rb

@@ -369,19 +369,18 @@ module Xolo
       # validate a title auto_release_delay:
       # - a non-negative integer?
       # OR
+      # - 'monthly'
+      # OR
       # - 'none' to unset the value
       #
       # @param val [Object] The value to validate
       #
-      # @return [String, Integer] The valid value
+      # @return [String] The valid value
       ###########################
-      def validate_auto_release_delay
+      def validate_auto_release_delay(val)
         return if val == Xolo::NONE
-
-        if val.pix_integer?
-          val = val.to_i
-          return val unless val.negative?
-        end
+        return Xolo::MONTHLY if val.casecmp? Xolo::MONTHLY
+        return val if val.pix_integer? && !val.to_i.negative?
 
         raise_invalid_data_error val, TITLE_ATTRS[:auto_release_delay][:invalid_msg]
       end
@@ -953,6 +952,9 @@ module Xolo
         # if targeting 'all'  can't be in self-service
         validate_title_consistency_no_all_in_ssvc(opts)
 
+        # if target_groups is set, release_group scan't be  all, and vice versa
+        validate_title_consistency_no_tgt_groups_with_all(opts)
+
         # if self-service category given, must be in self-service
         validate_title_consistency_ssvc_needs_category(opts)
 
@@ -1197,7 +1199,7 @@ module Xolo
         end
       end
 
-      # if target_group is all, can't be in self service
+      # if release_groups is all, can't be in self service
       #
       # @param opts [OpenStruct] the current options
       #
@@ -1208,13 +1210,33 @@ module Xolo
 
         msg =
           if walkthru?
-            "Cannot be in Self Service when Target Group is '#{Xolo::TARGET_ALL}'"
+            "Cannot be in Self Service when Release Group is '#{Xolo::TARGET_ALL}'"
           else
             "--self-service cannot be used when --release-groups contains '#{Xolo::TARGET_ALL}'"
           end
         raise_consistency_error msg
       end
 
+      # if target_groups is set, release_group scan't be  all, and vice versa
+      #
+      # @param opts [OpenStruct] the current options
+      #
+      # @return [void]
+      #######
+      def validate_title_consistency_no_tgt_groups_with_all(opts)
+        rel_all = opts[:release_groups].to_a.include?(Xolo::TARGET_ALL)
+        got_tgts = !opts[:target_groups].pix_empty?
+        return unless rel_all && got_tgts
+
+        msg =
+          if walkthru?
+            "Cannot use Target Group when Release Group is '#{Xolo::TARGET_ALL}'"
+          else
+            "--target-groups cannot be used when --release-groups contains '#{Xolo::TARGET_ALL}'"
+          end
+        raise_consistency_error msg
+      end
+
       # if in self service, a category must be assigned
       #
       # @param opts [OpenStruct] the current options

data/lib/xolo/admin.rb

@@ -20,25 +20,33 @@
 ######
 require 'openssl'
 
-# Monkeypatch OpenSSL::SSL::SSLContext to ignore unexpected EOF errors
-# happens with openssl v3 ??
+# Monkeypatch/workaround so that OpenSSL::SSL::SSLContext ignores unexpected EOF errors...
+# Seems to be a known problem  with openssl v3.x
+#
 # see https://stackoverflow.com/questions/76183622/since-a-ruby-container-upgrade-we-expirience-a-lot-of-opensslsslsslerror
+# and other googlings.
+#
+# In ruby 4.0 OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options] is frozen so we have to .dup it
+# to make the change.
+#
+# TODO: Remove this when the underlying problem is fixed, in either openssl itself, or
+# the OpenSSL ruby module.
 if OpenSSL::SSL.const_defined?(:OP_IGNORE_UNEXPECTED_EOF)
+  if OpenSSL::SSL::SSLContext::DEFAULT_PARAMS.frozen?
+    # supress redefined const. warning
+    original_verbose = $VERBOSE
+    $VERBOSE = nil
+    OpenSSL::SSL::SSLContext::DEFAULT_PARAMS = OpenSSL::SSL::SSLContext::DEFAULT_PARAMS.dup
+    $VERBOSE = original_verbose
+  end
+
   OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options] |= OpenSSL::SSL::OP_IGNORE_UNEXPECTED_EOF
 end
 
-require 'openssl'
 require 'faraday'
 require 'faraday/multipart'
 require 'highline'
 
-# Monkeypatch OpenSSL::SSL::SSLContext to ignore unexpected EOF errors
-# happens with openssl v3 ??
-# see https://stackoverflow.com/questions/76183622/since-a-ruby-container-upgrade-we-expirience-a-lot-of-opensslsslsslerror
-if OpenSSL::SSL.const_defined?(:OP_IGNORE_UNEXPECTED_EOF)
-  OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options] |= OpenSSL::SSL::OP_IGNORE_UNEXPECTED_EOF
-end
-
 # Yes we're using a OpenStruct for our @opts, even though it's very slow.
 # It isn't so slow that it's a problem for processing a CLI tool.
 # The benefit is being able to use either Hash-style references

data/lib/xolo/core/base_classes/title.rb

@@ -459,15 +459,17 @@ module Xolo
           },
 
           # @!attribute auto_release_delay
-          #   @return [String] 'none' or an integer in string. How many days before new versions are automatically released?
+          #   @return [String] 'none', 'monthly', or an integer in string.
+          #     How many days before new versions are automatically released?
           #     Applies only to subscribed titles with autopkg recipes.
           auto_release_delay: {
             label: 'Automatic Release Delay',
             cli: :A,
             type: :string,
             walkthru_na: :auto_release_delay_na,
+            validate: true,
             changelog: true,
-            invalid_msg: "Must be a non-negative integer, or '#{Xolo::NONE}'.",
+            invalid_msg: "Must be a non-negative integer, '#{Xolo::MONTHLY}', or '#{Xolo::NONE}'.",
             desc: <<~ENDDESC
               Specify how many days after a new version appears before it is automatically released from pilot.
 
@@ -477,6 +479,8 @@ module Xolo
 
               Setting it to zero means that new versions will be released at the next nightly auto-release task. *** USE WITH EXTREME CAUTION ***
 
+              Setting it to '#{Xolo::MONTHLY}' will release it on whatever day of the month is defined in the Xolo server's 'auto_release_monthly' setting, or on the first day of the month if the server isn't set. The server may be set to a specific date, like '15' or to an ordinal-weekday, like '3rd Mon'.
+
               To unset, meaning versions are never auto-released, use '#{Xolo::NONE}'
 
               Auto-release happens during the server's nightly maintenance between 2-3am.

data/lib/xolo/core/constants.rb

@@ -23,6 +23,9 @@ module Xolo
 
       ERROR = 'ERROR'
 
+      # A possible value for a title's auto-release delay
+      MONTHLY = 'monthly'
+
       # Several things use x
       X = 'x'
 

data/lib/xolo/core/version.rb

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

metadata

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