foreman_monitoring 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc195afe4c0af30313894eaf37dcf99c36625fe510998783df94932111c9891
-  data.tar.gz: 8d37c47d99c8d48163242ce490159c59a6a4e6c2588709daac0bac841a450c5a
+  metadata.gz: b8c19621c4296a6cc5d051522ee0176ef3a4726f24bc73eda2c1182c812939c5
+  data.tar.gz: 1691af6f9079acd23c0f826b6052605d99eff64346c127a5b50a2fbac4e38344
 SHA512:
-  metadata.gz: cf715511ef2835a64702b2f865c6380c178dd8c70b2038428ea3a0c9a72fefcef4715ec4c2bcca82fbf687c9ea5a463c5e041009fe7e795cb6aab6484020d6f3
-  data.tar.gz: 8c4c4cbaad0dffa2f7d338d19e116cc58c05272b262d36d5bf221137391577a414dcd3ba83c34d78c46207bf8298675529a988d42fd736961751687325b615b1
+  metadata.gz: 57746ee94c93571b9e8fa14050f2ff1358d265fa710908175fa26b9baa799c5597d31ef2b8a71c3d31b9a57c6c6e4e46fc7377700d1a4f686e1db2a18835f54c
+  data.tar.gz: 14c121e8aaf4c486e1fdd74ce09747578658cc8f8d7c5c9e471d897ea55fe27d8e5c5a3068c87373988af09d6b96bfee113fb90428680abed618eca0c825ebbd

data/README.md

@@ -36,6 +36,8 @@ touch ~foreman/tmp/restart.txt
 | >= 1.17         | ~> 1.0         |
 | >= 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/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/concerns/foreman_monitoring/host_extensions.rb

@@ -56,7 +56,7 @@ module ForemanMonitoring
     end
 
     def monitoring_attributes
-      {
+      attributes = {
         :ip => ip,
         :ip6 => ip6,
         :architecture => architecture.try(:name),
@@ -69,9 +69,12 @@ module ForemanMonitoring
         :organization => organization.try(:name),
         :location => location.try(:name),
         :comment => comment,
-        :environment => environment.try(:to_s),
         :owner_name => owner.try(:name)
       }
+
+      attributes[:environment] = environment.try(:to_s) if defined?(ForemanPuppet)
+
+      attributes
     end
 
     private

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/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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FixMonitoringSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  def up
+    Setting.where(category: 'Setting::Monitoring').update_all(category: 'Setting') if column_exists?(:settings, :category)
+  end
+end

data/lib/foreman_monitoring/engine.rb

@@ -18,19 +18,31 @@ module ForemanMonitoring
       end
     end
 
-    initializer 'foreman_monitoring.load_default_settings',
-                :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 '>= 2.2'
+        requires_foreman '>= 3.0'
+
+        settings do
+          category(:monitoring, N_('Monitoring')) do
+            setting('monitoring_affect_global_status',
+                    type: :boolean,
+                    description: N_("Monitoring status will affect a host's global status when enabled"),
+                    default: true,
+                    full_name: N_('Monitoring status should affect global status'))
+            setting('monitoring_create_action',
+                    type: :string,
+                    description: N_('What action should be taken when a host is created'),
+                    default: 'create',
+                    full_name: N_('Host Create Action'),
+                    collection: proc { ::Monitoring::CREATE_ACTIONS })
+            setting('monitoring_delete_action',
+                    type: :string,
+                    description: N_('What action should be taken when a host is deleted'),
+                    default: 'delete',
+                    full_name: N_('Host Delete Action'),
+                    collection: proc { ::Monitoring::DELETE_ACTIONS })
+          end
+        end
 
         apipie_documented_controllers ["#{ForemanMonitoring::Engine.root}/app/controllers/api/v2/*.rb"]
 
@@ -74,14 +86,12 @@ module ForemanMonitoring
     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)
+      ::HostsHelper.prepend(ForemanMonitoring::HostsHelperExt)
+      ::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 = '2.1.0'
+  VERSION = '3.1.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/test_plugin_helper.rb

@@ -11,10 +11,6 @@ FactoryBot.reload
 # Foreman's setup doesn't handle cleaning up for Minitest::Spec
 DatabaseCleaner.strategy = :transaction
 
-def setup_settings
-  Setting::Monitoring.load_defaults
-end
-
 def disable_monitoring_orchestration
   ProxyAPI::Monitoring.any_instance.stubs(:query_host).returns({})
 end

data/test/unit/host_status/monitoring_status_test.rb

@@ -4,7 +4,6 @@ require 'test_plugin_helper'
 
 class MonitoringStatusTest < ActiveSupport::TestCase
   setup do
-    setup_settings
     disable_monitoring_orchestration
   end
 

data/test/unit/host_test.rb

@@ -5,7 +5,6 @@ require 'test_plugin_helper'
 class HostTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_orchestration
     disable_monitoring_orchestration
   end
@@ -62,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
@@ -84,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
@@ -135,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

data/test/unit/monitoring_result_test.rb

@@ -5,7 +5,6 @@ require 'test_plugin_helper'
 class MonitoringResultTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_orchestration
     disable_monitoring_orchestration
   end

data/test/unit/monitoring_test.rb

@@ -5,7 +5,6 @@ require 'test_plugin_helper'
 class MonitoringTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_monitoring_orchestration
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_monitoring
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2024-05-28 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
@@ -115,7 +59,6 @@ files:
 - app/models/concerns/orchestration/monitoring.rb
 - app/models/host_status/monitoring_status.rb
 - app/models/monitoring_result.rb
-- app/models/setting/monitoring.rb
 - app/overrides/add_host_monitoring_result_tab.rb
 - app/overrides/add_host_multiple_power_set_downtime_checkbox.rb
 - app/overrides/add_host_set_downtime_modal.rb
@@ -131,6 +74,7 @@ files:
 - 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/migrate/20221026065954_fix_monitoring_settings_category_to_dsl.rb
 - db/seeds.d/60-monitoring_proxy_feature.rb
 - lib/foreman_monitoring.rb
 - lib/foreman_monitoring/engine.rb
@@ -156,7 +100,7 @@ homepage: https://github.com/theforeman/foreman_monitoring
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,27 +108,30 @@ 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.0.3
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Foreman plugin for monitoring system integration.
 test_files:
+- test/controllers/api/v2/downtime_controller_test.rb
+- test/factories/feature.rb
 - test/factories/host.rb
 - test/factories/monitoring_results.rb
 - test/factories/smart_proxy.rb
-- test/factories/feature.rb
-- test/lib/proxy_api/monitoring_test.rb
 - test/functional/hosts_controller_test.rb
-- test/controllers/api/v2/downtime_controller_test.rb
+- test/lib/proxy_api/monitoring_test.rb
 - test/test_plugin_helper.rb
-- test/unit/monitoring_result_test.rb
+- test/unit/host_status/monitoring_status_test.rb
 - test/unit/host_test.rb
+- test/unit/monitoring_result_test.rb
 - test/unit/monitoring_test.rb
-- test/unit/host_status/monitoring_status_test.rb

data/app/models/setting/monitoring.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-class Setting
-  class Monitoring < ::Setting
-    def self.default_settings
-      [
-        set('monitoring_affect_global_status',
-            _("Monitoring status will affect a host's global status when enabled"),
-            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 }),
-        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 })
-      ]
-    end
-
-    def self.load_defaults
-      # Check the table exists
-      return unless super
-
-      self.transaction do
-        default_settings.each { |s| self.create! s.update(:category => 'Setting::Monitoring') }
-      end
-
-      true
-    end
-
-    def self.humanized_category
-      N_('Monitoring')
-    end
-  end
-end