foreman_dlm 1.1.0 → 3.0.0

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
   namespace :api, :defaults => { :format => 'json' } do
     scope '(:apiv)', :module => :v2,

data/db/migrate/20170824084100_add_dlmlock.foreman_dlm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddDlmlock < ActiveRecord::Migration[4.2]
   def change
     create_table :dlmlocks do |t|

data/db/migrate/20180627150003_rename_dlmlock_sti_models.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RenameDlmlockStiModels < ActiveRecord::Migration[5.1]
   def up
     execute "UPDATE dlmlocks set type='ForemanDlm::Dlmlock::Update' where type='Dlmlock::Update';"

data/db/migrate/20180704162345_add_dlmlock_events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddDlmlockEvents < ActiveRecord::Migration[5.1]
   def change
     create_table :dlmlock_events do |t|

data/db/migrate/20180711090022_add_hosts_fk_to_dlmlocks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddHostsFkToDlmlocks < ActiveRecord::Migration[5.1]
   def change
     add_foreign_key :dlmlocks, :hosts

data/db/migrate/20180711111903_create_dlm_facets.foreman_dlm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateDlmFacets < ActiveRecord::Migration[5.1]
   def change
     create_table :dlm_facets do |t|

data/db/migrate/20180713113208_update_permissions_for_scoped_models.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UpdatePermissionsForScopedModels < ActiveRecord::Migration[5.1]
   class FakePermission < ApplicationRecord
     self.table_name = 'permissions'

data/lib/foreman_dlm/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class Engine < ::Rails::Engine
     engine_name 'foreman_dlm'
@@ -6,14 +8,6 @@ module ForemanDlm
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/jobs"]
 
-    initializer 'foreman_dlm.load_default_settings', before: :load_config_initializers do
-      require_dependency File.expand_path('../../app/models/settings/dlm.rb', __dir__) if begin
-                                                                                         Setting.table_exists?
-                                                                                       rescue StandardError
-                                                                                         (false)
-                                                                                       end
-    end
-
     # Add any db migrations
     initializer 'foreman_dlm.load_app_instance_data' do |app|
       ForemanDlm::Engine.paths['db/migrate'].existent.each do |path|
@@ -23,33 +17,44 @@ module ForemanDlm
 
     initializer 'foreman_dlm.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_dlm do
-        requires_foreman '>= 1.17'
+        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 } })
+          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]
+            :'api/v2/dlmlocks' => [:index, :show],
           }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :create_dlmlocks, {
-            :'api/v2/dlmlocks' => [:create]
+            :'api/v2/dlmlocks' => [:create],
           }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :edit_dlmlocks, {
             :'foreman_dlm/dlmlocks' => [:release, :enable, :disable],
-            :'api/v2/dlmlocks' => [:update, :acquire, :release]
+            :'api/v2/dlmlocks' => [:update, :acquire, :release],
           }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :destroy_dlmlocks, {
             :'foreman_dlm/dlmlocks' => [:destroy],
-            :'api/v2/dlmlocks' => [:destroy]
+            :'api/v2/dlmlocks' => [:destroy],
           }, :resource_type => 'ForemanDlm::Dlmlock'
 
           permission :view_dlmlock_events, {
-            :'api/v2/dlmlock_events' => [:index]
+            :'api/v2/dlmlock_events' => [:index],
           }, :resource_type => 'ForemanDlm::DlmlockEvent'
         end
 
@@ -58,14 +63,15 @@ module ForemanDlm
                                           :create_dlmlocks,
                                           :edit_dlmlocks,
                                           :destroy_dlmlocks,
-                                          :view_dlmlock_events]
+                                          :view_dlmlock_events],
+          'Role granting full access permissions to distributed locks'
 
         # add menu entry
-        menu :top_menu, :distributed_locks,
-             url_hash: { controller: :'foreman_dlm/dlmlocks', action: :index },
-             caption: N_('Distributed Locks'),
-             parent: :monitor_menu,
-             after: :audits
+        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
@@ -77,28 +83,26 @@ module ForemanDlm
         # 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 }
+            :name => N_('Locks'),
+            :partial => 'hosts/dlmlocks_tab',
+            :onlyif => proc { |host| host.dlm_facet }
         end
       end
     end
 
     # Include concerns in this config.to_prepare block
     config.to_prepare do
-      begin
-        Host::Managed.send(:include, ForemanDlm::HostExtensions)
-        User.send(:include, ForemanDlm::UserExtensions)
-        Host::Managed.send(:include, ForemanDlm::DlmFacetHostExtensions)
-
-        Host::Managed.send(:include, ForemanDlm::HostMonitoringExtensions) if ForemanDlm.with_monitoring?
-      rescue StandardError => e
-        Rails.logger.warn "ForemanDlm: skipping engine hook (#{e})"
-      end
+      Host::Managed.include ForemanDlm::HostExtensions
+      User.include ForemanDlm::UserExtensions
+      Host::Managed.include ForemanDlm::DlmFacetHostExtensions
+
+      Host::Managed.include ForemanDlm::HostMonitoringExtensions if ForemanDlm.with_monitoring?
+    rescue StandardError => e
+      Rails.logger.warn "ForemanDlm: skipping engine hook (#{e})"
     end
 
     initializer 'foreman_dlm.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_dlm'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_dlm/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
-  VERSION = '1.1.0'.freeze
+  VERSION = '3.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
@@ -44,10 +46,10 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.to_param }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        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
 
@@ -56,10 +58,10 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.to_param }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        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
 
@@ -68,13 +70,13 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.name }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        assert_not_empty body
         assert_equal dlmlock.id, body['id']
         assert_equal dlmlock.name, body['name']
         host = body['host']
         assert host
         assert_equal host1.name, host['name']
-        refute host.key?('self')
+        assert_not host.key?('self')
       end
 
       test 'should not find dlmlock with invalid id' do
@@ -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
@@ -178,10 +180,10 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.to_param }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        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
@@ -191,15 +193,15 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.to_param }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        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
@@ -207,20 +209,20 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
         get :show, params: { :id => dlmlock.to_param }
         assert_response :success
         body = ActiveSupport::JSON.decode(@response.body)
-        refute_empty body
+        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
         dlmlock = as_admin { FactoryBot.create(:dlmlock) }
-        refute as_admin { host1.dlm_facet }
+        assert_not as_admin { host1.dlm_facet }
         put :show, params: { :id => dlmlock.to_param }
         assert as_admin { host1.reload.dlm_facet.last_checkin_at }
       end
@@ -260,7 +262,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
 
       test 'should update checkin time' do
         dlmlock = as_admin { FactoryBot.create(:dlmlock) }
-        refute as_admin { host1.dlm_facet }
+        assert_not as_admin { host1.dlm_facet }
         put :acquire, params: { :id => dlmlock.to_param }
         assert as_admin { host1.reload.dlm_facet.last_checkin_at }
       end
@@ -300,7 +302,7 @@ class Api::V2::DlmlocksControllerTest < ActionController::TestCase
 
       test 'should update checkin time' do
         dlmlock = as_admin { FactoryBot.create(:dlmlock) }
-        refute as_admin { host1.dlm_facet }
+        assert_not as_admin { host1.dlm_facet }
         put :release, params: { :id => dlmlock.to_param }
         assert as_admin { host1.reload.dlm_facet.last_checkin_at }
       end
@@ -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
@@ -27,7 +29,7 @@ module ForemanDlm
       dlmlock = FactoryBot.create(:dlmlock)
       delete :destroy, params: { :id => dlmlock.id }, session: set_session_user
       assert_redirected_to foreman_dlm_dlmlocks_url
-      refute Dlmlock.exists?(dlmlock.id)
+      assert_not Dlmlock.exists?(dlmlock.id)
     end
 
     test '#enable' do
@@ -49,7 +51,7 @@ module ForemanDlm
       dlmlock = FactoryBot.create(:dlmlock, host: host)
       put :release, params: { :id => dlmlock.id }, session: set_session_user
       assert_redirected_to foreman_dlm_dlmlocks_url
-      refute dlmlock.reload.taken?
+      assert_not dlmlock.reload.taken?
     end
   end
 end

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,7 +1,9 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :dlmlock, class: ::ForemanDlm::Dlmlock::Update do
     sequence(:name) { |n| "Lock #{n}" }
-    type 'ForemanDlm::Dlmlock::Update'
+    type { 'ForemanDlm::Dlmlock::Update' }
 
     trait :locked do
       host

data/test/factories/dlmlock_events.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :dlmlock_event, class: ::ForemanDlm::DlmlockEvent do
     dlmlock
-    event_type 'release'
+    event_type { 'release' }
     host
 
     trait :old_event do

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'integration_test_helper'
+
+class DlmlocksTest < IntegrationTestWithJavascript
+  setup do
+    User.current = users(:admin)
+  end
+
+  test 'the index page works' do
+    FactoryBot.create_list(:dlmlock, 10)
+    assert_index_page(foreman_dlm_dlmlocks_path, 'Distributed Locks')
+  end
+
+  test 'the search bar has autocomplete' do
+    FactoryBot.create_list(:dlmlock, 10)
+
+    visit foreman_dlm_dlmlocks_path
+
+    search_bar = page.first('.foreman-search-bar')
+    search_bar.first('input').set('ho')
+
+    autocomplete_list = page.first('div[data-ouia-component-id="search-autocomplete-menu"]')
+    list = autocomplete_list.find_all('span.pf-c-menu__item-text').map(&:text)
+
+    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