foreman_monitoring 0.1.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f742aa658a66234e28555d6dbba4beca116e6ba3d49db3c02898bd7cc295a5d9
-  data.tar.gz: f11b41bb8dc37e78431df10c3fc255f7680039293e7e0c9ff0268a4c975d49ef
+  metadata.gz: 6bc195afe4c0af30313894eaf37dcf99c36625fe510998783df94932111c9891
+  data.tar.gz: 8d37c47d99c8d48163242ce490159c59a6a4e6c2588709daac0bac841a450c5a
 SHA512:
-  metadata.gz: f7dbdfc58ea1b7669eefff4b603ccc4f813b87a3aadbb4cd4a48ad86de3899403b440709d1b2a1f9145dc5b4b4487875ad0a33de031142d70e47d139278043d1
-  data.tar.gz: 39f27d2331c23bd24392d1abcaa47dc4ec9757463a27503518d501581ba2b276acc2528fa58b2e76f632f58ac00cb91801060d09a821a9853e0754ced75342dc
+  metadata.gz: cf715511ef2835a64702b2f865c6380c178dd8c70b2038428ea3a0c9a72fefcef4715ec4c2bcca82fbf687c9ea5a463c5e041009fe7e795cb6aab6484020d6f3
+  data.tar.gz: 8c4c4cbaad0dffa2f7d338d19e116cc58c05272b262d36d5bf221137391577a414dcd3ba83c34d78c46207bf8298675529a988d42fd736961751687325b615b1

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,15 @@ foreman-rake db:seed
 touch ~foreman/tmp/restart.txt
 ```
 
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| >= 1.15         | ~> 0.1         |
+| >= 1.17         | ~> 1.0         |
+| >= 2.0          | ~> 2.0         |
+| >= 2.2          | ~> 2.1         |
+
 # Usage
 
 For managing a host in the monitoring solution a Smart Proxy providing
@@ -35,15 +44,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 +60,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,60 @@
+# 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 :check_user_enabled, :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,18 +1,19 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostsControllerExtensions
-    extend ActiveSupport::Concern
-
-    included do
-      before_action :find_resource_with_monitoring, :only => [:downtime]
-      before_action :find_multiple_with_monitoring, :only => %i[select_multiple_downtime update_multiple_downtime
-                                                                select_multiple_monitoring_proxy update_multiple_monitoring_proxy]
-      before_action :validate_host_downtime_params, :only => [:downtime]
-      before_action :validate_hosts_downtime_params, :only => [:update_multiple_downtime]
-      before_action :validate_multiple_monitoring_proxy, :only => :update_multiple_monitoring_proxy
-
-      alias_method :find_resource_with_monitoring, :find_resource
-      alias_method :find_multiple_with_monitoring, :find_multiple
-      alias_method_chain :update_multiple_power_state, :monitoring
+    def self.prepended(base)
+      base.class_eval do
+        before_action :find_resource_with_monitoring, :only => [:downtime]
+        before_action :find_multiple_with_monitoring, :only => %i[select_multiple_downtime update_multiple_downtime
+                                                                  select_multiple_monitoring_proxy update_multiple_monitoring_proxy]
+        before_action :validate_host_downtime_params, :only => [:downtime]
+        before_action :validate_hosts_downtime_params, :only => [:update_multiple_downtime]
+        before_action :validate_multiple_monitoring_proxy, :only => :update_multiple_monitoring_proxy
+
+        alias_method :find_resource_with_monitoring, :find_resource
+        alias_method :find_multiple_with_monitoring, :find_multiple
+      end
     end
 
     def downtime
@@ -39,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.',
@@ -65,7 +66,7 @@ module ForemanMonitoring
       update_multiple_proxy(_('Monitoring'), :monitoring_proxy=)
     end
 
-    def update_multiple_power_state_with_monitoring
+    def update_multiple_power_state
       options = {
         :comment => 'Power state changed in Foreman',
         :author => "Foreman User #{User.current}",
@@ -86,7 +87,7 @@ module ForemanMonitoring
           end
         end
       end
-      update_multiple_power_state_without_monitoring
+      super
     end
 
     private
@@ -129,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,33 +1,30 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostsHelperExt
-    extend ActiveSupport::Concern
-
-    included do
-      alias_method_chain :host_title_actions, :monitoring
-      alias_method_chain :multiple_actions, :monitoring
-    end
-
-    def multiple_actions_with_monitoring
-      return multiple_actions_without_monitoring unless authorized_for(:controller => :hosts, :action => :select_multiple_downtime)
-      multiple_actions_without_monitoring + [[_('Set downtime'), select_multiple_downtime_hosts_path], [_('Change Monitoring Proxy'), select_multiple_monitoring_proxy_hosts_path]]
+    def multiple_actions
+      actions = super
+      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
 
-    def host_title_actions_with_monitoring(host)
+    def host_title_actions(host)
       title_actions(
         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' })
         )
       )
-      host_title_actions_without_monitoring(host)
+      super
     end
 
     def host_monitoring_result_icon_class(result)
@@ -58,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,15 +1,15 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostExtensions
-    extend ActiveSupport::Concern
-    included do
-      include Orchestration::Monitoring
-
-      after_build :downtime_host_build
+    def self.prepended(base)
+      base.class_eval do
+        include Orchestration::Monitoring
 
-      alias_method_chain :smart_proxy_ids, :monitoring_proxy
-      alias_method_chain :hostgroup_inherited_attributes, :monitoring
+        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
 
     def monitoring_status(options = {})
@@ -30,6 +30,7 @@ module ForemanMonitoring
 
     def downtime_host(options)
       return unless monitored?
+
       begin
         monitoring.set_downtime_host(self, options)
       rescue ProxyAPI::ProxyException => e
@@ -42,12 +43,12 @@ module ForemanMonitoring
       monitoring_proxy.present?
     end
 
-    def hostgroup_inherited_attributes_with_monitoring
-      hostgroup_inherited_attributes_without_monitoring + ['monitoring_proxy_id']
+    def hostgroup_inherited_attributes
+      super + ['monitoring_proxy_id']
     end
 
-    def smart_proxy_ids_with_monitoring_proxy
-      ids = smart_proxy_ids_without_monitoring_proxy
+    def smart_proxy_ids
+      ids = super
       [monitoring_proxy, hostgroup.try(:monitoring_proxy)].compact.each do |proxy|
         ids << proxy.id
       end
@@ -61,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)