xolo-admin 1.0.0 → 2.0.2

data/lib/xolo/admin/options.rb

@@ -152,6 +152,7 @@ module Xolo
 
       LIST_TITLES_CMD = 'list-titles'
       ADD_TITLE_CMD = 'add-title'
+      SUBSCRIBE_CMD = 'subscribe'
       EDIT_TITLE_CMD = 'edit-title'
       DELETE_TITLE_CMD = 'delete-title'
       FREEZE_TITLE_CMD = 'freeze'
@@ -174,6 +175,7 @@ module Xolo
 
       LIST_GROUPS_CMD = 'list-groups'
       LIST_CATEGORIES_CMD = 'list-categories'
+      LIST_AVAILABLE_CMD = 'list-available'
       SAVE_CLIENT_CODE_CMD = 'save-client'
 
       SERVER_STATUS_CMD = 'server-status'
@@ -190,7 +192,7 @@ module Xolo
 
       HELP_OPT = '--help'
 
-      DFT_CMD_TITLE_ARG_BANNER = "  title:     The unique name of a title in Xolo, e.g. 'google-chrome'"
+      DFT_CMD_TITLE_ARG_BANNER = "  title:     The unique name of a title in Xolo, e.g. 'google-chrome'\n             Must be lowercase alphanumeric and dashes only."
       DFT_CMD_VERSION_ARG_BANNER = "  version:   The version of the title you are working with. e.g. '12.34.5'"
 
       TARGET_TITLE_PLACEHOLDER = Xolo::Admin::Title::TARGET_TITLE_PLACEHOLDER
@@ -299,7 +301,7 @@ module Xolo
           readline_prompt: 'Group Name',
           readline: :jamf_computer_group_names,
           desc: <<~ENDDESC
-            One or more Jamf Computer Group names or ids whose members will receive the MDM deployment.
+            One or more Jamf Computer Group names whose members will receive the MDM deployment.
 
             When using the --groups CLI option, you can specify more than one group by using the option more than once, or by providing a single option value with the groups separated by commas.
           ENDDESC
@@ -425,6 +427,17 @@ 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",
@@ -554,7 +567,7 @@ module Xolo
             before the MDM command is sent.
 
             Computers can be specified by name, serial number, or Jamf ID. Groups can be specified by
-            name or ID.
+            name.
 
             NOTE: Any automated installs (via Pilot or Release groups) will happen eventually anyway.
             All Macs with the title already installed will also get new versions automatically.
@@ -688,6 +701,21 @@ module Xolo
           process_method: :list_categories
         },
 
+        LIST_AVAILABLE_CMD => {
+          desc: 'List all titles available for subscription, and their Patch Sources and Title IDs.',
+          long_desc: <<~ENDLONG,
+            When adding a subscribed title to Xolo, you need to know the Patch Source and Title ID.
+            This command lists all available titles from all defined Patch Sources on the Jamf Pro server,
+            and the unique identifiers for each. You can use those values with the --patch-source and --title-id
+            options of the 'xadm add-title' command.
+          ENDLONG
+          display: LIST_AVAILABLE_CMD,
+          usage: "#{Xolo::Admin::EXECUTABLE_FILENAME} [global-options] #{LIST_AVAILABLE_CMD}",
+          opts: {},
+          arg_banner: :none,
+          process_method: :list_available_titles
+        },
+
         SAVE_CLIENT_CODE_CMD => {
           desc: 'Save the xolo client tool to a directory for packaging and deployment.',
           long_desc: <<~ENDLONG,
@@ -1090,6 +1118,12 @@ module Xolo
         # versions
         elsif version_command?
 
+          # make note of the title being subscribed or managed
+          title_obj = Xolo::Admin::Title.fetch(cli_cmd.title, server_cnx)
+
+          @current_opt_values[:subscribed] = title_obj.subscribed?
+          @current_opt_values[:display_name] = title_obj.display_name
+
           # adding a new one?
           if add_command?
             prev_version = Xolo::Admin::Title.latest_version cli_cmd.title, server_cnx

data/lib/xolo/admin/processing.rb

@@ -26,7 +26,7 @@ module Xolo
       # Routes for server admins
 
       SERVER_STATUS_ROUTE = '/maint/state'
-      SERVER_CLENUP_ROUTE = '/maint/cleanup'
+      SERVER_CLEANUP_ROUTE = '/maint/cleanup'
       SERVER_ROTATE_LOGS_ROUTE = '/maint/rotate-logs'
       SERVER_UPDATE_CLIENT_DATA_ROUTE = '/maint/update-client-data'
       SERVER_LOG_LEVEL_ROUTE = '/maint/set-log-level'
@@ -72,6 +72,14 @@ module Xolo
         puts msg unless quiet?
       end
 
+      # TODO: Use this everywhere in admin
+      ##########################
+      def show_debug(msg)
+        return unless debug?
+
+        puts "DEBUG: #{msg}"
+      end
+
       # Search for a title in Xolo
       # Looks for the search string (case insensitive) in these attributes:
       #  - title
@@ -234,19 +242,30 @@ module Xolo
 
         new_title = Xolo::Admin::Title.new opts_to_process
 
+        # TMP TESTING
+        # puts 'DEBUG: opts_to_process:'
+        # opts_to_process.to_h.each do |k, v|
+        #   puts "  #{k}: #{v}"
+        # end
+        # return
+
         response_data = new_title.add(server_cnx)
 
         if debug?
           puts "DEBUG: response_data: #{response_data}"
           puts
         end
-
-        display_progress response_data[:progress_stream_url_path]
+        if response_data[:progress_stream_url_path]
+          display_progress response_data[:progress_stream_url_path]
+        else
+          puts '# No progress stream URL returned'
+          return
+        end
 
         # Upload the ssvc icon, if any?
         upload_ssvc_icon new_title
 
-        speak "Title '#{cli_cmd.title}' has been added to Xolo.\nAdd at least one version to enable piloting and deployment"
+        speak "Title '#{cli_cmd.title}' has been added to Xolo.\nEnsure there's at least one version to enable piloting and deployment"
       rescue StandardError => e
         handle_processing_error e
       end
@@ -307,9 +326,26 @@ module Xolo
       def upload_ssvc_icon(title)
         return unless title.self_service_icon.is_a? Pathname
 
+        speak 'Pausing to let jamf server catch up before uploading self-service icon...'
+        sleep 30
         speak "Uploading self-service icon #{title.self_service_icon.basename}, #{title.self_service_icon.pix_humanize_size} to Xolo."
 
-        title.upload_self_service_icon(upload_cnx)
+        wait_for_title_timer = 0
+        begin
+          title.upload_self_service_icon(upload_cnx)
+        rescue Xolo::ConnectionError => e
+          speak "Error uploading self-service icon: #{e.message}, trying again in 5 secs"
+          # If we get a 404, it might be because the title isn't fully created yet.
+          # Wait a bit and try again, up to a certain number of seconds.
+          if wait_for_title_timer < 90
+            sleep 5
+            wait_for_title_timer += 5
+            retry
+          else
+            msg = "Failed to upload icon for Title '#{title}' after retrying for #{wait_for_title_timer} seconds."
+            raise Xolo::NoSuchItemError, msg
+          end # if
+        end # begin
 
         speak 'Self-service icon uploaded. Will be added to Self Service policies as needed'
       rescue StandardError => e
@@ -478,6 +514,7 @@ module Xolo
         opts_to_process.title = cli_cmd.title
         opts_to_process.version = cli_cmd.version
 
+        title_obj = Xolo::Admin::Title.fetch cli_cmd.title, server_cnx
         new_vers = Xolo::Admin::Version.new opts_to_process
         response_data = new_vers.add(server_cnx)
 
@@ -489,7 +526,8 @@ module Xolo
         display_progress response_data[:progress_stream_url_path]
 
         # Upload the pkg, if any?
-        upload_pkg(new_vers)
+        upload_pkg(new_vers) unless title_obj.autopkg_enabled?
+
         speak 'It can take up to 15 minutes for the version to be available via Jamf and Self Service.'
       rescue StandardError => e
         handle_processing_error e
@@ -510,6 +548,8 @@ module Xolo
       def upload_pkg(version)
         return unless version.pkg_to_upload.is_a? Pathname
 
+        # TODO: deal with autopkg pkgs, should we be able to do this?
+
         speak "Uploading #{version.pkg_to_upload.basename}, #{version.pkg_to_upload.pix_humanize_size} to Xolo"
         # start the upload in a thread
         upload_thr = Thread.new { version.upload_pkg(upload_cnx) }
@@ -941,7 +981,7 @@ module Xolo
       def server_cleanup
         return unless confirmed? 'Run the Xolo Server cleanup process'
 
-        result = server_cnx.post(SERVER_CLENUP_ROUTE).body
+        result = server_cnx.post(SERVER_CLEANUP_ROUTE).body
         puts result[:result]
       rescue StandardError => e
         handle_processing_error e
@@ -1036,6 +1076,35 @@ module Xolo
         list_in_cols header, jamf_computer_group_names.sort_by(&:downcase)
       end
 
+      # List Available titles for subscription
+      #
+      # @return [void]
+      #############################
+      def list_available_titles
+        data = jamf_available_titles.sort_by { |t| t[:app_name].downcase }
+        data.map! do |t|
+          {
+            display_name: t[:app_name],
+            publisher: t[:publisher],
+            patch_source: t[:source_name],
+            title_id: t[:name_id],
+            current_version: t[:current_version],
+            last_modified: t[:last_modified]
+          }
+        end
+
+        if json?
+          puts JSON.pretty_generate(data)
+          return
+        end
+
+        title = 'Titles Available for Subscription'
+        header = %w[DisplayName Publisher PatchSource TitleID]
+        lines = data.map { |t| [t[:display_name], t[:publisher], t[:patch_source], t[:title_id]] }
+
+        show_text generate_report(lines, header_row: header, title: title)
+      end
+
       # List all the SSVC categories in jamf pro
       #
       # @return [void]
@@ -1079,7 +1148,7 @@ module Xolo
       end
 
       # run the cleanup
-      # get the /test route to do whatever testing it does
+      # get the /test route to do whatever testing it does.
       # during testing - this will return all kinds of things.
       #
       # @return [void]
@@ -1104,11 +1173,7 @@ module Xolo
           display_progress resp[:progress_stream_url_path]
         end
 
-        # test uploads
-        # 1.2 gb
-        large_file = '/dist/caspershare/Packages-DEACTIVATED/SecUpd2020-006HighSierra.pkg'
-
-        pkg_to_upload = Pathname.new large_file
+        pkg_to_upload = Pathname.new '/path/to/some/file.pkg'
         puts "Uploading Test File #{pkg_to_upload.size} bytes... "
         upload_test_file(pkg_to_upload)
 

data/lib/xolo/admin/progress_history.rb

@@ -85,7 +85,7 @@ module Xolo
       ###################
       def progress_history
         progress_history_file.pix_touch
-        history = YAML.load progress_history_file.read
+        history = YAML.safe_load progress_history_file.read, permitted_classes: [Symbol, Time]
         history ||= {}
 
         now = Time.now

data/lib/xolo/admin/title.rb

@@ -43,10 +43,17 @@ module Xolo
       #############################
 
       # @return [Hash{Symbol: Hash}] The ATTRIBUTES that are available as CLI & walkthru options
+      ##############################
       def self.cli_opts
         @cli_opts ||= ATTRIBUTES.select { |_k, v| v[:cli] }
       end
 
+      # @return [Hash{Symbol: Hash}] The ATTRIBUTES that are available as opts for the subscribe command
+      ################################
+      # def self.subscribe_cli_opts
+      #   @subscribe_cli_opts ||= ATTRIBUTES.select { |_k, v| v[:cli_subscribe] }
+      # end
+
       # @return [Array<String>] The currently known titles names on the server
       #############################
       def self.all_titles(cnx)
@@ -77,8 +84,11 @@ module Xolo
       ####################
       def self.fetch(title, cnx)
         resp = cnx.get "#{SERVER_ROUTE}/#{title}"
-
-        new resp.body
+        title_obj = new resp.body
+        title_obj.cnx = cnx
+        title_obj
+      rescue Faraday::ResourceNotFound
+        raise Xolo::NoSuchItemError, "No such title '#{title}'"
       end
 
       # Delete a title from the server
@@ -113,6 +123,8 @@ module Xolo
       # Attributes
       ######################
       ######################
+      # the server connection used to fetch this version
+      attr_accessor :cnx
 
       # Constructor
       ######################
@@ -137,7 +149,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash] the response body from the server
       ####################
-      def add(cnx)
+      def add(cnx = self.cnx)
         resp = cnx.post SERVER_ROUTE, to_h
         resp.body
       end
@@ -146,7 +158,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash] the response body from the server
       ####################
-      def update(cnx)
+      def update(cnx = self.cnx)
         resp = cnx.put "#{SERVER_ROUTE}/#{title}", to_h
         resp.body
       end
@@ -156,7 +168,7 @@ module Xolo
       # @param version [String] the version to release
       # @return [Hash] the response body from the server
       ####################
-      def release(cnx, version:)
+      def release(cnx = self.cnx, version:)
         resp = cnx.patch "#{SERVER_ROUTE}/#{title}/release/#{version}", {}
         resp.body
       end
@@ -166,7 +178,7 @@ module Xolo
       # @param versions [Boolean] if true, repair all versions of this title
       # @return [Hash] the response body from the server
       ####################
-      def repair(cnx, versions: false)
+      def repair(cnx = self.cnx, versions: false)
         resp = cnx.post "#{SERVER_ROUTE}/#{title}/repair", { repair_versions: versions }
         resp.body
       end
@@ -175,7 +187,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash] the response data
       ####################
-      def delete(cnx)
+      def delete(cnx = self.cnx)
         self.class.delete title, cnx
       end
 
@@ -184,7 +196,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash] the response data
       ####################
-      def freeze(targets, users = false, cnx)
+      def freeze(targets, users = false, cnx = self.cnx)
         data = { targets: targets, users: users }
         resp = cnx.put "#{SERVER_ROUTE}/#{title}/freeze", data
         resp.body
@@ -195,7 +207,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash] the response data
       ####################
-      def thaw(targets, users = false, cnx)
+      def thaw(targets, users = false, cnx = self.cnx)
         data = { targets: targets, users: users }
         resp = cnx.put "#{SERVER_ROUTE}/#{title}/thaw", data
         resp.body
@@ -205,7 +217,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash{String => String}] computer name => user name
       ####################
-      def frozen(cnx)
+      def frozen(cnx = self.cnx)
         resp = cnx.get "#{SERVER_ROUTE}/#{title}/frozen"
         resp.body
       end
@@ -214,7 +226,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Hash{String => String}] page_name => url
       ####################
-      def gui_urls(cnx)
+      def gui_urls(cnx = self.cnx)
         resp = cnx.get "#{SERVER_ROUTE}/#{title}/urls"
         resp.body
       end
@@ -225,7 +237,7 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Array<Hash>] The change log for this title
       ####################
-      def changelog(cnx)
+      def changelog(cnx = self.cnx)
         resp = cnx.get "#{SERVER_ROUTE}/#{title}/changelog"
         resp.body
       end
@@ -246,19 +258,16 @@ module Xolo
                 "Can't upload self service icon '#{self_service_icon}': file doesn't exist or is not readable"
         end
 
-        # upfile = Faraday::UploadIO.new(
-        #   self_service_icon.to_s,
-        #   'application/octet-stream',
-        #   self_service_icon.basename.to_s
-        # )
-
         mimetype = `/usr/bin/file --brief --mime-type #{Shellwords.escape self_service_icon.expand_path.to_s}`.chomp
         upfile = Faraday::Multipart::FilePart.new(self_service_icon.expand_path.to_s, mimetype)
         content = { file: upfile }
-        # route =  "#{UPLOAD_ICON_ROUTE}/#{title}"
-        route = "#{SERVER_ROUTE}/#{title}/#{UPLOAD_ICON_ROUTE}"
 
+        route = "#{SERVER_ROUTE}/#{title}/#{UPLOAD_ICON_ROUTE}"
         upload_cnx.post(route) { |req| req.body = content }
+      rescue Xolo::NoSuchItemError
+        raise
+      rescue StandardError => e
+        raise Xolo::ConnectionError, "#{e.class}: #{e.message}"
       end
 
       # Get the patch report data for this title
@@ -267,16 +276,16 @@ module Xolo
       # @param cnx [Faraday::Connection] The connection to use, must be logged in already
       # @return [Array<Hash>] Data for each computer with any version of this title installed
       ##################################
-      def patch_report_data(cnx)
+      def patch_report_data(cnx = self.cnx)
         resp = cnx.get "#{SERVER_ROUTE}/#{title}/patch_report"
         resp.body
       end
 
       # Add more data to our hash
       ###########################
-      def to_h
-        super
-      end
+      # def to_h
+      #   super
+      # end
 
     end # class Title