ruby-jss 1.6.0 → 2.0.0a11

data/test/lib/jamf_test/prestage_tests.rb

@@ -0,0 +1,135 @@
+### 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 PrestageTests
+
+    include JamfTest::CollectionTests
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests do_object_tests: false
+
+      if @cached_all.empty?
+        say 'No ComputerPrestages defined, skipping remaining tests'
+        return
+      end
+
+      # class methods
+      fetch_default_prestage
+      all_serials_by_prestage_id
+      serials_for_prestage
+
+      unless @sampled_sn
+        say 'No serial numbers assigned to any prestage, cannot continue tests on this server.'
+        return
+      end
+
+      assigned_prestage_id
+      assigned_via_class
+
+      say 'NOTE: Not testing assign/unassign. Too much potential for havoc on prod. servers. Use IRB to test manually'
+
+      # instance methods
+      scope
+      assigned_via_scope
+    end
+
+    #########
+    def fetch_default_prestage
+      @default_computer_prestage = collection_class.default
+      say "Ran #{collection_class}.default to fetch the default Computer prestage"
+    end
+
+    #########
+    def all_serials_by_prestage_id
+      serials = collection_class.serials_by_prestage_id
+      say "Ran #{collection_class}.default to fetch the default Computer prestage"
+      validate_hash serials, key_class: String, val_class: String
+      @sampled_sn = serials.keys.sample
+      @sample_prestage_id = serials[@sampled_sn]
+    end
+
+    ###########
+    def serials_for_prestage
+      collection_class.serials_for_prestage @default_computer_prestage.id
+      say "Ran #{collection_class}.serials_for_prestage '#{@default_computer_prestage.id}'"
+
+      collection_class.serials_for_prestage @default_computer_prestage.displayName
+      say "Ran #{collection_class}.serials_for_prestage '#{@default_computer_prestage.displayName}'"
+    end
+
+    ##########
+    def assigned_prestage_id
+      looked_up_id = collection_class.assigned_prestage_id @sampled_sn, :refresh
+      say "Ran #{collection_class}.assiged_prestage_id '#{@sampled_sn}', :refresh"
+
+      if looked_up_id == @sample_prestage_id
+        say "Prestage id returned was '#{looked_up_id}' as expected"
+        return
+      end
+
+      raise "Prestage id returned was '#{looked_up_id}' but expected '#{@sample_prestage_id}'"
+    end
+
+    ##########
+    def assigned_via_class
+      assigned = collection_class.assigned? @sampled_sn, refresh: false
+      say "Ran #{collection_class}.assigned? '#{@sampled_sn}', refresh: false"
+      raise "Expected #{collection_class}.assigned? '#{@sampled_sn}' to return true, but got false" unless assigned
+
+      assigned = collection_class.assigned? 'NotA-Real-SerialNumber', refresh: false
+      say "Ran #{collection_class}.assigned? 'NotA-Real-SerialNumber', refresh: false"
+      raise "Expected #{collection_class}.assigned? 'NotA-Real-SerialNumber' to return false, but got true" if assigned
+    end
+
+    ###########
+    def scope
+      @default_computer_prestage_scope = @default_computer_prestage.scope
+      say "Ran #{collection_class}#scope on default prestage"
+      unless @default_computer_prestage_scope.is_a?(Jamf::OAPISchemas::PrestageScopeResponseV2)
+        raise 'Returned scope is not a Jamf::OAPISchemas::PrestageScopeResponseV2'
+      end
+
+      say 'Validating #assignments'
+      validate_array @default_computer_prestage_scope.assignments, item_class: Jamf::OAPISchemas::PrestageScopeAssignmentV2
+      say 'scope assignments are valid'
+    end
+
+    ##############
+    def assigned_via_scope
+      assigned = @default_computer_prestage.assigned? @sampled_sn
+      say "Ran @default_computer_prestage.assigned? '#{@sampled_sn}'"
+      raise "Expected @default_computer_prestage.assigned? '#{@sampled_sn}' to return true, but got false" unless assigned
+
+      assigned = @default_computer_prestage.assigned? 'NotA-Real-SerialNumber'
+      say "Ran @default_computer_prestage.assigned? 'NotA-Real-SerialNumber'"
+      raise "Expected @default_computer_prestage.assigned? 'NotA-Real-SerialNumber' to return false, but got true" if assigned
+    end
+
+  end # module
+
+end # module JamfTest

data/test/lib/{testhelper.rb → jamf_test.rb}

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,29 +24,26 @@
 ###
 
 # Methods and constants for the tests
-module JSSTestHelper
+module JamfTest
 
   TOP_PREFIX = '>>>>>'.freeze
-  TEST_PREFIX = '---->'.freeze
+  TEST_PREFIX = '-->'.freeze
 
   ERROR_PREFIX1 = '****-> ERROR in :'.freeze
   ERROR_PREFIX2 = '****->   '.freeze
 
-  module_function
-
-  def say(msg, from: :top)
+  def self.say(msg, from: :top)
     msgs = msg.is_a?(Array) ? msg : [msg]
     prefix =
       if from == :top
         TOP_PREFIX
       else
-        puts # for interlacing with minitest's dots
-        "-- #{from} #{TEST_PREFIX}"
+        "- #{from} #{TEST_PREFIX}"
       end
     msgs.each { |m| puts "#{prefix} #{m}" }
   end
 
-  def report(a_problem)
+  def self.report(a_problem)
     if a_problem.is_a? Exception
       puts caller_locations
       src = caller_locations(5..5).first
@@ -61,9 +58,15 @@ module JSSTestHelper
     puts " #{ERROR_PREFIX2} #{msg}"
   end
 
-end # module JSSTestHelper
+end # module JamfTest
 
 # load in the rest of the module
 libdir = Pathname.new File.dirname(__FILE__)
-moduledir = libdir + 'testhelper'
-moduledir.children.each { |mf| load mf.to_s }
+moduledir = libdir + 'jamf_test'
+
+# order matters, of course
+require "#{moduledir}/auth"
+require "#{moduledir}/APITest"
+require "#{moduledir}/collection_tests"
+require "#{moduledir}/prestage_tests"
+require "#{moduledir}/advanced_search"

data/{lib/jss/ruby_extensions.rb → test/tests/advanced_computer_search.rb}

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,15 +23,14 @@
 ###
 ###
 
-### All monkey-patched convenience methods are either prefixed with "jss_"  or
-### if they are type coercions, "to_jss_"
-###
+module JamfTest
+
+  class AdvancedComputerSearch < JamfTest::APITest
+
+    include JamfTest::AdvancedSearchTests
+
+    COLLECTION_CLASS = Jamf::AdvancedComputerSearch
+
+  end # class
 
-require "jss/ruby_extensions/filetest.rb"
-require "jss/ruby_extensions/hash.rb"
-require "jss/ruby_extensions/ipaddr.rb"
-require "jss/ruby_extensions/object.rb"
-require "jss/ruby_extensions/pathname.rb"
-require "jss/ruby_extensions/time.rb"
-require "jss/ruby_extensions/string.rb"
-require "jss/ruby_extensions/array.rb"
+end # module JamfTest

data/test/tests/advanced_mobile_device_search.rb

@@ -0,0 +1,36 @@
+### 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
+
+  class AdvancedMobileDeviceSearch < JamfTest::APITest
+
+    include JamfTest::AdvancedSearchTests
+
+    COLLECTION_CLASS = Jamf::AdvancedMobileDeviceSearch
+
+  end # class
+
+end # module JamfTest

data/test/tests/advanced_user_search.rb

@@ -0,0 +1,36 @@
+### 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
+
+  class AdvancedUserSearch < JamfTest::APITest
+
+    include JamfTest::AdvancedSearchTests
+
+    COLLECTION_CLASS = Jamf::AdvancedUserSearch
+
+  end # class
+
+end # module JamfTest

data/test/tests/category.rb

@@ -0,0 +1,41 @@
+### 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
+
+  class Category < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::Category
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests
+    end
+
+  end # class
+
+end # module JamfTest

data/test/tests/computer_prestage.rb

@@ -0,0 +1,36 @@
+### 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
+
+  class ComputerPrestage < JamfTest::APITest
+
+    include JamfTest::PrestageTests
+
+    COLLECTION_CLASS = Jamf::ComputerPrestage
+
+  end # class
+
+end # module JamfTest

data/test/tests/device_enrollment.rb

@@ -0,0 +1,101 @@
+### 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
+
+  class DeviceEnrollment < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::DeviceEnrollment
+
+    # run the tests - order matters
+    def run_class_tests
+      run_collection_tests do_object_tests: false
+
+      if @cached_all.empty?
+        say 'The result of .all was empty, skipping related device &  sync history tests'
+        return
+      end
+
+      fetch_all_devices
+      fetch_all_devices_for_instance
+      fetch_all_sync_history
+      fetch_sync_history_for_instance
+      fetch_latest_sync_for_instance
+    end
+
+    ########
+    def fetch_all_devices
+      validate_array Jamf::DeviceEnrollment.devices, item_class: Jamf::OAPISchemas::DeviceEnrollmentDevice
+      say 'Fetched devices for all DeviceEnrollment instances'
+    end
+
+    #########
+    def fetch_all_devices_for_instance
+      @cached_all = Jamf::DeviceEnrollment.all
+      inst_name = Jamf::DeviceEnrollment.all_names(cached_list: @cached_all).sample
+      inst_id = Jamf::DeviceEnrollment.valid_id inst_name
+      inst_devices = Jamf::DeviceEnrollment.devices inst_name
+      validate_array inst_devices, item_class: Jamf::OAPISchemas::DeviceEnrollmentDevice
+
+      if inst_devices.sample.deviceEnrollmentProgramInstanceId == inst_id
+        say "Fetched devices for DeviceEnrollment instance '#{inst_name}'"
+        return
+      end
+
+      raise "Device returned by Jamf::DeviceEnrollment.devices('#{inst_name}') has different deviceEnrollmentProgramInstanceId than the id of '#{inst_name}'"
+    end
+
+    ######
+    def fetch_all_sync_history
+      validate_array Jamf::DeviceEnrollment.sync_history, item_class: Jamf::OAPISchemas::DeviceEnrollmentInstanceSyncStatus
+      say 'Fetched sync history for all DeviceEnrollment instances'
+    end
+
+    #########
+    def fetch_sync_history_for_instance
+      @cached_all = Jamf::DeviceEnrollment.all
+      inst_name = Jamf::DeviceEnrollment.all_names(cached_list: @cached_all).sample
+      inst_history = Jamf::DeviceEnrollment.sync_history inst_name
+      say "Fetched Sync History for DeviceEnrollment instance '#{inst_name}'"
+      return if inst_history.empty?
+
+      validate_array inst_history, item_class: Jamf::OAPISchemas::DeviceEnrollmentInstanceSyncStatus
+    end
+
+    #########
+    def fetch_latest_sync_for_instance
+      @cached_all = Jamf::DeviceEnrollment.all
+      inst_name = Jamf::DeviceEnrollment.all_names(cached_list: @cached_all).sample
+      inst_latest = Jamf::DeviceEnrollment.sync_history inst_name, latest: true
+      raise "Latest Sync History for DeviceEnrollment instance '#{inst_name}' did not return a Jamf::OAPISchemas::DeviceEnrollmentInstanceSyncStatus object" unless inst_latest.is_a? Jamf::OAPISchemas::DeviceEnrollmentInstanceSyncStatus
+
+      say "Fetched Latest Sync History for DeviceEnrollment instance '#{inst_name}'"
+    end
+
+  end # class
+
+end #  JamfTest

data/test/tests/inventory_preload_record.rb

@@ -0,0 +1,131 @@
+### 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
+
+  class InventoryPreloadRecord < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::InventoryPreloadRecord
+
+    TEST_SN = 'ABC123XYZ987-no-really'
+    TEST_DEV_TYPE = 'Computer'
+    TEST_USERNAME = 'testy-tester'
+    TEST_EA_NAME = 'test-ext-attr'
+    TEST_EA_VALUE = 'A valuable value'
+    TEST_BARCODE_1_VALUE = 'barcode-1-here'
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests do_object_tests: false
+
+      # custom object tests... some from the mixin, others overridden here
+      create_new # in mixin
+      add_data_to_new_with_failures
+      save_new_with_failures
+      add_data_to_new
+      save_new # in mixin
+      fetch_new(
+        by_name: false,
+        by_searchterm: true,
+        by_ident: :serialNumber,
+        val_to_fetch: TEST_SN
+      ) # in mixin
+      validate_fetched # in mixin
+      modify_fetched
+      re_save_fetched # in mixin
+      re_fetch
+      validate_changes
+      delete # in mixin
+      confirm_deleted # in mixin
+    ensure
+      ensure_deleted
+    end
+
+    ################
+    def add_data_to_new_with_failures
+      begin
+        @unsaved_new_object.deviceType = 'NotARealDeviceType'
+      rescue Jamf::InvalidDataError
+        say 'Got expected Jamf::InvalidDataError when setting deviceType to an invalid value (not in the enum)'
+        return
+      end
+      raise 'Setting deviceType to an invalid value (not in the enum) did not raise Jamf::InvalidDataError'
+    end
+
+    ################
+    def save_new_with_failures
+      begin
+        @new_object_id = @unsaved_new_object.save
+      rescue Jamf::MissingDataError
+        say 'Got expected Jamf::MissingDataError when saved with no SN'
+      end
+      @unsaved_new_object.serialNumber = TEST_SN
+
+      begin
+        @new_object_id = @unsaved_new_object.save
+      rescue Jamf::MissingDataError
+        say 'Got expected Jamf::MissingDataError when saved with no deviceType'
+        return
+      end
+
+      raise 'Saving without required values did not raise Jamf::MissingDataError'
+    end
+
+    ################
+    def add_data_to_new
+      @unsaved_new_object.deviceType = TEST_DEV_TYPE
+      @unsaved_new_object.username = TEST_USERNAME
+      @unsaved_new_object.set_ext_attr TEST_EA_NAME, TEST_EA_VALUE
+      say "Set deviceType, username, and EA #{TEST_EA_NAME}"
+    end
+
+    ################
+    def modify_fetched
+      @fetched_new_object.barCode1 = TEST_BARCODE_1_VALUE
+
+      say "Changed local instance barCode1 from '' to '#{TEST_BARCODE_1_VALUE}'"
+    end
+
+    ################
+    def re_fetch
+      @fetched_edited_object = collection_class.fetch serialNumber: TEST_SN
+      say "Fetched fresh instance of #{collection_class} SN '#{TEST_SN}'"
+    end
+
+    ################
+    def validate_changes
+      if @fetched_edited_object.barCode1 == TEST_BARCODE_1_VALUE
+        say "Re-fetched instance of #{collection_class} SN '#{TEST_SN}' has changed barCode1"
+        return
+      end
+
+      raise "Re-fetched instance of #{collection_class} SN '#{TEST_SN}' did not have changed barCode1"
+    end
+
+  end # class
+
+end # module JamfTest

data/test/tests/jp_building.rb

@@ -0,0 +1,41 @@
+### 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
+
+  class JpBuilding < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::JpBuilding
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests
+    end
+
+  end # class
+
+end # module JamfTest