foreman_dlm 2.0.0 → 4.0.0

data/lib/foreman_dlm/engine.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class Engine < ::Rails::Engine
     engine_name 'foreman_dlm'
 
-    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/jobs"]
-
     # Add any db migrations
     initializer 'foreman_dlm.load_app_instance_data' do |app|
       ForemanDlm::Engine.paths['db/migrate'].existent.each do |path|
@@ -13,77 +11,79 @@ module ForemanDlm
       end
     end
 
-    initializer 'foreman_dlm.register_plugin', :before => :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_dlm do
-        requires_foreman '>= 3.0'
-
-        apipie_documented_controllers ["#{ForemanDlm::Engine.root}/app/controllers/api/v2/*.rb"]
-
-        settings do
-          category(:general) do
-            setting('dlm_stale_time',
-                    type: :integer,
-                    default: 4,
-                    description: N_('Number of hours after which locked Distributed Lock is stale'),
-                    full_name: N_('Distributed Lock stale time'),
-                    validate: { numericality: { greater_than: 0 } })
+    initializer 'foreman_dlm.register_plugin', :before => :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :foreman_dlm do
+          requires_foreman '>= 3.13'
+
+          apipie_documented_controllers ["#{ForemanDlm::Engine.root}/app/controllers/api/v2/*.rb"]
+
+          settings do
+            category(:general) do
+              setting('dlm_stale_time',
+                type: :integer,
+                default: 4,
+                description: N_('Number of hours after which locked Distributed Lock is stale'),
+                full_name: N_('Distributed Lock stale time'),
+                validate: { numericality: { greater_than: 0 } })
+            end
           end
-        end
 
-        # Add permissions
-        security_block :foreman_dlm do
-          permission :view_dlmlocks, {
-            :'foreman_dlm/dlmlocks' => [:index, :show, :auto_complete_search],
-            :'api/v2/dlmlocks' => [:index, :show]
-          }, :resource_type => 'ForemanDlm::Dlmlock'
-
-          permission :create_dlmlocks, {
-            :'api/v2/dlmlocks' => [:create]
-          }, :resource_type => 'ForemanDlm::Dlmlock'
-
-          permission :edit_dlmlocks, {
-            :'foreman_dlm/dlmlocks' => [:release, :enable, :disable],
-            :'api/v2/dlmlocks' => [:update, :acquire, :release]
-          }, :resource_type => 'ForemanDlm::Dlmlock'
-
-          permission :destroy_dlmlocks, {
-            :'foreman_dlm/dlmlocks' => [:destroy],
-            :'api/v2/dlmlocks' => [:destroy]
-          }, :resource_type => 'ForemanDlm::Dlmlock'
-
-          permission :view_dlmlock_events, {
-            :'api/v2/dlmlock_events' => [:index]
-          }, :resource_type => 'ForemanDlm::DlmlockEvent'
-        end
+          # Add permissions
+          security_block :foreman_dlm do
+            permission :view_dlmlocks, {
+              :'foreman_dlm/dlmlocks' => [:index, :show, :auto_complete_search],
+              :'api/v2/dlmlocks' => [:index, :show],
+            }, :resource_type => 'ForemanDlm::Dlmlock'
+
+            permission :create_dlmlocks, {
+              :'api/v2/dlmlocks' => [:create],
+            }, :resource_type => 'ForemanDlm::Dlmlock'
+
+            permission :edit_dlmlocks, {
+              :'foreman_dlm/dlmlocks' => [:release, :enable, :disable],
+              :'api/v2/dlmlocks' => [:update, :acquire, :release],
+            }, :resource_type => 'ForemanDlm::Dlmlock'
+
+            permission :destroy_dlmlocks, {
+              :'foreman_dlm/dlmlocks' => [:destroy],
+              :'api/v2/dlmlocks' => [:destroy],
+            }, :resource_type => 'ForemanDlm::Dlmlock'
+
+            permission :view_dlmlock_events, {
+              :'api/v2/dlmlock_events' => [:index],
+            }, :resource_type => 'ForemanDlm::DlmlockEvent'
+          end
 
-        # Add a new role called 'Distributed Lock Manager' if it doesn't exist
-        role 'Distributed Lock Manager', [:view_dlmlocks,
-                                          :create_dlmlocks,
-                                          :edit_dlmlocks,
-                                          :destroy_dlmlocks,
-                                          :view_dlmlock_events],
-             'Role granting full access permissions to distributed locks'
-
-        # add menu entry
-        menu :top_menu, :foreman_dlm_dlmlocks,
-             url_hash: { controller: :'foreman_dlm/dlmlocks', action: :index },
-             caption: N_('Distributed Locks'),
-             parent: :monitor_menu,
-             after: :audits
-
-        # Dlm Facet
-        register_facet(ForemanDlm::DlmFacet, :dlm_facet) do
-          api_view list: 'foreman_dlm/api/v2/dlm_facets/base_with_root', single: 'foreman_dlm/api/v2/dlm_facets/show'
-        end
+          # Add a new role called 'Distributed Lock Manager' if it doesn't exist
+          role 'Distributed Lock Manager', [:view_dlmlocks,
+                                            :create_dlmlocks,
+                                            :edit_dlmlocks,
+                                            :destroy_dlmlocks,
+                                            :view_dlmlock_events],
+            'Role granting full access permissions to distributed locks'
+
+          # add menu entry
+          menu :top_menu, :foreman_dlm_dlmlocks,
+            url_hash: { controller: :'foreman_dlm/dlmlocks', action: :index },
+            caption: N_('Distributed Locks'),
+            parent: :monitor_menu,
+            after: :audits
+
+          # Dlm Facet
+          register_facet(ForemanDlm::DlmFacet, :dlm_facet) do
+            api_view list: 'foreman_dlm/api/v2/dlm_facets/base_with_root', single: 'foreman_dlm/api/v2/dlm_facets/show'
+          end
 
-        register_custom_status HostStatus::DlmlockStatus
+          register_custom_status HostStatus::DlmlockStatus
 
-        # extend host show page
-        extend_page('hosts/show') do |context|
-          context.add_pagelet :main_tabs,
-                              :name => N_('Locks'),
-                              :partial => 'hosts/dlmlocks_tab',
-                              :onlyif => proc { |host| host.dlm_facet }
+          # extend host show page
+          extend_page('hosts/show') do |context|
+            context.add_pagelet :main_tabs,
+              :name => N_('Locks'),
+              :partial => 'hosts/dlmlocks_tab',
+              :onlyif => proc { |host| host.dlm_facet }
+          end
         end
       end
     end

data/lib/foreman_dlm/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
-  VERSION = '2.0.0'.freeze
+  VERSION = '4.0.0'
 end

data/lib/foreman_dlm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_dlm/engine'
 
 module ForemanDlm

data/lib/tasks/dlmlock_events.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 desc <<-TASK_DESCRIPTION
  Expire lock events automatically
 

data/lib/tasks/foreman_dlm_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 # Tests
@@ -12,24 +14,4 @@ namespace :test do
   end
 end
 
-namespace :foreman_dlm do
-  task :rubocop do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_dlm) do |task|
-        task.patterns = ["#{ForemanDlm::Engine.root}/app/**/*.rb",
-                         "#{ForemanDlm::Engine.root}/lib/**/*.rb",
-                         "#{ForemanDlm::Engine.root}/test/**/*.rb"]
-      end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_dlm'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_dlm']
-
-load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_dlm', 'foreman_dlm:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_dlm.gemspec
-_('TODO: Description of ForemanDlm.')
+_('Adds a Distributed Lock Manager to Foreman. This enables painless system updates for clusters.')

data/test/controllers/api/v2/dlmlocks_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class Api::V2::DlmlocksControllerTest < ActionController::TestCase
@@ -33,7 +35,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert dlmlock
         assert_equal valid_attrs['name'], dlmlock.name
         assert_equal valid_attrs['type'], dlmlock.type
-        assert_equal true, dlmlock.enabled
+        assert dlmlock.enabled
         assert_nil dlmlock.host
       end
     end
@@ -47,7 +49,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert_not_empty body
         assert_equal dlmlock.name, body['name']
         assert_equal dlmlock.type, body['type']
-        assert_equal true, body['enabled']
+        assert body['enabled']
         assert_equal host1.id, body['host_id']
       end
 
@@ -59,7 +61,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert_not_empty body
         assert_equal dlmlock.name, body['name']
         assert_equal dlmlock.type, body['type']
-        assert_equal false, body['enabled']
+        assert_not body['enabled']
         assert_nil body['host_id']
       end
 
@@ -91,7 +93,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         dlmlock.reload
         assert_equal valid_attrs['name'], dlmlock.name
         assert_equal valid_attrs['type'], dlmlock.type
-        assert_equal false, dlmlock.enabled
+        assert_not dlmlock.enabled
         assert_equal host1.id, dlmlock.host_id
       end
     end
@@ -181,7 +183,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert_not_empty body
         assert_equal dlmlock.name, body['name']
         assert_equal dlmlock.type, body['type']
-        assert_equal true, body['enabled']
+        assert body['enabled']
         assert_nil body['host_id']
         assert_nil body['host']
       end
@@ -194,12 +196,12 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert_not_empty body
         assert_equal dlmlock.name, body['name']
         assert_equal dlmlock.type, body['type']
-        assert_equal true, body['enabled']
+        assert body['enabled']
         assert_equal host1.id, body['host_id']
         host = body['host']
         assert host
         assert_equal host1.name, host['name']
-        assert_equal true, host['self']
+        assert host['self']
       end
 
       test 'should show individual acquired lock by other' do
@@ -210,12 +212,12 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         assert_not_empty body
         assert_equal dlmlock.name, body['name']
         assert_equal dlmlock.type, body['type']
-        assert_equal true, body['enabled']
+        assert body['enabled']
         assert_equal host2.id, body['host_id']
         host = body['host']
         assert host
         assert_equal host2.name, host['name']
-        assert_equal false, host['self']
+        assert_not host['self']
       end
 
       test 'should update checkin time' do
@@ -378,7 +380,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
   def valid_attrs
     {
       'name' => 'testlock',
-      'type' => 'ForemanDlm::Dlmlock::Update'
+      'type' => 'ForemanDlm::Dlmlock::Update',
     }
   end
 

data/test/controllers/api/v2/dlmlocks_dlmlock_events_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class Api::V2::DlmlockEventsControllerTest < ActionController::TestCase

data/test/controllers/api/v2/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class Api::V2::HostsControllerTest < ActionController::TestCase

data/test/controllers/find_host_by_client_cert_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class FindHostByClientCertTest < ActionController::TestCase
@@ -62,7 +64,7 @@ class FindHostByClientCertTest < ActionController::TestCase
 
         get :index
 
-        assert_equal false, @controller.send(:require_client_cert_or_login)
+        assert_not @controller.send(:require_client_cert_or_login)
         assert_nil @controller.detected_host
       end
 
@@ -73,7 +75,7 @@ class FindHostByClientCertTest < ActionController::TestCase
 
         get :index
 
-        assert_equal false, @controller.send(:require_client_cert_or_login)
+        assert_not @controller.send(:require_client_cert_or_login)
         assert_nil @controller.detected_host
       end
 
@@ -83,7 +85,7 @@ class FindHostByClientCertTest < ActionController::TestCase
 
         get :index
 
-        assert_equal false, @controller.send(:require_client_cert_or_login)
+        assert_not @controller.send(:require_client_cert_or_login)
         assert_nil @controller.detected_host
       end
     end

data/test/controllers/foreman_dlm/dlmlocks_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanDlm

data/test/controllers/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostsControllerTest < ActionController::TestCase
@@ -7,6 +9,6 @@ class HostsControllerTest < ActionController::TestCase
     FactoryBot.create_list(:dlmlock, 2, host: host)
     get :show, params: { :id => host.to_param }, session: set_session_user
     assert_response :success
-    assert @response.body.match(/id='pagelet-id-locks'/)
+    assert_match(/id='pagelet-id-locks'/, @response.body)
   end
 end

data/test/factories/dlm_facets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :dlm_facet, class: 'ForemanDlm::DlmFacet' do
     sequence(:last_checkin_at) { |n| n.minutes.ago }

data/test/factories/dlmlock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :dlmlock, class: ::ForemanDlm::Dlmlock::Update do
     sequence(:name) { |n| "Lock #{n}" }

data/test/factories/dlmlock_events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :dlmlock_event, class: ::ForemanDlm::DlmlockEvent do
     dlmlock

data/test/factories/host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :host do
     trait :with_dlm_facet do

data/test/integration/foreman_dlm/dlmlocks_test.rb

@@ -14,15 +14,21 @@ class DlmlocksTest < IntegrationTestWithJavascript
   end
 
   test 'the search bar has autocomplete' do
-    skip if Gem::Version.new(Foreman::Version.new.notag) < Gem::Version.new('1.20')
     FactoryBot.create_list(:dlmlock, 10)
 
     visit foreman_dlm_dlmlocks_path
 
-    search_bar = page.first('#search-bar')
+    search_bar = page.first('.foreman-search-bar')
     search_bar.first('input').set('ho')
 
-    list = search_bar.find_all('a.dropdown-item').map(&:text)
+    autocomplete_list = page.first('div[data-ouia-component-id="search-autocomplete-menu"]')
+    version = Foreman::Version.new
+    list = if version.major.to_i == 3 && version.minor.to_i <= 14
+             autocomplete_list.find_all('span.pf-c-menu__item-text').map(&:text)
+           else
+             autocomplete_list.find_all('span.pf-v5-c-menu__item-text').map(&:text)
+           end
+
     assert_includes list, 'host'
   end
 end

data/test/jobs/refresh_dlmlock_status_test.rb

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

data/test/models/foreman_dlm/dlm_facet_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanDlm

data/test/models/foreman_dlm/dlmlock_event_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module ForemanDlm

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
@@ -100,21 +102,21 @@ module ForemanDlm
       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
 
@@ -122,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
 
@@ -131,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
@@ -147,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
 
@@ -159,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
 
@@ -196,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
 

data/test/models/host_managed_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 module Host

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

@@ -32,14 +32,14 @@ class DlmlockStatusTest < ActiveSupport::TestCase
       status = host.get_status(HostStatus::DlmlockStatus)
 
       assert_not_empty host.dlmlocks
-      assert_equal true, status.relevant?
+      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,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 

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