foreman_monitoring 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca113371402bd1f2251f09d5fd35ef5fce8ef9719299517e37cd56856ee9bbc
-  data.tar.gz: 1d03b4a53865238e521074bf22f9f247e0b74413b1265790995ca6269be923cf
+  metadata.gz: 5e703d5ad965ed3aecba3fee0dc31a7a2c80a84eab893392484555fda8ba8ab1
+  data.tar.gz: 6dce2771bea3df536cb244aadfbad6483387d71157c4b70d5cbe0256b27f508c
 SHA512:
-  metadata.gz: 9f6bb65a07d9a823f9ebad01708ce60b5a8058b6d86b2d67af1016c5361927de85a7e5ce2868bd4b8ec886236949f755d2a04e8b78698d07ed0de9b208b0e830
-  data.tar.gz: f1a7ae4199d026bbcf8feb054f783aca7d0eb86096129b3d54d6e051d2be6174648086280ca4b3e1c4c3545cc41d8f4aa921cdd8fa720ea52ef7f1b177e444ac
+  metadata.gz: e3c24e7c223b0103333d21717636f338176cb2756028d60943c8e6276ffaa366de039dec2b5afd527b5f50464737194b6cc6d5e357f9696d6b56aff167b7fc6e
+  data.tar.gz: ca91aa5af43494a254fbe03bd13cb4e4e30dccfdab8e47befb8252f97b2cce1bd8ab850739993d1675d194f3253a8b5825b248f6d95cc75b6b7c4915252356eb

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

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 StandardError => 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
   module HostsHelperExt
     def multiple_actions
@@ -12,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

data/app/lib/proxy_api/monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyAPI
   class Monitoring < ProxyAPI::Resource
     def initialize(args)
@@ -31,6 +33,7 @@ module ProxyAPI
 
     def delete_host(host)
       raise Foreman::Exception, 'Missing hostname.' if host.blank?
+
       parse(delete("host/#{host}"))
     rescue RestClient::ResourceNotFound
       true

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)
@@ -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,7 +62,7 @@ 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),

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 if ancestry.blank?
+
       SmartProxy.find_by(id: inherited_monitoring_proxy_id)
     end
 
     def inherited_monitoring_proxy_id
       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,32 +12,38 @@ 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.')
     return unless ::Monitoring.create_action?(:create)
-    queue.create(:name   => _('Monitoring update for %s') % old, :priority => 2,
+
+    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
     return unless ::Monitoring.delete_action?(:downtime)
-    queue.create(:name   => _('Set monitoring downtime for %s') % self, :priority => 2,
+
+    queue.create(:name => _('Set monitoring downtime for %s') % self, :priority => 2,
                  :action => [self, :setMonitoringDowntime])
   end
 
@@ -95,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)

data/app/models/host_status/monitoring_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HostStatus
   class MonitoringStatus < HostStatus::Status
     OK = 0
@@ -14,6 +16,7 @@ module HostStatus
       grouped_results.each_key do |resultset|
         result, downtime, acknowledged = resultset
         next if downtime
+
         result = map_result_to_status(result)
         result = WARNING if acknowledged || result == UNKNOWN
         state = result if result > state
@@ -23,6 +26,7 @@ module HostStatus
 
     def to_global(_options = {})
       return HostStatus::Global::OK unless should_affect_global_status?
+
       case status
       when OK
         HostStatus::Global::OK
@@ -74,6 +78,7 @@ module HostStatus
 
     def map_result_to_status(result)
       return result if Rails::VERSION::MAJOR < 5
+
       case result.to_sym
       when :ok
         OK

data/app/models/monitoring_result.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class MonitoringResult < ApplicationRecord
-  enum :result => %i[ok warning critical unknown]
+  enum :result => { :ok => 0, :warning => 1, :critical => 2, :unknown => 3 }
 
   belongs_to_host
 
@@ -30,11 +32,11 @@ class MonitoringResult < ApplicationRecord
     created = MonitoringResult.where(:host => host, :service => result[:service]).first_or_create
     # rubocop:disable Rails/Date
     if created.timestamp.blank? || updates[:timestamp].blank? || (created.timestamp.to_time - updates[:timestamp].to_time) < 2
-      created.update_attributes(updates)
+      created.update(updates)
 
       if created.persisted?
         logger.info("Imported monitoring result for #{host} in #{(Time.now.utc - start_time).round(2)} seconds")
-        host.refresh_statuses
+        host.get_status(::HostStatus::MonitoringStatus).refresh!
       end
     else
       logger.debug "Skipping monitoring result import for #{host} as it is older than what we have."
@@ -46,6 +48,7 @@ class MonitoringResult < ApplicationRecord
   def status
     return :ok if downtime
     return :warning if acknowledged
+
     result.to_sym
   end
 

data/app/models/setting/monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Setting
   class Monitoring < ::Setting
     def self.default_settings

data/app/overrides/add_host_monitoring_result_tab.rb

@@ -1,9 +1,11 @@
-Deface::Override.new(:virtual_path  => 'hosts/show',
-                     :name          => 'add_monitoring_result_tab',
+# frozen_string_literal: true
+
+Deface::Override.new(:virtual_path => 'hosts/show',
+                     :name => 'add_monitoring_result_tab',
                      :insert_bottom => 'ul.nav-tabs',
-                     :partial       => 'monitoring_results/host_tab')
+                     :partial => 'monitoring_results/host_tab')
 
-Deface::Override.new(:virtual_path  => 'hosts/show',
-                     :name          => 'add_monitoring_result_tab_pane',
+Deface::Override.new(:virtual_path => 'hosts/show',
+                     :name => 'add_monitoring_result_tab_pane',
                      :insert_bottom => 'div.tab-content',
-                     :partial       => 'monitoring_results/host_tab_pane')
+                     :partial => 'monitoring_results/host_tab_pane')

data/app/overrides/add_host_multiple_power_set_downtime_checkbox.rb

@@ -1,4 +1,6 @@
-Deface::Override.new(:virtual_path  => 'hosts/select_multiple_power_state',
-                     :name          => 'add_host_multiple_power_set_downtime_checkbox',
+# frozen_string_literal: true
+
+Deface::Override.new(:virtual_path => 'hosts/select_multiple_power_state',
+                     :name => 'add_host_multiple_power_set_downtime_checkbox',
                      :insert_before => "erb[silent]:contains('end')",
-                     :partial       => 'hosts/host_downtime_checkbox')
+                     :partial => 'hosts/host_downtime_checkbox')

data/app/overrides/add_host_set_downtime_modal.rb

@@ -1,4 +1,6 @@
-Deface::Override.new(:virtual_path  => 'hosts/show',
-                     :name          => 'add_monitoring_set_downtime_modal',
+# frozen_string_literal: true
+
+Deface::Override.new(:virtual_path => 'hosts/show',
+                     :name => 'add_monitoring_set_downtime_modal',
                      :insert_after => 'div#review_before_build',
                      :partial => 'hosts/set_host_downtime')

data/app/services/monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Monitoring
   CREATE_ACTIONS = {
     'none' => _('None'),
@@ -49,6 +51,7 @@ class Monitoring
   def query_host(host)
     result = proxy_api.query_host(host.name)
     return {} unless result
+
     {
       :attrs => result
     }

data/app/views/monitoring_results/_host_tab_pane.html.erb

@@ -2,7 +2,7 @@
 <div class="tab-pane" id="monitoring">
 <% if @host.monitoring_results.any? %>
   <table class="<%= table_css_classes %>">
-    <thead
+    <thead>
       <tr>
         <th colspan="2">Monitoring</th>
       </tr>

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,
@@ -5,6 +7,7 @@ Rails.application.routes.draw do
                      :apiv => /v1|v2/,
                      :constraints => ApiConstraints.new(:version => 2) do
       resources :monitoring_results, :only => [:create]
+      resources :downtime, :only => [:create]
     end
   end
 

data/db/migrate/20160817135723_create_monitoring_results.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateMonitoringResults < ActiveRecord::Migration[4.2]
   def change
     # rubocop:disable Rails/CreateTableWithTimestamps

data/db/migrate/20161220201510_add_monitoring_proxy_id_to_host_and_hostgroup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class AddMonitoringProxyIdToHostAndHostgroup < ActiveRecord::Migration[4.2]
   def self.up
     add_column :hosts, :monitoring_proxy_id, :integer

data/db/migrate/201910180900_rename_downtime_host_permission.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class RenameDowntimeHostPermission < ActiveRecord::Migration[5.2]
+  def up
+    # rubocop:disable Rails/SkipsModelValidations
+    Permission.where(name: 'manage_host_downtimes').update_all(name: 'manage_downtime_hosts')
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+
+  def down
+    # rubocop:disable Rails/SkipsModelValidations
+    Permission.where(name: 'manage_downtime_hosts').update_all(name: 'manage_host_downtimes')
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+end

data/db/seeds.d/60-monitoring_proxy_feature.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 f = Feature.where(:name => 'Monitoring').first_or_create
 raise "Unable to create proxy feature: #{format_errors f}" if f.nil? || f.errors.any?

data/lib/foreman_monitoring.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_monitoring/engine'
 
 module ForemanMonitoring

data/lib/foreman_monitoring/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'deface'
 
 module ForemanMonitoring
@@ -18,18 +20,17 @@ module ForemanMonitoring
 
     initializer 'foreman_monitoring.load_default_settings',
                 :before => :load_config_initializers do |_app|
-      if begin
-        Setting.table_exists?
-      rescue StandardError
-        false
-      end
-        require_dependency File.expand_path('../../../app/models/setting/monitoring.rb', __FILE__)
-      end
+      setting_table_exists = begin
+                               Setting.table_exists?
+                             rescue StandardError
+                               false
+                             end
+      require_dependency File.expand_path('../../app/models/setting/monitoring.rb', __dir__) if setting_table_exists
     end
 
     initializer 'foreman_monitoring.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_monitoring do
-        requires_foreman '>= 1.17'
+        requires_foreman '>= 2.0'
 
         apipie_documented_controllers ["#{ForemanMonitoring::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -37,22 +38,25 @@ module ForemanMonitoring
           permission :view_monitoring_results,
                      {},
                      :resource_type => 'Host'
-          permission :manage_host_downtimes,
-                     { :hosts => [:downtime, :select_multiple_downtime, :update_multiple_downtime] },
+          permission :manage_downtime_hosts,
+                     { :hosts => [:downtime, :select_multiple_downtime, :update_multiple_downtime], :'api/v2/downtime' => [:create] },
                      :resource_type => 'Host'
           permission :upload_monitoring_results,
                      :'api/v2/monitoring_results' => [:create]
-          permission :edit_hosts,
-                     { :hosts => [:select_multiple_monitoring_proxy, :update_multiple_monitoring_proxy] },
-                     :resource_type => 'Host'
         end
 
-        role 'Monitoring viewer', [:view_monitoring_results]
-        role 'Monitoring manager', [:view_monitoring_results, :manage_host_downtimes]
+        # Extend built in permissions
+        Foreman::AccessControl.permission(:edit_hosts).actions.concat [
+          'hosts/select_multiple_monitoring_proxy',
+          'hosts/update_multiple_monitoring_proxy'
+        ]
+
+        role 'Monitoring viewer', [:view_monitoring_results], 'Role granting permissions to view monitor results'
+        role 'Monitoring manager', [:view_monitoring_results, :manage_downtime_hosts], 'Role granting permissions to view monitor results and manage downtimes'
 
         register_custom_status HostStatus::MonitoringStatus
 
-        add_controller_action_scope(HostsController, :index) { |base_scope| base_scope.includes(:monitoring_results) }
+        add_controller_action_scope('HostsController', :index) { |base_scope| base_scope.includes(:monitoring_results) }
 
         monitoring_proxy_options = {
           :feature => 'Monitoring',
@@ -65,23 +69,23 @@ module ForemanMonitoring
         smart_proxy_for Host::Managed, :monitoring_proxy, monitoring_proxy_options
         smart_proxy_for Hostgroup, :monitoring_proxy, monitoring_proxy_options
 
-        add_controller_action_scope(HostsController, :index) { |base_scope| base_scope.includes(:monitoring_proxy) }
+        add_controller_action_scope('HostsController', :index) { |base_scope| base_scope.includes(:monitoring_proxy) }
       end
     end
 
     config.to_prepare do
       begin
-        ::Host::Managed.send(:prepend, ForemanMonitoring::HostExtensions)
-        ::Hostgroup.send(:include, ForemanMonitoring::HostgroupExtensions)
-        ::HostsHelper.send(:prepend, ForemanMonitoring::HostsHelperExt)
-        ::HostsController.send(:prepend, ForemanMonitoring::HostsControllerExtensions)
+        ::Host::Managed.prepend(ForemanMonitoring::HostExtensions)
+        ::Hostgroup.include(ForemanMonitoring::HostgroupExtensions)
+        ::HostsHelper.prepend(ForemanMonitoring::HostsHelperExt)
+        ::HostsController.prepend(ForemanMonitoring::HostsControllerExtensions)
       rescue StandardError => e
         Rails.logger.warn "ForemanMonitoring: skipping engine hook (#{e})"
       end
     end
 
     initializer 'foreman_monitoring.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_monitoring'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_monitoring/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanMonitoring
-  VERSION = '1.0.1'.freeze
+  VERSION = '2.0.0'
 end

data/lib/tasks/foreman_monitoring_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tests
 namespace :test do
   desc 'Test ForemanMonitoring'
@@ -11,7 +13,7 @@ namespace :test do
 end
 
 namespace :foreman_monitoring do
-  task :rubocop do
+  task rubocop: :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_monitoring) do |task|

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_monitoring.gemspec
 _('Set a downtime for hosts after they are deleted in Foreman.')

data/test/controllers/api/v2/downtime_controller_test.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class Api::V2::DowntimeControllerTest < ActionController::TestCase
+  let(:host1) { as_admin { FactoryBot.create(:host, :managed) } }
+
+  context 'with user authentication' do
+    context '#create' do
+      test 'should deny access' do
+        put :create
+        assert_response :forbidden
+      end
+    end
+  end
+
+  context 'with client cert' do
+    setup do
+      User.current = nil
+      reset_api_credentials
+
+      Setting[:ssl_client_dn_env] = 'SSL_CLIENT_S_DN'
+      Setting[:ssl_client_verify_env] = 'SSL_CLIENT_VERIFY'
+
+      @request.env['HTTPS'] = 'on'
+      @request.env['SSL_CLIENT_S_DN'] = "CN=#{host1.name},DN=example,DN=com"
+      @request.env['SSL_CLIENT_VERIFY'] = 'SUCCESS'
+    end
+
+    context '#create' do
+      test 'should create downtime' do
+        put :create
+        assert_response :success
+      end
+    end
+
+    context '#create with duration' do
+      test 'should create downtime with given duration' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:end_time] - params[:start_time] == 3600 }
+        put :create, params: { duration: 3600 }
+        assert_response :success
+      end
+
+      test 'should create downtime with given duration as string' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:end_time] - params[:start_time] == 3600 }
+        put :create, params: { duration: '3600' }
+        assert_response :success
+      end
+    end
+
+    context '#create with reason' do
+      test 'should create downtime with given reason' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:comment] == 'In testing' }
+        put :create, params: { reason: 'In testing' }
+        assert_response :success
+      end
+    end
+  end
+
+  context 'without any credentials' do
+    setup do
+      User.current = nil
+      reset_api_credentials
+    end
+
+    context '#create' do
+      test 'should deny access' do
+        post :create
+        assert_response :unauthorized
+      end
+    end
+  end
+end

data/test/factories/feature.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :feature do
     trait :monitoring do
-      name 'Monitoring'
+      name { 'Monitoring' }
     end
   end
 end

data/test/factories/host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :host do
     trait :with_monitoring do
@@ -8,7 +10,7 @@ FactoryBot.modify do
 
     trait :with_monitoring_results do
       transient do
-        monitoring_result_count 20
+        monitoring_result_count { 20 }
       end
       after(:create) do |host, evaluator|
         evaluator.monitoring_result_count.times do

data/test/factories/monitoring_results.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :monitoring_result do
     sequence(:service) { |n| "Service #{n}" }
     result { rand(0..3) }
 
     trait :ok do
-      result 0
+      result { 0 }
     end
 
     trait :warning do
-      result 1
+      result { 1 }
     end
 
     trait :critical do
-      result 2
+      result { 2 }
     end
 
     trait :unknown do
-      result 3
+      result { 3 }
     end
 
     trait :downtime do
-      downtime true
+      downtime { true }
     end
 
     trait :acknowledged do
-      acknowledged true
+      acknowledged { true }
     end
   end
 end

data/test/factories/smart_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FactoryBot.modify do
   factory :smart_proxy do
     trait :monitoring do

data/test/functional/hosts_controller_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostsControllerExtensionsTest < ActionController::TestCase
@@ -22,17 +24,17 @@ class HostsControllerExtensionsTest < ActionController::TestCase
           params: {
             :id => @host.name,
             :downtime => {
-              :comment   => 'Maintenance work.',
+              :comment => 'Maintenance work.',
               :starttime => Time.current,
-              :endtime   => Time.current.advance(:hours => 2)
+              :endtime => Time.current.advance(:hours => 2)
             }
           },
           session: set_session_user
       assert_response :found
       assert_redirected_to host_path(:id => @host)
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal "Created downtime for #{@host}", flash[:notice]
+      assert_not_nil flash[:success]
+      assert_equal "Created downtime for #{@host}", flash[:success]
     end
 
     test 'with missing comment param the flash should inform it' do
@@ -58,9 +60,9 @@ class HostsControllerExtensionsTest < ActionController::TestCase
           params: {
             :id => @host.name,
             :downtime => {
-              :comment   => 'Maintenance work.',
+              :comment => 'Maintenance work.',
               :starttime => 'invalid',
-              :endtime   => 'invalid'
+              :endtime => 'invalid'
             }
           },
           session: set_session_user
@@ -78,9 +80,9 @@ class HostsControllerExtensionsTest < ActionController::TestCase
           params: {
             :id => @host.name,
             :downtime => {
-              :comment   => 'Maintenance work.',
+              :comment => 'Maintenance work.',
               :starttime => '2017-04-20T10:15',
-              :endtime   => '2017-04-20T12:15'
+              :endtime => '2017-04-20T12:15'
             }
           },
           session: set_session_user
@@ -120,8 +122,8 @@ class HostsControllerExtensionsTest < ActionController::TestCase
       assert_response :found
       assert_redirected_to hosts_path
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal 'A downtime was set for the selected hosts.', flash[:notice]
+      assert_not_nil flash[:success]
+      assert_equal 'A downtime was set for the selected hosts.', flash[:success]
     end
   end
 
@@ -151,8 +153,8 @@ class HostsControllerExtensionsTest < ActionController::TestCase
       assert_response :found
       assert_redirected_to hosts_path
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:notice]
+      assert_not_nil flash[:success]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:success]
     end
 
     test 'should not set a downtime if not selected' do
@@ -170,8 +172,8 @@ class HostsControllerExtensionsTest < ActionController::TestCase
       assert_response :found
       assert_redirected_to hosts_path
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:notice]
+      assert_not_nil flash[:success]
+      assert_equal 'The power state of the selected hosts will be set to poweroff', flash[:success]
     end
   end
 
@@ -196,7 +198,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
 
     test 'should change the proxy' do
       hosts.each do |host|
-        refute_equal monitoring_proxy, host.monitoring_proxy
+        assert_not_equal monitoring_proxy, host.monitoring_proxy
       end
 
       params = {
@@ -209,7 +211,7 @@ class HostsControllerExtensionsTest < ActionController::TestCase
       assert_response :found
       assert_redirected_to hosts_path
       assert_nil flash[:error]
-      assert_equal "The Monitoring proxy of the selected hosts was set to #{monitoring_proxy.name}", flash[:notice]
+      assert_equal "The Monitoring proxy of the selected hosts was set to #{monitoring_proxy.name}", flash[:success]
 
       hosts.each do |host|
         as_admin do

data/test/lib/proxy_api/monitoring_test.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
-class ProxyApiDhcpTest < ActiveSupport::TestCase
+class ProxyApiMonitoringTest < ActiveSupport::TestCase
   def setup
     @url = 'http://localhost:8443'
     @monitoring = ProxyAPI::Monitoring.new(:url => @url)

data/test/test_plugin_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 require 'database_cleaner'

data/test/unit/host_status/monitoring_status_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class MonitoringStatusTest < ActiveSupport::TestCase
@@ -61,7 +63,7 @@ class MonitoringStatusTest < ActiveSupport::TestCase
       assert status.relevant?
 
       host.build = true
-      refute status.relevant?
+      assert_not status.relevant?
     end
 
     test '#host_known_in_monitoring? should be true' do
@@ -76,10 +78,10 @@ class MonitoringStatusTest < ActiveSupport::TestCase
   context 'status with host without monitoring results' do
     test '#relevant? is always false when build changes' do
       host.build = false
-      refute status.relevant?
+      assert_not status.relevant?
 
       host.build = true
-      refute status.relevant?
+      assert_not status.relevant?
     end
 
     test '#refresh! refreshes the date and persists the record' do
@@ -90,7 +92,7 @@ class MonitoringStatusTest < ActiveSupport::TestCase
     end
 
     test '#host_known_in_monitoring? should be false' do
-      refute status.host_known_in_monitoring?
+      assert_not status.host_known_in_monitoring?
     end
   end
 end

data/test/unit/host_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostTest < ActiveSupport::TestCase

data/test/unit/monitoring_result_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class MonitoringResultTest < ActiveSupport::TestCase

data/test/unit/monitoring_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class MonitoringTest < ActiveSupport::TestCase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_monitoring
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -28,16 +28,58 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: deface
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +104,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/api/v2/downtime_controller.rb
 - app/controllers/api/v2/monitoring_results_controller.rb
+- app/controllers/concerns/foreman_monitoring/find_host_by_client_cert.rb
 - app/controllers/concerns/foreman_monitoring/hosts_controller_extensions.rb
 - app/helpers/concerns/foreman_monitoring/hosts_helper_ext.rb
 - app/lib/proxy_api/monitoring.rb
@@ -86,6 +130,7 @@ files:
 - config/routes.rb
 - db/migrate/20160817135723_create_monitoring_results.rb
 - db/migrate/20161220201510_add_monitoring_proxy_id_to_host_and_hostgroup.rb
+- db/migrate/201910180900_rename_downtime_host_permission.rb
 - db/seeds.d/60-monitoring_proxy_feature.rb
 - lib/foreman_monitoring.rb
 - lib/foreman_monitoring/engine.rb
@@ -95,6 +140,7 @@ files:
 - locale/en/foreman_monitoring.po
 - locale/foreman_monitoring.pot
 - locale/gemspec.rb
+- test/controllers/api/v2/downtime_controller_test.rb
 - test/factories/feature.rb
 - test/factories/host.rb
 - test/factories/monitoring_results.rb
@@ -106,11 +152,11 @@ files:
 - test/unit/host_test.rb
 - test/unit/monitoring_result_test.rb
 - test/unit/monitoring_test.rb
-homepage: http://www.github.com/theforeman/foreman_monitoring
+homepage: https://github.com/theforeman/foreman_monitoring
 licenses:
-- GPLv3
+- GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +171,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Foreman plugin for monitoring system integration.
 test_files:
@@ -141,4 +186,5 @@ test_files:
 - test/factories/host.rb
 - test/lib/proxy_api/monitoring_test.rb
 - test/test_plugin_helper.rb
+- test/controllers/api/v2/downtime_controller_test.rb
 - test/functional/hosts_controller_test.rb