foreman_ansible 0.2.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 651683d29fb40dbd94af8c41c17aac05d338da63
-  data.tar.gz: 08b2873008325af3d6108f2cebe5cfef7e3a3198
+  metadata.gz: f98cfedfee37e7a9829abe818b80cfc7d553b001
+  data.tar.gz: 008f22e68ec44bf9aa46e75d9006608df8c2821a
 SHA512:
-  metadata.gz: 1e2d6381c31429e26137a351e8125f7475a9328f3fa58f46b5b59d60f0590f7ff4f85be8d72b11bc822c4db3711e77497c49b30c1395745374787a73a0808a78
-  data.tar.gz: 8e6cdf7a6c43694f79a1587fd10cc30b4d74543ea329dff02628d2c03e0aa7a9b9272abf1c353e1c52b4a7eef1a5c769d6509d5f7eb0ed379677d487dd6d8f93
+  metadata.gz: 1b1a8c519e2f29aaf1cfdb5b8c604e06db5d8dcbf3a7646a25b1e9a2a935e9dab4b0977ae21d56e4623fd022fd6b68db4358efddcb9f1a32ab83755f4b2921cf
+  data.tar.gz: 54eace7707e28bcb0870cb8e24a270fb473c208c4845bb85c3fbdcf925a1690f0c31577072a5a076502564dde7a1b4ec9c2202336c21bf4b4bc4ea828ffbd2fb

data/README.md

@@ -15,8 +15,19 @@ Deploy `extras/foreman_callback.py` as a callback on your Ansible installation.
 callback_plugins = ~/.ansible/plugins/callback_plugins/
 bin_ansible_callbacks = True
 ```
+And copy `extras/foreman_callback.py` from this repo to `~/.ansible/plugins/callback_plugins/`.
 
-And copy `extras/foreman_callback.py` from this repo to `~/.ansible/plugins/callback_plugins/`. That's it!
+You can configure it via the following environment variables:
+
+* FOREMAN_URL: the URL of your Foreman installation (default "http://localhost:3000")
+* FOREMAN_SSL_CERT: The public key when using SSL client certificates (default "/etc/foreman/client_cert.pem")
+* FOREMAN_SSL_KEY: The private key when using SSL client certificates (default  "/etc/foreman/client_key.pem")
+* FOREMAN_SSL_VERIFY: wether to verify SSL certificates. Use *False*
+  to disable certificate checks. You can also set it to CA bundle (default is "True").
+
+See the [python-requests documentation](http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification) on the details of certificate setup.
+
+That's it!
 
 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.
 
@@ -62,3 +73,6 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -0,0 +1,27 @@
+module ForemanAnsible
+  # This module takes the config reports stored in Foreman for Ansible and
+  # modifies them to be properly presented in views
+  module AnsibleReportsHelper
+    def module_name(log)
+      JSON.parse(log.source.value)['module_name']
+    end
+
+    def module_args(log)
+      JSON.parse(log.source.value)['module_args']
+    end
+
+    def ansible_module_message(log)
+      paragraph_style = 'margin:0px;font-family:Menlo,Monaco,Consolas,monospace'
+      JSON.parse(log.message.value).except('invocation').map do |name, value|
+        next if value.blank?
+        "<p style=#{paragraph_style}>#{name}: #{value}</p>"
+      end.join.html_safe
+    end
+
+    def ansible_report?(log)
+      module_name(log).present?
+    rescue # Failures when parsing the log indicates it's not an Ansible report
+      false
+    end
+  end
+end

data/app/overrides/report_output.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  :virtual_path => 'config_reports/_output',
+  :name => 'report_output',
+  :surround => '#report_log',
+  :partial => 'foreman_ansible/config_reports/output'
+)

data/app/services/foreman_ansible/fact_importer.rb

@@ -53,7 +53,7 @@ module ForemanAnsible
 
     # Returns pairs [id, fact_name]
     def fact_names
-      @fact_names ||= fact_name_class.group('name').maximum(:id)
+      fact_name_class.group('name').maximum(:id)
     end
 
     # Fact fully qualified name contains an unambiguous name for a fact
@@ -72,8 +72,9 @@ module ForemanAnsible
     def add_fact_value(value, fact_name)
       return unless missing_facts.include?(fact_name.name)
       method = host.new_record? ? :build : :create!
-      #value = nil if compose?(value)
-      host.fact_values.send(method, :value => value.to_s, :fact_name => fact_name)
+      host.fact_values.send(method,
+                            :value => value.to_s,
+                            :fact_name => fact_name)
       @counters[:added] += 1
     end
 

data/app/views/foreman_ansible/config_reports/_ansible.html.erb

@@ -0,0 +1,23 @@
+<table id='report_log' class="table table-bordered table-striped">
+  <thead>
+    <tr>
+      <th><%= _("Level") %></th>
+      <th><%= _("Module") %></th>
+      <th><%= _("Arguments") %></th>
+      <th><%= _("Message") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% logs.each do |log| %>
+      <tr>
+        <td><span <%= report_tag log.level %>><%= h log.level %></span></td>
+        <td><%= h module_name(log) %></td>
+        <td><%= h module_args(log) %></td>
+        <td><%= ansible_module_message(log) %></td>
+      </tr>
+    <% end %>
+    <tr id='ntsh' <%= "style='display: none;'".html_safe if logs.size > 0%>><td colspan="3">
+        <%= _("Nothing to show") %>
+      </td></tr>
+  </tbody>
+</table>

data/app/views/foreman_ansible/config_reports/_output.html.erb

@@ -0,0 +1,15 @@
+<!--
+We parse a few parts of the report log, to check if it's an Ansible report
+An alternative to this would be to subclass Ansible < ConfigReport and change
+the API endpoint at api/v2/config_reports to accept a :type argument with the
+config management system type.
+
+However, that solution breaks compatibility of this plugin with older versions
+of Foreman that do not have that endpoint.
+-->
+<% if ansible_report?(logs.first) %>
+  <%= render :partial => 'foreman_ansible/config_reports/ansible',
+    :locals => { :logs => logs } %>
+<% else %>
+  <%= render_original, :locals => { :logs => logs } %>
+<% end %>

data/lib/foreman_ansible/engine.rb

@@ -1,14 +1,17 @@
+require 'deface'
 module ForemanAnsible
   # This engine connects ForemanAnsible with Foreman core
   class Engine < ::Rails::Engine
     engine_name 'foreman_ansible'
 
+    config.autoload_paths += Dir["#{config.root}/app/helpers"]
     config.autoload_paths += Dir["#{config.root}/app/overrides"]
     config.autoload_paths += Dir["#{config.root}/app/services"]
+    config.autoload_paths += Dir["#{config.root}/app/views"]
 
-    initializer 'foreman_ansible.register_plugin', :after => :finisher_hook do
+    initializer 'foreman_ansible.register_plugin', :before => :finisher_hook do
       Foreman::Plugin.register :foreman_ansible do
-        requires_foreman '>= 1.6'
+        requires_foreman '>= 1.9'
       end
     end
 

data/lib/foreman_ansible/version.rb

@@ -2,5 +2,5 @@
 # This way other parts of Foreman can just call ForemanAnsible::VERSION
 # and detect what version the plugin is running.
 module ForemanAnsible
-  VERSION = '0.2.2'
+  VERSION = '0.3'
 end

data/lib/tasks/foreman_ansible_tasks.rake

@@ -1,13 +1,3 @@
-# Tasks
-namespace :foreman_ansible do
-  namespace :example do
-    desc 'Example Task'
-    task :task => :environment do
-      # Task goes here
-    end
-  end
-end
-
 # Tests
 namespace :test do
   desc 'Test ForemanAnsible'

data/test/test_plugin_helper.rb

@@ -1 +1,10 @@
 require 'test_helper'
+
+def sample_facts_file
+  File.read(File.join(
+    ForemanAnsible::Engine.root, 'test', 'fixtures', 'sample_facts.json'))
+end
+
+def facts_json
+  HashWithIndifferentAccess.new(JSON.parse(sample_facts_file))
+end

data/test/unit/fact_importer_test.rb

@@ -0,0 +1,47 @@
+require 'test_plugin_helper'
+
+module ForemanAnsible
+  class FactImporterTest < ActiveSupport::TestCase
+    setup do
+      @host = FactoryGirl.build_stubbed(:host)
+    end
+
+    test 'add new facts adds all fact names in the fixture' do
+      @fact_importer = FactImporter.new(@host, facts_json)
+      facts_to_be_added = FactSparser.sparse(facts_json[:ansible_facts]).keys +
+        FactSparser.unsparse(facts_json[:ansible_facts]).keys
+      @fact_importer.send(:add_new_facts)
+      assert (facts_to_be_added - FactName.all.map(&:name)).empty?
+    end
+
+    test 'missing_facts returns facts we do not have in the database' do
+      @fact_importer = FactImporter.new(@host, facts_json)
+      @fact_importer.expects(:db_facts).returns('ansible_cmdline' => 'fakevalue')
+      refute @fact_importer.send(:missing_facts).include?('ansible_cmdline')
+    end
+
+    describe '#add_fact_value' do
+      setup do
+        @fact_importer = FactImporter.new(@host, :ansible_facts => {})
+      end
+      test 'does not add existing facts' do
+        existing_fact = FactoryGirl.build(:fact_name)
+        @fact_importer.expects(:missing_facts).returns([])
+        assert_nil @fact_importer.send(:add_fact_value, nil, existing_fact)
+      end
+
+      test 'adds missing facts' do
+        missing_fact = FactoryGirl.build(:fact_name)
+        @fact_importer.expects(:missing_facts).returns([missing_fact.name])
+        @fact_importer.counters[:added] = 0
+        assert_difference('@host.fact_values.count', 1) do
+          @fact_importer.send(:add_fact_value, 'missing_value', missing_fact)
+        end
+      end
+    end
+
+    test 'add_fact_value works for hosts that have not been created yet' do
+    end
+  end
+end
+

data/test/unit/fact_parser_test.rb

@@ -3,40 +3,39 @@ 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)
+      @facts_parser = 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
+      expect_where(Domain, @facts_parser.facts[:facter_domain])
+      @facts_parser.domain
     end
 
     test 'finds model' do
-      expect_where(Model, @facts_importer.facts[:ansible_product_name])
-      @facts_importer.model
+      expect_where(Model, @facts_parser.facts[:ansible_product_name])
+      @facts_parser.model
     end
 
     test 'finds architecture' do
-      expect_where(Architecture, @facts_importer.facts[:ansible_architecture])
-      @facts_importer.architecture
+      expect_where(Architecture, @facts_parser.facts[:ansible_architecture])
+      @facts_parser.architecture
     end
 
     test 'does not set environment' do
-      refute @facts_importer.environment
+      refute @facts_parser.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.
+      major_fact = @facts_parser.facts['ansible_distribution_major_version']
+      _, minor_fact = @facts_parser.
                       facts['ansible_distribution_version'].split('.')
       Operatingsystem.expects(:where).
-        with(:name => @facts_importer.facts['ansible_distribution'],
+        with(:name => @facts_parser.facts['ansible_distribution'],
              :major => major_fact, :minor => minor_fact || '').
         returns(sample_mock)
       sample_mock.expects(:first)
-      @facts_importer.operatingsystem
+      @facts_parser.operatingsystem
     end
 
     private
@@ -48,9 +47,5 @@ module ForemanAnsible
         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

@@ -7,17 +7,17 @@ module ForemanAnsible
                                                     'name' => 'Fedora' } }
       @sparsed_os_facts = { 'operatingsystem::major' => 20,
                             'operatingsystem::minor' => 1,
-                            'operatingsystem::name' => 'Fedora'}
+                            'operatingsystem::name' => 'Fedora' }
     end
 
     test 'sparses simple hash' do
       assert_equal @sparsed_os_facts,
-        ForemanAnsible::FactSparser.sparse(@original_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)
+                   ForemanAnsible::FactSparser.unsparse(@sparsed_os_facts)
     end
   end
 end

data/test/unit/helpers/foreman_ansible/ansible_reports_helper_test.rb

@@ -0,0 +1,23 @@
+require 'test_plugin_helper'
+
+module ForemanAnsible
+  module Helpers
+    class AnsibleReportsHelperTest < ActiveSupport::TestCase
+      include ForemanAnsible::AnsibleReportsHelper
+
+      test 'ansible_report? returns false when log is not parseable' do
+        refute ansible_report?('')
+      end
+
+      test 'ansible_report? returns false when log is from Puppet' do
+        refute ansible_report?(FactoryGirl.build(:log))
+      end
+
+      test 'ansible_report? returns true when log contains module_name' do
+        log = FactoryGirl.build(:log)
+        log.source.value = '{ "module_name" : "foo" }'
+        assert ansible_report?(log)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: '0.3'
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Ansible integration with Foreman
 email:
 - elobatocs@gmail.com
@@ -34,10 +48,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/helpers/foreman_ansible/ansible_reports_helper.rb
 - app/models/foreman_ansible/fact_name.rb
+- app/overrides/report_output.rb
 - app/services/foreman_ansible/fact_importer.rb
 - app/services/foreman_ansible/fact_parser.rb
 - app/services/foreman_ansible/fact_sparser.rb
+- app/views/foreman_ansible/config_reports/_ansible.html.erb
+- app/views/foreman_ansible/config_reports/_output.html.erb
 - lib/foreman_ansible.rb
 - lib/foreman_ansible/engine.rb
 - lib/foreman_ansible/version.rb
@@ -48,8 +66,10 @@ files:
 - locale/gemspec.rb
 - test/fixtures/sample_facts.json
 - test/test_plugin_helper.rb
+- test/unit/fact_importer_test.rb
 - test/unit/fact_parser_test.rb
 - test/unit/fact_sparser_test.rb
+- test/unit/helpers/foreman_ansible/ansible_reports_helper_test.rb
 homepage: https://github.com/theforeman/foreman_ansible
 licenses:
 - GPL-3
@@ -78,4 +98,6 @@ test_files:
 - test/fixtures/sample_facts.json
 - test/test_plugin_helper.rb
 - test/unit/fact_parser_test.rb
+- test/unit/fact_importer_test.rb
 - test/unit/fact_sparser_test.rb
+- test/unit/helpers/foreman_ansible/ansible_reports_helper_test.rb