foreman_default_hostgroup 2.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d454d40d36c903cdb01917607ff7bb5a95ec18f
-  data.tar.gz: a620ee8b99e5bf30147d2266378462473b326628
+SHA256:
+  metadata.gz: cbf9d232426c55fc207fed30c696a03c1268f02df5d481daf7bbaec627867a8b
+  data.tar.gz: b4e30338ca588f25c2ef0f74d383aa432357c5f94f9fae2603445107c55ae382
 SHA512:
-  metadata.gz: 79200d8486340a22124c1f4b8f7df6645db83fc0c4933cf7f0a9b1269acc5a11648b810718c1dd8a97a9f9a4b0d0bf98fc0bfb638b56616c530cb28e0a1d150b
-  data.tar.gz: 6e49893a8db8af0cde5e8dc7dd242e7de90569182555cfb3232a2c2eb7b01b7bade2ec248ac932714752fb3b7f14830f4acf6ecf4a6920af68faf7cf126afac6
+  metadata.gz: 965c2c192b549c92c474af2d6074a837e8f2ef9fe1241394f083ac519730aaab34732e3ccc99897c8521e97195dc81ab6cc5517f96f5aaa5b4dff4b326ce3209
+  data.tar.gz: 59434c38a0e0a3da2d63160ccebf1d06b08b6b3907df95455ba8229821d1302c7cad7471adae8e44e72c88c98a8265ab4efc88e27f599493b3ae761b40fbdd93

data/README.md

@@ -5,23 +5,26 @@ a Hostgroup set.
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
-for how to install Foreman plugins
+See Foreman's [plugin installation documentation](https://theforeman.org/plugins/#2.Installation).
 
 ## 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          | 2.1.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 |
 
 ## Usage
 
 The configuration is done inside foreman's plugin settings directory which is
-`~foreman/config/settings.plugins.d/`.
+`/etc/foreman/plugins/`.
 
 You can simply copy `default_hostgroup.yaml.example` and adjust it to fit
 your needs. The format is shown in the example. The simplest form would be:
@@ -34,14 +37,23 @@ your needs. The format is shown in the example. The simplest form would be:
       "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.
+
 *Important Note:* You have to restart foreman in order to apply changes in
 `default_hostgroup.yaml`!
 
 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/app/models/setting/default_hostgroup.rb

@@ -1,19 +1,21 @@
+# 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
-        [
-          self.set('force_hostgroup_match', 'Apply hostgroup matching even if a host already has one.', false),
-          self.set('force_hostgroup_match_only_new', 'Apply hostgroup matching only on new hosts', true),
-        ].compact.each { |s| self.create s.update(:category => 'Setting::DefaultHostgroup')}
-      end
+    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

data/default_hostgroup.yaml.example

@@ -0,0 +1,27 @@
+# Example default_hostgroup settings
+#
+# Must be placed in ~foreman/config/settings.plugins.d/
+#
+# :facts_map:
+#   <hostgroup>:
+#     <fact_name>: <regex>
+#
+# The Hostgroup is the full label, include any Parent Hostgroups, eg Base/Redhat
+#
+# The regex can be written either with or without the enclosing slashes:
+#   ^test$      - valid
+#   /^test$/    - also valid
+#
+# List the regexes in the order of priority, you can have as many as you like. The
+# first one to match will be used. Debug statements are written to the log if you
+# are getting the wrong group applied.
+---
+:default_hostgroup:
+  :facts_map:
+    "Redhat":
+      "osfamily": "RedHat"
+      "lsbdistcodename": "Santiago"
+    "Osx/Common":
+      "osfamily": "Darwin"
+    "Base":
+      "hostname": ".*"

data/lib/default_hostgroup_base_host_patch.rb

@@ -0,0 +1,99 @@
+module DefaultHostgroupBaseHostPatch
+  extend ActiveSupport::Concern
+
+  module ManagedOverrides
+    # 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)
+
+      # Module#prepend removes the import_facts_without_match_hostgroup method, so use
+      # a flag to return here if needed
+      return result if without_alias
+
+      # Check settings are created
+      return result unless settings_exist?
+
+      Rails.logger.debug "DefaultHostgroupMatch: performing Hostgroup match"
+
+      return result unless host_new_or_forced?
+      return result unless host_has_no_hostgroup_or_forced?
+
+      facts_map = SETTINGS[:default_hostgroup][:facts_map]
+      new_hostgroup = find_match(facts_map)
+
+      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}"
+
+      result
+    end
+  end
+
+  included do
+    prepend Overrides
+  end
+
+  def find_match(facts_map)
+    facts_map.each do |group_name, facts|
+      hg = Hostgroup.find_by(title: group_name)
+      return hg if hg.present? && group_matches?(facts)
+    end
+    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]
+      Rails.logger.info "Fact = #{fact_name}"
+      Rails.logger.info "Regex = #{fact_regex}"
+      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."
+      return false
+    end
+    true
+  end
+
+  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"
+        return false
+      end
+    end
+    true
+  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
+    end
+    true
+  end
+end

data/lib/foreman_default_hostgroup/engine.rb

@@ -1,28 +1,32 @@
-require 'default_hostgroup_managed_host_patch'
+require "default_hostgroup_base_host_patch"
 
 module ForemanDefaultHostgroup
-  #Inherit from the Rails module of the parent app (Foreman), not the plugin.
-  #Thus, inherits from ::Rails::Engine and not from Rails::Engine
   class Engine < ::Rails::Engine
+    engine_name "foreman_default_hostgroup"
 
-    # Load this before the Foreman config initizializers, so that the Setting.descendants
-    # list includes the plugin STI setting class
-    initializer 'foreman_discovery.load_default_settings', :before => :load_config_initializers do |app|
-      require_dependency File.expand_path("../../../app/models/setting/default_hostgroup.rb", __FILE__) if (Setting.table_exists? rescue(false))
+    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__
+      )
     end
 
-    initializer 'foreman_default_hostgroup.register_plugin', :after=> :finisher_hook do |app|
+    initializer "foreman_default_hostgroup.register_plugin",
+                before: :finisher_hook do
       Foreman::Plugin.register :foreman_default_hostgroup do
-      end if (Rails.env == "development" or defined? Foreman::Plugin)
+        requires_foreman ">= 2.2"
+      end
     end
 
     config.to_prepare do
-      ::Host::Managed.send :include, DefaultHostgroupManagedHostPatch
-    end
-
-    rake_tasks do
-      load "default_hostgroup.rake"
+      begin
+        ::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 = "2.1.0"
+  VERSION = '6.0.0'.freeze
 end

data/lib/tasks/foreman_default_hostgroup.rake

@@ -0,0 +1,36 @@
+require 'rake/testtask'
+# Tests
+namespace :test do
+  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]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_default_hostgroup do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_default_hostgroup) do |task|
+        task.patterns = ["#{ForemanDefaultHostgroup::Engine.root}/app/**/*.rb",
+                         "#{ForemanDefaultHostgroup::Engine.root}/lib/**/*.rb",
+                         "#{ForemanDefaultHostgroup::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_default_hostgroup'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_default_hostgroup']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_default_hostgroup', 'foreman_default_hostgroup:rubocop']
+end

data/test/test_plugin_helper.rb

@@ -1,6 +1,6 @@
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 
-# Add plugin to FactoryGirl's paths
-FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
-FactoryGirl.reload
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload

data/test/unit/default_hostgroup_test.rb

@@ -1,155 +1,223 @@
 require 'test_plugin_helper'
 
+# Tests for the plugin
 class DefaultHostgroupTest < ActiveSupport::TestCase
+  include FactImporterIsolation
+
+  allow_transactions_for_any_importer
+
   setup do
     disable_orchestration
-    User.current = User.find_by_login "admin"
-  end
-
-  def parse_json_fixture(relative_path)
-    return JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + relative_path)))
+    set_admin
+    setup_hostgroup_matchers
+    setup_host_and_facts
   end
 
-  def setup_hostgroup_match
+  def setup_hostgroup_matchers
     # The settings.yml fixture in Core wipes out the Setting table,
-    # so we use FactoryGirl to re-create it
-    FactoryGirl.create(:setting,
-                       :name => 'force_hostgroup_match',
-                       :category => 'Setting::DefaultHostgroup')
-    FactoryGirl.create(:setting,
-                       :name => 'force_hostgroup_match_only_new',
-                       :category => 'Setting::DefaultHostgroup')
+    # so we use FactoryBot to re-create it
+    FactoryBot.create(:setting,
+                      name: 'force_hostgroup_match',
+                      category: 'Setting::DefaultHostgroup')
+    FactoryBot.create(:setting,
+                      name: 'force_hostgroup_match_only_new',
+                      category: 'Setting::DefaultHostgroup')
+    FactoryBot.create(:setting,
+                      name: 'force_host_environment',
+                      category: 'Setting::DefaultHostgroup')
+    # Set the defaults
     Setting[:force_hostgroup_match] = false
     Setting[:force_hostgroup_match_only_new] = true
-    SETTINGS[:default_hostgroup] = Hash.new
-  end
-
-  test "full matching regex not enclosed in /" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Full" => {'hostname' =>'^sinn1636.lan$'} }
-
-    hostgroup = Hostgroup.create(:name => "Test Full")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+    Setting[:force_host_environment] = true
+
+    # Mimic plugin config fron config file
+    FactoryBot.create(:hostgroup, :with_environment, name: 'Test Default')
+    SETTINGS[:default_hostgroup] = {}
+    SETTINGS[:default_hostgroup][:facts_map] = {
+      'Test Default' => { 'hostname' => '.*' }
+    }
   end
 
-  test "partial matching regex enclosed in /" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Partial" => {'hostname' => '/\.lan$/' }}
-
-    hostgroup = Hostgroup.create(:name => "Test Partial")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  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')
+    @facts = raw['facts']
   end
 
-  test "invalid hostgroup name is ignored" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "Nonexistent Group" => {'hostname' => '.*'}, "Existent Group" => {'hostname' => '/\.lan$/'} }
+  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
+    end
 
-    hostgroup = Hostgroup.create(:name => "Existent Group")
-    raw = parse_json_fixture('/facts.json')
+    test 'matched host not updated if host already has a hostgroup' do
+      hostgroup = FactoryBot.create(:hostgroup)
+      @host.hostgroup = hostgroup
+      @host.save(validate: false)
 
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
-  end
+      assert @host.import_facts(@facts)
+      assert_equal hostgroup, Host.find_by(name: @name).hostgroup
+    end
 
-  test "first matching hostgroup is used" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "First Group" => {'hostname' => '.*'}, "Second Group" => {'hostname' => '.*'} }
+    test 'hostgroup is not updated if host is not new' do
+      @host.created_at = Time.current - 1000
+      @host.save(validate: false)
 
-    hostgroup = Hostgroup.create(:name => "First Group")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+      assert @host.import_facts(@facts)
+      assert_not Host.find_by(name: @name).hostgroup
+    end
   end
 
-  test "invalid keys ignored" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "First Group" => {'nosuchfact' => '.*', 'hostname' => '.*'} }
-
-    hostgroup = Hostgroup.create(:name => "First Group")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  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
 
-  test "unmatched values ignored" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "First Group" => {'hostname' => 'nosuchname', 'osfamily' => '.*'} }
-
-    hostgroup = Hostgroup.create(:name => "First Group")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  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)
+    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)
+    end
+
+    test 'matches first available hostgroup' do
+      facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
+        '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)
+    end
+
+    test 'nonexistant groups are ignored' do
+      facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
+        '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)
+    end
   end
 
-  test "default hostgroup" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' =>'.*'} }
-
-    hostgroup = Hostgroup.create(:name => "Test Default")
-    raw = parse_json_fixture('/facts.json')
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  context 'group_matches?' do
+    # 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)
+    end
+
+    test 'partial regex matches' do
+      regex = { 'hostname' => '.lan$' }
+      assert @host.import_facts(@facts, nil, true)
+      assert @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)
+    end
+
+    test 'invalid keys are ignored' do
+      regex = { 'nosuchfact' => '.*' }
+      assert @host.import_facts(@facts, nil, true)
+      assert_not @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)
+    end
+
+    test 'multiple entries with invalid keys / values match' do
+      regex = {
+        'nosuchfact' => '.*',
+        'osfamily' => 'nosuchos',
+        'hostname' => '.lan$'
+      }
+      assert @host.import_facts(@facts, nil, true)
+      assert @host.group_matches?(regex)
+    end
   end
 
-  test "host already has a hostgroup" do
-    setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
-
-    hostgroup = Hostgroup.create(:name => "Test Group")
-    Hostgroup.create(:name => "Test Default")
-    raw = parse_json_fixture('/facts.json')
-
-    host, result = Host.import_host_and_facts_without_match_hostgroup(raw['name'], raw['facts'])
-    host.hostgroup = hostgroup
-    host.save(:validate => false)
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  context 'settings_exist?' do
+    test 'true when Settings exist' do
+      h = FactoryBot.create(:host)
+      assert h.settings_exist?
+    end
+
+    test 'false when Settings are missing' do
+      SETTINGS[:default_hostgroup] = {}
+      h = FactoryBot.create(:host)
+      assert_not h.settings_exist?
+    end
   end
 
-  test "force hostgroup match on host with existing hostgroup" do
-    setup_hostgroup_match
-    Setting[:force_hostgroup_match] = true
-    Setting[:force_hostgroup_match_only_new] = false
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
-
-    hostgroup = Hostgroup.create(:name => "Test Group")
-    default = Hostgroup.create(:name => "Test Default")
-    raw = parse_json_fixture('/facts.json')
-
-    host, result = Host.import_host_and_facts_without_match_hostgroup(raw['name'], raw['facts'])
-    host.hostgroup = hostgroup
-    host.save(:validate => false)
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal default, Host.find_by_name('sinn1636.lan').hostgroup
+  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?
+    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?
+    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?
+    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?
+    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?
+    end
   end
 
-  test "hostgroup is not updated if host is not new" do
-    setup_hostgroup_match
-    Setting[:force_hostgroup_match] = true
-    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
-
-    hostgroup = Hostgroup.create(:name => "Test Group")
-    Hostgroup.create(:name => "Test Default")
-    raw = parse_json_fixture('/facts.json')
-
-    host, result = Host.import_host_and_facts_without_match_hostgroup(raw['name'], raw['facts'])
-    host.hostgroup = hostgroup
-    host.save(:validate => false)
-
-    assert Host.import_host_and_facts(raw['name'], raw['facts'])
-    assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+  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?
+    end
+
+    test 'false if host has hostgroup' do
+      h = FactoryBot.create(:host, :with_hostgroup)
+      assert_not 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?
+    end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Greg Sutcliffe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -22,19 +22,20 @@ files:
 - LICENSE
 - README.md
 - app/models/setting/default_hostgroup.rb
-- lib/default_hostgroup.rake
-- lib/default_hostgroup_managed_host_patch.rb
+- default_hostgroup.yaml.example
+- lib/default_hostgroup_base_host_patch.rb
 - lib/foreman_default_hostgroup.rb
 - lib/foreman_default_hostgroup/engine.rb
 - lib/foreman_default_hostgroup/version.rb
+- lib/tasks/foreman_default_hostgroup.rake
 - 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
@@ -49,12 +50,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Default Hostgroup Plugin for Foreman
 test_files:
 - test/test_plugin_helper.rb
-- test/unit/default_hostgroup_test.rb
 - test/unit/facts.json
+- test/unit/default_hostgroup_test.rb

data/lib/default_hostgroup.rake

@@ -1,21 +0,0 @@
-namespace :test do
-  desc "Test DefaultHostgroup plugin"
-  Rake::TestTask.new(:default_hostgroup) do |t|
-    test_dir = File.join(File.dirname(__FILE__), '..', 'test')
-    t.libs << ["test",test_dir]
-    t.pattern = "#{test_dir}/**/*_test.rb"
-    t.verbose = true
-  end
-
-end
-
-Rake::Task[:test].enhance do
-  Rake::Task['test:default_hostgroup'].invoke
-end
-
-load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:setup')
-  Rake::Task["jenkins:unit"].enhance do
-    Rake::Task['test:default_hostgroup'].invoke
-  end
-end

data/lib/default_hostgroup_managed_host_patch.rb

@@ -1,74 +0,0 @@
-module DefaultHostgroupManagedHostPatch
-  def self.included(base)
-    base.extend ClassMethods
-    base.class_eval do
-      class << self
-        alias_method_chain :import_host_and_facts, :match_hostgroup
-      end
-    end
-  end
-
-  module ClassMethods
-    def import_host_and_facts_with_match_hostgroup hostname, facts, certname = nil, proxy_id = nil
-      @host, result = import_host_and_facts_without_match_hostgroup(hostname, facts, certname, proxy_id)
-
-      unless SETTINGS[:default_hostgroup] && SETTINGS[:default_hostgroup][:facts_map]
-        Rails.logger.warn "DefaultHostgroupMatch: Could not load default_hostgroup map from settings, check config."
-        return @host, result
-      end
-
-      Rails.logger.debug "DefaultHostgroupMatch: performing Hostgroup match"
-
-      if Setting[:force_hostgroup_match_only_new]
-        # host.new_record? will only test for the early return in the core method, a real host
-        # will have already been saved at least once.
-        unless @host.present? && !@host.new_record? && @host.hostgroup.nil? && @host.reports.empty?
-
-          Rails.logger.debug "DefaultHostgroupMatch: skipping, host exists"
-          return @host, result
-        end
-      end
-
-      unless Setting[:force_hostgroup_match]
-        if @host.hostgroup.present?
-          Rails.logger.debug "DefaultHostgroupMatch: skipping, host has hostgroup"
-          return @host, result
-        end
-      end
-
-      facts_map = SETTINGS[:default_hostgroup][:facts_map]
-      new_hostgroup = find_match(facts_map)
-
-      return @host, result unless new_hostgroup
-
-      @host.hostgroup = new_hostgroup
-      @host.save(:validate => false)
-      Rails.logger.info "DefaultHostgroupMatch: #{hostname} added to #{new_hostgroup}"
-
-      return @host, result
-    end
-
-    def group_matches?(fact)
-      fact.each do |fact_name, fact_regex|
-        fact_regex.gsub!(/(\A\/|\/\z)/, '')
-        host_fact_value = @host.facts_hash[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)
-      end
-      return false
-    end
-
-    def find_match(facts_map)
-      facts_map.each do |group_name, facts|
-        return Hostgroup.find_by_title(group_name) if group_matches?(facts) and valid_hostgroup?(group_name)
-      end
-      Rails.logger.info "No match ..."
-      return false
-    end
-
-    def valid_hostgroup?(hostgroup)
-      Hostgroup.find_by_title(hostgroup) ? true : false
-    end
-  end
-end