foreman_dlm 1.1.0 → 3.0.0

data/test/models/foreman_dlm/dlmlock_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanDlm
@@ -45,10 +47,10 @@ module ForemanDlm
       let(:dlmlock) { FactoryBot.create(:dlmlock) }
 
       test 'should be enabled and unlocked' do
-        assert_equal true, dlmlock.enabled?
-        assert_equal false, dlmlock.disabled?
-        assert_equal false, dlmlock.locked?
-        assert_equal false, dlmlock.taken?
+        assert dlmlock.enabled?
+        assert_not dlmlock.disabled?
+        assert_not dlmlock.locked?
+        assert_not dlmlock.taken?
       end
 
       test 'can be acquired' do
@@ -82,27 +84,39 @@ module ForemanDlm
         assert dlmlock.acquire!(host)
         assert_equal ['callback1'], host.callbacks
       end
+
+      context 'with a parameter disabeling the locking' do
+        setup do
+          FactoryBot.create(:host_parameter, host: host1, name: 'can_acquire_update_locks', value: 'false')
+        end
+
+        test 'can not be acquired' do
+          assert_nil dlmlock.host
+          assert_not dlmlock.acquire!(host1)
+          assert_nil dlmlock.reload.host
+        end
+      end
     end
 
     context 'a free and disabled DLM lock' do
       let(:dlmlock) { FactoryBot.create(:dlmlock, :enabled => false) }
 
       test 'should be disabled and unlocked' do
-        assert_equal false, dlmlock.enabled?
-        assert_equal true, dlmlock.disabled?
-        assert_equal false, dlmlock.locked?
-        assert_equal false, dlmlock.taken?
+        assert_not dlmlock.enabled?
+        assert dlmlock.disabled?
+        assert_not dlmlock.locked?
+        assert_not dlmlock.taken?
       end
 
       test 'can not be acquired' do
         assert_nil dlmlock.host
-        assert_equal false, dlmlock.acquire!(host1)
+        assert_not dlmlock.acquire!(host1)
         assert_nil dlmlock.reload.host
       end
 
       test 'can not be released' do
         assert_nil dlmlock.host
-        assert_equal false, dlmlock.release!(host1)
+        assert_not dlmlock.release!(host1)
         assert_nil dlmlock.reload.host
       end
 
@@ -110,8 +124,8 @@ module ForemanDlm
         host = HostWithCallbacks.new
         host.name = 'test.example.com'
         host.save
-        assert_equal false, dlmlock.release!(host)
-        assert_equal [], host.callbacks
+        assert_not dlmlock.release!(host)
+        assert_empty host.callbacks
       end
     end
 
@@ -119,12 +133,12 @@ module ForemanDlm
       let(:dlmlock) { FactoryBot.create(:dlmlock, :host => host1) }
 
       test 'should be enabled and locked' do
-        assert_equal true, dlmlock.enabled?
-        assert_equal false, dlmlock.disabled?
-        assert_equal true, dlmlock.locked?
-        assert_equal true, dlmlock.taken?
-        assert_equal true, dlmlock.locked_by?(host1)
-        assert_equal true, dlmlock.acquired_by?(host1)
+        assert dlmlock.enabled?
+        assert_not dlmlock.disabled?
+        assert dlmlock.locked?
+        assert dlmlock.taken?
+        assert dlmlock.locked_by?(host1)
+        assert dlmlock.acquired_by?(host1)
       end
 
       test 'can be acquired by owner' do
@@ -135,7 +149,7 @@ module ForemanDlm
 
       test 'can not be acquired by other host' do
         assert_equal host1, dlmlock.host
-        assert_equal false, dlmlock.acquire!(host2)
+        assert_not dlmlock.acquire!(host2)
         assert_equal host1, dlmlock.reload.host
       end
 
@@ -147,7 +161,7 @@ module ForemanDlm
 
       test 'can not be released by other host' do
         assert_equal host1, dlmlock.host
-        assert_equal false, dlmlock.release!(host2)
+        assert_not dlmlock.release!(host2)
         assert_equal host1, dlmlock.reload.host
       end
 
@@ -184,16 +198,16 @@ module ForemanDlm
         assert host1_with_callbacks
         assert host2_with_callbacks
         dlmlock.update(:host => host1_with_callbacks)
-        assert_equal false, dlmlock.release!(host2_with_callbacks)
-        assert_equal [], host1_with_callbacks.callbacks
-        assert_equal [], host2_with_callbacks.callbacks
+        assert_not dlmlock.release!(host2_with_callbacks)
+        assert_empty host1_with_callbacks.callbacks
+        assert_empty host2_with_callbacks.callbacks
       end
 
       test 'triggers no callbacks on acquiry attempt by owner' do
         assert host1_with_callbacks
         dlmlock.update(:host => host1_with_callbacks)
         assert dlmlock.acquire!(host1_with_callbacks)
-        assert_equal [], host1_with_callbacks.callbacks
+        assert_empty host1_with_callbacks.callbacks
       end
     end
 
@@ -212,15 +226,11 @@ module ForemanDlm
         not_locked = FactoryBot.create(:dlmlock)
 
         assert_includes subject, locked
-        refute_includes subject, not_locked
+        assert_not_includes subject, not_locked
       end
     end
 
     describe '#stale' do
-      setup do
-        FactoryBot.create(:setting, category: Setting::General, name: 'dlm_stale_time', value: 4)
-      end
-
       subject { Dlmlock.stale }
 
       it 'includes only Distributed Locks that are stale' do
@@ -232,8 +242,8 @@ module ForemanDlm
           not_locked = FactoryBot.create(:dlmlock)
 
           assert_includes subject, stale
-          refute_includes subject, not_stale
-          refute_includes subject, not_locked
+          assert_not_includes subject, not_stale
+          assert_not_includes subject, not_locked
         end
       end
     end

data/test/models/host_managed_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module Host
@@ -6,6 +8,24 @@ module Host
     should have_many(:dlmlock_events)
     should have_one(:dlm_facet)
 
+    describe '#can_acquire_update_locks?' do
+      let(:host) { FactoryBot.create(:host, :managed) }
+
+      it 'should be true without a host parameter' do
+        assert host.can_acquire_update_locks?
+      end
+
+      it 'should be true if parameter is true' do
+        FactoryBot.create(:host_parameter, host: host, name: 'can_acquire_update_locks', value: 'true')
+        assert host.can_acquire_update_locks?
+      end
+
+      it 'should be false if parameter is false' do
+        FactoryBot.create(:host_parameter, host: host, name: 'can_acquire_update_locks', value: 'false')
+        assert_not host.can_acquire_update_locks?
+      end
+    end
+
     context 'scoped search on' do
       context 'a host' do
         let(:host) { FactoryBot.create(:host, :with_dlm_facet) }

data/test/models/host_monitoring_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostMonitoringTest < ActiveSupport::TestCase

data/test/models/host_status/dlmlock_status_test.rb

@@ -3,10 +3,6 @@
 require 'test_plugin_helper'
 
 class DlmlockStatusTest < ActiveSupport::TestCase
-  setup do
-    FactoryBot.create(:setting, category: Setting::General, name: 'dlm_stale_time', value: 4)
-  end
-
   let(:host) { FactoryBot.create(:host, :managed) }
 
   describe '#to_status' do
@@ -17,7 +13,7 @@ class DlmlockStatusTest < ActiveSupport::TestCase
         FactoryBot.create(:dlmlock, :locked, host: host, updated_at: now - 5.hours)
         status = host.get_status(HostStatus::DlmlockStatus)
 
-        refute_empty host.dlmlocks.stale
+        assert_not_empty host.dlmlocks.stale
         assert_equal HostStatus::DlmlockStatus::STALE, status.to_status
       end
     end
@@ -35,15 +31,15 @@ class DlmlockStatusTest < ActiveSupport::TestCase
       FactoryBot.create(:dlmlock, host: host)
       status = host.get_status(HostStatus::DlmlockStatus)
 
-      refute_empty host.dlmlocks
-      assert_equal true, status.relevant?
+      assert_not_empty host.dlmlocks
+      assert status.relevant?
     end
 
     test 'should return false if host has no dlmlocks' do
       status = host.get_status(HostStatus::DlmlockStatus)
 
       assert_empty host.dlmlocks
-      assert_equal false, status.relevant?
+      assert_not status.relevant?
     end
   end
 end

data/test/models/user_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class UserTest < ActiveSupport::TestCase

data/test/test_plugin_helper.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 
 # Add plugin to FactoryBot's paths
 FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+
+# Add factories of external plugin dependencies
 FactoryBot.definition_file_paths << "#{ForemanMonitoring::Engine.root}/test/factories" if ForemanDlm.with_monitoring?
+
+# Reload factory paths
 FactoryBot.reload

data/test/unit/foreman_dlm/access_permissions_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'unit/shared/access_permissions_test_base'
+
+# Permissions are added in AccessPermissions with lists of controllers and
+# actions that they enable access to.  For non-admin users, we need to test
+# that there are permissions available that cover every controller action, else
+# it can't be delegated and this will lead to parts of the application that
+# aren't functional for non-admin users.
+#
+# In particular, it's important that actions for AJAX requests are added to
+# an appropriate permission so views using those requests function.
+class AccessPermissionsTest < ActiveSupport::TestCase
+  include AccessPermissionsTestBase
+
+  check_routes(ForemanDlm::Engine.routes, [])
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_dlm
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: theforeman-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.1.2
 description: Adds a Distributed Lock Manager to Foreman. This enables painless system
   updates for clusters.
 email:
@@ -69,7 +69,6 @@ files:
 - app/models/foreman_dlm/dlmlock/update.rb
 - app/models/foreman_dlm/dlmlock_event.rb
 - app/models/host_status/dlmlock_status.rb
-- app/models/settings/dlm.rb
 - app/views/api/v2/dlmlock_events/index.json.rabl
 - app/views/api/v2/dlmlocks/acquire.json.rabl
 - app/views/api/v2/dlmlocks/base.json.rabl
@@ -117,6 +116,7 @@ files:
 - test/factories/dlmlock.rb
 - test/factories/dlmlock_events.rb
 - test/factories/host.rb
+- test/integration/foreman_dlm/dlmlocks_test.rb
 - test/jobs/refresh_dlmlock_status_test.rb
 - test/models/foreman_dlm/dlm_facet_test.rb
 - test/models/foreman_dlm/dlmlock_event_test.rb
@@ -126,11 +126,14 @@ files:
 - test/models/host_status/dlmlock_status_test.rb
 - test/models/user_test.rb
 - test/test_plugin_helper.rb
+- test/unit/foreman_dlm/access_permissions_test.rb
 homepage: https://github.com/dm-drogeriemarkt/foreman_dlm
 licenses:
 - GPL-3.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+  is_foreman_plugin: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,35 +141,39 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Distributed Lock Manager for Foreman.
 test_files:
-- test/models/host_managed_test.rb
-- test/models/foreman_dlm/dlmlock_event_test.rb
+- test/controllers/api/v2/dlmlocks_controller_test.rb
+- test/controllers/api/v2/dlmlocks_dlmlock_events_controller_test.rb
+- test/controllers/api/v2/hosts_controller_test.rb
+- test/controllers/find_host_by_client_cert_test.rb
+- test/controllers/foreman_dlm/dlmlocks_test.rb
+- test/controllers/hosts_controller_test.rb
+- test/factories/dlm_facets.rb
+- test/factories/dlmlock.rb
+- test/factories/dlmlock_events.rb
+- test/factories/host.rb
+- test/integration/foreman_dlm/dlmlocks_test.rb
+- test/jobs/refresh_dlmlock_status_test.rb
 - test/models/foreman_dlm/dlm_facet_test.rb
+- test/models/foreman_dlm/dlmlock_event_test.rb
 - test/models/foreman_dlm/dlmlock_test.rb
-- test/models/host_status/dlmlock_status_test.rb
+- test/models/host_managed_test.rb
 - test/models/host_monitoring_test.rb
+- test/models/host_status/dlmlock_status_test.rb
 - test/models/user_test.rb
-- test/factories/dlm_facets.rb
-- test/factories/host.rb
-- test/factories/dlmlock_events.rb
-- test/factories/dlmlock.rb
 - test/test_plugin_helper.rb
-- test/jobs/refresh_dlmlock_status_test.rb
-- test/controllers/foreman_dlm/dlmlocks_test.rb
-- test/controllers/api/v2/dlmlocks_controller_test.rb
-- test/controllers/api/v2/hosts_controller_test.rb
-- test/controllers/api/v2/dlmlocks_dlmlock_events_controller_test.rb
-- test/controllers/hosts_controller_test.rb
-- test/controllers/find_host_by_client_cert_test.rb
+- test/unit/foreman_dlm/access_permissions_test.rb

data/app/models/settings/dlm.rb

@@ -1,20 +0,0 @@
-class Setting
-  class Dlm < ::Setting
-    def self.load_defaults
-      return unless ActiveRecord::Base.connection.table_exists?('settings')
-      return unless super
-
-      Setting.transaction do
-        [
-          set('dlm_stale_time', N_('Number of hours after which locked Distributed Lock is stale'), 4, N_('Distributed Lock stale time'))
-        ].compact.each { |s| Setting::General.create s.update(category: 'Setting::General') }
-      end
-
-      true
-    end
-
-    def self.humanized_category
-      N_('Distributed Locks')
-    end
-  end
-end