foreman_default_hostgroup 6.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbf9d232426c55fc207fed30c696a03c1268f02df5d481daf7bbaec627867a8b
-  data.tar.gz: b4e30338ca588f25c2ef0f74d383aa432357c5f94f9fae2603445107c55ae382
+  metadata.gz: '08730dfb1749cc946d09ae2617082c8b5b0d3d9adbe2d1d4596139b9f02324b7'
+  data.tar.gz: 721b72f3b18205aefca9b3197762512a45c5ad00168da3abde9a0409222ed8f5
 SHA512:
-  metadata.gz: 965c2c192b549c92c474af2d6074a837e8f2ef9fe1241394f083ac519730aaab34732e3ccc99897c8521e97195dc81ab6cc5517f96f5aaa5b4dff4b326ce3209
-  data.tar.gz: 59434c38a0e0a3da2d63160ccebf1d06b08b6b3907df95455ba8229821d1302c7cad7471adae8e44e72c88c98a8265ab4efc88e27f599493b3ae761b40fbdd93
+  metadata.gz: bffa62fa45943f54e3903c58f76b33c51b28baf7875528ee2606118510f658803857d8d92888857356181c6d827a6df4e6384cb4b57bc0d9f8f8dd9b2934de29
+  data.tar.gz: e7e0d7c88f204afa63e06ef66b0add324809f3520b2d014cbd78830ae355ca1039bf06c5da4d48a645237ee6cfc9f28f5daf9873e23c6b3add3e0de918d48be7

data/README.md

@@ -20,6 +20,7 @@ See Foreman's [plugin installation documentation](https://theforeman.org/plugins
 | >= 1.16         |          4.0.1 |
 | >= 1.16         |          5.0.0 |
 | >= 2.2.0        |          6.0.0 |
+| >= 3.0          |          7.0.0 |
 
 ## Usage
 

data/db/migrate/20221103122801_fix_default_hostgroup_settings_category_to_dsl.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class FixDefaultHostgroupSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  def up
+    # rubocop:disable Rails/SkipsModelValidations
+    Setting.where(category: 'Setting::DefaultHostgroup').update_all(category: 'Setting') if column_exists?(:settings, :category)
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+end

data/lib/default_hostgroup_base_host_patch.rb

@@ -24,7 +24,7 @@ module DefaultHostgroupBaseHostPatch
       # Check settings are created
       return result unless settings_exist?
 
-      Rails.logger.debug "DefaultHostgroupMatch: performing Hostgroup match"
+      Rails.logger.debug 'DefaultHostgroupMatch: performing Hostgroup match'
 
       return result unless host_new_or_forced?
       return result unless host_has_no_hostgroup_or_forced?
@@ -34,10 +34,10 @@ module DefaultHostgroupBaseHostPatch
 
       return result unless new_hostgroup
 
-      self.host.hostgroup = new_hostgroup
-      self.host.environment = new_hostgroup.environment if Setting[:force_host_environment] == true
-      self.host.save(validate: false)
-      Rails.logger.info "DefaultHostgroupMatch: #{facts["hostname"]} added to #{new_hostgroup}"
+      host.hostgroup = new_hostgroup
+      host.environment = new_hostgroup.environment if (Setting[:force_host_environment] == true) && (facts[:_type] == :puppet)
+      host.save(validate: false)
+      Rails.logger.info "DefaultHostgroupMatch: #{facts['hostname']} added to #{new_hostgroup}"
 
       result
     end
@@ -52,14 +52,14 @@ module DefaultHostgroupBaseHostPatch
       hg = Hostgroup.find_by(title: group_name)
       return hg if hg.present? && group_matches?(facts)
     end
-    Rails.logger.info "No match ..."
+    Rails.logger.info 'No match ...'
     false
   end
 
   def group_matches?(facts)
     facts.each do |fact_name, fact_regex|
-      fact_regex.gsub!(%r{(\A/|/\z)}, "")
-      host_fact_value = self.host.facts[fact_name]
+      fact_regex.gsub!(%r{(\A/|/\z)}, '')
+      host_fact_value = host.facts[fact_name]
       Rails.logger.info "Fact = #{fact_name}"
       Rails.logger.info "Regex = #{fact_regex}"
       return true if Regexp.new(fact_regex).match?(host_fact_value)
@@ -69,7 +69,7 @@ module DefaultHostgroupBaseHostPatch
 
   def settings_exist?
     unless SETTINGS[:default_hostgroup] && SETTINGS[:default_hostgroup][:facts_map]
-      Rails.logger.warn "DefaultHostgroupMatch: Could not load :default_hostgroup map from Settings."
+      Rails.logger.warn 'DefaultHostgroupMatch: Could not load :default_hostgroup map from Settings.'
       return false
     end
     true
@@ -78,9 +78,9 @@ module DefaultHostgroupBaseHostPatch
   def host_new_or_forced?
     if Setting[:force_hostgroup_match_only_new]
       # hosts have already been saved during import_host, so test the creation age instead
-      new_host = ((Time.current - self.host.created_at) < 300)
-      unless new_host && self.host.hostgroup.nil? && self.host.reports.empty?
-        Rails.logger.debug "DefaultHostgroupMatch: skipping, host exists"
+      new_host = ((Time.current - host.created_at) < 300)
+      unless new_host && host.hostgroup.nil? && host.reports.empty?
+        Rails.logger.debug 'DefaultHostgroupMatch: skipping, host exists'
         return false
       end
     end
@@ -88,11 +88,9 @@ module DefaultHostgroupBaseHostPatch
   end
 
   def host_has_no_hostgroup_or_forced?
-    unless Setting[:force_hostgroup_match]
-      if self.host.hostgroup.present?
-        Rails.logger.debug "DefaultHostgroupMatch: skipping, host has hostgroup"
-        return false
-      end
+    if !Setting[:force_hostgroup_match] && host.hostgroup.present?
+      Rails.logger.debug 'DefaultHostgroupMatch: skipping, host has hostgroup'
+      return false
     end
     true
   end

data/lib/foreman_default_hostgroup/engine.rb

@@ -1,32 +1,45 @@
-require "default_hostgroup_base_host_patch"
+require 'default_hostgroup_base_host_patch'
 
 module ForemanDefaultHostgroup
   class Engine < ::Rails::Engine
-    engine_name "foreman_default_hostgroup"
+    engine_name 'foreman_default_hostgroup'
 
     config.autoload_paths += Dir["#{config.root}/app/models"]
 
-    initializer "foreman_default_hostgroup.load_default_settings",
-                before: :load_config_initializers do
-      require_dependency File.expand_path(
-        "../../app/models/setting/default_hostgroup.rb", __dir__
-      )
+    # Add any db migrations
+    initializer 'foreman_default_hostgroup.load_app_instance_data' do |app|
+      ForemanDefaultHostgroup::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
     end
 
-    initializer "foreman_default_hostgroup.register_plugin",
+    initializer 'foreman_default_hostgroup.register_plugin',
                 before: :finisher_hook do
       Foreman::Plugin.register :foreman_default_hostgroup do
-        requires_foreman ">= 2.2"
+        requires_foreman '>= 3.0'
+
+        settings do
+          category(:default_hostgroup, N_('Default Hostgroup')) do
+            setting('force_hostgroup_match',
+                    type: :boolean,
+                    description: 'Apply hostgroup matching even if a host already has one.',
+                    default: false)
+            setting('force_hostgroup_match_only_new',
+                    type: :boolean,
+                    description: 'Apply hostgroup matching only on new hosts',
+                    default: true)
+            setting('force_host_environment',
+                    type: :boolean,
+                    description: "Apply hostgroup's environment to host even if a host already has a different one",
+                    default: true)
+          end
+        end
       end
     end
 
     config.to_prepare do
-      begin
-        ::HostFactImporter.include DefaultHostgroupBaseHostPatch
-        ::HostFactImporter.prepend DefaultHostgroupBaseHostPatch::ManagedOverrides
-      rescue StandardError => e
-        Rails.logger.warn "ForemanDefaultHostgroup: skipping engine hook (#{e})"
-      end
+      ::HostFactImporter.include DefaultHostgroupBaseHostPatch
+      ::HostFactImporter.prepend DefaultHostgroupBaseHostPatch::ManagedOverrides
     end
   end
 end

data/lib/foreman_default_hostgroup/version.rb

@@ -1,3 +1,3 @@
 module ForemanDefaultHostgroup
-  VERSION = '6.0.0'.freeze
+  VERSION = '7.1.0'.freeze
 end

data/test/unit/default_hostgroup_test.rb

@@ -17,21 +17,18 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     # The settings.yml fixture in Core wipes out the Setting table,
     # so we use FactoryBot to re-create it
     FactoryBot.create(:setting,
-                      name: 'force_hostgroup_match',
-                      category: 'Setting::DefaultHostgroup')
+                      name: 'force_hostgroup_match')
     FactoryBot.create(:setting,
-                      name: 'force_hostgroup_match_only_new',
-                      category: 'Setting::DefaultHostgroup')
+                      name: 'force_hostgroup_match_only_new')
     FactoryBot.create(:setting,
-                      name: 'force_host_environment',
-                      category: 'Setting::DefaultHostgroup')
+                      name: 'force_host_environment')
     # Set the defaults
     Setting[:force_hostgroup_match] = false
     Setting[:force_hostgroup_match_only_new] = true
     Setting[:force_host_environment] = true
 
     # Mimic plugin config fron config file
-    FactoryBot.create(:hostgroup, :with_environment, name: 'Test Default')
+    FactoryBot.create(:hostgroup, name: 'Test Default')
     SETTINGS[:default_hostgroup] = {}
     SETTINGS[:default_hostgroup][:facts_map] = {
       'Test Default' => { 'hostname' => '.*' }
@@ -39,7 +36,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
   end
 
   def setup_host_and_facts
-    raw = JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + '/facts.json')))
+    raw = JSON.parse(File.read(File.join(__dir__, 'facts.json')))
     @name = raw['name']
     @host = Host.import_host(raw['name'], 'puppet')
     @facts = raw['facts']
@@ -47,7 +44,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   context 'import_facts_with_match_hostgroup' do
     test 'matched host is saved with new hostgroup' do
-      assert @host.import_facts(@facts)
+      assert HostFactImporter.new(@host).import_facts(@facts)
       assert_equal Hostgroup.find_by(name: 'Test Default'), Host.find_by(name: @name).hostgroup
     end
 
@@ -56,7 +53,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
       @host.hostgroup = hostgroup
       @host.save(validate: false)
 
-      assert @host.import_facts(@facts)
+      assert HostFactImporter.new(@host).import_facts(@facts)
       assert_equal hostgroup, Host.find_by(name: @name).hostgroup
     end
 
@@ -64,40 +61,25 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
       @host.created_at = Time.current - 1000
       @host.save(validate: false)
 
-      assert @host.import_facts(@facts)
+      assert HostFactImporter.new(@host).import_facts(@facts)
       assert_not Host.find_by(name: @name).hostgroup
     end
   end
 
-  context 'force host environment setting' do
-    test 'environment is updated if enabled' do
-      h = FactoryBot.create(:host, :with_environment, created_at: Time.current)
-      h.import_facts(@facts)
-      assert_equal Hostgroup.find_by(name: 'Test Default').environment, h.environment
-    end
-
-    test 'environment not updated if disabled' do
-      Setting[:force_host_environment] = false
-      h = FactoryBot.create(:host, :with_environment, created_at: Time.current)
-      h.import_facts(@facts)
-      assert_not_equal Hostgroup.find_by(name: 'Test Default').environment, h.environment
-    end
-  end
-
   context 'find_match' do
     # takes a config map, returns a group or false
     test 'match a single hostgroup' do
       facts_map = SETTINGS[:default_hostgroup][:facts_map]
-      assert @host.import_facts(@facts, nil, true)
-      assert_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_equal Hostgroup.find_by(name: 'Test Default'), HostFactImporter.new(@host).find_match(facts_map)
     end
 
     test 'returns false for no match' do
       facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
         'Test Default' => { 'hostname' => 'nosuchhost' }
       }
-      assert @host.import_facts(@facts, nil, true)
-      assert_not @host.find_match(facts_map)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_not HostFactImporter.new(@host).find_match(facts_map)
     end
 
     test 'matches first available hostgroup' do
@@ -105,8 +87,8 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'Test Default' => { 'hostname' => '.*' },
         'Some Other Group' => { 'hostname' => '/\.lan$/' }
       }
-      assert @host.import_facts(@facts, nil, true)
-      assert_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_equal Hostgroup.find_by(name: 'Test Default'), HostFactImporter.new(@host).find_match(facts_map)
     end
 
     test 'nonexistant groups are ignored' do
@@ -114,8 +96,8 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'Some Other Group' => { 'hostname' => '.*' },
         'Test Default' => { 'hostname' => '/\.lan$/' }
       }
-      assert @host.import_facts(@facts, nil, true)
-      assert_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_equal Hostgroup.find_by(name: 'Test Default'), HostFactImporter.new(@host).find_match(facts_map)
     end
   end
 
@@ -123,32 +105,32 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     # passing a hash of (group_name, regex) pairs
     test 'full regex matches' do
       regex = { 'hostname' => '^sinn1636.lan$' }
-      assert @host.import_facts(@facts, nil, true)
-      assert @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert HostFactImporter.new(@host).group_matches?(regex)
     end
 
     test 'partial regex matches' do
       regex = { 'hostname' => '.lan$' }
-      assert @host.import_facts(@facts, nil, true)
-      assert @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert HostFactImporter.new(@host).group_matches?(regex)
     end
 
     test 'regex slashes are stripped' do
       regex = { 'hostname' => '/\.lan$/' }
-      assert @host.import_facts(@facts, nil, true)
-      assert @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert HostFactImporter.new(@host).group_matches?(regex)
     end
 
     test 'invalid keys are ignored' do
       regex = { 'nosuchfact' => '.*' }
-      assert @host.import_facts(@facts, nil, true)
-      assert_not @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_not HostFactImporter.new(@host).group_matches?(regex)
     end
 
     test 'unmatched values are ignored' do
       regex = { 'hostname' => 'nosuchname' }
-      assert @host.import_facts(@facts, nil, true)
-      assert_not @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert_not HostFactImporter.new(@host).group_matches?(regex)
     end
 
     test 'multiple entries with invalid keys / values match' do
@@ -157,67 +139,67 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'osfamily' => 'nosuchos',
         'hostname' => '.lan$'
       }
-      assert @host.import_facts(@facts, nil, true)
-      assert @host.group_matches?(regex)
+      assert HostFactImporter.new(@host).import_facts(@facts, nil, true)
+      assert HostFactImporter.new(@host).group_matches?(regex)
     end
   end
 
   context 'settings_exist?' do
     test 'true when Settings exist' do
       h = FactoryBot.create(:host)
-      assert h.settings_exist?
+      assert HostFactImporter.new(h).settings_exist?
     end
 
     test 'false when Settings are missing' do
       SETTINGS[:default_hostgroup] = {}
       h = FactoryBot.create(:host)
-      assert_not h.settings_exist?
+      assert_not HostFactImporter.new(h).settings_exist?
     end
   end
 
   context 'host_new_or_forced?' do
     test 'true when host is new' do
       h = FactoryBot.create(:host, created_at: Time.current)
-      assert h.host_new_or_forced?
+      assert HostFactImporter.new(h).host_new_or_forced?
     end
 
     test 'false when host has existed for > 300s' do
       h = FactoryBot.create(:host, created_at: Time.current - 1000)
-      assert_not h.host_new_or_forced?
+      assert_not HostFactImporter.new(h).host_new_or_forced?
     end
 
     test 'false when host has a hostgroup' do
       h = FactoryBot.create(:host, :with_hostgroup, created_at: Time.current)
-      assert_not h.host_new_or_forced?
+      assert_not HostFactImporter.new(h).host_new_or_forced?
     end
 
     test 'false when host has reports' do
       h = FactoryBot.create(:host, :with_reports, created_at: Time.current)
-      assert_not h.host_new_or_forced?
+      assert_not HostFactImporter.new(h).host_new_or_forced?
     end
 
     test 'true when setting is forced' do
       Setting[:force_hostgroup_match_only_new] = false
       h = FactoryBot.create(:host, :with_hostgroup, created_at: Time.current)
-      assert h.host_new_or_forced?
+      assert HostFactImporter.new(h).host_new_or_forced?
     end
   end
 
   context 'host_has_no_hostgroup_or_forced?' do
     test 'true if host has no hostgroup' do
       h = FactoryBot.create(:host)
-      assert h.host_has_no_hostgroup_or_forced?
+      assert HostFactImporter.new(h).host_has_no_hostgroup_or_forced?
     end
 
     test 'false if host has hostgroup' do
       h = FactoryBot.create(:host, :with_hostgroup)
-      assert_not h.host_has_no_hostgroup_or_forced?
+      assert_not HostFactImporter.new(h).host_has_no_hostgroup_or_forced?
     end
 
     test 'true if host has hostgroup and setting forced' do
       Setting[:force_hostgroup_match] = true
       h = FactoryBot.create(:host, :with_hostgroup)
-      assert h.host_has_no_hostgroup_or_forced?
+      assert HostFactImporter.new(h).host_has_no_hostgroup_or_forced?
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Greg Sutcliffe
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -21,7 +20,7 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- app/models/setting/default_hostgroup.rb
+- db/migrate/20221103122801_fix_default_hostgroup_settings_category_to_dsl.rb
 - default_hostgroup.yaml.example
 - lib/default_hostgroup_base_host_patch.rb
 - lib/foreman_default_hostgroup.rb
@@ -35,7 +34,6 @@ homepage: https://github.com/theforeman/foreman_default_hostgroup
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,18 +41,20 @@ 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.6.2
 specification_version: 4
 summary: Default Hostgroup Plugin for Foreman
 test_files:
 - test/test_plugin_helper.rb
-- test/unit/facts.json
 - test/unit/default_hostgroup_test.rb
+- test/unit/facts.json

data/app/models/setting/default_hostgroup.rb

@@ -1,21 +0,0 @@
-# rubocop:disable Style/ClassAndModuleChildren
-class Setting::DefaultHostgroup < ::Setting
-  # rubocop:enable Style/ClassAndModuleChildren
-  BLANK_ATTRS << 'default_hostgroup'
-
-  def self.load_defaults
-    # Check the table exists
-    return unless ActiveRecord::Base.connection.table_exists?('settings')
-    return unless super
-
-    Setting.transaction do
-      [
-        set('force_hostgroup_match', 'Apply hostgroup matching even if a host already has one.', false),
-        set('force_hostgroup_match_only_new', 'Apply hostgroup matching only on new hosts', true),
-        set('force_host_environment', "Apply hostgroup's environment to host even if a host already has a different one", true)
-      ].compact.each { |s| create s.update(category: 'Setting::DefaultHostgroup') }
-    end
-
-    true
-  end
-end