foreman_default_hostgroup 1.1.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjIyNTViYmQ0MmVjZTkxZDU2N2JlZDNkY2ZiNmRiNTJkNTE1MzYxOQ==
+    MjlmNWYzMGJjMGZiMTNiNWYwNTU4YTJiNThlYjk5MjZhZjBhYzM0Yw==
   data.tar.gz: !binary |-
-    MDQ1ZTIwZDczYWYyNzgwYzQxYTk1ODdiOTgzMmI5MWJmMzAyYzQzZA==
+    Yjg1MjJhMTFlYzY0YjQ4YWM2MTdlY2E3YjY4YmFkYmM3Njc0ZjZmMw==
 SHA512:
   metadata.gz: !binary |-
-    ZDQyMTNlOWU0ZWIyYmQ0MzA5MGNiNmQ3Njc4M2JkMTBiMDM0MTA3OTlkMTNk
-    M2NmYzU2ZjNkMjc0MzYzZGEzNzhkNDM2MTlmODMwMWU5ZjIzOTEyYWEzZDU3
-    OTRhMWRiYTAxNzllOGE5ZjkwYmQyZTg5ZDY4MzM1ZmM1NDk1ODc=
+    YTMzNGEzNDA3OGM1YTEwZGQ4MmRhMWI0MjZlYzgwNzZiYmE0MGE2NDZjYjMz
+    NGU5OGI0ZGQ4YTMyMWE1NzcxOTY0OWQ5ODlmYmQ4ODU4YjA0NWM0MzhhZTkz
+    NDczODMwNDRiNTNjN2FhYjgxODdhMzM5YjFlM2IwZTk5YTU0MzM=
   data.tar.gz: !binary |-
-    M2E4MDBlNDg2ZDBiYjMxNWE3OWY1OTJiMzU3NGMyYTQwOGYwNjNkMWIxZTg0
-    ZGU1ZTRmMzcxYmIxNDljNjc4OGEwNGRiZWUyODJjZWUxOTE5N2FmOTdiYmY1
-    ZWVkMzgwN2FlNWVlMDMxZmQ2YmU2Nzg2OTQ4OTgxNmFmNjdlNTk=
+    NjliZmFjMTEyZWUzYTQ0MWJlZmI5Y2IxYTA5MDU3N2FiNGE2YWE3NmY3MDk1
+    YjVmYzQyMjUyMzMyOGZlMDlmNThjMjI0NWZjZDNkMWEwNjk5MjBiYmNiYzkw
+    NWVlNWUwMWJhYTkyZGRlMjdiODdmODg3YzhhNGM5NDVmOWI3Y2I=

data/README.md

@@ -13,25 +13,38 @@ for how to install Foreman plugins
 | Foreman Version | Plugin Version |
 | --------------- | --------------:|
 | <= 1.2          | 0.1.0          |
-| >= 1.3          | 1.0.1          |
+|    1.3          | 1.0.1          |
+|    1.4          | 1.1.0          |
+| >= 1.5          | 2.0.0          |
 
 ## Usage
 
-Go to `Settings -> DefaultHostgroup` and enter the name of the default
-hostgroup. Leaving this blank disables the plugin. Nested Hostgroups should be
-specified with the full label, e.g. `Base/Level1/Level2`
+The configuration is done inside foreman's plugin settings directory which is
+```~foreman/config/settings.plugins.d/```.
 
-Once set, any fact upload to `/api/hosts/facts` for a Host with no Hostgroup set
-will cause the Hostgroup to be set to the value in the Settings. This happens
-*before* the ENC data is downloaded, meaning it applies for a Host's very first
-run.
+You can simply copy ```default_hostgroup.yaml.example``` and adjust it to fit
+your needs. The simplest example would be:
 
-The plugin only sets the Hostgroup for Hosts which have no Hostgroup, and no
-reports (i.e new Hosts only).
+```
+---
+:default_hostgroup:
+    :map:
+        "Default": ".*"
+```
+
+*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``` |
+| ```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
 
-* Tests
+* Deface the Hostgroup UI to add the regular expressions directly into the Hostgroup
 
 ## Contributing
 

data/app/models/setting/default_hostgroup.rb

@@ -7,7 +7,8 @@ class Setting::DefaultHostgroup < ::Setting
 
       Setting.transaction do
         [
-          self.set('default_hostgroup', 'The default Hostgroup to place new Hosts in', ''),
+          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
 

data/lib/default_hostgroup_managed_host_patch.rb

@@ -1,36 +1,64 @@
-require 'yaml'
 module DefaultHostgroupManagedHostPatch
   def self.included(base)
     base.extend ClassMethods
     base.class_eval do
       class << self
-        alias_method_chain :importHostAndFacts, :apply_hostgroup
+        alias_method_chain :import_host_and_facts, :match_hostgroup
       end
     end
   end
 
   module ClassMethods
-    def importHostAndFacts_with_apply_hostgroup hostname, facts, certname = nil, proxy_id = nil
-      host, result = importHostAndFacts_without_apply_hostgroup(hostname, facts, certname, proxy_id)
-      Rails.logger.debug "DefaultHostgroup: performing Hostgroup check"
+    def import_host_and_facts_with_match_hostgroup hostname, facts, certname = nil, proxy_id = nil
+      raise Foreman::Exception.new "Could not load default_hostgroup settings, check config" unless SETTINGS[:default_hostgroup]
+      raise Foreman::Exception.new "Could not load default_hostgroup map from settings, check config." unless SETTINGS[:default_hostgroup][:map]
 
-      unless valid_hostgroup?
-        Rails.logger.debug "DefaultHostgroup: Could not find Hostgroup '#{Setting[:default_hostgroup]}'"
-        return host, result
+      Rails.logger.debug "DefaultHostgroupMatch: performing Hostgroup match"
+      host, result = import_host_and_facts_without_match_hostgroup(hostname, facts, certname, proxy_id)
+
+      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
 
-      # 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.
-      if host.present? && !host.new_record? && host.hostgroup.nil? && host.reports.empty?
-        host.hostgroup = Hostgroup.find_by_label(Setting[:default_hostgroup])
-        host.save(:validate => false)
-        Rails.logger.debug "DefaultHostgroup: added #{host.name} to #{host.hostgroup.label}"
+      map = SETTINGS[:default_hostgroup][:map]
+      new_hostgroup = nil
+
+      map.each do |hostgroup, regex|
+        unless valid_hostgroup?(hostgroup)
+          Rails.logger.error "DefaultHostgroupMatch: #{hostgroup} is not a valid hostgroup, skipping."
+          next
+        end
+        regex.gsub!(/(\A\/|\/\z)/, '')
+        if Regexp.new(regex).match(hostname)
+          new_hostgroup = Hostgroup.find_by_title(hostgroup)
+          break
+        end
       end
+
+      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 valid_hostgroup?
-      Hostgroup.find_by_label(Setting[:default_hostgroup]) ? true : false
+    def valid_hostgroup?(hostgroup)
+      Hostgroup.find_by_title(hostgroup) ? true : false
     end
   end
 end

data/lib/foreman_default_hostgroup/version.rb

@@ -1,3 +1,3 @@
 module ForemanDefaultHostgroup
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/test/unit/default_hostgroup_test.rb

@@ -10,36 +10,113 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     return JSON.parse(File.read(File.expand_path(File.dirname(__FILE__) + relative_path)))
   end
 
-  def setup_hostgroup
+  def setup_hostgroup_match
     # The settings.yml fixture in Core wipes out the Setting table,
     # so we use FactoryGirl to re-create it
     FactoryGirl.create(:setting,
-                       :name => 'default_hostgroup',
+                       :name => 'force_hostgroup_match',
                        :category => 'Setting::DefaultHostgroup')
-    @hostgroup = Hostgroup.create :name => "MyGroup"
-    Setting[:default_hostgroup] = @hostgroup.name
+    FactoryGirl.create(:setting,
+                       :name => 'force_hostgroup_match_only_new',
+                       :category => 'Setting::DefaultHostgroup')
+    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][:map] = { "Test Full" => '^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
+  end
+
+  test "partial matching regex enclosed in /" do
+    setup_hostgroup_match
+    SETTINGS[:default_hostgroup][:map] = { "Test Partial" => '/\.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
+  end
+
+  test "invalid hostgroup does nothing" do
+    setup_hostgroup_match
+    SETTINGS[:default_hostgroup][:map] = { "Nonexistent Group" => '.*', "Existent Group" => '/\.lan$/' }
+
+    hostgroup = Hostgroup.create(:name => "Existent 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
+  end
+
+  test "default hostgroup" do
+    setup_hostgroup_match
+    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+
+    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
   end
 
-  test "a new, fact-imported, host has a default hostgroup set" do
-    setup_hostgroup
+  test "host already has a hostgroup" do
+    setup_hostgroup_match
+    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+
+    hostgroup = Hostgroup.create(:name => "Test Group")
+    Hostgroup.create(:name => "Test Default")
     raw = parse_json_fixture('/facts.json')
-    assert Host.importHostAndFacts(raw['name'], raw['facts'])
-    assert_equal @hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
+
+    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
   end
 
-  test "an invalid hostgroup setting does nothing" do
-    setup_hostgroup
-    Setting[:default_hostgroup] = "doesnotexist"
+  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][:map] = { "Test Default" => '.*' }
+
+    hostgroup = Hostgroup.create(:name => "Test Group")
+    default = Hostgroup.create(:name => "Test Default")
     raw = parse_json_fixture('/facts.json')
-    assert     Host.importHostAndFacts(raw['name'], raw['facts'])
-    refute Host.find_by_name('sinn1636.lan').hostgroup
+
+    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
   end
 
-  # Contrived example to check new plugin factories are loaded
-  test "my factory exists" do
-    refute Environment.find_by_name('defaulthostgrouptest')
-    FactoryGirl.create(:environment)
-    assert Environment.find_by_name('defaulthostgrouptest')
+  test "hostgroup is not updated if host is not new" do
+    setup_hostgroup_match
+    Setting[:force_hostgroup_match] = true
+    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+
+    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
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -28,7 +28,6 @@ files:
 - lib/foreman_default_hostgroup.rb
 - lib/foreman_default_hostgroup/engine.rb
 - lib/foreman_default_hostgroup/version.rb
-- test/factories/environments.rb
 - test/test_plugin_helper.rb
 - test/unit/default_hostgroup_test.rb
 - test/unit/facts.json
@@ -57,7 +56,6 @@ signing_key:
 specification_version: 4
 summary: Default Hostgroup Plugin for Foreman
 test_files:
-- test/factories/environments.rb
+- test/test_plugin_helper.rb
 - test/unit/facts.json
 - test/unit/default_hostgroup_test.rb
-- test/test_plugin_helper.rb

data/test/factories/environments.rb

@@ -1,5 +0,0 @@
-FactoryGirl.define do
-  factory :environment do
-    name 'defaulthostgrouptest'
-  end
-end