foreman_dlm 1.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be1f946127eae4cab43fdd6ec4337fc1b3980ed40de368aa895c89f0714c459
-  data.tar.gz: 3f9df625f01d5c1bc64f36628388a5de2e1a38f84aac3f00be0a36c9b33a75f3
+  metadata.gz: cbea781adcb410612c6d6fde4e13f116f31f50f393ac518c55cdf8ff0bc0ab22
+  data.tar.gz: 201b1a484408da1971ebd7b33285d5738a1a707bd84ec06a04ed05510c85d065
 SHA512:
-  metadata.gz: 752c99cf8b373c6aec85803c3bd8c16104bdb50cee490138da55dcf1e924174f27121308f3a319b9632c97843b2e8f69277fc6900f881a8159b2679d6bdacbbf
-  data.tar.gz: 9b4d6b7903914234db467d42d44e33dd3d78126a3219a15b221e5a9080e84881e249b64f6fd506440fa3eb509d00e12eb3d5526445ab8bf455a0e7a5d57042e6
+  metadata.gz: 961720c5a51b86f720e61f1463bc9b413419be9876d93d36070053d14961db07b9f42f0a82c99c0b917f621296b401da1caf49f123882402e943d8994228f734
+  data.tar.gz: c9cab6e1b37b3321ce4d862dc8599f9af2d8b9b5ce911eaa4141f28816364cfed1d29e372cbe5a1583df2876d47681b7c4c66c70c11dc5ef3164611965ccd99b

data/README.md

@@ -14,6 +14,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         |
 
 ## Installation
 
@@ -34,6 +36,7 @@ Use the HTTP method `GET` to show a lock, `PUT` to acquire a lock and `DELETE` t
 Foreman will respond with the HTTP status code `200 OK` if the action was successful and `412 Precondition Failed` if the lock could not be acquired or release. This may happen, if the lock is taken by another host.
 
 To process the HTTP status code in a bash script, you can do something like this:
+
 ```
 curl --write-out %{http_code} -H 'Content-Type: application/json' -sS -o /dev/null -X PUT --key $(puppet config print hostprivkey) --cert $(puppet config print hostcert) https://foreman.example.com/api/dlmlocks/test/lock
 ```
@@ -59,17 +62,19 @@ $ brew link curl --force
 ```
 
 After that `curl --version` changes from
+
 ```
 $ curl --version
 curl 7.54.0 (x86_64-apple-darwin16.0) libcurl/7.54.0 SecureTransport zlib/1.2.8
 ```
+
 to
+
 ```
 $ curl --version
 curl 7.56.1 (x86_64-apple-darwin16.7.0) libcurl/7.56.1 OpenSSL/1.0.2m zlib/1.2.8
 ```
 
-
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
@@ -85,9 +90,8 @@ the Free Software Foundation, either version 3 of the License, or
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
+along with this program. If not, see <http://www.gnu.org/licenses/>.

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
@@ -34,6 +36,7 @@ module Api
       def resource_class_for(resource)
         return ForemanDlm::Dlmlock if resource == 'dlmlock'
         return ForemanDlm::DlmlockEvent if resource == 'dlmlock_event'
+
         super
       end
     end

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')
@@ -73,7 +76,7 @@ module Api
 
         == Authentication & Host Identification
         The host is authenticated via a client certificate and identified via the CN of that certificate.
-        DOCS
+      DOCS
 
       def acquire
         process_lock_response @dlmlock.acquire!(@host)
@@ -91,7 +94,7 @@ module Api
 
         == Authentication & Host Identification
          The host is authenticated via a client certificate and identified via the CN of that certificate.
-        DOCS
+      DOCS
 
       def release
         process_lock_response @dlmlock.release!(@host)
@@ -108,6 +111,7 @@ module Api
       rescue ActiveRecord::RecordNotFound
         result = scope.find_by(:name => id)
         raise ActiveRecord::RecordNotFound unless result
+
         result
       end
 
@@ -132,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
@@ -162,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
@@ -46,17 +48,11 @@ module ForemanDlm
     end
 
     def get_client_cert_hostname
-      verify = request.env[Setting[:ssl_client_verify_env]]
-      unless verify == 'SUCCESS'
-        logger.info { "Client certificate is invalid: #{verify}" }
-        return
-      end
-
-      dn = request.env[Setting[:ssl_client_dn_env]]
-      return unless dn && dn =~ /CN=([^\s\/,]+)/i
+      client_certificate = Foreman::ClientCertificate.new(request: request)
+      return unless client_certificate.verified?
 
-      hostname = Regexp.last_match(1).downcase
-      logger.debug "Extracted hostname '#{hostname}' from client certificate."
+      hostname = client_certificate.subject
+      logger.debug "Extracted hostname '#{hostname}' from client certificate." if hostname
       hostname
     end
   end

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
@@ -13,6 +15,7 @@ module ForemanDlm
     # Updates the last_checkin timestamp of a user
     def update_detected_host_checkin_time
       return unless @detected_host
+
       facet = @detected_host.dlm_facet || @detected_host.build_dlm_facet
       facet.save unless facet.persisted?
       facet.touch(:last_checkin_at)

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

data/app/helpers/foreman_dlm/dlmlock_helper.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module ForemanDlm
   module DlmlockHelper
     def dlmlock_status_icon_class(lock)
       return 'ban' if lock.disabled?
       return 'lock' if lock.taken?
+
       'unlock'
     end
 
     def dlmlock_status_icon_color_class(lock)
       return 'text-danger' if lock.disabled?
       return 'text-success' if lock.taken?
+
       'text-info'
     end
 

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
@@ -22,6 +24,7 @@ module ForemanDlm
           total_count += count
 
           break if event_ids.blank?
+
           sleep sleep_time
         end
         duration = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) / 60).to_i

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

@@ -1,24 +1,33 @@
+# 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
     end
 
+    def can_acquire_update_locks?
+      param = host_param('can_acquire_update_locks')
+      return true if param.blank?
+
+      Foreman::Cast.to_bool(param)
+    end
+
     def refresh_dlmlock_status
       refresh_statuses([HostStatus::DlmlockStatus])
     end

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
@@ -9,6 +11,7 @@ module ForemanDlm
 
     def add_lock_monitoring_downtime
       return unless monitored?
+
       logger.info "Setting Monitoring downtime for #{self}"
       monitoring.set_downtime_host(self, lock_monitoring_downtime_options)
       true
@@ -18,6 +21,7 @@ module ForemanDlm
 
     def remove_lock_monitoring_downtime
       return unless monitored?
+
       logger.info "Deleting Monitoring downtime for #{self}"
       monitoring.del_downtime_host(self, lock_monitoring_downtime_options)
       true
@@ -29,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
@@ -7,16 +9,15 @@ module ForemanDlm
     end
 
     def self.dlm_stale_time
-      (Setting::General[:dlm_stale_time] || 4).hours
+      (Setting[:dlm_stale_time] || 4).hours
     end
 
     belongs_to_host
 
     has_many :dlmlock_events,
-             class_name: '::ForemanDlm::DlmlockEvent',
-             foreign_key: 'dlmlock_id',
-             dependent: :destroy,
-             inverse_of: :dlmlock
+      class_name: '::ForemanDlm::DlmlockEvent',
+      dependent: :destroy,
+      inverse_of: :dlmlock
 
     validates :name, presence: true, uniqueness: true
 
@@ -46,6 +47,8 @@ module ForemanDlm
     attr_accessor :old
 
     def acquire!(host)
+      return false unless host.can_acquire_update_locks?
+
       result = atomic_update(nil, host)
       ForemanDlm::RefreshDlmlockStatus.set(wait: self.class.dlm_stale_time).perform_later([host.id]) if result
       result
@@ -66,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?
@@ -75,7 +78,7 @@ module ForemanDlm
     def locked?
       host.present?
     end
-    alias taken? locked?
+    alias_method :taken?, :locked?
 
     def humanized_type
       _('Generic Lock')
@@ -90,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))
@@ -126,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/app/views/foreman_dlm/dlmlocks/index.html.erb

@@ -1,2 +1,2 @@
-<% title _("Locks") %>
+<% title _('Distributed Locks') %>
 <%= render :partial => 'list' %>

data/app/views/foreman_dlm/dlmlocks/show.html.erb

@@ -1,6 +1,6 @@
 <% title @dlmlock.name %>
 <% breadcrumbs(
-   resource_url: api_dlmlocks_path
+  resource_url: api_dlmlocks_path
 ) if respond_to?(:breadcrumbs) # Requires Foreman >= 1.18 %>
 
 <%= title_actions link_to(_('Back'), foreman_dlm_dlmlocks_path, :class => 'btn btn-default'),

data/app/views/foreman_dlm/dlmlocks/welcome.html.erb

@@ -6,9 +6,9 @@
   <p>
   <%= _('You don\'t seem to have any locks.') %></br>
   <%= _('The distributed lock manager allows you to automatically schedule system updates across a cluster of hosts.') %>
-  <%= link_to _('Learn more about this in the documentation.'), 'https://github.com/timogoebel/foreman_dlm', :rel => "external" %>.
+  <%= link_to _('Learn more about this in the documentation.'), 'https://github.com/dm-drogeriemarkt/foreman_dlm', :rel => "external" %>.
   </p>
   <div class="blank-slate-pf-main-action">
-    <%= link_to _('Documentation'), 'https://github.com/timogoebel/foreman_dlm', :rel => 'external', :class => 'btn btn-primary btn-lg' %>
+    <%= link_to _('Documentation'), 'https://github.com/dm-drogeriemarkt/foreman_dlm', :rel => 'external', :class => 'btn btn-primary btn-lg' %>
   </div>
 </div>

data/app/views/hosts/_dlmlocks_tab.html.erb

@@ -2,14 +2,14 @@
   <%= alert class: 'alert-info',
     header: '',
     text: n_(
-      'This host holds %s lock.',
+      'This host holds one lock.',
       'This host holds %s locks.',
       @host.dlmlocks.count
     ) % @host.dlmlocks.count
   %>
 <% end %>
 
-<table class="<%= table_css_classes %> table-fixed">
+<table class="<%= table_css_classes %>">
   <thead>
     <tr>
       <th colspan="2"><%= _('Locks') %></th>
@@ -17,7 +17,7 @@
   </thead>
   <tbody>
     <tr>
-      <td><%= _('Last checkin') %></td>
+      <td class="text-nowrap"><%= _('Last check-in') %></td>
       <td><%= @host.dlm_facet && @host.dlm_facet.last_checkin_at ? date_time_relative(@host.dlm_facet.last_checkin_at) : _('N/A') %></td>
     </tr>
     <tr>