foreman_default_hostgroup 5.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7312b3c6f0f24f26aa86fe8930f3c05bb41f844c8b1e968e24a96d980233a5be
-  data.tar.gz: 88c9aec69371906eed99689c20729b10e9a0e09a1cf506aa35b6b6fdfd972582
+  metadata.gz: 8e1266d987eb1c009c18ccbcb3d3b7c93da09b277465cead1fce9436bb7547d4
+  data.tar.gz: 88fe5230bca03cdef1808dd28d8f1778e7942db64b1b8716726f7d744cac9136
 SHA512:
-  metadata.gz: 126d928a10e32954e5a9e3661c2243b85668f3373da902deace6ce2e1f24b63c90190e5e9b8fe8ceba221bb7e3920a4c29191bd56ad228416b028d6ce52de577
-  data.tar.gz: 8b1d8acdf52bf758b689965cd3817bd6f00c05d7043e045f78c4d1f1f527ff4a504fd197acc23c2212213e0ed19a7cf6e73563ece0f0631a8d9ea7ef62be8663
+  metadata.gz: 937af6365b281ddd5cfc5131d7d4251c3d377bf13fa87e37329345e9dd69368ffbdf855cc26a1a11b937a81f9b9347d0a51ecf5e260d147855c04a59058fda58
+  data.tar.gz: 6d618171ba97d86e839d849dcac811f3ce6d42e92f5338c0f9cacf7010be3168fcc6422ec22ce37d83ce25f786fd649f9a97c6fb42cc64c5fdc02963b2f04cdd

data/README.md

@@ -10,15 +10,17 @@ See Foreman's [plugin installation documentation](https://theforeman.org/plugins
 ## Compatibility
 
 | Foreman Version | Plugin Version |
-| --------------- | --------------:|
-| <= 1.2          | 0.1.0          |
-|    1.3          | 1.0.1          |
-|    1.4          | 1.1.0          |
-|    1.5          | 2.0.1          |
-|    1.6 - 1.11   | 3.0.0          |
-| >= 1.12         | 4.0.0          |
-| >= 1.16         | 4.0.1          |
-| >= 1.16         | 5.0.0          |
+| --------------- | -------------: |
+| <= 1.2          |          0.1.0 |
+| 1.3             |          1.0.1 |
+| 1.4             |          1.1.0 |
+| 1.5             |          2.0.1 |
+| 1.6 - 1.11      |          3.0.0 |
+| >= 1.12         |          4.0.0 |
+| >= 1.16         |          4.0.1 |
+| >= 1.16         |          5.0.0 |
+| >= 2.2.0        |          6.0.0 |
+| >= 3.0          |          7.0.0 |
 
 ## Usage
 
@@ -35,6 +37,12 @@ your needs. The format is shown in the example. The simplest form would be:
     "Default":
       "hostname": ".*"
 ```
+
+`Default` is the host group name (more precisely title) that will be assigned if all its the rules matches.
+Under the host group name, there's a list of rules. If all of them (in this example just one) is matching,
+the host is assigned to the `Default` host group. The `hostname` is the name of the fact while the value `.*`
+is used as a regular expression. This rule means host with any `hostname` is added to the `Default` host group.
+
 If you are ugrading from plugin version 2.0.1 or older the format of this
 file changes and you will need modify `default_hostgroup.yaml.example` to
 follow the format above.
@@ -44,9 +52,9 @@ follow the format above.
 
 There are also two more settings under `Settings -> DefaultHostgroup`
 
-| Setting | Description |
-| ------- | ----------- |
-| `force_hostgroup_match` | Setting this to `true` will perform matching even on hosts that already have a hostgroup set. Enabling this needs `force_hostgroup_match_only_new` to be `false`.  Default: `false` |
+| Setting                          | Description                                                                                                                                                                                                          |
+| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `force_hostgroup_match`          | Setting this to `true` will perform matching even on hosts that already have a hostgroup set. Enabling this needs `force_hostgroup_match_only_new` to be `false`.  Default: `false`                                  |
 | `force_hostgroup_match_only_new` | Setting this to `true` will only perform matching when a host uploads its facts for the first time, i.e. after provisioning or when adding an existing puppetmaster and thus its nodes into foreman. Default: `true` |
 
 ## TODO

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')
+    # rubocop:enable Rails/SkipsModelValidations
+  end
+end

data/lib/default_hostgroup_base_host_patch.rb

@@ -2,13 +2,18 @@ module DefaultHostgroupBaseHostPatch
   extend ActiveSupport::Concern
 
   module ManagedOverrides
-    def import_facts(facts, source_proxy = nil, without = false)
+    # rubocop:disable Lint/UnusedMethodArgument
+    def import_facts(facts, source_proxy = nil, without_alias = false)
+      # rubocop:enable Lint/UnusedMethodArgument
       super(facts, source_proxy)
     end
   end
 
   module Overrides
+    # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
     def import_facts(facts, source_proxy = nil, without_alias = false)
+      # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity
+
       # Load the facts anyway, hook onto the end of it
       result = super(facts, source_proxy)
 
@@ -19,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?
@@ -29,12 +34,10 @@ module DefaultHostgroupBaseHostPatch
 
       return result unless new_hostgroup
 
-      self.hostgroup = new_hostgroup
-      if Setting[:force_host_environment] == true
-        self.environment = new_hostgroup.environment
-      end
-      save(validate: false)
-      Rails.logger.info "DefaultHostgroupMatch: #{hostname} added to #{new_hostgroup}"
+      self.host.hostgroup = new_hostgroup
+      self.host.environment = new_hostgroup.environment if Setting[:force_host_environment] == true and facts[:_type] == :puppet
+      self.host.save(validate: false)
+      Rails.logger.info "DefaultHostgroupMatch: #{facts["hostname"]} added to #{new_hostgroup}"
 
       result
     end
@@ -46,27 +49,27 @@ module DefaultHostgroupBaseHostPatch
 
   def find_match(facts_map)
     facts_map.each do |group_name, facts|
-      hg = Hostgroup.find_by_title(group_name)
+      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 = facts_hash[fact_name]
+      fact_regex.gsub!(%r{(\A/|/\z)}, "")
+      host_fact_value = self.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)
+      return true if Regexp.new(fact_regex).match?(host_fact_value)
     end
     false
   end
 
   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
@@ -75,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 - created_at) < 300)
-      unless new_host && hostgroup.nil? && reports.empty?
-        Rails.logger.debug 'DefaultHostgroupMatch: skipping, host exists'
+      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"
         return false
       end
     end
@@ -86,8 +89,8 @@ module DefaultHostgroupBaseHostPatch
 
   def host_has_no_hostgroup_or_forced?
     unless Setting[:force_hostgroup_match]
-      if hostgroup.present?
-        Rails.logger.debug 'DefaultHostgroupMatch: skipping, host has hostgroup'
+      if self.host.hostgroup.present?
+        Rails.logger.debug "DefaultHostgroupMatch: skipping, host has hostgroup"
         return false
       end
     end

data/lib/foreman_default_hostgroup/engine.rb

@@ -1,32 +1,49 @@
-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', __FILE__)
+    # 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 '>= 1.17'
+        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
-        ::Host::Base.send(:include, DefaultHostgroupBaseHostPatch)
-        ::Host::Managed.send(:prepend, DefaultHostgroupBaseHostPatch::ManagedOverrides)
-      rescue => e
+        ::HostFactImporter.include DefaultHostgroupBaseHostPatch
+        ::HostFactImporter.prepend DefaultHostgroupBaseHostPatch::ManagedOverrides
+      rescue StandardError => e
         Rails.logger.warn "ForemanDefaultHostgroup: skipping engine hook (#{e})"
       end
     end
-
   end
 end

data/lib/foreman_default_hostgroup/version.rb

@@ -1,3 +1,3 @@
 module ForemanDefaultHostgroup
-  VERSION = '5.0.0'.freeze
+  VERSION = '7.0.0'.freeze
 end

data/lib/tasks/foreman_default_hostgroup.rake

@@ -1,7 +1,7 @@
 require 'rake/testtask'
 # Tests
 namespace :test do
-  desc "Test DefaultHostgroup plugin"
+  desc 'Test DefaultHostgroup plugin'
   Rake::TestTask.new(:foreman_default_hostgroup) do |t|
     test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
     t.libs << ['test', test_dir]
@@ -20,7 +20,7 @@ namespace :foreman_default_hostgroup do
                          "#{ForemanDefaultHostgroup::Engine.root}/lib/**/*.rb",
                          "#{ForemanDefaultHostgroup::Engine.root}/test/**/*.rb"]
       end
-    rescue
+    rescue StandardError
       puts 'Rubocop not loaded.'
     end
 

data/test/unit/default_hostgroup_test.rb

@@ -18,20 +18,20 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     # so we use FactoryBot to re-create it
     FactoryBot.create(:setting,
                       name: 'force_hostgroup_match',
-                      category: 'Setting::DefaultHostgroup')
+                      category: 'Setting')
     FactoryBot.create(:setting,
                       name: 'force_hostgroup_match_only_new',
-                      category: 'Setting::DefaultHostgroup')
+                      category: 'Setting')
     FactoryBot.create(:setting,
                       name: 'force_host_environment',
-                      category: 'Setting::DefaultHostgroup')
+                      category: 'Setting')
     # 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' => '.*' }
@@ -40,15 +40,15 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   def setup_host_and_facts
     raw = JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + '/facts.json')))
-    @name  = raw['name']
-    @host  = Host.import_host(raw['name'], 'puppet')
+    @name = raw['name']
+    @host = Host.import_host(raw['name'], 'puppet')
     @facts = raw['facts']
   end
 
   context 'import_facts_with_match_hostgroup' do
     test 'matched host is saved with new hostgroup' do
       assert @host.import_facts(@facts)
-      assert_equal Hostgroup.find_by_name('Test Default'), Host.find_by_name(@name).hostgroup
+      assert_equal Hostgroup.find_by(name: 'Test Default'), Host.find_by(name: @name).hostgroup
     end
 
     test 'matched host not updated if host already has a hostgroup' do
@@ -57,7 +57,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
       @host.save(validate: false)
 
       assert @host.import_facts(@facts)
-      assert_equal hostgroup, Host.find_by_name(@name).hostgroup
+      assert_equal hostgroup, Host.find_by(name: @name).hostgroup
     end
 
     test 'hostgroup is not updated if host is not new' do
@@ -65,22 +65,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
       @host.save(validate: false)
 
       assert @host.import_facts(@facts)
-      refute 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)
-      refute_equal Hostgroup.find_by_name('Test Default').environment, h.environment
+      assert_not Host.find_by(name: @name).hostgroup
     end
   end
 
@@ -89,33 +74,33 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     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_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
     end
 
     test 'returns false for no match' do
       facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
-        'Test Default'     => { 'hostname' => 'nosuchhost' }
+        'Test Default' => { 'hostname' => 'nosuchhost' }
       }
       assert @host.import_facts(@facts, nil, true)
-      refute @host.find_match(facts_map)
+      assert_not @host.find_match(facts_map)
     end
 
     test 'matches first available hostgroup' do
       facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
-        'Test Default'     => { 'hostname' => '.*' },
+        '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_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
     end
 
     test 'nonexistant groups are ignored' do
       facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
         'Some Other Group' => { 'hostname' => '.*' },
-        'Test Default'     => { 'hostname' => '/\.lan$/' }
+        '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_equal Hostgroup.find_by(name: 'Test Default'), @host.find_match(facts_map)
     end
   end
 
@@ -142,20 +127,20 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     test 'invalid keys are ignored' do
       regex = { 'nosuchfact' => '.*' }
       assert @host.import_facts(@facts, nil, true)
-      refute @host.group_matches?(regex)
+      assert_not @host.group_matches?(regex)
     end
 
     test 'unmatched values are ignored' do
       regex = { 'hostname' => 'nosuchname' }
       assert @host.import_facts(@facts, nil, true)
-      refute @host.group_matches?(regex)
+      assert_not @host.group_matches?(regex)
     end
 
     test 'multiple entries with invalid keys / values match' do
       regex = {
         'nosuchfact' => '.*',
-        'osfamily'   => 'nosuchos',
-        'hostname'   => '.lan$'
+        'osfamily' => 'nosuchos',
+        'hostname' => '.lan$'
       }
       assert @host.import_facts(@facts, nil, true)
       assert @host.group_matches?(regex)
@@ -171,7 +156,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     test 'false when Settings are missing' do
       SETTINGS[:default_hostgroup] = {}
       h = FactoryBot.create(:host)
-      refute h.settings_exist?
+      assert_not h.settings_exist?
     end
   end
 
@@ -183,17 +168,17 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
     test 'false when host has existed for > 300s' do
       h = FactoryBot.create(:host, created_at: Time.current - 1000)
-      refute h.host_new_or_forced?
+      assert_not h.host_new_or_forced?
     end
 
     test 'false when host has a hostgroup' do
       h = FactoryBot.create(:host, :with_hostgroup, created_at: Time.current)
-      refute h.host_new_or_forced?
+      assert_not h.host_new_or_forced?
     end
 
     test 'false when host has reports' do
       h = FactoryBot.create(:host, :with_reports, created_at: Time.current)
-      refute h.host_new_or_forced?
+      assert_not h.host_new_or_forced?
     end
 
     test 'true when setting is forced' do
@@ -211,7 +196,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
     test 'false if host has hostgroup' do
       h = FactoryBot.create(:host, :with_hostgroup)
-      refute h.host_has_no_hostgroup_or_forced?
+      assert_not h.host_has_no_hostgroup_or_forced?
     end
 
     test 'true if host has hostgroup and setting forced' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Greg Sutcliffe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -21,7 +21,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
@@ -31,11 +31,11 @@ files:
 - test/test_plugin_helper.rb
 - test/unit/default_hostgroup_test.rb
 - test/unit/facts.json
-homepage: http://github.com/GregSutcliffe/foreman_default_hostgroup
+homepage: https://github.com/theforeman/foreman_default_hostgroup
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,9 +50,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Default Hostgroup Plugin for Foreman
 test_files:

data/app/models/setting/default_hostgroup.rb

@@ -1,19 +0,0 @@
-class Setting::DefaultHostgroup < ::Setting
-  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