ruby-jss 2.0.0a10 → 2.0.0b3

data/lib/jamf/client/management_action.rb

@@ -31,7 +31,7 @@ module Jamf
 
     #  Module for working with the Management Action.app, which is an interface
     # to the Notification Center
-    # This should be extended into Jamf::Client
+    # This should be included into Jamf::Client
     #####################################
     module ManagementAction
 
@@ -43,67 +43,77 @@ module Jamf
       # MGMT_ACTION_BUNDLE_ID = 'com.jamfsoftware.Management-Action'.freeze
       # HUP_NOTIF_CTR_CMD = '/usr/bin/killall sighup usernoted NotificationCenter'.freeze
 
+      # when this module is included, also extend our Class Methods
+      def self.included(includer)
+        Jamf.load_msg "--> #{includer} is including Jamf::Client::ManagementAction"
+        includer.extend(ClassMethods)
+      end
+
       # class Methods
       #####################################
 
-      def management_action(msg, title: nil, subtitle: nil, delay: 0)
-        raise Jamf::InvalidDataError, 'delay: must be a non-negative integer.' unless delay.is_a?(Integer) && delay > -1
+      module ClassMethods
 
-        cmd = Shellwords.escape MGMT_ACTION.to_s
-        cmd << " -message #{Shellwords.escape msg.to_s}"
-        cmd << " -title #{Shellwords.escape title.to_s}" if title
-        cmd << " -subtitle #{Shellwords.escape subtitle.to_s}" if subtitle
-        cmd << " -deliverydelay #{Shellwords.escape delay}" if delay > 0
-        `#{cmd} 2>&1`
-      end
-      alias nc_notify management_action
-
-      # Skipping all the force-alerts stuff until we figure out cleaner
-      # ways to do it in 10.13+
-      # The plan is to be able to make the NotificationCenter notification be an
-      # 'alert' (which stays visible til the user clicks) or a
-      # 'banner' (which vanishes in a few seconds), regardless of the user's
-      # setting in the NC prefs.
-
-      def force_alerts
-        orig_flags = {}
-        console_users.each do |user|
-          orig_flags[user] = set_mgmt_action_ncprefs_flags user, NC_ALERT_STYLE_FLAGS, hup: false
+        def management_action(msg, title: nil, subtitle: nil, delay: 0)
+          raise Jamf::InvalidDataError, 'delay: must be a non-negative integer.' unless delay.is_a?(Integer) && delay > -1
+
+          cmd = Shellwords.escape MGMT_ACTION.to_s
+          cmd << " -message #{Shellwords.escape msg.to_s}"
+          cmd << " -title #{Shellwords.escape title.to_s}" if title
+          cmd << " -subtitle #{Shellwords.escape subtitle.to_s}" if subtitle
+          cmd << " -deliverydelay #{Shellwords.escape delay}" if delay > 0
+          `#{cmd} 2>&1`
+        end
+        alias nc_notify management_action
+
+        # Skipping all the force-alerts stuff until we figure out cleaner
+        # ways to do it in 10.13+
+        # The plan is to be able to make the NotificationCenter notification be an
+        # 'alert' (which stays visible til the user clicks) or a
+        # 'banner' (which vanishes in a few seconds), regardless of the user's
+        # setting in the NC prefs.
+
+        def force_alerts
+          orig_flags = {}
+          console_users.each do |user|
+            orig_flags[user] = set_mgmt_action_ncprefs_flags user, NC_ALERT_STYLE_FLAGS, hup: false
+          end
+          system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
+          sleep 1
+          orig_flags
         end
-        system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
-        sleep 1
-        orig_flags
-      end
 
-      def restore_alerts(orig_flags)
-        orig_flags.each do |user, flags|
-          set_mgmt_action_ncprefs_flags user, flags, hup: false
+        def restore_alerts(orig_flags)
+          orig_flags.each do |user, flags|
+            set_mgmt_action_ncprefs_flags user, flags, hup: false
+          end
+          system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
         end
-        system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
-      end
 
-      # set the NotificationCenter option flags for a user
-      # flags = an integer.
-      #
-      # Doesn't seem to work in 10.13, so ignore this for now.
-      #
-      # @return [Integer] the original flags, or given flags if no originals.
-      #
-      def set_mgmt_action_ncprefs_flags(user, flags, hup: true)
-        plist = Pathname.new "/Users/#{user}/Library/Preferences/#{NCPREFS_DOMAIN}.plist"
-        prefs = JSS.parse_plist plist
-        mgmt_action_setting = prefs['apps'].select { |a| a['bundle-id'] == MGMT_ACTION_BUNDLE_ID }.first
-        if mgmt_action_setting
-          orig_flags = mgmt_action_setting['flags']
-          mgmt_action_setting['flags'] = flags
-        else
-          orig_flags = flags
-          prefs['apps'] << { 'bundle-id' => MGMT_ACTION_BUNDLE_ID, 'flags' => flags }
+        # set the NotificationCenter option flags for a user
+        # flags = an integer.
+        #
+        # Doesn't seem to work in 10.13, so ignore this for now.
+        #
+        # @return [Integer] the original flags, or given flags if no originals.
+        #
+        def set_mgmt_action_ncprefs_flags(user, flags, hup: true)
+          plist = Pathname.new "/Users/#{user}/Library/Preferences/#{NCPREFS_DOMAIN}.plist"
+          prefs = JSS.parse_plist plist
+          mgmt_action_setting = prefs['apps'].select { |a| a['bundle-id'] == MGMT_ACTION_BUNDLE_ID }.first
+          if mgmt_action_setting
+            orig_flags = mgmt_action_setting['flags']
+            mgmt_action_setting['flags'] = flags
+          else
+            orig_flags = flags
+            prefs['apps'] << { 'bundle-id' => MGMT_ACTION_BUNDLE_ID, 'flags' => flags }
+          end
+          plist.open('w') { |f| f.write JSS.xml_plist_from(prefs) }
+          system HUP_NOTIF_CTR_CMD if hup
+          orig_flags
         end
-        plist.open('w') { |f| f.write JSS.xml_plist_from(prefs) }
-        system HUP_NOTIF_CTR_CMD if hup
-        orig_flags
-      end
+
+      end # ClassMethods
 
     end # moculde
 

data/lib/jamf/client.rb

@@ -64,9 +64,9 @@ module Jamf
     # the path to a users byhost folder from home
     USER_PREFS_BYHOST_FOLDER = 'Library/Preferences/ByHost/'.freeze
 
-    extend Jamf::Client::JamfBinary
-    extend Jamf::Client::JamfHelper
-    extend Jamf::Client::ManagementAction
+    include Jamf::Client::JamfBinary
+    include Jamf::Client::JamfHelper
+    include Jamf::Client::ManagementAction
 
     # Class Methods
     #####################################

data/lib/jamf/constants.rb

@@ -30,7 +30,7 @@ module Jamf
   module Constants
 
     # The minimum Ruby version needed for ruby-jss
-    MINIMUM_RUBY_VERSION = '2.7.0'.freeze
+    MINIMUM_RUBY_VERSION = '2.6.3'.freeze
 
     # These are handy for testing values without making new arrays, strings, etc every time.
     TRUE_FALSE = [true, false].freeze

data/lib/jamf/deprecations/deprecated_api_connection_class.rb

@@ -0,0 +1,29 @@
+# Copyright 2022 Pixar
+
+#
+#    Licensed under the Apache License, Version 2.0 (the "Apache License")
+#    with the following modification; you may not use this file except in
+#    compliance with the Apache License and the following modification to it:
+#    Section 6. Trademarks. is deleted and replaced with:
+#
+#    6. Trademarks. This License does not grant permission to use the trade
+#       names, trademarks, service marks, or product names of the Licensor
+#       and its affiliates, except as required to comply with Section 4(c) of
+#       the License and to reproduce the content of the NOTICE file.
+#
+#    You may obtain a copy of the Apache License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the Apache License with the above modification is
+#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#    KIND, either express or implied. See the Apache License for the specific
+#    language governing permissions and limitations under the Apache License.
+
+# @deprecated Use class Jamf::Connection
+module Jamf
+
+  APIConnection = Connection
+
+end

data/lib/jamf/deprecations/deprecated_api_constant.rb

@@ -22,4 +22,6 @@
 #    language governing permissions and limitations under the Apache License.
 
 # @deprecated Use Jamf.cnx to access the module-wide default connection
-Jamf::API = Jamf.cnx
+module Jamf
+  API = Jamf.cnx
+end

data/lib/jamf/deprecations/deprecated_config_constant.rb

@@ -22,4 +22,6 @@
 #    language governing permissions and limitations under the Apache License.
 
 # @deprecated Use Jamf.config to access the module-wide config settings
-Jamf::CONFIG = Jamf.config
+module Jamf
+  CONFIG = Jamf.config
+end

data/lib/jamf/version.rb

@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of ruby-jss
-  VERSION = '2.0.0a10'.freeze
+  VERSION = '2.0.0b3'.freeze
 
 end # module

data/lib/zeitwerk_config.rb

@@ -29,7 +29,7 @@ def setup_zeitwerk_loader(loader)
   loader.ignore __FILE__
 
   # these paths all define classes & modules directly below 'Jamf'
-  # If we didn't collaps them, then e.g.
+  # If we didn't collapse them, then e.g.
   #   /jamf/api/base_classes/classic/group.rb
   # would be expected to define
   #   Jamf::Api::BaseClasses::Classic::Group
@@ -51,7 +51,8 @@ def setup_zeitwerk_loader(loader)
 
   loader.collapse("#{__dir__}/jamf/deprecations")
 
-  # filenames => Constants, which don't adhere to zeitwerk's parsing standards
+  # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
+  #
   # Mostly because the a filename like 'oapi_object' would be
   # loaded by zeitwerk expecting it to define 'OapiObject', but it really
   # defines 'OAPIObject'
@@ -86,16 +87,18 @@ def setup_zeitwerk_loader(loader)
   loader.inflector.inflect 'md_prestage_name' => 'MobileDevicePrestageName'
   loader.inflector.inflect 'md_prestage_names' => 'MobileDevicePrestageNames'
   loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
+  loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
 
-  # deprecations, separated so they load only when used
-  loader.inflector.inflect("deprecated_api_constant" => "API")
-  loader.inflector.inflect("deprecated_config_constant" => "CONFIG")
+  # deprecations, separated so they load only when used.
+  # When its time to get rid of them, delete the files from the 
+  # 'deprecations' directory, and the matching line here.
+  loader.inflector.inflect('deprecated_api_constant' => 'API')
+  loader.inflector.inflect('deprecated_config_constant' => 'CONFIG')
+  loader.inflector.inflect('deprecated_api_connection_class' => 'APIConnection')
 
   # These should be ignored, some will be required directly
   #####################################
 
-  loader.ignore "#{__dir__}/jamf/api/jamf_pro/pre_oapi"
-
   loader.ignore "#{__dir__}/jamf/db_connection.rb"
   loader.ignore "#{__dir__}/jamf/ruby_extensions.rb"
   loader.ignore "#{__dir__}/jamf/ruby_extensions"
@@ -105,16 +108,18 @@ def setup_zeitwerk_loader(loader)
   loader.ignore "#{__dir__}/ruby-jss.rb"
 
   # callback for when a specific file/constant loads
+  # duplicate and uncomment this if desired to react to 
+  # specific things loading 
   #####################################
-  loader.on_load('Jamf::SomeClass') do |klass, abspath|
-    Jamf.load_msg "I just loaded #{klass} from #{abspath}"
-  end
+  # loader.on_load('Jamf::SomeClass') do |klass, abspath|
+  #   Jamf.load_msg "I just loaded #{klass} from #{abspath}"
+  # end
 
   # callback for when anything loads
   #  - const_path is like "Jamf::SomeClass" or "Jamf::SomeClass::SOME_CONST_ARRY"
   #  - value is the value that constant contains after loading,
-  #    e.g. a the class Jamf::SomeClass for 'Jamf::SomeClass' or
-  #    and Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
+  #    e.g. the class Jamf::SomeClass for 'Jamf::SomeClass' or
+  #    an Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
   #  - abspath is the full path to the file where the constant was loaded from.
   #####################################
   loader.on_load do |const_path, value, abspath|
@@ -122,13 +127,14 @@ def setup_zeitwerk_loader(loader)
 
     # Parse OAPI_PROPERTIES into getters and setters for subclasses of
     # OAPIObject in the JPAPI.
+    #
     # The class we just loaded must have this method and constant
-    # and the constant must be defined directly in the file we just loaded.
+    # and the method must not have run already for the class or any superclass.
     # This prevents running parse_oapi_properties again in subclasses that
     # don't need to do that
-    if value.respond_to?(:parse_oapi_properties) && \
+    if value.respond_to?(:oapi_properties_parsed?) && \
        defined?(value::OAPI_PROPERTIES) && \
-       abspath == value.const_source_location(:OAPI_PROPERTIES).first
+       !value.oapi_properties_parsed?
 
       parsed = value.parse_oapi_properties
       Jamf.load_msg "Parsed OAPI_PROPERTIES for #{value}" if parsed
@@ -157,6 +163,6 @@ def eager_load_for_testing
 
   @loader.eager_load(force: true)
   warn :loaded
-# rescue Zeitwerk::NameError => e
-#   warn e.message
+  # rescue Zeitwerk::NameError => e
+  #   warn e.message
 end

data/test/{README.md → README-TEST.md}

@@ -47,6 +47,9 @@ Want to test with a different version of ruby? Change the #! line of the `runtes
 
  - The individual tests are methods in classes defined in files in the 'tests' directory adjacent to this file.
  - In general, each class test a matching ruby-jss class, usually an APIObject (classic) or JPAPIResource (jamf pro).
+ - Shared code is in modules defined in the 'jamf_test' directory. See those files for more info. E.g.
+   - 'collection_tests.rb' defines common tests for all collection-resources
+   - 'prestage_tests.rb' defines common tests for 'computer_prestage' and 'mobile_device_prestage'
 
 **WARNING**: **DANGER DANGER** Be very careful about running these tests on your production Jamf Pro server!!!
 

data/test/bin/runtests

@@ -29,6 +29,40 @@ require 'pathname'
 require 'getoptlong'
 require 'ruby-jss'
 
+# Debug Trace support, Ideas from
+# https://gist.github.com/bendilley/1453a555e981ed533f68
+# and the other gist and stack overflow mentioned there.
+####################################
+
+# Enable tracing to help debug stack level too deep errors
+$do_tracing = false
+
+# set this to true to save the call traces to a file
+$save_trace = false
+
+# the file to hold the traces
+$trace_out = open('/tmp/ruby-jss-tests-trace.txt', 'w')
+
+# the max call-stack depth - adjust this to help catch and 
+# debug SystemStackError exceptions
+$trace_max_call_stack_depth = 1000
+
+# the tracing proc
+set_trace_func proc { |event, file, line, id, _binding, classname|
+  if $do_tracing
+    begin
+      if event == 'call'
+        $trace_out.puts "#{file}:#{line} #{classname}##{id}" if $save_trace 
+        raise 'MaxCallStackReached' if caller_locations.length > $trace_max_call_stack_depth
+      end
+    rescue => e
+      warn "ERROR: #{e.class}: #{e}"
+      e.backtrace.each { |l| warn "..#{l}" }
+      exit 1
+    end
+  end # if
+}
+
 # app
 class App
 
@@ -62,8 +96,8 @@ class App
     @testsdir = @appdir + 'tests'
 
     @tests_to_run = ARGV.dup
-    @tests_to_run = @testsdir.children.map { |c| c.basename.to_s }.sort if @tests_to_run .empty?
-    @tests_to_run.delete_if { |t| t.start_with? '.'}
+    @tests_to_run = @testsdir.children.map { |c| c.basename.to_s }.sort if @tests_to_run.empty?
+    @tests_to_run.delete_if { |t| t.start_with? '.' }
 
     @minitest_opts = ['--verbose']
 
@@ -126,6 +160,7 @@ class App
 
   ###################################
   def run_tests
+    puts
     JamfTest.say "Starting tests of ruby-jss v#{Jamf::VERSION}, using ruby version #{RUBY_VERSION}"
     JamfTest.say "API Connection: #{Jamf.cnx}; Server running Jamf Pro #{Jamf.cnx.jamf_version}"
 
@@ -158,6 +193,7 @@ class App
   ###################################
   def show_help
     return false unless @show_help
+
     puts <<-USAGEBLURB
 Usage: #{File.basename __FILE__} [options] [spec [spec ...]]
 
@@ -209,6 +245,10 @@ if $PROGRAM_NAME == __FILE__
     app = App.new
     app.run
     exit 0
+  rescue SystemStackError
+    puts $!
+    puts caller[0..100]
+    exit 1
   rescue => e
     puts "ERROR #{e.class}: #{e}"
     puts e.backtrace

data/test/lib/jamf_test/APITest.rb

@@ -41,25 +41,51 @@ module JamfTest
     end
 
     #####
-    def validate_hash(hash, has_key: nil, val_class: nil)
+    def validate_hash(hash, has_key: nil, class_for_has_key: nil, key_class: nil, val_class: nil)
       raise 'Value is not a Hash' unless hash.is_a? Hash
-      return unless has_key
 
-      raise "Hash does not have required key #{has_key}" unless hash.key? has_key
-      return unless val_class
+      if hash.empty?
+        say 'WARNING: Hash is empty! This may be OK depending on your environment'
+        return
+      end
+
+      if has_key
+        raise "Hash does not have required key #{has_key}" unless hash.key?(has_key)
+
+        say "Hash has key '#{has_key}'"
+        if class_for_has_key
+          val = hash[has_key]
+          raise "Value '#{val}' for key '#{has_key}' is a #{val.class} not #{class_for_has_key}" unless val.is_a?(class_for_has_key)
+
+          say "Value '#{val}' for key '#{has_key}' is a #{class_for_has_key}"
+        end
+      end
+
+      if key_class
+        key = hash.keys.sample
 
-      raise "Value for Hash key #{has_key} is not a #{val_class}" unless hash[has_key].is_a? val_class
+        raise "Hash key'#{key}' is a #{key.class} not #{key_class}" unless key.is_a?(key_class)
+
+        say "Hash keys are class: #{key_class}"
+      end
+
+      if val_class
+        val = hash.values.sample
+        raise "Hash value '#{val}' is a #{val.class} not #{val_class}" unless val.is_a?(val_class)
+
+        say "Hash value are class: #{val_class}"
+      end
     end
 
     #####
     def validate_array(ary, item_class: nil)
       raise 'Value is not an Array' unless ary.is_a? Array
-      return unless item_class
 
       if ary.empty?
-        puts 'WARNING: Array is empty! This may be OK depending on your environment'
+        say 'WARNING: Array is empty! This may be OK depending on your environment'
         return
       end
+      return unless item_class
 
       raise "Randomly chosen item from Array is not a #{item_class}" unless ary.sample.is_a? item_class
     end

data/test/lib/jamf_test/advanced_search.rb

@@ -0,0 +1,40 @@
+### Copyright 2022 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module JamfTest
+
+  module AdvancedSearchTests
+
+    include JamfTest::CollectionTests
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests do_object_tests: false
+
+    end
+
+  end # module
+
+end # module JamfTest

data/test/lib/jamf_test/collection_tests.rb

@@ -93,11 +93,12 @@ module JamfTest
       fetch_random
       return unless do_object_tests
 
-      # These methods are very basic and assume a simple object
+      # The methods below are very basic and assume a simple object
       # that can be created with only a 'name'.
       #
       # For anything more complex, they should be overridden in the classes that
       # mixin this module, since the details will be very different
+      # See inventory_preload_record.rb for an example
 
       create_new
       add_data_to_new
@@ -128,8 +129,7 @@ module JamfTest
 
       one_of_all = @cached_all.sample
 
-      validate_hash one_of_all, has_key: :id, val_class: id_class
-
+      validate_hash one_of_all, has_key: :id, class_for_has_key: id_class
     end
 
     #################
@@ -140,8 +140,6 @@ module JamfTest
         say "There are no #{collection_class} objects on the server, not testing sorted_all"
         return
       end
-
-
       sorted_desc = collection_class.all sort: 'id:desc'
       raise "#{collection_class}.all sort: 'id:desc' ; didn't work as expected" unless sorted_desc.first[:id].to_i >= sorted_desc.last[:id].to_i
 
@@ -178,11 +176,11 @@ module JamfTest
       say "Ran #{collection_class}.all_ids"
       validate_array ids, item_class: id_class
 
-
       identifiers.each do |ident|
         next if ident == :id
 
-        mth = ident.end_with?('s') ? "all_#{ident}es" : "all_#{ident}s"
+        mth = ident.to_s.end_with?('s') ? "all_#{ident}es" : "all_#{ident}s"
+        say "Testing #{collection_class}.#{mth}"
         collection_class.send mth
         say "Ran #{collection_class}.#{mth}"
       end
@@ -198,7 +196,6 @@ module JamfTest
       cached_ids = collection_class.all_ids cached_list: @cached_all
       say "Ran #{collection_class}.all_ids cached_list: @cached_all"
       validate_array cached_ids, item_class: id_class
-
     end
 
     #################
@@ -225,7 +222,6 @@ module JamfTest
 
       validate_hash ids_to_other
       validate_array ids_to_other.keys, item_class: id_class
-
     end
 
     ################
@@ -252,7 +248,6 @@ module JamfTest
 
       validate_hash ids_to_other
       validate_array ids_to_other.keys, item_class: id_class
-
     end
 
     ################
@@ -267,7 +262,9 @@ module JamfTest
       id, other = ids_to_other_ident.to_a.sample
 
       valid_id = collection_class.valid_id other
-      raise "#{collection_class} id #{id}, has #{other_ident} '#{other}', but calling .valid_id('#{other}') returned id: #{valid_id}" unless id.to_s == valid_id.to_s
+      unless id.to_s == valid_id.to_s
+        raise "#{collection_class} id #{id}, has #{other_ident} '#{other}', but calling .valid_id('#{other}') returned id: #{valid_id}"
+      end
 
       say "#{collection_class}.valid_id for #{other_ident} '#{other}' returned the correct id"
     end
@@ -286,13 +283,11 @@ module JamfTest
     ########### Object Tests
     ####################################
 
-
     # override this if the class requires more than 'name' with .create
     ################
     def create_new
       @unsaved_new_object = collection_class.create name: test_object_name
       say "Created new #{collection_class}, to be saved in Jamf."
-
     end
 
     # override this if your class can take more than 'name'