foreman_default_hostgroup 2.0.1 → 2.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDQ3MDU3NTRiNDNkNmExNzcxNmJlZDBmMDM3N2NkOWJhZGQxNTExZg==
-  data.tar.gz: !binary |-
-    OWNkODUwM2VmYTk4YWFhYzQ2MDViZWRlZTQyZTNlMWE1ZTA5MDFlNQ==
+SHA1:
+  metadata.gz: 5d454d40d36c903cdb01917607ff7bb5a95ec18f
+  data.tar.gz: a620ee8b99e5bf30147d2266378462473b326628
 SHA512:
-  metadata.gz: !binary |-
-    NGIyZWZmN2NmNTZkMDNjZWJhMjViMTk4NWU1MWU3ODUxMzczZmVlODgzNTg1
-    MmExYjU2MzAxMWIwNjViY2MyNGQ3MzVjMWVjNmY3YjQzOTM4MGUwOGViMzk3
-    NjVjZDk2NDQ0MThhZmRiODc4YjQ5NzJiY2EwYWI2ZjJhZTg3Y2I=
-  data.tar.gz: !binary |-
-    ZTFkMzZlZTgyMjBkYTJkYmI2Nzk2OTQ4YTlkN2UxMzg4ZjdhZDk3YjZiMmJh
-    OTQ5MTZkYjIwNjIxZGRkZDNiYWUzZjkwY2YxNWE1ZGRhYzIwZjc4ZmIxNzBk
-    ZjBjMzE3ZDRjYzUxMzVkOGFhNGI4NDVmN2QyYjQzOTBkOGE5Y2M=
+  metadata.gz: 79200d8486340a22124c1f4b8f7df6645db83fc0c4933cf7f0a9b1269acc5a11648b810718c1dd8a97a9f9a4b0d0bf98fc0bfb638b56616c530cb28e0a1d150b
+  data.tar.gz: 6e49893a8db8af0cde5e8dc7dd242e7de90569182555cfb3232a2c2eb7b01b7bade2ec248ac932714752fb3b7f14830f4acf6ecf4a6920af68faf7cf126afac6

data/README.md

@@ -15,32 +15,34 @@ for how to install Foreman plugins
 | <= 1.2          | 0.1.0          |
 |    1.3          | 1.0.1          |
 |    1.4          | 1.1.0          |
-| >= 1.5          | 2.0.1          |
+|    1.5          | 2.0.1          |
+| >= 1.6          | 2.1.0          |
 
 ## Usage
 
 The configuration is done inside foreman's plugin settings directory which is
-```~foreman/config/settings.plugins.d/```.
+`~foreman/config/settings.plugins.d/`.
 
-You can simply copy ```default_hostgroup.yaml.example``` and adjust it to fit
-your needs. The simplest example would be:
+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:
 
 ```
 ---
 :default_hostgroup:
-    :map:
-        "Default": ".*"
+  :facts_map:
+    "Default":
+      "hostname": ".*"
 ```
 
 *Important Note:* You have to restart foreman in order to apply changes in
-```default_hostgroup.yaml```!
+`default_hostgroup.yaml`!
 
-There are also two more settings under ```Settings -> DefaultHostgroup```
+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``` |
+| `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/lib/default_hostgroup_managed_host_patch.rb

@@ -10,11 +10,11 @@ module DefaultHostgroupManagedHostPatch
 
   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)
+      @host, result = import_host_and_facts_without_match_hostgroup(hostname, facts, certname, proxy_id)
 
-      unless SETTINGS[:default_hostgroup] && SETTINGS[:default_hostgroup][:map]
+      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
+        return @host, result
       end
 
       Rails.logger.debug "DefaultHostgroupMatch: performing Hostgroup match"
@@ -22,42 +22,49 @@ module DefaultHostgroupManagedHostPatch
       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?
+        unless @host.present? && !@host.new_record? && @host.hostgroup.nil? && @host.reports.empty?
 
           Rails.logger.debug "DefaultHostgroupMatch: skipping, host exists"
-          return host, result
+          return @host, result
         end
       end
 
       unless Setting[:force_hostgroup_match]
-        if host.hostgroup.present?
+        if @host.hostgroup.present?
           Rails.logger.debug "DefaultHostgroupMatch: skipping, host has hostgroup"
-          return host, result
+          return @host, result
         end
       end
 
-      map = SETTINGS[:default_hostgroup][:map]
-      new_hostgroup = nil
+      facts_map = SETTINGS[:default_hostgroup][:facts_map]
+      new_hostgroup = find_match(facts_map)
 
-      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
 
-      return host, result unless new_hostgroup
-
-      host.hostgroup = new_hostgroup
-      host.save(:validate => false)
+      @host.hostgroup = new_hostgroup
+      @host.save(:validate => false)
       Rails.logger.info "DefaultHostgroupMatch: #{hostname} added to #{new_hostgroup}"
 
-      return host, result
+      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)

data/lib/foreman_default_hostgroup/version.rb

@@ -1,3 +1,3 @@
 module ForemanDefaultHostgroup
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/test/unit/default_hostgroup_test.rb

@@ -26,7 +26,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   test "full matching regex not enclosed in /" do
     setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:map] = { "Test Full" => '^sinn1636.lan$' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Full" => {'hostname' =>'^sinn1636.lan$'} }
 
     hostgroup = Hostgroup.create(:name => "Test Full")
     raw = parse_json_fixture('/facts.json')
@@ -37,7 +37,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   test "partial matching regex enclosed in /" do
     setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:map] = { "Test Partial" => '/\.lan$/' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Partial" => {'hostname' => '/\.lan$/' }}
 
     hostgroup = Hostgroup.create(:name => "Test Partial")
     raw = parse_json_fixture('/facts.json')
@@ -46,9 +46,9 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
   end
 
-  test "invalid hostgroup does nothing" do
+  test "invalid hostgroup name is ignored" do
     setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:map] = { "Nonexistent Group" => '.*', "Existent Group" => '/\.lan$/' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Nonexistent Group" => {'hostname' => '.*'}, "Existent Group" => {'hostname' => '/\.lan$/'} }
 
     hostgroup = Hostgroup.create(:name => "Existent Group")
     raw = parse_json_fixture('/facts.json')
@@ -57,9 +57,42 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     assert_equal hostgroup, Host.find_by_name('sinn1636.lan').hostgroup
   end
 
+  test "first matching hostgroup is used" do
+    setup_hostgroup_match
+    SETTINGS[:default_hostgroup][:facts_map] = { "First Group" => {'hostname' => '.*'}, "Second Group" => {'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
+  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
+  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
+  end
+
   test "default hostgroup" do
     setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' =>'.*'} }
 
     hostgroup = Hostgroup.create(:name => "Test Default")
     raw = parse_json_fixture('/facts.json')
@@ -70,7 +103,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
 
   test "host already has a hostgroup" do
     setup_hostgroup_match
-    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
 
     hostgroup = Hostgroup.create(:name => "Test Group")
     Hostgroup.create(:name => "Test Default")
@@ -88,7 +121,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
     setup_hostgroup_match
     Setting[:force_hostgroup_match] = true
     Setting[:force_hostgroup_match_only_new] = false
-    SETTINGS[:default_hostgroup][:map] = { "Test Default" => '.*' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
 
     hostgroup = Hostgroup.create(:name => "Test Group")
     default = Hostgroup.create(:name => "Test Default")
@@ -105,7 +138,7 @@ class DefaultHostgroupTest < ActiveSupport::TestCase
   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" => '.*' }
+    SETTINGS[:default_hostgroup][:facts_map] = { "Test Default" => {'hostname' => '.*'} }
 
     hostgroup = Hostgroup.create(:name => "Test Group")
     Hostgroup.create(:name => "Test Default")

data/test/unit/facts.json

@@ -26,7 +26,7 @@
     "serialnumber": "abcdefg",
     "processor7": "Intel(R) Xeon(R) CPU           E5620  @ 2.40GHz",
     "macaddress_vnet4": "FE:54:00:62:53:67",
-    "hostname": "h02",
+    "hostname": "sinn1636.lan",
     "osfamily": "RedHat",
     "gateway_if": "br180",
     "lsbrelease": ":core-4.0-amd64:core-4.0-noarch:graphics-4.0-amd64:graphics-4.0-noarch:printing-4.0-amd64:printing-4.0-noarch",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_default_hostgroup
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies: []
 description: Adds the option to specify a default hostgroup for new hosts created
   from facts/reports
@@ -22,7 +22,6 @@ files:
 - LICENSE
 - README.md
 - app/models/setting/default_hostgroup.rb
-- config/environment.rb
 - lib/default_hostgroup.rake
 - lib/default_hostgroup_managed_host_patch.rb
 - lib/foreman_default_hostgroup.rb
@@ -41,21 +40,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 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