foreman_ansible 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cae18690ddfd00ff1050acdefd09a621457177a
-  data.tar.gz: bba73f69e7a760c310c712f69027cc0312b23a1a
+  metadata.gz: 5d9930905b911888013c949cc42e140daed748c4
+  data.tar.gz: 62f9e18006e75d4be30d9bf263cdb81edbbf4b05
 SHA512:
-  metadata.gz: 2f58daf8630756494fa0f39ecf99df13cbf38694005fcf73bad1f2ec4a1e026c89ab3cde7703ca051041b41ec80469934aeb2d75d8f43360d63c6bdec6126a46
-  data.tar.gz: 46a793766a4fd1cfd2c75e67ecacc68225410efea24d430115f452fe5f4ff9964acac8b0ef3468eab895f4fc6b5153ca1e333675cdf1070089abf11867a469be
+  metadata.gz: 468ae9f121f50e441d2d1317bd87a79f0b547aa4f7fba0c4c6ce18a63e7538813ac02301530757fedaeef7c8c7f95bb54007ad25b5c75771dfc91bd6f8ff4fd5
+  data.tar.gz: 676edd7606ac3c52c5d195ff2550ac0a610ad7e22b3987fdec4093a79a7bc538b71e9a7f66ef616e53a5d9e0215ced797b0ff94b2f569c16cdb221660eb42cb1

data/README.md

@@ -2,7 +2,7 @@
 
 [Foreman](http://theforeman.org) integration with Ansible. For now, it's just importing facts and not meant for general use.
 
-** Warning - this project hasn't been released yet, and might change significantly. Please don't use in production. **
+**Warning - this project hasn't been released yet, and might change significantly. Please don't use in production**
 
 ## Basic usage
 
@@ -17,15 +17,17 @@ bin_ansible_callbacks = True
 
 And copy `extras/foreman_callback.py` from this repo to `~/.ansible/plugins/callback_plugins/`. That's it!
 
-Now, every time you run `ansible -m setup $HOSTNAME`, Ansible will automatically submit facts for $HOSTNAME to Foreman.
+Now, every time you run a playbook or  `ansible -m setup $HOSTNAME`, Ansible will automatically submit facts and a small report for $HOSTNAME to Foreman. See 'Extra information' below if you find any error.
 
-In Foreman, you should add whatever Ansible hosts you want to submit facts from to the Setting (Administer > Settings, Puppet tab - I know..)) 'trusted_puppetmaster_hosts'.
+##### Registering a new host in Foreman
+![sign up gif](http://i.imgur.com/mlnVFJj.gif)
 
-#### Demo
+##### Host with failed and successful reports
+![reports](http://i.imgur.com/1ySO4sh.png)
 
-![demo gif](http://i.imgur.com/mlnVFJj.gif)
+### Extra information
 
-### Extra
+In Foreman, you should add whatever Ansible hosts you want to submit facts from to the setting `trusted_puppetmaster_hosts`. Change it at Administer > Settings, Puppet tab.
 
 If the Foreman setting 'create_new_host_when_facts_are_uploaded' is true, and $HOSTNAME doesn't exist in Foreman, it will autocreate that host in Foreman. If it already exists, it will update the facts.
 
@@ -33,9 +35,9 @@ Similarly, the Foreman setting 'ignore_puppet_facts_for_provisioning' is set to
 
 ### Devs
 
-Send a POST request to /api/v2/hosts/facts with the format you can see [in the API docs](http://theforeman.org/api/1.9/apidoc/v2/hosts/facts.html).
+The callback sends a POST request to /api/v2/hosts/facts with the format you can see [in the API docs](http://theforeman.org/api/1.9/apidoc/v2/hosts/facts.html).
 
-Facts must contain the output of `ansible -m setup $HOSTNAME`, plus a '_type' and '_timestamp' top level keys. You can see an example on test/fixtures/sample_facts.json in this repository.
+Facts must contain the output of `ansible -m setup $HOSTNAME`, plus a '_type' and '_timestamp' keys. You can see an example on test/fixtures/sample_facts.json in this repository.
 
 After that request, you should have a host registered in Foreman with the Ansible facts. It takes into account some facter and ohai facts if these are available on the system as well.
 

data/app/services/foreman_ansible/fact_importer.rb

@@ -7,7 +7,69 @@ module ForemanAnsible
     def initialize(host, facts = {})
       @host = host
       @facts = normalize(facts[:ansible_facts])
+      @original_facts = FactSparser.unsparse(facts[:ansible_facts])
       @counters = {}
     end
+
+    private
+
+    def add_new_facts
+      @counters[:added] = 0
+      add_missing_facts(FactSparser.unsparse(@original_facts))
+      logger.debug("Merging facts for '#{host}': added #{@counters[:added]} facts")
+    end
+
+    def add_missing_facts(imported_facts, parent = nil, prefix = '')
+      imported_facts.select! { |fact_name, fact_value| !fact_value.nil? }
+
+      imported_facts.each do |imported_name, imported_value|
+        fact_fqn = fact_fqn(imported_name, prefix)
+        next unless missing_facts.include?(fact_fqn)
+        fact_name = find_fact_name(fact_fqn, parent)
+
+        add_fact_value(imported_value, fact_name)
+        add_compose_fact(imported_value, fact_name, fact_fqn)
+      end
+    end
+
+    def add_compose_fact(imported_values, fact_name, fact_fqn)
+      if imported_values.is_a?(Hash)
+        add_missing_facts(imported_values, fact_name, fact_fqn)
+      elsif imported_values.is_a?(Array)
+        imported_values.each do |imported_value|
+          next unless imported_value.is_a?(Hash)
+          add_missing_facts(imported_value, fact_name, fact_fqn)
+        end
+      end
+    end
+
+    def missing_facts
+      @missing_facts ||= (facts.keys + FactSparser.sparse(@original_facts).keys) - db_facts.keys
+    end
+
+    # Returns pairs [id, fact_name]
+    def fact_names
+      @fact_names ||= fact_name_class.maximum(:id, :group => 'name')
+    end
+
+    # Fact fully qualified name contains an unambiguous name for a fact
+    # e.g: ansible_lo::ipv6, ansible_virbr0::active
+    def fact_fqn(name, prefix)
+      prefix.empty? ? name : prefix + FactName::SEPARATOR + name
+    end
+
+    def find_fact_name(name, parent)
+      return FactName.find(fact_names[name]) if fact_names[name].present?
+      fact_name_class.create!(:name => name,
+                              :parent => parent,
+                              :compose => compose)
+    end
+
+    def add_fact_value(value, fact_name)
+      method = host.new_record? ? :build : :create!
+      host.fact_values.send(method, :value => value, :fact_name => fact_name)
+      @counters[:added] += 1
+    end
+
   end
 end

data/app/services/foreman_ansible/fact_parser.rb

@@ -12,9 +12,7 @@ module ForemanAnsible
         Operatingsystem.create!(args.merge(:description => os_description))
     end
 
-    def environment
-      # Don't do anything
-    end
+    def environment; end # Don't do anything as there's no env in Ansible
 
     def architecture
       name = facts[:ansible_architecture] || facts[:facter_architecture]
@@ -41,7 +39,13 @@ module ForemanAnsible
     end
 
     def get_interfaces
-      facts[:ansible_interfaces]
+      # Move ansibles default interface first in the list of interfaces since
+      # Foreman picks the first one that is usable. If ansible has no
+      # preference otherwise at least sort the list.
+      pref = facts[:ansible_default_ipv4] &&
+                facts[:ansible_default_ipv4]['interface']
+      pref ? (facts[:ansible_interfaces] - [pref]).unshift(pref) :
+                facts[:ansible_interfaces].sort
     end
 
     def get_facts_for_interface(interface)
@@ -51,9 +55,7 @@ module ForemanAnsible
       HashWithIndifferentAccess[interface_facts.merge(:ipaddress => ipaddress)]
     end
 
-    def ipmi_interface
-      # ?
-    end
+    def ipmi_interface; end
 
     private
 
@@ -64,17 +66,17 @@ module ForemanAnsible
 
     def os_name
       facts[:ansible_distribution] ||
-        facts[:ansible_lsb]['id']
+        facts[:ansible_lsb] && facts[:ansible_lsb]['id']
     end
 
     def os_major
       facts[:ansible_distribution_major_version] ||
-        facts[:ansible_lsb]['major_release']
+        facts[:ansible_lsb] && facts[:ansible_lsb]['major_release']
     end
 
     def os_release
       facts[:ansible_distribution_version] ||
-        facts[:ansible_lsb]['release']
+        facts[:ansible_lsb] && facts[:ansible_lsb]['release']
     end
 
     def os_minor
@@ -83,7 +85,7 @@ module ForemanAnsible
     end
 
     def os_description
-      facts[:ansible_lsb]['description']
+      facts[:ansible_lsb] && facts[:ansible_lsb]['description']
     end
   end
 end

data/app/services/foreman_ansible/fact_sparser.rb

@@ -0,0 +1,24 @@
+module ForemanAnsible
+  class FactSparser
+    class << self
+      def sparse(hash, options = {} )
+        hash.map do |k, v|
+          prefix = options.fetch(:prefix, []) + [k]
+          next sparse(v, options.merge(:prefix => prefix)) if v.is_a? Hash
+          { prefix.join(options.fetch(:separator, FactName::SEPARATOR)) => v }
+        end.reduce(:merge) || Hash.new
+      end
+
+      def unsparse(hash, options={})
+        ret = Hash.new
+        sparse(hash).each do |k, v|
+          current = ret
+          key = k.to_s.split(options.fetch(:separator, FactName::SEPARATOR))
+          current = (current[key.shift] ||= Hash.new) until key.size <= 1
+          current[key.first] = v
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/foreman_ansible/version.rb

@@ -1,3 +1,3 @@
 module ForemanAnsible
-  VERSION = '0.1.1'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -37,6 +37,7 @@ files:
 - app/models/foreman_ansible/fact_name.rb
 - app/services/foreman_ansible/fact_importer.rb
 - app/services/foreman_ansible/fact_parser.rb
+- app/services/foreman_ansible/fact_sparser.rb
 - lib/foreman_ansible.rb
 - lib/foreman_ansible/engine.rb
 - lib/foreman_ansible/version.rb