ruby-jss 1.6.4 → 2.0.0b1

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

data/test/tests/mobile_device.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 MobileDevice < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::MobileDevice
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests do_object_tests: false
+    end
+
+  end # class
+
+end # module JamfTest

data/test/tests/mobile_device_prestage.rb

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

data/test/tests/policy.rb

@@ -0,0 +1,151 @@
+### 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 Policy < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::Policy
+
+    CUSTOM_TRIGGER = 'ruby-jss-test-custom-trigger'.freeze
+
+    # The main test method for this class
+    def run_class_tests
+      # policies are special so we define all the object tests here 
+      run_collection_tests do_object_tests: false
+
+      create_new
+
+      add_data_to_new
+
+      # save_new
+      # fetch_new
+      # validate_fetched
+      # modify_fetched
+      # re_save_fetched
+      # re_fetch
+      # validate_changes
+      # delete
+      # confirm_deleted
+    end
+
+    #################
+    def add_data_to_new
+      set_new_pol_category
+      set_new_pol_pkg
+      set_new_pol_trigger
+      set_new_pol_scope
+    end
+
+    #################
+    def set_new_pol_category
+      # DEPRECATED - should raise an error, but eventually will not until saved.
+      begin
+        @unsaved_new_object.category = 'foo-this-is-not-a-real-category'
+      rescue Jamf::NoSuchItemError
+        nil
+      end
+      @unsaved_new_object.category = pol_category
+      say "Set policy category to: #{pol_category}"
+    end
+
+    #################
+    def set_new_pol_pkg
+      # DEPRECATED - should raise an error, but eventually will not until saved
+      begin
+        @unsaved_new_object.add_package 'foo'
+      rescue Jamf::NoSuchItemError
+        nil
+      end
+      @unsaved_new_object.add_package pol_pkg
+      say "Added policy pkg: #{pol_pkg}"
+    end
+
+    #################
+    def set_new_pol_trigger
+      @unsaved_new_object.set_trigger_event :custom, CUSTOM_TRIGGER
+      say "Set policy trigger to: #{CUSTOM_TRIGGER}"
+    end
+
+    #################
+    def set_new_pol_scope
+      @unsaved_new_object.scope.add_target :computer, target_computer_name
+      say "Set policy scope targets to: #{@unsaved_new_pol.scope.targets}"
+      @unsaved_new_object.scope.add_exclusion :computer_group, excluded_group_name
+      say "Set policy scope targets to: #{@unsaved_new_pol.scope.exclusions}"
+    end
+
+    #################
+    def save_new_pol; end
+
+    #################
+    def fetch_new_pol; end
+
+    #################
+    def validate_new_pol; end
+
+    #################
+    def modify_pol; end
+
+    #################
+    def save_pol; end
+
+    #################
+    def re_fetch_pol; end
+
+    #################
+    def validate_changes; end
+
+    #################
+    def delete_pol; end
+
+    #################
+    def confirm_deleted; end
+
+    #######
+    def pol_category
+      @pol_category ||= Jamf::Category.all_names.sample
+    end
+
+    #######
+    def pol_pkg
+      @pol_pkg ||= Jamf::Package.all_names.sample
+    end
+
+    ########
+    def target_computer_name
+      @target_computer_name ||= Jamf::Computer.all_names.sample
+    end
+
+    ########
+    def excluded_group_name
+      @excluded_group_name ||= Jamf::ComputerGroup.all_names.sample
+    end
+
+  end # class
+
+end # module JamfTest