foreman_monitoring 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba72edc0a48bb00f5818a0662ef643ea892cef4f457b474fd35332471bf1751
-  data.tar.gz: b62364ba84ac51878993cd2d6d7be654cfb10aa2c2a565b2ec71f6dc38f933a1
+  metadata.gz: 685e5be086aa9ee637a3ef119df3310475334138a687f2583e21148ba63e1743
+  data.tar.gz: 2dd299e15e6a4701e15ff7fc04e95c733c72454bd718f15082315fada5db2e4a
 SHA512:
-  metadata.gz: d1d0834a1dc76d2009dc1bd1bbd35c0fbcfc166e1b1206c87a3ba1fd7d8543c693d22550cd899129b41d9dcbf76d0a379ab7c0ef6a7d83e2ffa1960c0b8ec3a2
-  data.tar.gz: 8715c42a9d55a3f491a860373c74dcda03351be2752a14e2dc798781f1ab807b55ff332822ead436637b1d479702920cbe9c19b6b30bff4844418acbe3d8611f
+  metadata.gz: 612b798a6f43d52b223c248e63298606fafe545caf2350633c9f24ec08b0f35de0a8459a560171b519a24972e39cc84c974b902c39c578adb680586cfc51f238
+  data.tar.gz: def3221fb65d2d545ee7b404725d173de31f444008dff5140fcbfe6e315d20574cba95f2e8f5a14ad580c3d180fc89022ec8827a51d1ad541df51a08964679fc

data/README.md

@@ -37,6 +37,7 @@ touch ~foreman/tmp/restart.txt
 | >= 2.0          | ~> 2.0         |
 | >= 2.2          | ~> 2.1         |
 | >= 3.0          | ~> 3.0         |
+| >= 3.6          | ~> 3.1         |
 
 # Usage
 

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

@@ -10,6 +10,7 @@ module Api
       before_action :find_host, :only => [:create]
 
       api :POST, '/downtime', N_('Schedule host downtime')
+      param :all_services, [true, false], :desc => N_('Set downtime for all services'), :required => false
       param :duration, :number, :desc => N_('Downtime duration (seconds)'), :required => false
       param :reason, String, :desc => N_('Downtime reason'), :required => false
 
@@ -18,6 +19,7 @@ module Api
           options = {
             :comment => downtime_params[:reason] || _('Host requested downtime')
           }
+          options[:all_services] = downtime_params[:all_services] if downtime_params.key? :all_services
           if downtime_params.key? :duration
             options[:start_time] = Time.now.to_i
             options[:end_time] = Time.now.to_i + downtime_params[:duration].to_i
@@ -35,7 +37,7 @@ module Api
       private
 
       def downtime_params
-        params.permit(:duration, :reason)
+        params.permit(:all_services, :duration, :reason)
       end
 
       def find_host

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

@@ -97,7 +97,8 @@ module ForemanMonitoring
         :comment => params[:downtime][:comment],
         :author => "Foreman User #{User.current}",
         :start_time => Time.zone.parse(params[:downtime][:starttime]).to_i,
-        :end_time => Time.zone.parse(params[:downtime][:endtime]).to_i
+        :end_time => Time.zone.parse(params[:downtime][:endtime]).to_i,
+        **(params[:downtime][:all_services] == '1' ? { :all_services => true } : {})
       }
     end
 

data/app/helpers/foreman_monitoring/hosts_helper.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ForemanMonitoring
+  module HostsHelper
+    def monitoring_hosts_multiple_actions
+      actions = []
+      actions << { action: [_('Set downtime'), select_multiple_downtime_hosts_path], priority: 1000 } \
+        if authorized_for(:controller => :hosts, :action => :select_multiple_downtime)
+      actions << { action: [_('Change Monitoring Proxy'), select_multiple_monitoring_proxy_hosts_path], priority: 1000 } \
+        if authorized_for(:controller => :hosts, :action => :select_multiple_monitoring_proxy)
+      actions
+    end
+
+    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_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',
+            }
+          )
+        )
+      )
+      super
+    end
+
+    def host_monitoring_result_icon_class(result)
+      icon_class = case result
+                   when :ok
+                     'pficon-ok'
+                   when :warning
+                     'pficon-info'
+                   when :critical
+                     'pficon-error-circle-o'
+                   else
+                     'pficon-help'
+                   end
+
+      "host-status #{icon_class} #{host_monitoring_result_class(result)}"
+    end
+
+    def host_monitoring_result_class(result)
+      case result
+      when :ok
+        'status-ok'
+      when :warning
+        'status-warn'
+      when :critical
+        'status-error'
+      else
+        'status-question'
+      end
+    end
+
+    def monitoring_datetime_f(f, attr, options = {})
+      field(f, attr, options) do
+        addClass options, 'form-control'
+        f.datetime_field attr, options
+      end
+    end
+  end
+end

data/app/lib/proxy_api/monitoring.rb

@@ -3,7 +3,7 @@
 module ProxyAPI
   class Monitoring < ProxyAPI::Resource
     def initialize(args)
-      @url = args[:url] + '/monitoring'
+      @url = "#{args[:url]}/monitoring"
       super args
     end
 

data/app/models/monitoring_result.rb

@@ -30,7 +30,6 @@ class MonitoringResult < ApplicationRecord
     end
 
     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(updates)
 
@@ -41,7 +40,6 @@ class MonitoringResult < ApplicationRecord
     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
 

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

@@ -1,3 +1,4 @@
 <%= text_f f, :comment, :size => "col-md-5", :label => _('Comment'), :help_inline => _('Short description that explains why the downtime was set.'), :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 %>
+<%= checkbox_f f, :all_services, :size => "col-md-5", :label => _('All services'), :help_inline => _("Set downtime for all host's services.") %>

data/config/routes.rb

@@ -12,7 +12,7 @@ Rails.application.routes.draw do
   end
 
   scope '/monitoring' do
-    constraints(:id => %r{[^\/]+}) do
+    constraints(:id => %r{[^/]+}) do
       resources :hosts, :only => [] do
         member do
           put 'downtime'

data/db/migrate/201910180900_rename_downtime_host_permission.rb

@@ -2,14 +2,10 @@
 
 class RenameDowntimeHostPermission < ActiveRecord::Migration[5.2]
   def up
-    # rubocop:disable Rails/SkipsModelValidations
     Permission.where(name: 'manage_host_downtimes').update_all(name: 'manage_downtime_hosts') if table_exists?(:permissions)
-    # rubocop:enable Rails/SkipsModelValidations
   end
 
   def down
-    # rubocop:disable Rails/SkipsModelValidations
     Permission.where(name: 'manage_downtime_hosts').update_all(name: 'manage_host_downtimes') if table_exists?(:permissions)
-    # rubocop:enable Rails/SkipsModelValidations
   end
 end

data/db/migrate/20221026065954_fix_monitoring_settings_category_to_dsl.rb

@@ -2,8 +2,6 @@
 
 class FixMonitoringSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
   def up
-    # rubocop:disable Rails/SkipsModelValidations
-    Setting.where(category: 'Setting::Monitoring').update_all(category: 'Setting')
-    # rubocop:enable Rails/SkipsModelValidations
+    Setting.where(category: 'Setting::Monitoring').update_all(category: 'Setting') if column_exists?(:settings, :category)
   end
 end

data/lib/foreman_monitoring/engine.rb

@@ -82,18 +82,19 @@ module ForemanMonitoring
         smart_proxy_for Hostgroup, :monitoring_proxy, monitoring_proxy_options
 
         add_controller_action_scope('HostsController', :index) { |base_scope| base_scope.includes(:monitoring_proxy) }
+
+        describe_host do
+          multiple_actions_provider :monitoring_hosts_multiple_actions
+        end
       end
     end
 
     config.to_prepare do
-      begin
-        ::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
+      ::Host::Managed.prepend(ForemanMonitoring::HostExtensions)
+      ::Hostgroup.include(ForemanMonitoring::HostgroupExtensions)
+      ::HostsController.prepend(ForemanMonitoring::HostsControllerExtensions)
+    rescue StandardError => e
+      Rails.logger.warn "ForemanMonitoring: skipping engine hook (#{e})"
     end
 
     initializer 'foreman_monitoring.register_gettext', after: :load_config_initializers do |_app|

data/lib/foreman_monitoring/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanMonitoring
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

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

@@ -34,6 +34,26 @@ class Api::V2::DowntimeControllerTest < ActionController::TestCase
       end
     end
 
+    context '#create with all_services' do
+      test 'should create downtime without all_services value if none given' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| !params.key? :all_services }
+        post :create
+        assert_response :success
+      end
+
+      test 'should create downtime with given all_services value' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:all_services] }
+        post :create, params: { all_services: true }
+        assert_response :success
+      end
+
+      test 'should create downtime with given all_services value even if false' do
+        Host::Managed.any_instance.expects(:downtime_host).with { |params| params[:all_services] == false }
+        post :create, params: { all_services: false }
+        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 }

data/test/unit/host_test.rb

@@ -61,7 +61,7 @@ class HostTest < ActiveSupport::TestCase
         ProxyAPI::Monitoring.any_instance.stubs(:query_host).returns(fake_host_query_result)
         assert_valid host
         tasks = host.queue.all.map(&:name)
-        assert_equal [], tasks
+        assert_empty tasks
       end
 
       test 'should queue monitoring destroy' do
@@ -83,7 +83,7 @@ class HostTest < ActiveSupport::TestCase
       test 'should not queue monitoring create actions' do
         assert_valid host
         tasks = host.queue.all.map(&:name)
-        assert_equal [], tasks
+        assert_empty tasks
       end
 
       test 'should queue monitoring downtime on host destroy' do
@@ -134,7 +134,7 @@ class HostTest < ActiveSupport::TestCase
       host.send(:queue_monitoring)
       host.send(:queue_monitoring_destroy)
       tasks = host.queue.all.map(&:name)
-      assert_equal [], tasks
+      assert_empty tasks
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_monitoring
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Timo Goebel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -24,62 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.80.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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
@@ -108,7 +52,7 @@ files:
 - 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/helpers/foreman_monitoring/hosts_helper.rb
 - app/lib/proxy_api/monitoring.rb
 - app/models/concerns/foreman_monitoring/host_extensions.rb
 - app/models/concerns/foreman_monitoring/hostgroup_extensions.rb
@@ -164,14 +108,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Foreman plugin for monitoring system integration.

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module ForemanMonitoring
-  module HostsHelperExt
-    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(host)
-      title_actions(
-        button_group(
-          display_link_if_authorized(_('Downtime'),
-                                     hash_for_host_path(:id => host).merge(:auth_object => host,
-                                                                           :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' })
-        )
-      )
-      super
-    end
-
-    def host_monitoring_result_icon_class(result)
-      icon_class = case result
-                   when :ok
-                     'pficon-ok'
-                   when :warning
-                     'pficon-info'
-                   when :critical
-                     'pficon-error-circle-o'
-                   else
-                     'pficon-help'
-                   end
-
-      "host-status #{icon_class} #{host_monitoring_result_class(result)}"
-    end
-
-    def host_monitoring_result_class(result)
-      case result
-      when :ok
-        'status-ok'
-      when :warning
-        'status-warn'
-      when :critical
-        'status-error'
-      else
-        'status-question'
-      end
-    end
-
-    def monitoring_datetime_f(f, attr, options = {})
-      field(f, attr, options) do
-        addClass options, 'form-control'
-        f.datetime_field attr, options
-      end
-    end
-  end
-end