foreman_default_hostgroup 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eea2c1504b131e0856539a55695b98550c20114169a60dd36e300a8745e748d9
-  data.tar.gz: 1f7098318bbb2dc3bab72be79766c80f787922a1ba13542a74d2f8729285c591
+  metadata.gz: 7312b3c6f0f24f26aa86fe8930f3c05bb41f844c8b1e968e24a96d980233a5be
+  data.tar.gz: 88c9aec69371906eed99689c20729b10e9a0e09a1cf506aa35b6b6fdfd972582
 SHA512:
-  metadata.gz: 1091a967380e92d8653b7b80085919371dd03d2538380c950bad23e54a02a890de8c481ab409aceaaa052f539e14c5994c43c52bf99a6896b4961c1083d1246f
-  data.tar.gz: 8a35fbe829648e2f5e92517dfa519e0287d95604db70c1460e1aac0c1f0df4cdce6460e762b46eafa2ed8d480677f1b54b4e5566840b5877d1997aa9d227afed
+  metadata.gz: 126d928a10e32954e5a9e3661c2243b85668f3373da902deace6ce2e1f24b63c90190e5e9b8fe8ceba221bb7e3920a4c29191bd56ad228416b028d6ce52de577
+  data.tar.gz: 8b1d8acdf52bf758b689965cd3817bd6f00c05d7043e045f78c4d1f1f527ff4a504fd197acc23c2212213e0ed19a7cf6e73563ece0f0631a8d9ea7ef62be8663

data/README.md

@@ -17,6 +17,8 @@ See Foreman's [plugin installation documentation](https://theforeman.org/plugins
 |    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          |
 
 ## Usage
 

data/lib/default_hostgroup_base_host_patch.rb

@@ -1,34 +1,47 @@
 module DefaultHostgroupBaseHostPatch
   extend ActiveSupport::Concern
 
-  included do
-    alias_method_chain :import_facts, :match_hostgroup
+  module ManagedOverrides
+    def import_facts(facts, source_proxy = nil, without = false)
+      super(facts, source_proxy)
+    end
   end
 
-  def import_facts_with_match_hostgroup(facts)
-    # Load the facts anyway, hook onto the end of it
-    result = import_facts_without_match_hostgroup(facts)
+  module Overrides
+    def import_facts(facts, source_proxy = nil, without_alias = false)
+      # Load the facts anyway, hook onto the end of it
+      result = super(facts, source_proxy)
 
-    return result unless settings_exist?
+      # Module#prepend removes the import_facts_without_match_hostgroup method, so use
+      # a flag to return here if needed
+      return result if without_alias
 
-    Rails.logger.debug 'DefaultHostgroupMatch: performing Hostgroup match'
+      # Check settings are created
+      return result unless settings_exist?
 
-    return result unless host_new_or_forced?
-    return result unless host_has_no_hostgroup_or_forced?
+      Rails.logger.debug 'DefaultHostgroupMatch: performing Hostgroup match'
 
-    facts_map = SETTINGS[:default_hostgroup][:facts_map]
-    new_hostgroup = find_match(facts_map)
+      return result unless host_new_or_forced?
+      return result unless host_has_no_hostgroup_or_forced?
 
-    return result unless new_hostgroup
+      facts_map = SETTINGS[:default_hostgroup][:facts_map]
+      new_hostgroup = find_match(facts_map)
 
-    self.hostgroup = new_hostgroup
-    if Setting[:force_host_environment] == true
-      self.environment = new_hostgroup.environment
+      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}"
+
+      result
     end
-    save(validate: false)
-    Rails.logger.info "DefaultHostgroupMatch: #{hostname} added to #{new_hostgroup}"
+  end
 
-    result
+  included do
+    prepend Overrides
   end
 
   def find_match(facts_map)

data/lib/foreman_default_hostgroup/engine.rb

@@ -1,12 +1,11 @@
 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'
 
+    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(
@@ -16,20 +15,18 @@ module ForemanDefaultHostgroup
     initializer 'foreman_default_hostgroup.register_plugin',
                 before: :finisher_hook do
       Foreman::Plugin.register :foreman_default_hostgroup do
-        requires_foreman '>= 1.12'
+        requires_foreman '>= 1.17'
       end
     end
 
     config.to_prepare do
       begin
         ::Host::Base.send(:include, DefaultHostgroupBaseHostPatch)
+        ::Host::Managed.send(:prepend, DefaultHostgroupBaseHostPatch::ManagedOverrides)
       rescue => e
         Rails.logger.warn "ForemanDefaultHostgroup: skipping engine hook (#{e})"
       end
     end
 
-    rake_tasks do
-      load 'default_hostgroup.rake'
-    end
   end
 end

data/lib/foreman_default_hostgroup/version.rb

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

data/lib/{default_hostgroup.rake → tasks/foreman_default_hostgroup.rake}

@@ -1,11 +1,13 @@
+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]
+    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
 

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

@@ -2,32 +2,36 @@ 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'
+    set_admin
     setup_hostgroup_matchers
     setup_host_and_facts
   end
 
   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')
-    FactoryGirl.create(:setting,
-                       name: 'force_host_environment',
-                       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
     Setting[:force_host_environment] = true
 
     # Mimic plugin config fron config file
-    FactoryGirl.create(:hostgroup, :with_environment, name: 'Test Default')
+    FactoryBot.create(:hostgroup, :with_environment, name: 'Test Default')
     SETTINGS[:default_hostgroup] = {}
     SETTINGS[:default_hostgroup][:facts_map] = {
       'Test Default' => { 'hostname' => '.*' }
@@ -48,7 +52,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     end
 
     test 'matched host not updated if host already has a hostgroup' do
-      hostgroup = FactoryGirl.create(:hostgroup)
+      hostgroup = FactoryBot.create(:hostgroup)
       @host.hostgroup = hostgroup
       @host.save(validate: false)
 
@@ -67,14 +71,14 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   context 'force host environment setting' do
     test 'environment is updated if enabled' do
-      h = FactoryGirl.create(:host, :with_environment, created_at: Time.current)
+      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 = FactoryGirl.create(:host, :with_environment, created_at: Time.current)
+      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
     end
@@ -84,7 +88,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     # 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_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       assert_equal Hostgroup.find_by_name('Test Default'), @host.find_match(facts_map)
     end
 
@@ -92,7 +96,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
       facts_map = SETTINGS[:default_hostgroup][:facts_map] = {
         'Test Default'     => { 'hostname' => 'nosuchhost' }
       }
-      assert @host.import_facts_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       refute @host.find_match(facts_map)
     end
 
@@ -101,7 +105,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'Test Default'     => { 'hostname' => '.*' },
         'Some Other Group' => { 'hostname' => '/\.lan$/' }
       }
-      assert @host.import_facts_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       assert_equal Hostgroup.find_by_name('Test Default'), @host.find_match(facts_map)
     end
 
@@ -110,7 +114,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'Some Other Group' => { 'hostname' => '.*' },
         'Test Default'     => { 'hostname' => '/\.lan$/' }
       }
-      assert @host.import_facts_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       assert_equal Hostgroup.find_by_name('Test Default'), @host.find_match(facts_map)
     end
   end
@@ -119,31 +123,31 @@ 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_without_match_hostgroup(@facts)
+      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_without_match_hostgroup(@facts)
+      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_without_match_hostgroup(@facts)
+      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_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       refute @host.group_matches?(regex)
     end
 
     test 'unmatched values are ignored' do
       regex = { 'hostname' => 'nosuchname' }
-      assert @host.import_facts_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       refute @host.group_matches?(regex)
     end
 
@@ -153,66 +157,66 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
         'osfamily'   => 'nosuchos',
         'hostname'   => '.lan$'
       }
-      assert @host.import_facts_without_match_hostgroup(@facts)
+      assert @host.import_facts(@facts, nil, true)
       assert @host.group_matches?(regex)
     end
   end
 
   context 'settings_exist?' do
     test 'true when Settings exist' do
-      h = FactoryGirl.create(:host)
+      h = FactoryBot.create(:host)
       assert h.settings_exist?
     end
 
     test 'false when Settings are missing' do
       SETTINGS[:default_hostgroup] = {}
-      h = FactoryGirl.create(:host)
+      h = FactoryBot.create(:host)
       refute h.settings_exist?
     end
   end
 
   context 'host_new_or_forced?' do
     test 'true when host is new' do
-      h = FactoryGirl.create(:host, created_at: Time.current)
+      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 = FactoryGirl.create(:host, created_at: Time.current - 1000)
+      h = FactoryBot.create(:host, created_at: Time.current - 1000)
       refute h.host_new_or_forced?
     end
 
     test 'false when host has a hostgroup' do
-      h = FactoryGirl.create(:host, :with_hostgroup, created_at: Time.current)
+      h = FactoryBot.create(:host, :with_hostgroup, created_at: Time.current)
       refute h.host_new_or_forced?
     end
 
     test 'false when host has reports' do
-      h = FactoryGirl.create(:host, :with_reports, created_at: Time.current)
+      h = FactoryBot.create(:host, :with_reports, created_at: Time.current)
       refute h.host_new_or_forced?
     end
 
     test 'true when setting is forced' do
       Setting[:force_hostgroup_match_only_new] = false
-      h = FactoryGirl.create(:host, :with_hostgroup, created_at: Time.current)
+      h = FactoryBot.create(:host, :with_hostgroup, created_at: Time.current)
       assert h.host_new_or_forced?
     end
   end
 
   context 'host_has_no_hostgroup_or_forced?' do
     test 'true if host has no hostgroup' do
-      h = FactoryGirl.create(:host)
+      h = FactoryBot.create(:host)
       assert h.host_has_no_hostgroup_or_forced?
     end
 
     test 'false if host has hostgroup' do
-      h = FactoryGirl.create(:host, :with_hostgroup)
+      h = FactoryBot.create(:host, :with_hostgroup)
       refute h.host_has_no_hostgroup_or_forced?
     end
 
     test 'true if host has hostgroup and setting forced' do
       Setting[:force_hostgroup_match] = true
-      h = FactoryGirl.create(:host, :with_hostgroup)
+      h = FactoryBot.create(:host, :with_hostgroup)
       assert h.host_has_no_hostgroup_or_forced?
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -23,11 +23,11 @@ files:
 - README.md
 - app/models/setting/default_hostgroup.rb
 - default_hostgroup.yaml.example
-- lib/default_hostgroup.rake
 - 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
@@ -51,11 +51,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 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