foreman_monitoring 0.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6ec30b6e40aad99c7da94b66100590381d300289
-  data.tar.gz: ef1bb20065f0c5b11544f64babe2ab0c8faa3b6d
+SHA256:
+  metadata.gz: 5e703d5ad965ed3aecba3fee0dc31a7a2c80a84eab893392484555fda8ba8ab1
+  data.tar.gz: 6dce2771bea3df536cb244aadfbad6483387d71157c4b70d5cbe0256b27f508c
 SHA512:
-  metadata.gz: 92fc91db5150b641f8a169fce2468695a4a64e84ec02235259385864deb0c1b7309e49853fb297a88f9e37d143371f88d6aa446c37abebc8d8a2172433a725d1
-  data.tar.gz: 9306c61272155529c75cd7c90b9a115a5d931b11455f0313fa057de42ac565a3a301023cbd95fc8fa744d913e570ea8a8ad3c689f042c45aa5a6d4dc00d944e2
+  metadata.gz: e3c24e7c223b0103333d21717636f338176cb2756028d60943c8e6276ffaa366de039dec2b5afd527b5f50464737194b6cc6d5e357f9696d6b56aff167b7fc6e
+  data.tar.gz: ca91aa5af43494a254fbe03bd13cb4e4e30dccfdab8e47befb8252f97b2cce1bd8ab850739993d1675d194f3253a8b5825b248f6d95cc75b6b7c4915252356eb

data/README.md

@@ -17,7 +17,7 @@ The gem name is `foreman_monitoring`.
 
 RPM users can install the `tfm-rubygem-foreman_monitoring` package.
 
-Deb users can install the `ruby-foreman_monitoring` package.
+Deb users can install the `ruby-foreman-monitoring` package.
 
 If using the gem as installation source database enhancement and service restart must
 be done manually.
@@ -28,6 +28,13 @@ foreman-rake db:seed
 touch ~foreman/tmp/restart.txt
 ```
 
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| >= 1.15         | ~> 0.1         |
+| >= 1.17         | ~> 1.0         |
+
 # Usage
 
 For managing a host in the monitoring solution a Smart Proxy providing
@@ -35,15 +42,15 @@ the `monitoring` feature has to be assigned. This can be done during
 provisioning or as a bulk action from the host overview.
 
 You can configure the default action which will be done during host
-provisioning and deprovisioning. Provisioning allows to create a monitoring
-object or take no action while deprovisioing allows to delete the monitoring
-object, set a downtime or take no action. For rebuild it will by default
+provisioning and de-provisioning. Provisioning allows to create a monitoring
+object or take no action while de-provisoning allows deleting the monitoring
+object, set a downtime or take no action. For rebuild, it will by default
 set a downtime.
 
 The plugin will show you the monitoring status as a sub-status and a detail
 panel. You can configure if the sub-status should affect the global status.
 
-Furthermore it allows to individually set a downtime at the host detail view
+Furthermore, it allows to individually set a downtime at the host detail view
 or as a bulk action from the host overview.
 
 # Troubleshooting
@@ -51,8 +58,8 @@ or as a bulk action from the host overview.
 Logging entries relevant to the plug-in will be located in the Foreman's log
 which is by default `/var/log/foreman/production.log`.
 
-Also check the troubleshooting section of the Smart Proxy plug-in if problems
-occure in the underlying communication.
+Also, check the troubleshooting section of the Smart Proxy plug-in if problems
+occur in the underlying communication.
 
 ## Contributing
 

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    class DowntimeController < V2::BaseController
+      include Api::Version2
+      include ::ForemanMonitoring::FindHostByClientCert
+
+      authorize_host_by_client_cert %i[create]
+      before_action :find_host, :only => [:create]
+
+      api :POST, '/downtime', N_('Schedule host downtime')
+      param :duration, :number, :desc => N_('Downtime duration (seconds)'), :required => false
+      param :reason, String, :desc => N_('Downtime reason'), :required => false
+
+      def create
+        begin
+          options = {
+            :comment => downtime_params[:reason] || _('Host requested downtime')
+          }
+          if downtime_params.key? :duration
+            options[:start_time] = Time.now.to_i
+            options[:end_time] = Time.now.to_i + downtime_params[:duration].to_i
+          end
+          @host.downtime_host(options)
+        rescue StandardError => e
+          Foreman::Logging.exception('Failed to request downtime', e)
+          render :json => { 'message' => e.message }, :status => :unprocessable_entity
+          return
+        end
+
+        render :json => { 'message' => 'OK' }
+      end
+
+      private
+
+      def downtime_params
+        params.permit(:duration, :reason)
+      end
+
+      def find_host
+        @host = detected_host
+
+        return true if @host
+
+        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.'
+                       }
+        else
+          render_error 'unauthorized',
+                       :status => :unauthorized,
+                       :locals => {
+                         :user_login => get_client_cert_hostname
+                       }
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class MonitoringResultsController < V2::BaseController
@@ -17,10 +19,9 @@ module Api
 
       def create
         begin
-          MonitoringResult.import(monitoring_result_params.with_indifferent_access)
-        rescue => e
-          logger.error "Failed to import monitoring result: #{e.message}"
-          logger.debug e.backtrace.join("\n")
+          MonitoringResult.import(monitoring_result_params.to_h.with_indifferent_access)
+        rescue StandardError => e
+          Foreman::Logging.exception('Failed to import monitoring result', e)
           render :json => { 'message' => e.message }, :status => :unprocessable_entity
           return
         end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ForemanMonitoring
+  module FindHostByClientCert
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def authorize_host_by_client_cert(actions, _options = {})
+        skip_before_action :require_login, :only => actions, :raise => false
+        skip_before_action :authorize, :only => actions
+        skip_before_action :verify_authenticity_token, :only => actions
+        skip_before_action :set_taxonomy, :only => actions, :raise => false
+        skip_before_action :session_expiry, :update_activity_time, :only => actions
+        before_action(:only => actions) { require_client_cert_or_login }
+        attr_reader :detected_host
+      end
+    end
+
+    private
+
+    # Permits Hosts authorized by their client cert
+    # or a user with permission
+    def require_client_cert_or_login
+      @detected_host = find_host_by_client_cert
+
+      if detected_host
+        set_admin_user
+        return true
+      end
+
+      require_login
+      unless User.current
+        render_error 'unauthorized', :status => :unauthorized unless performed? && api_request?
+        return false
+      end
+      authorize
+    end
+
+    def find_host_by_client_cert
+      hostname = get_client_cert_hostname
+
+      return unless hostname
+
+      host ||= Host::Base.find_by(certname: hostname) ||
+               Host::Base.find_by(name: hostname)
+      logger.info { "Found Host #{host} by client cert #{hostname}" } if host
+      host
+    end
+
+    def get_client_cert_hostname
+      client_certificate = Foreman::ClientCertificate.new(request: request)
+      return unless client_certificate.verified?
+
+      hostname = client_certificate.subject
+      logger.debug "Extracted hostname '#{hostname}' from client certificate." if hostname
+      hostname
+    end
+  end
+end

data/app/controllers/concerns/foreman_monitoring/hosts_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostsControllerExtensions
     def self.prepended(base)
@@ -38,14 +40,14 @@ module ForemanMonitoring
             failed_hosts[host.name] = error_message
             logger.error "Failed to set a host downtime for #{host}: #{error_message}"
           end
-        rescue => error
-          failed_hosts[host.name] = error
-          Foreman::Logging.exception(_('Failed to set a host downtime for %s.') % host, error)
+        rescue StandardError => e
+          failed_hosts[host.name] = e
+          Foreman::Logging.exception(_('Failed to set a host downtime for %s.') % host, e)
         end
       end
 
       if failed_hosts.empty?
-        notice _('A downtime was set for the selected hosts.')
+        success _('A downtime was set for the selected hosts.')
       else
         error n_('A downtime clould not be set for host: %s.',
                  'A downtime could not be set for hosts: %s.',
@@ -128,7 +130,7 @@ module ForemanMonitoring
     def action_permission
       case params[:action]
       when 'downtime', 'select_multiple_downtime', 'update_multiple_downtime'
-        :downtime
+        :manage_downtime
       when 'select_multiple_monitoring_proxy', 'update_multiple_monitoring_proxy'
         :edit
       else

data/app/helpers/concerns/foreman_monitoring/hosts_helper_ext.rb

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostsHelperExt
     def multiple_actions
       actions = super
-      if authorized_for(:controller => :hosts, :action => :select_multiple_downtime)
-        actions << [_('Set downtime'), select_multiple_downtime_hosts_path]
-      end
-      if authorized_for(:controller => :hosts, :action => :select_multiple_monitoring_proxy)
-        actions << [_('Change Monitoring Proxy'), select_multiple_monitoring_proxy_hosts_path]
-      end
+      actions << [_('Set downtime'), select_multiple_downtime_hosts_path] if authorized_for(:controller => :hosts, :action => :select_multiple_downtime)
+      actions << [_('Change Monitoring Proxy'), select_multiple_monitoring_proxy_hosts_path] if authorized_for(:controller => :hosts, :action => :select_multiple_monitoring_proxy)
       actions
     end
 
@@ -16,14 +14,14 @@ module ForemanMonitoring
         button_group(
           display_link_if_authorized(_('Downtime'),
                                      hash_for_host_path(:id => host).merge(:auth_object => host,
-                                                                           :permission => :manage_host_downtimes,
+                                                                           :permission => :manage_downtime_hosts,
                                                                            :anchor => 'set_host_downtime'),
                                      :class => 'btn btn-default',
                                      :disabled => !host.monitored?,
-                                     :title    => _('Set a downtime for this host'),
-                                     :id       => 'host-downtime',
-                                     :data     => { :toggle => 'modal',
-                                                    :target => '#set_host_downtime' })
+                                     :title => _('Set a downtime for this host'),
+                                     :id => 'host-downtime',
+                                     :data => { :toggle => 'modal',
+                                                :target => '#set_host_downtime' })
         )
       )
       super
@@ -57,10 +55,10 @@ module ForemanMonitoring
       end
     end
 
-    def datetime_f(f, attr, options = {})
+    def monitoring_datetime_f(f, attr, options = {})
       field(f, attr, options) do
         addClass options, 'form-control'
-        f.datetime_local_field attr, options
+        f.datetime_field attr, options
       end
     end
   end

data/app/lib/proxy_api/monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyAPI
   class Monitoring < ProxyAPI::Resource
     def initialize(args)
@@ -7,34 +9,35 @@ module ProxyAPI
 
     def create_host_downtime(host, args = {})
       parse(post(args, "downtime/host/#{host}"))
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to set downtime for %s') % host)
     end
 
     def remove_host_downtime(host, args = {})
       parse(delete("downtime/host/#{host}?#{args.to_query}"))
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to remove downtime for %s') % host)
     end
 
     def create_host(host, attributes = {})
       parse(put({ :attributes => attributes }, "host/#{host}"))
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to create monitoring host object for %s') % host)
     end
 
     def update_host(host, attributes = {})
       parse(post({ :attributes => attributes }, "host/#{host}"))
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to update monitoring host object for %s') % host)
     end
 
     def delete_host(host)
       raise Foreman::Exception, 'Missing hostname.' if host.blank?
+
       parse(delete("host/#{host}"))
     rescue RestClient::ResourceNotFound
       true
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to delete monitoring host object for %s') % host)
     end
 
@@ -42,7 +45,7 @@ module ProxyAPI
       parse(get("host/#{host}"))
     rescue RestClient::ResourceNotFound
       nil
-    rescue => e
+    rescue StandardError => e
       raise ProxyException.new(url, e, N_('Unable to query monitoring host object for %{host}: %{message}') % { :host => host, :message => e.try(:response) || e.try(:message) })
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostExtensions
     def self.prepended(base)
@@ -6,7 +8,7 @@ module ForemanMonitoring
 
         after_build :downtime_host_build
 
-        has_many :monitoring_results, :dependent => :destroy, :foreign_key => 'host_id'
+        has_many :monitoring_results, :dependent => :destroy, :foreign_key => 'host_id', :inverse_of => :host
       end
     end
 
@@ -28,6 +30,7 @@ module ForemanMonitoring
 
     def downtime_host(options)
       return unless monitored?
+
       begin
         monitoring.set_downtime_host(self, options)
       rescue ProxyAPI::ProxyException => e
@@ -59,12 +62,12 @@ module ForemanMonitoring
         :architecture => architecture.try(:name),
         :os => operatingsystem.try(:to_label),
         :osfamily => operatingsystem.try(:family),
-        :virtual => provider != 'BareMetal',
+        :virtual => virtual.presence || provider != 'BareMetal',
         :provider => provider,
         :compute_resource => compute_resource.try(:to_label),
         :hostgroup => hostgroup.try(:to_label),
         :organization => organization.try(:name),
-        :location => organization.try(:name),
+        :location => location.try(:name),
         :comment => comment,
         :environment => environment.try(:to_s),
         :owner_name => owner.try(:name)

data/app/models/concerns/foreman_monitoring/hostgroup_extensions.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostgroupExtensions
     extend ActiveSupport::Concern
 
     def monitoring_proxy
-      return super unless ancestry.present?
-      SmartProxy.find_by_id(inherited_monitoring_proxy_id)
+      return super if ancestry.blank?
+
+      SmartProxy.find_by(id: inherited_monitoring_proxy_id)
     end
 
     def inherited_monitoring_proxy_id
-      return monitoring_proxy_id unless ancestry.present?
+      return monitoring_proxy_id if ancestry.blank?
+
       self[:monitoring_proxy_id] || self.class.sort_by_ancestry(ancestors.where('monitoring_proxy_id is not NULL')).last.try(:monitoring_proxy_id)
     end
   end

data/app/models/concerns/orchestration/monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Orchestration::Monitoring
   extend ActiveSupport::Concern
 
@@ -10,55 +12,59 @@ module Orchestration::Monitoring
 
   def queue_monitoring
     return unless monitored? && errors.empty?
+
     clear_monitoring_object
     !monitoring_object.key?(:attrs) ? queue_monitoring_create : queue_monitoring_update
   end
 
   def queue_monitoring_create
     return true unless ::Monitoring.create_action?(:create)
-    queue.create(:name   => _('Create monitoring object for %s') % self, :priority => 20,
+
+    queue.create(:name => _('Create monitoring object for %s') % self, :priority => 20,
                  :action => [self, :setMonitoring])
   end
 
   def queue_monitoring_update
     return unless monitoring_update_required?(monitoring_object[:attrs], monitoring_attributes)
+
     Rails.logger.debug('Detected a change to the monitoring object is required.')
-    if ::Monitoring.create_action?(:create)
-      queue.create(:name   => _('Monitoring update for %s') % old, :priority => 2,
-                   :action => [self, :setMonitoringUpdate])
-    end
+    return unless ::Monitoring.create_action?(:create)
+
+    queue.create(:name => _('Monitoring update for %s') % old, :priority => 2,
+                 :action => [self, :setMonitoringUpdate])
   end
 
   def queue_monitoring_destroy
     return unless monitored? && errors.empty?
+
     if ::Monitoring.delete_action?(:delete)
-      queue.create(:name   => _('Removing monitoring object for %s') % self, :priority => 2,
+      queue.create(:name => _('Removing monitoring object for %s') % self, :priority => 2,
                    :action => [self, :delMonitoring])
     end
-    if ::Monitoring.delete_action?(:downtime)
-      queue.create(:name   => _('Set monitoring downtime for %s') % self, :priority => 2,
-                   :action => [self, :setMonitoringDowntime])
-    end
+    return unless ::Monitoring.delete_action?(:downtime)
+
+    queue.create(:name => _('Set monitoring downtime for %s') % self, :priority => 2,
+                 :action => [self, :setMonitoringDowntime])
   end
 
   def setMonitoring
     Rails.logger.info "Adding Monitoring object for #{name}"
     monitoring.create_host(self)
-  rescue => e
+  rescue StandardError => e
     failure format(_("Failed to create a monitoring object %{name}: %{message}\n "), :name => name, :message => e.message), e
   end
 
   def delMonitoring
     Rails.logger.info "Deleting Monitoring object for #{name}"
     monitoring.delete_host(self)
-  rescue => e
+  rescue StandardError => e
     failure format(_("Failed to delete a monitoring object %{name}: %{message}\n "), :name => name, :message => e.message), e
   end
 
   def setMonitoringUpdate
     Rails.logger.info "Updating Monitoring object for #{name}"
     monitoring.update_host(self)
-  rescue => e
+  rescue StandardError => e
     failure format(_("Failed to update a monitoring object %{name}: %{message}\n "), :name => name, :message => e.message), e
   end
 
@@ -67,14 +73,14 @@ module Orchestration::Monitoring
   def setMonitoringDowntime
     Rails.logger.info "Setting Monitoring downtime for #{name}"
     monitoring.set_downtime_host(self, monitoring_downtime_defaults)
-  rescue => e
+  rescue StandardError => e
     failure format(_("Failed to set a monitoring downtime for %{name}: %{message}\n "), :name => name, :message => e.message), e
   end
 
   def delMonitoringDowntime
     Rails.logger.info "Deleting Monitoring downtime for #{name}"
     monitoring.del_downtime_host(self, monitoring_downtime_defaults)
-  rescue => e
+  rescue StandardError => e
     failure format(_("Failed to set a monitoring downtime for %{name}: %{message}\n "), :name => name, :message => e.message), e
   end
 
@@ -97,6 +103,7 @@ module Orchestration::Monitoring
 
   def monitoring_update_required?(actual_attrs, desired_attrs)
     return true if actual_attrs.deep_symbolize_keys.keys != desired_attrs.deep_symbolize_keys.keys
+
     actual_attrs.deep_symbolize_keys.merge(desired_attrs.deep_symbolize_keys) do |k, actual_v, desired_v|
       if actual_v.is_a?(Hash) && desired_v.is_a?(Hash)
         return true if monitoring_update_required?(actual_v, desired_v)