foreman_dlm 2.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b88d4ab255520440c5a8aeb4222e8ab62e167027ca0a833eaa03bf4ee32885
-  data.tar.gz: 9b953cde9907b2e7be6282aedbf44fad05d447f13d97e420c62ffd47a3ccf685
+  metadata.gz: 3b80fdd6f962a1cb1ab338f061bea43d0ea641f7b34f647c225bf6abc2a366f4
+  data.tar.gz: b7860026fa2dd1c7885011297483b79de657678123e1b25960c974ee4505e9cc
 SHA512:
-  metadata.gz: 3f07de80a511db25bbfdc37d01726a611678b8be5c360c1020ad6ff3e69fdac0d269fe2312fbed24770d8ebec21f05148eb5d629ea69e8b6f2298597adfdea1f
-  data.tar.gz: 9ced134c94780300383e6096e968fdadf1035ac6323f053a0ffcffa8027c660447ce1fd49c830a9d9c103389c7412021e96243fe63e8581fbe743f314b8a605d
+  metadata.gz: d647bbeaeaefac4d7eb91396e68815348da49713d149b000b30619ef8b808ca86b9f0a90bb2b5409454023286399136d847d15aab1c54785c0430a455b1d480c
+  data.tar.gz: dc5b9bd8d089fbbecaae290e501aa7536f689cd0c8af96f154cff9fef449c8d68dea560e7051e967180c9457aa29dffd7e9bba388406e82d7a605011ef9f06e9

data/README.md

@@ -1,6 +1,6 @@
 # Foreman Distributed Lock Manager
 
-[<img src="https://opensourcelogos.aws.dmtech.cloud/dmTECH_opensource_logo%401x.svg" height="21" width="130">](https://www.dmtech.de/)
+[<img src="https://raw.githubusercontent.com/dm-drogeriemarkt/.github/refs/heads/main/assets/dmtech-open-source-badge.svg">](https://www.dmtech.de/)
 
 This is a plugin for Foreman that allows Foreman to act as a distributed lock manager.
 Updates are key to security, but updates of an operating system are hard to apply and existing tools are hard to manage at scale. This might lead to a large drift between important security updates becoming available and all your hosts being successfully patched. Security experts recommend to install updates as soon as they come available. The ability to easily update software is the most effective way to improve server security. Automation is key to ensure this goal is reached.
@@ -15,6 +15,8 @@ With this plugin servers can acquire a lock in Foreman to ensure only one server
 | >= 1.15         | ~> 0.1         |
 | >= 1.17         | ~> 1.0         |
 | >= 3.0          | ~> 2.0         |
+| >= 3.9          | ~> 3.0         |
+| >= 3.13         | ~> 4.0         |
 
 ## Installation
 

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,7 +22,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -38,7 +40,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/api/v2/dlmlock_events_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class DlmlockEventsController < V2::BaseController

data/app/controllers/api/v2/dlmlocks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class DlmlocksController < V2::BaseController
@@ -37,7 +39,8 @@ module Api
       error 404, 'Lock could not be found.'
       param :id, String, :required => true, :desc => N_('Id or name of the DLM lock')
 
-      def show; end
+      def show
+      end
 
       api :POST, '/dlmlocks', N_('Create a DLM lock')
       param_group :dlmlock, :as => :create
@@ -52,7 +55,7 @@ module Api
       param_group :dlmlock
 
       def update
-        process_response @dlmlock.update_attributes(dlmlocks_params)
+        process_response @dlmlock.update(dlmlocks_params)
       end
 
       api :DELETE, '/dlmlocks/:id/', N_('Delete a DLM lock')
@@ -133,16 +136,16 @@ module Api
           logger.info 'Denying access because no host could be detected.'
           if User.current
             render_error 'access_denied',
-                         :status => :forbidden,
-                         :locals => {
-                           :details => 'You need to authenticate with a valid client cert. The DN has to match a known host.'
-                         }
+              :status => :forbidden,
+              :locals => {
+                :details => 'You need to authenticate with a valid client cert. The DN has to match a known host.',
+              }
           else
             render_error 'unauthorized',
-                         :status => :unauthorized,
-                         :locals => {
-                           :user_login => get_client_cert_hostname
-                         }
+              :status => :unauthorized,
+              :locals => {
+                :user_login => get_client_cert_hostname,
+              }
           end
         end
         true
@@ -163,7 +166,7 @@ module Api
           deny_access
         else
           render_error 'precondition_failed', :status => :precondition_failed, :locals => {
-            :message => 'Precondition failed. Lock is in invalid state for this operation.'
+            :message => 'Precondition failed. Lock is in invalid state for this operation.',
           }
         end
       end

data/app/controllers/concerns/foreman/controller/parameters/dlmlocks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Foreman::Controller::Parameters::Dlmlocks
   extend ActiveSupport::Concern
 

data/app/controllers/concerns/foreman_dlm/find_host_by_client_cert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module FindHostByClientCert
     extend ActiveSupport::Concern

data/app/controllers/concerns/foreman_dlm/find_host_by_ip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module FindHostByIp
     extend ActiveSupport::Concern

data/app/controllers/concerns/foreman_dlm/update_checkin_time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module UpdateCheckinTime
     extend ActiveSupport::Concern

data/app/controllers/foreman_dlm/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class ApplicationController < ::ApplicationController
     def resource_class

data/app/controllers/foreman_dlm/dlmlocks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class DlmlocksController < ::ForemanDlm::ApplicationController
     include ::Foreman::Controller::AutoCompleteSearch
@@ -9,7 +11,8 @@ module ForemanDlm
       @dlmlocks = resource_base_search_and_page(:host)
     end
 
-    def show; end
+    def show
+    end
 
     def destroy
       if @dlmlock.destroy
@@ -59,15 +62,6 @@ module ForemanDlm
       ForemanDlm::Dlmlock
     end
 
-    # see https://projects.theforeman.org/issues/25976
-    # can be removed for Foreman 1.22+
-    def auto_complete_controller_name
-      current_version = Gem::Version.new(Foreman::Version.new.notag)
-      return '/foreman_dlm/dlmlocks' if current_version >= Gem::Version.new('1.20') && current_version < Gem::Version.new('1.22')
-
-      controller_name
-    end
-
     private
 
     def action_permission

data/app/helpers/foreman_dlm/dlmlock_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module DlmlockHelper
     def dlmlock_status_icon_class(lock)

data/app/jobs/foreman_dlm/refresh_dlmlock_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class RefreshDlmlockStatus < ApplicationJob
     queue_as :refresh_dlmlock_status_queue

data/app/models/concerns/foreman_dlm/dlm_facet_host_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module DlmFacetHostExtensions
     extend ActiveSupport::Concern

data/app/models/concerns/foreman_dlm/expirable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module Expirable
     extend ActiveSupport::Concern

data/app/models/concerns/foreman_dlm/host_extensions.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module HostExtensions
     extend ActiveSupport::Concern
 
     included do
       has_many :dlmlocks,
-               class_name: 'ForemanDlm::Dlmlock',
-               foreign_key: 'host_id',
-               dependent: :nullify,
-               inverse_of: :host
+        class_name: 'ForemanDlm::Dlmlock',
+        foreign_key: 'host_id',
+        dependent: :nullify,
+        inverse_of: :host
 
       has_many :dlmlock_events,
-               class_name: 'ForemanDlm::DlmlockEvent',
-               foreign_key: 'host_id',
-               dependent: :destroy,
-               inverse_of: :host
+        class_name: 'ForemanDlm::DlmlockEvent',
+        foreign_key: 'host_id',
+        dependent: :destroy,
+        inverse_of: :host
 
       define_model_callbacks :lock, :only => :after
       define_model_callbacks :unlock, :only => :after

data/app/models/concerns/foreman_dlm/host_monitoring_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module HostMonitoringExtensions
     extend ActiveSupport::Concern
@@ -31,7 +33,7 @@ module ForemanDlm
       {
         comment: _('Host acquired lock.'),
         start_time: Time.current.to_i,
-        end_time: Time.current.advance(:minutes => 180).to_i
+        end_time: Time.current.advance(:minutes => 180).to_i,
       }
     end
   end

data/app/models/concerns/foreman_dlm/user_extensions.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module UserExtensions
     extend ActiveSupport::Concern
 
     included do
       has_many :dlmlock_events,
-               class_name: 'ForemanDlm::DlmlockEvent',
-               foreign_key: 'user_id',
-               dependent: :nullify,
-               inverse_of: :user
+        class_name: 'ForemanDlm::DlmlockEvent',
+        foreign_key: 'user_id',
+        dependent: :nullify,
+        inverse_of: :user
     end
   end
 end

data/app/models/foreman_dlm/dlm_facet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class DlmFacet < ApplicationRecord
     include Facets::Base

data/app/models/foreman_dlm/dlmlock/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class Dlmlock
     class Update < Dlmlock

data/app/models/foreman_dlm/dlmlock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class Dlmlock < ApplicationRecord
     include Authorizable
@@ -13,9 +15,9 @@ module ForemanDlm
     belongs_to_host
 
     has_many :dlmlock_events,
-             class_name: '::ForemanDlm::DlmlockEvent',
-             dependent: :destroy,
-             inverse_of: :dlmlock
+      class_name: '::ForemanDlm::DlmlockEvent',
+      dependent: :destroy,
+      inverse_of: :dlmlock
 
     validates :name, presence: true, uniqueness: true
 
@@ -67,7 +69,7 @@ module ForemanDlm
     def locked_by?(host)
       self.host == host
     end
-    alias acquired_by? locked_by?
+    alias_method :acquired_by?, :locked_by?
 
     def disabled?
       !enabled?
@@ -76,7 +78,7 @@ module ForemanDlm
     def locked?
       host.present?
     end
-    alias taken? locked?
+    alias_method :taken?, :locked?
 
     def humanized_type
       _('Generic Lock')
@@ -91,7 +93,7 @@ module ForemanDlm
       query = {
         id: id,
         host_id: [new_host.try(:id), old_host.try(:id)],
-        enabled: true
+        enabled: true,
       }
 
       updated = self.class.where(query).update(changes.merge(updated_at: Time.now.utc))
@@ -127,9 +129,9 @@ module ForemanDlm
       )
     end
 
-    def run_callback(h, callback)
-      h.run_callbacks callback do
-        logger.debug { "custom hook after_#{callback} on #{h} will be executed if defined." }
+    def run_callback(host, callback)
+      host.run_callbacks callback do
+        logger.debug { "custom hook after_#{callback} on #{host} will be executed if defined." }
         true
       end
     end

data/app/models/foreman_dlm/dlmlock_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   class DlmlockEvent < ApplicationRecord
     include Authorizable

data/app/models/host_status/dlmlock_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HostStatus
   class DlmlockStatus < Status
     OK = 0

data/app/views/api/v2/dlmlock_events/index.json.rabl

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 collection @events
 attributes :id, :event_type, :created_at, :updated_at

data/app/views/api/v2/dlmlocks/acquire.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/main'

data/app/views/api/v2/dlmlocks/base.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 attributes :id, :host_id, :name, :enabled, :type

data/app/views/api/v2/dlmlocks/create.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/show'

data/app/views/api/v2/dlmlocks/index.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 collection @dlmlocks
 
 extends 'api/v2/dlmlocks/main'

data/app/views/api/v2/dlmlocks/main.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/base'

data/app/views/api/v2/dlmlocks/release.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/main'

data/app/views/api/v2/dlmlocks/show.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/main'

data/app/views/api/v2/dlmlocks/update.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @dlmlock
 
 extends 'api/v2/dlmlocks/show'

data/app/views/api/v2/errors/precondition_failed.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object controller.get_resource
 
 attributes :id

data/app/views/foreman_dlm/api/v2/dlm_facets/base.json.rabl

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 attributes :id, :last_checkin_at

data/app/views/foreman_dlm/api/v2/dlm_facets/base_with_root.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 child :dlm_facet => :dlm_facet_attributes do |_dlm_facet|
   extends 'foreman_dlm/api/v2/dlm_facets/base'
 end

data/app/views/foreman_dlm/api/v2/dlm_facets/show.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 child :dlm_facet => :dlm_facet_attributes do
   extends 'foreman_dlm/api/v2/dlm_facets/base'
 end

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,4 +1,6 @@
-class RenameDlmlockStiModels < ActiveRecord::Migration[5.1]
+# frozen_string_literal: true
+
+class RenameDlmlockSTIModels < ActiveRecord::Migration[5.1]
   def up
     execute "UPDATE dlmlocks set type='ForemanDlm::Dlmlock::Update' where type='Dlmlock::Update';"
   end

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'