foreman_monitoring 0.1.1 → 2.0.0

data/app/models/host_status/monitoring_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HostStatus
   class MonitoringStatus < HostStatus::Status
     OK = 0
@@ -11,9 +13,10 @@ module HostStatus
 
     def to_status(_options = {})
       state = OK
-      grouped_results.each do |resultset, _count|
+      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
@@ -60,9 +64,7 @@ module HostStatus
       host.monitoring_results.any?
     end
 
-    def host_monitored?
-      host.monitored?
-    end
+    delegate :monitored?, to: :host, prefix: true
 
     def should_affect_global_status?
       Setting[:monitoring_affect_global_status]
@@ -76,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,10 +1,13 @@
-class MonitoringResult < ActiveRecord::Base
-  enum :result => %i[ok warning critical unknown]
+# frozen_string_literal: true
+
+class MonitoringResult < ApplicationRecord
+  enum :result => { :ok => 0, :warning => 1, :critical => 2, :unknown => 3 }
 
   belongs_to_host
 
+  # rubocop:disable Metrics/AbcSize
   def self.import(result)
-    host = Host.find_by_name(result[:host])
+    host = Host.find_by(name: result[:host])
 
     if host.nil?
       logger.error "Unable to find host #{result[:host]}"
@@ -27,21 +30,25 @@ class MonitoringResult < ActiveRecord::Base
     end
 
     created = MonitoringResult.where(:host => host, :service => result[:service]).first_or_create
-    if created.timestamp.blank? || updates[:timestamp].blank? || created.timestamp < updates[:timestamp]
-      created.update_attributes(updates)
+    # rubocop:disable Rails/Date
+    if created.timestamp.blank? || updates[:timestamp].blank? || (created.timestamp.to_time - updates[:timestamp].to_time) < 2
+      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."
     end
+    # rubocop:enable Rails/Date
   end
+  # rubocop:enable Metrics/AbcSize
 
   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
@@ -7,10 +9,10 @@ class Setting
             true, N_('Monitoring status should affect global status')),
         set('monitoring_create_action',
             _('What action should be taken when a host is created'),
-            'create', N_('Host Create Action'), nil, { :collection => proc { ::Monitoring::CREATE_ACTIONS } }),
+            'create', N_('Host Create Action'), nil, :collection => proc { ::Monitoring::CREATE_ACTIONS }),
         set('monitoring_delete_action',
             _('What action should be taken when a host is deleted'),
-            'delete', N_('Host Delete Action'), nil, { :collection => proc { ::Monitoring::DELETE_ACTIONS } })
+            'delete', N_('Host Delete Action'), nil, :collection => proc { ::Monitoring::DELETE_ACTIONS })
       ]
     end
 

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/hosts/_downtime_fields.html.erb

@@ -1,3 +1,3 @@
 <%= text_f f, :comment, :size => "col-md-5", :label => _('Comment'), :help_inline => _('Short description that explains why the downtime was set.'), :required => true %>
-<%= datetime_f f, :starttime, :size => "col-md-5", :label => _('Starttime'), :help_inline => _('Time when the downtime should start.'), :value => Time.current.strftime("%Y-%m-%dT%H:%M"), :required => true %>
-<%= datetime_f f, :endtime, :size => "col-md-5", :label => _('Endtime'), :help_inline => _('Time when the downtime should end.'), :value => Time.current.advance(:hours => 2).strftime("%Y-%m-%dT%H:%M"), :required => true %>
+<%= monitoring_datetime_f f, :starttime, :size => "col-md-5", :label => _('Starttime'), :help_inline => _('Time when the downtime should start.'), :min => DateTime.now, :value => Time.current, :required => true %>
+<%= monitoring_datetime_f f, :endtime, :size => "col-md-5", :label => _('Endtime'), :help_inline => _('Time when the downtime should end.'), :value => Time.current.advance(:hours => 2), :required => true %>

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

@@ -1,8 +1,8 @@
 <%- if authorized_for(:permission => 'view_monitoring_results', :auth_object => @host) && @host.monitored? -%>
 <div class="tab-pane" id="monitoring">
 <% if @host.monitoring_results.any? %>
-  <table class="table table-bordered table-striped">
-    <thead
+  <table class="<%= table_css_classes %>">
+    <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,5 +1,8 @@
-class CreateMonitoringResults < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateMonitoringResults < ActiveRecord::Migration[4.2]
   def change
+    # rubocop:disable Rails/CreateTableWithTimestamps
     create_table :monitoring_results do |t|
       t.references :host, :null => false
       t.string :service, :null => false
@@ -8,5 +11,6 @@ class CreateMonitoringResults < ActiveRecord::Migration
       t.boolean :acknowledged, :default => false, :null => false
       t.datetime :timestamp
     end
+    # rubocop:enable Rails/CreateTableWithTimestamps
   end
 end

data/db/migrate/20161220201510_add_monitoring_proxy_id_to_host_and_hostgroup.rb

@@ -1,4 +1,6 @@
-class AddMonitoringProxyIdToHostAndHostgroup < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class AddMonitoringProxyIdToHostAndHostgroup < ActiveRecord::Migration[4.2]
   def self.up
     add_column :hosts, :monitoring_proxy_id, :integer
     add_column :hostgroups, :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
@@ -17,42 +19,44 @@ module ForemanMonitoring
     end
 
     initializer 'foreman_monitoring.load_default_settings',
-      :before => :load_config_initializers do |_app|
-      if begin
-        Setting.table_exists?
-      rescue
-        false
-      end
-        require_dependency File.expand_path('../../../app/models/setting/monitoring.rb', __FILE__)
-      end
+                :before => :load_config_initializers do |_app|
+      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.15'
+        requires_foreman '>= 2.0'
 
         apipie_documented_controllers ["#{ForemanMonitoring::Engine.root}/app/controllers/api/v2/*.rb"]
 
         security_block :foreman_monitoring do
           permission :view_monitoring_results,
-            {},
-            :resource_type => 'Host'
-          permission :manage_host_downtimes,
-            { :hosts => [:downtime, :select_multiple_downtime, :update_multiple_downtime] },
-            :resource_type => 'Host'
+                     {},
+                     :resource_type => 'Host'
+          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'
+                     :'api/v2/monitoring_results' => [:create]
         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)
-      rescue => e
+        ::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 = '0.1.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|
@@ -19,7 +21,7 @@ namespace :foreman_monitoring do
                          "#{ForemanMonitoring::Engine.root}/lib/**/*.rb",
                          "#{ForemanMonitoring::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 
@@ -30,6 +32,4 @@ end
 Rake::Task[:test].enhance ['test:foreman_monitoring']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_monitoring', 'foreman_monitoring:rubocop']
-end
+Rake::Task['jenkins:unit'].enhance ['test:foreman_monitoring', 'foreman_monitoring:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

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