foreman_ansible 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d9930905b911888013c949cc42e140daed748c4
-  data.tar.gz: 62f9e18006e75d4be30d9bf263cdb81edbbf4b05
+  metadata.gz: 651683d29fb40dbd94af8c41c17aac05d338da63
+  data.tar.gz: 08b2873008325af3d6108f2cebe5cfef7e3a3198
 SHA512:
-  metadata.gz: 468ae9f121f50e441d2d1317bd87a79f0b547aa4f7fba0c4c6ce18a63e7538813ac02301530757fedaeef7c8c7f95bb54007ad25b5c75771dfc91bd6f8ff4fd5
-  data.tar.gz: 676edd7606ac3c52c5d195ff2550ac0a610ad7e22b3987fdec4093a79a7bc538b71e9a7f66ef616e53a5d9e0215ced797b0ff94b2f569c16cdb221660eb42cb1
+  metadata.gz: 1e2d6381c31429e26137a351e8125f7475a9328f3fa58f46b5b59d60f0590f7ff4f85be8d72b11bc822c4db3711e77497c49b30c1395745374787a73a0808a78
+  data.tar.gz: 8e6cdf7a6c43694f79a1587fd10cc30b4d74543ea329dff02628d2c03e0aa7a9b9272abf1c353e1c52b4a7eef1a5c769d6509d5f7eb0ed379677d487dd6d8f93

data/README.md

@@ -1,8 +1,9 @@
 # Foreman Ansible :arrow_forward:
 
-[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**
+## Features
+* Import facts
+* Monitor playbook and ansible runs runtime
+* Sends Ansible reports to Foreman that contain what changed on your system after an ansible run.
 
 ## Basic usage
 

data/app/services/foreman_ansible/fact_importer.rb

@@ -1,4 +1,7 @@
 module ForemanAnsible
+  # Override methods from Foreman app/services/fact_importer so that Ansible
+  # facts are recognized in Foreman as ForemanAnsible facts. It supports
+  # nested facts.
   class FactImporter < ::FactImporter
     def fact_name_class
       ForemanAnsible::FactName
@@ -16,17 +19,16 @@ module ForemanAnsible
     def add_new_facts
       @counters[:added] = 0
       add_missing_facts(FactSparser.unsparse(@original_facts))
-      logger.debug("Merging facts for '#{host}': added #{@counters[:added]} 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.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)
-
+        fact_name = find_or_create_fact_name(fact_fqn, parent, imported_value)
         add_fact_value(imported_value, fact_name)
         add_compose_fact(imported_value, fact_name, fact_fqn)
       end
@@ -44,12 +46,14 @@ module ForemanAnsible
     end
 
     def missing_facts
-      @missing_facts ||= (facts.keys + FactSparser.sparse(@original_facts).keys) - db_facts.keys
+      @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')
+      @fact_names ||= fact_name_class.group('name').maximum(:id)
     end
 
     # Fact fully qualified name contains an unambiguous name for a fact
@@ -58,18 +62,24 @@ module ForemanAnsible
       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?
+    def find_or_create_fact_name(name, parent, fact_value)
+      return fact_name_class.find(fact_names[name]) if fact_names[name].present?
       fact_name_class.create!(:name => name,
                               :parent => parent,
-                              :compose => compose)
+                              :compose => compose?(fact_value))
     end
 
     def add_fact_value(value, fact_name)
+      return unless missing_facts.include?(fact_name.name)
       method = host.new_record? ? :build : :create!
-      host.fact_values.send(method, :value => value, :fact_name => fact_name)
+      #value = nil if compose?(value)
+      host.fact_values.send(method, :value => value.to_s, :fact_name => fact_name)
       @counters[:added] += 1
     end
 
+    def compose?(fact_value)
+      fact_value.is_a?(Hash) ||
+        fact_value.is_a?(Array) && fact_value.first.is_a?(Hash)
+    end
   end
 end

data/app/services/foreman_ansible/fact_parser.rb

@@ -1,4 +1,6 @@
 module ForemanAnsible
+  # Override methods from Foreman app/services/fact_parser so that facts
+  # representing host properties are understood when they come from Ansible.
   class FactParser < ::FactParser
     attr_reader :facts
 
@@ -20,17 +22,13 @@ module ForemanAnsible
     end
 
     def model
-      name ||= facts[:ansible_product_name] ||
-               facts[:facter_virtual] ||
-               facts[:facter_productname] ||
-               facts[:facter_model]
+      name = detect_fact([:ansible_product_name, :facter_virtual,
+                          :facter_productname, :facter_model])
       Model.where(:name => name.strip).first_or_create unless name.blank?
     end
 
     def domain
-      name = facts[:ansible_domain] ||
-             facts[:facter_domain] ||
-             facts[:ohai_domain]
+      name = detect_fact([:ansible_domain, :facter_domain, :ohai_domain])
       Domain.where(:name => name).first_or_create unless name.blank?
     end
 
@@ -38,18 +36,24 @@ module ForemanAnsible
       true
     end
 
-    def get_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.
+    # Move ansible's 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.
+    #
+    # This method overrides app/services/fact_parser.rb on Foreman and returns
+    # an array of interface names, ['eth0', 'wlan1', etc...]
+    def get_interfaces # rubocop:disable Style/AccessorMethodName
       pref = facts[:ansible_default_ipv4] &&
-                facts[:ansible_default_ipv4]['interface']
-      pref ? (facts[:ansible_interfaces] - [pref]).unshift(pref) :
-                facts[:ansible_interfaces].sort
+             facts[:ansible_default_ipv4]['interface']
+      if pref.present?
+        (facts[:ansible_interfaces] - [pref]).unshift(pref)
+      else
+        facts[:ansible_interfaces].sort
+      end
     end
 
     def get_facts_for_interface(interface)
-      interface.gsub!(/-/, '_') # virbr1-nic -> virbr1_nic
+      interface.tr!('-', '_') # virbr1-nic -> virbr1_nic
       interface_facts = facts[:"ansible_#{interface}"]
       ipaddress = ip_from_interface(interface)
       HashWithIndifferentAccess[interface_facts.merge(:ipaddress => ipaddress)]
@@ -87,5 +91,14 @@ module ForemanAnsible
     def os_description
       facts[:ansible_lsb] && facts[:ansible_lsb]['description']
     end
+
+    # Returns first non-empty fact. Needed to check for empty strings.
+    def detect_fact(fact_names)
+      facts[
+        fact_names.detect do |fact_name|
+          facts[fact_name].present?
+        end
+      ]
+    end
   end
 end

data/app/services/foreman_ansible/fact_sparser.rb

@@ -1,21 +1,32 @@
 module ForemanAnsible
+  # See sparse and unsparse documentation
   class FactSparser
     class << self
-      def sparse(hash, options = {} )
+      # Sparses facts, so that it converts a facts hash
+      # { operatingsystem : { major: 20, name : 'fedora' }
+      # into
+      # { operatingsystem::major: 20,
+      #   operatingsystem::name: 'fedora' }
+      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.reduce(:merge) || {}
       end
 
-      def unsparse(hash, options={})
-        ret = Hash.new
-        sparse(hash).each do |k, v|
+      # Unsparses facts, so that it converts a hash with facts
+      # { operatingsystem::major: 20,
+      #   operatingsystem::name: 'fedora' }
+      # into
+      # { operatingsystem : { major: 20, name: 'fedora' } }
+      def unsparse(facts_hash)
+        ret = {}
+        sparse(facts_hash).each do |full_name, value|
           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
+          fact_name = full_name.to_s.split(FactName::SEPARATOR)
+          current = (current[fact_name.shift] ||= {}) until fact_name.size <= 1
+          current[fact_name.first] = value
         end
         ret
       end

data/lib/foreman_ansible.rb

@@ -1,4 +1,5 @@
 require 'foreman_ansible/engine'
 
+# Module required to start the Foreman Rails engine
 module ForemanAnsible
 end

data/lib/foreman_ansible/engine.rb

@@ -1,4 +1,5 @@
 module ForemanAnsible
+  # This engine connects ForemanAnsible with Foreman core
   class Engine < ::Rails::Engine
     engine_name 'foreman_ansible'
 

data/lib/foreman_ansible/version.rb

@@ -1,3 +1,6 @@
+# Specify the version to be picked up in the foreman_ansible.gemspec
+# This way other parts of Foreman can just call ForemanAnsible::VERSION
+# and detect what version the plugin is running.
 module ForemanAnsible
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/test/unit/fact_parser_test.rb

@@ -0,0 +1,56 @@
+require 'test_plugin_helper'
+
+module ForemanAnsible
+  class FactParserTest < ActiveSupport::TestCase
+    setup do
+      facts_json = HashWithIndifferentAccess.new(JSON.parse(sample_facts_file))
+      @facts_importer = ForemanAnsible::FactParser.new(facts_json)
+    end
+
+    test 'finds facter domain even if ansible_domain is empty' do
+      expect_where(Domain, @facts_importer.facts[:facter_domain])
+      @facts_importer.domain
+    end
+
+    test 'finds model' do
+      expect_where(Model, @facts_importer.facts[:ansible_product_name])
+      @facts_importer.model
+    end
+
+    test 'finds architecture' do
+      expect_where(Architecture, @facts_importer.facts[:ansible_architecture])
+      @facts_importer.architecture
+    end
+
+    test 'does not set environment' do
+      refute @facts_importer.environment
+    end
+
+    test 'creates operatingsystem from operating system options' do
+      sample_mock = mock
+      major_fact = @facts_importer.facts['ansible_distribution_major_version']
+      _, minor_fact = @facts_importer.
+                      facts['ansible_distribution_version'].split('.')
+      Operatingsystem.expects(:where).
+        with(:name => @facts_importer.facts['ansible_distribution'],
+             :major => major_fact, :minor => minor_fact || '').
+        returns(sample_mock)
+      sample_mock.expects(:first)
+      @facts_importer.operatingsystem
+    end
+
+    private
+
+    def expect_where(model, fact_name)
+      sample_mock = mock
+      model.expects(:where).
+        with(:name => fact_name).
+        returns(sample_mock)
+      sample_mock.expects(:first_or_create)
+    end
+
+    def sample_facts_file
+      File.read(File.join(Engine.root, 'test', 'fixtures', 'sample_facts.json'))
+    end
+  end
+end

data/test/unit/fact_sparser_test.rb

@@ -0,0 +1,23 @@
+require 'test_plugin_helper'
+
+module ForemanAnsible
+  class FactSparserTest < ActiveSupport::TestCase
+    setup do
+      @original_os_facts = { 'operatingsystem' => { 'major' => 20, 'minor' => 1,
+                                                    'name' => 'Fedora' } }
+      @sparsed_os_facts = { 'operatingsystem::major' => 20,
+                            'operatingsystem::minor' => 1,
+                            'operatingsystem::name' => 'Fedora'}
+    end
+
+    test 'sparses simple hash' do
+      assert_equal @sparsed_os_facts,
+        ForemanAnsible::FactSparser.sparse(@original_os_facts)
+    end
+
+    test 'unsparse simple hash' do
+      assert_equal @original_os_facts,
+        ForemanAnsible::FactSparser.unsparse(@sparsed_os_facts)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -48,6 +48,8 @@ files:
 - locale/gemspec.rb
 - test/fixtures/sample_facts.json
 - test/test_plugin_helper.rb
+- test/unit/fact_parser_test.rb
+- test/unit/fact_sparser_test.rb
 homepage: https://github.com/theforeman/foreman_ansible
 licenses:
 - GPL-3
@@ -75,3 +77,5 @@ summary: Ansible integration with Foreman (theforeman.org)
 test_files:
 - test/fixtures/sample_facts.json
 - test/test_plugin_helper.rb
+- test/unit/fact_parser_test.rb
+- test/unit/fact_sparser_test.rb