ruby-jss 1.0.0b2 → 1.0.0b6

data/test/specs/patch03_external_source_spec.rb

@@ -0,0 +1,120 @@
+### Copyright 2018 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.
+###
+###
+
+# External Sources
+#
+describe JSS::PatchExternalSource do
+
+  ##### Constants
+
+  ##### Class methods
+
+  # this effectively makes the tests run in the order defined, which is
+  # needed in this situattion.
+  def self.test_order
+    :alpha
+  end
+
+  ##### Instance Methods
+
+  # shortcut
+  def src
+    JSSTestHelper::PatchMgmt.external_src
+  end
+
+  ##### Specs
+
+  it 'can delete crufty objects from earlier tests' do
+    crufty_name = JSSTestHelper::PatchMgmt::EXT_SRC_NAME
+    break unless JSS::PatchExternalSource.all_names(:refresh).include? crufty_name
+
+    puts 'Found crufty External Source from Previous Tests - deleting'
+
+    crufty_id = JSS::PatchExternalSource.map_all_ids_to(:name).invert[crufty_name]
+    deleted = JSS::PatchExternalSource.delete crufty_id
+
+    deleted.must_be_instance_of Array
+    deleted.must_be_empty
+    JSS::PatchExternalSource.all_names(:refresh).wont_include crufty_name
+  end
+
+  it 'can be made' do
+    src.must_be_instance_of JSS::PatchExternalSource
+  end
+
+  it 'cannot be created without a host' do
+    proc { src.save }.must_raise JSS::UnsupportedError
+  end
+
+  it 'can be created with a host' do
+    src.host_name = JSSTestHelper::PatchMgmt::EXT_SRC_NAME
+    src.save.must_be_kind_of Integer
+  end
+
+  it 'can set the port' do
+    src.port = JSSTestHelper::PatchMgmt::EXT_SRC_PORT
+    src.port.must_equal JSSTestHelper::PatchMgmt::EXT_SRC_PORT
+  end
+
+  it 'can be enabled and disabled' do
+    src.enable
+    src.enabled?.must_be_instance_of TrueClass
+    src.disable
+    src.enabled?.must_be_instance_of FalseClass
+  end
+
+  it 'can enable and disable ssl' do
+    src.disable_ssl
+    src.ssl_enabled?.must_be_instance_of FalseClass
+    src.enable_ssl
+    src.ssl_enabled?.must_be_instance_of TrueClass
+  end
+
+  it 'can update changes to the server' do
+    src.update
+  end
+
+  it 'can be fetched by name' do
+    JSSTestHelper::PatchMgmt.refetch_external_src
+    src.must_be_instance_of JSS::PatchExternalSource
+  end
+
+  it 'tells us its host' do
+    src.host_name.must_equal JSSTestHelper::PatchMgmt::EXT_SRC_NAME
+  end
+
+  it 'tells us its port' do
+    src.port.must_equal JSSTestHelper::PatchMgmt::EXT_SRC_PORT
+  end
+
+  it 'tells us if it is enabled' do
+    JSS::TRUE_FALSE.must_include src.enabled?
+  end
+
+  it 'tells us if ssl is enabled' do
+    JSS::TRUE_FALSE.must_include src.ssl_enabled?
+  end
+
+end # describe JSS::PatchInternalSource

data/test/specs/patch04_titles_spec.rb

@@ -0,0 +1,207 @@
+### Copyright 2018 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.
+###
+###
+
+describe JSS::PatchTitle do
+
+  ##### Constants
+
+  ##### Class Methods
+
+  # this effectively makes the tests run in the order defined, which is
+  # needed in this situattion.
+  def self.test_order
+    :alpha
+  end
+
+  ##### Instance Methods
+
+  # shortcuts
+
+  def tt
+    JSSTestHelper::PatchMgmt.title
+  end
+
+  def tv
+    tt.versions[JSSTestHelper::PatchMgmt.version_key]
+  end
+
+  def prompt_for_name_id
+    puts '***************************'
+    puts 'Enter an unused Patch Title name_id for testing.'
+    puts 'Must be one of the following:'
+    unused_name_ids = self.class.unused_name_ids
+    unused_name_ids.each { |ni| puts "  #{ni}" }
+    puts
+    print 'which one?: '
+    chosen = $stdin.gets.chomp
+    until unused_name_ids.include? chosen
+      puts 'that one isnt on the list'
+      print 'which one?: '
+      chosen = $stdin.gets.chomp
+    end
+    chosen
+  end
+
+  ##### Specs
+
+  it 'can delete crufty title from earlier tests' do
+    deleted = JSSTestHelper::PatchMgmt.delete_title
+    deleted.must_be_instance_of Array
+    deleted.must_be_empty
+    JSS::PatchTitle.all_names(:refresh).wont_include JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME
+  end
+
+  it 'can list all patch title source_name_ids' do
+    source_name_ids = JSS::PatchTitle.all_source_name_ids
+    source_name_ids.must_be_instance_of Array
+    break if source_name_ids.empty?
+    source_name_ids.first.must_be_instance_of String
+  end
+
+  it 'can list source_ids in use' do
+    srcids = JSS::PatchTitle.all_source_ids
+    srcids.must_be_instance_of Array
+    break if srcids.empty?
+    srcids.first.must_be_kind_of Integer
+  end
+
+  it 'cannot be made without a source and name_id' do
+    proc {
+      JSS::PatchTitle.make name: JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME
+    }.must_raise JSS::MissingDataError
+
+    proc {
+      JSS::PatchTitle.make name: JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME,
+      source: 'Foobar'
+    }.must_raise JSS::MissingDataError
+
+    proc {
+      JSS::PatchTitle.make name: JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME,
+      name_id: 'Foobar'
+    }.must_raise JSS::MissingDataError
+  end
+
+  it 'must check that the source exists' do
+    proc {
+      JSS::PatchTitle.make(
+        name: JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME,
+        source: 'Foobar',
+        name_id: 'FoobarNoSuchNameId'
+      )
+    }.must_raise JSS::NoSuchItemError
+  end
+
+  it 'must check that the name_id is available in the source' do
+    proc {
+      JSS::PatchTitle.make(
+        name: JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME,
+        source: JSSTestHelper::PatchMgmt::PATCH_TITLE_SOURCE,
+        name_id: 'FoobarNoSuchNameId'
+      )
+    }.must_raise JSS::NoSuchItemError
+  end
+
+  it 'can be made with name, source, and name_id' do
+    tt.must_be_instance_of JSS::PatchTitle
+  end
+
+  it 'can be created' do
+    tt.create
+    JSS::PatchTitle.all_names(:refresh).must_include JSSTestHelper::PatchMgmt::PATCH_TITLE_NAME
+    tt.in_jss.must_be_instance_of TrueClass
+  end
+
+  it 'can be fetched by souce and name_id' do
+    id = tt.id
+    JSSTestHelper::PatchMgmt.title(:refetch)
+    tt.id.must_equal id
+  end
+
+  # TODO: simplify this when we aren't reading the data via
+  # XMLWorkaround
+  it 'can get a patch report' do
+    report = JSS::PatchTitle.patch_report tt.id
+    report.must_be_instance_of Hash
+    report.keys.must_include :versions
+    report[:versions].must_be_instance_of Hash
+    break if report[:versions].empty?
+
+    vers_name = report[:versions].keys.sample
+    vers_name.must_be_instance_of String
+    report[:versions][vers_name].must_be_instance_of Array
+    break if report[:versions][vers_name].empty?
+
+    client = report[:versions][vers_name].sample
+    client.must_be_instance_of Hash
+    client[:id].must_be_kind_of Integer
+  end
+
+  it 'has an array of Version objects' do
+    tt.versions.must_be_instance_of Hash
+    tv.must_be_instance_of JSS::PatchTitle::Version
+  end
+
+  it 'has no packages assigned by default' do
+    tv.package_assigned?.must_be_instance_of FalseClass
+    tt.versions_with_packages.size.must_be :==, 0
+  end
+
+  it 'cannot assign a non-existing package to a version' do
+    proc { tv.package = 'there should be no such package here' }.must_raise JSS::NoSuchItemError
+  end
+
+  it 'can assign a package to a version' do
+    pkg = JSS::Package.all.sample
+    tv.package = pkg[:id]
+    tv.package_name.must_equal pkg[:name]
+  end
+
+  it 'can get a patch report from a version' do
+    tv.patch_report.must_be_instance_of Hash
+  end
+
+  it 'can set email notifications' do
+    tt.email_notification = true
+  end
+
+  it 'can set web notifications' do
+    tt.web_notification = true
+  end
+
+  it 'can update the JSS with changes' do
+    tt.update
+    tt.need_to_update.must_be_instance_of FalseClass
+  end
+
+  it 'has the saved values when re-fetched' do
+    JSSTestHelper::PatchMgmt.title :refetch
+    tt.email_notification.must_be_instance_of TrueClass
+    tt.web_notification.must_be_instance_of TrueClass
+    verss = tt.versions_with_packages
+    verss.size.must_be :==, 1
+    verss.keys.first.must_equal tv.version
+  end
+
+end

data/test/specs/patch05_policies_spec.rb

@@ -0,0 +1,119 @@
+### Copyright 2018 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.
+###
+###
+
+describe JSS::PatchPolicy do
+  ##### Constants
+
+  DEADLINE_DAYS = 17
+
+  ##### Class Methods
+
+  # this effectively makes the tests run in the order defined, which is
+  # needed in this situattion.
+  def self.test_order
+    :alpha
+  end
+
+  ##### Specs
+
+  it 'can delete crufty patch policies from earlier tests' do
+    deleted = JSSTestHelper::PatchMgmt.delete_policy
+    deleted.must_be_instance_of Array
+    deleted.must_be_empty
+    JSS::PatchPolicy.all_names(:refresh).wont_include JSSTestHelper::PatchMgmt::PATCHCPOL_NAME
+  end
+
+  it 'cannot be made without a patch title' do
+    proc { JSS::PatchPolicy.make name: JSSTestHelper::PatchMgmt::PATCHCPOL_NAME }.must_raise JSS::MissingDataError
+  end
+
+  it 'can be made with a patch title' do
+    # JSSTestHelper::PatchMgmt.policy will do a make with our test title the
+    # first time its called
+    JSSTestHelper::PatchMgmt.policy.must_be_instance_of JSS::PatchPolicy
+    JSSTestHelper::PatchMgmt.policy.in_jss.must_be_instance_of FalseClass
+  end
+
+  it 'cannot be created without a target_version' do
+    proc { JSSTestHelper::PatchMgmt.policy.create }.must_raise JSS::MissingDataError
+  end
+
+  it 'will not accept a target_version that has no package' do
+    title = JSSTestHelper::PatchMgmt.title
+    badvers = (title.versions.keys - title.versions_with_packages.keys).sample
+    proc { JSSTestHelper::PatchMgmt.policy.target_version = badvers }.must_raise JSS::UnsupportedError
+  end
+
+  it 'can be created with a target_version that has a package' do
+    JSSTestHelper::PatchMgmt.policy.target_version = JSSTestHelper::PatchMgmt.version_key
+    JSSTestHelper::PatchMgmt.policy.create
+    JSS::PatchPolicy.all_names(:refresh).must_include JSSTestHelper::PatchMgmt::PATCHCPOL_NAME
+    JSSTestHelper::PatchMgmt.policy.in_jss.must_be_instance_of TrueClass
+  end
+
+  it 'can be fetched by name' do
+    id = JSSTestHelper::PatchMgmt.policy.id
+    JSSTestHelper::PatchMgmt.policy :refresh
+    JSSTestHelper::PatchMgmt.policy.id.must_equal id
+  end
+
+  it 'can be put into self service' do
+    JSSTestHelper::PatchMgmt.policy.add_to_self_service
+    JSSTestHelper::PatchMgmt.policy.in_self_service?.must_be_instance_of TrueClass
+  end
+
+  it 'interprets non-positive deadline as no deadline' do
+    JSSTestHelper::PatchMgmt.policy.deadline = 0
+    JSSTestHelper::PatchMgmt.policy.deadline.must_equal JSS::PatchPolicy::NO_DEADLINE
+    JSSTestHelper::PatchMgmt.policy.deadline = -2
+    JSSTestHelper::PatchMgmt.policy.deadline.must_equal JSS::PatchPolicy::NO_DEADLINE
+  end
+
+  it 'can take a positive deadline value' do
+    JSSTestHelper::PatchMgmt.policy.deadline = DEADLINE_DAYS
+    JSSTestHelper::PatchMgmt.policy.deadline.must_equal DEADLINE_DAYS
+  end
+
+  it 'interprets negative grace period value as zero' do
+    JSSTestHelper::PatchMgmt.policy.grace_period = -12
+    JSSTestHelper::PatchMgmt.policy.grace_period.must_equal 0
+  end
+
+  it 'can take a non-negative grace period value' do
+    JSSTestHelper::PatchMgmt.policy.grace_period = 0
+    JSSTestHelper::PatchMgmt.policy.grace_period.must_equal 0
+    JSSTestHelper::PatchMgmt.policy.grace_period = 16
+    JSSTestHelper::PatchMgmt.policy.grace_period.must_equal 16
+  end
+
+  it 'can save changes' do
+    JSSTestHelper::PatchMgmt.policy.update.must_equal JSSTestHelper::PatchMgmt.policy.id
+    JSSTestHelper::PatchMgmt.policy :refresh
+    JSSTestHelper::PatchMgmt.policy.grace_period.must_equal 16
+    JSSTestHelper::PatchMgmt.policy.deadline.must_equal DEADLINE_DAYS
+    JSSTestHelper::PatchMgmt.policy.in_self_service?.must_be_instance_of TrueClass
+  end
+
+end

data/test/specs/patch06_cleanup_spec.rb

@@ -0,0 +1,52 @@
+### Copyright 2018 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.
+###
+###
+
+describe JSSTestHelper do
+
+  # this effectively makes the tests run in the order defined, which is
+  # needed in this situattion.
+  def self.test_order
+    :alpha
+  end
+
+  it 'can delete external source' do
+    gone = JSSTestHelper::PatchMgmt.delete_external_src
+    gone.must_be_instance_of Array
+    gone.must_be_empty
+  end
+
+  it 'can delete patch policy' do
+    gone = JSSTestHelper::PatchMgmt.delete_policy
+    gone.must_be_instance_of Array
+    gone.must_be_empty
+  end
+
+  it 'can delete patch title' do
+    gone = JSSTestHelper::PatchMgmt.delete_title
+    gone.must_be_instance_of Array
+    gone.must_be_empty
+  end
+
+end

data/test/specs/policy_spec.rb

@@ -0,0 +1,112 @@
+### Copyright 2018 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.
+###
+###
+
+describe JSSTestHelper do
+
+  # CONSTANTS
+
+  POLICY_NAME = 'rubyjss-testPolicy'.freeze
+
+  # CLASS METHODS
+
+  # this effectively makes the tests run in the order defined
+  def self.test_order
+    :alpha
+  end
+
+  def self.policy(refresh = false)
+    @policy = nil if refresh
+    return @policy if @policy
+    @policy =
+      if JSS::Policy.all_names.include? POLICY_NAME
+        JSS::Policy.fetch name: POLICY_NAME
+      else
+        JSS::Policy.make name: POLICY_NAME
+      end
+  end
+
+  def self.delete_policy
+    return [] unless JSS::Policy.all_names(:refresh).include? POLICY_NAME
+    JSS::Policy.delete JSS::Policy.map_all_ids_to(:name).invert[POLICY_NAME]
+  end
+
+  # SPECS
+
+  it 'can delete crufty policies from earlier tests' do
+    deleted = self.class.delete_policy
+    deleted.must_be_instance_of Array
+    deleted.must_be_empty
+    JSS::Policy.all_names(:refresh).wont_include POLICY_NAME
+  end
+
+  it 'can be made' do
+    # see .policy class method above
+    self.class.policy.must_be_instance_of JSS::Policy
+    self.class.policy.in_jss.must_be_instance_of FalseClass
+  end
+
+  it 'can set maintenance tasks' do
+    pol = self.class.policy
+    pol.verify_startup_disk = true
+    pol.permissions_repair = false
+    pol.recon = true
+    pol.fix_byhost = false
+    pol.reset_name = true
+    pol.flush_system_cache = false
+    pol.install_cached_pkgs = true
+    pol.flush_user_cache = false
+  end
+
+  it 'can be created ' do
+    pol = self.class.policy
+    pol.create
+    JSS::Policy.all_names(:refresh).must_include POLICY_NAME
+    pol.in_jss.must_be_instance_of TrueClass
+  end
+
+  it 'can be fetched by name' do
+    id = self.class.policy.id
+    self.class.policy :refresh
+    self.class.policy.id.must_equal id
+  end
+
+  it 'still has correct maintenance tasks' do
+    pol = self.class.policy
+    pol.verify_startup_disk.must_be_instance_of TrueClass
+    pol.permissions_repair.must_be_instance_of FalseClass
+    pol.recon.must_be_instance_of TrueClass
+    pol.fix_byhost.must_be_instance_of FalseClass
+    pol.reset_name.must_be_instance_of TrueClass
+    pol.flush_system_cache.must_be_instance_of FalseClass
+    pol.install_cached_pkgs.must_be_instance_of TrueClass
+    pol.flush_user_cache.must_be_instance_of FalseClass
+  end
+
+  it 'can be deleted' do
+    self.class.policy.delete.must_equal :deleted
+    JSS::Policy.all_names(:refresh).wont_include POLICY_NAME
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 1.0.0b2
+  version: 1.0.0b6
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-26 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -252,6 +252,19 @@ files:
 - lib/jss/version.rb
 - lib/jss/xml_workaround.rb
 - lib/ruby-jss.rb
+- test/README.md
+- test/bin/runtests
+- test/lib/testhelper.rb
+- test/lib/testhelper/auth.rb
+- test/lib/testhelper/patch_mgmt.rb
+- test/specs/api_connection_spec.rb
+- test/specs/patch01_source_spec.rb
+- test/specs/patch02_internal_source_spec.rb
+- test/specs/patch03_external_source_spec.rb
+- test/specs/patch04_titles_spec.rb
+- test/specs/patch05_policies_spec.rb
+- test/specs/patch06_cleanup_spec.rb
+- test/specs/policy_spec.rb
 homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
 - Apache-2.0 WITH Modifications
@@ -277,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the Jamf Pro REST API