foreman_ansible 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 832a0aa23787c1f390fab13d3ecc3e58a60c6af6
-  data.tar.gz: 3ca0fcc13b040e9e36fb7a7d2b3ff9c4344d8b12
+  metadata.gz: 11936ad8fbecb22faf149473256064f197414c8b
+  data.tar.gz: f54a4994feab57e29e2a974d04137be329105b5b
 SHA512:
-  metadata.gz: 73c63a710e5d0de08464f4a4e24fe65d782294b6f1eee55978235eb1df0d35378ad9336c919fe44d0e8c13849c610620d3a357352a51e6f770aa56d557f2ef98
-  data.tar.gz: 728a72b85aeda5be356c6c442b523fd36ffb0775a3a090dc83cd3623bd3145569f0fc6aa8aa136d937cba3b274832c0ebadcf5fe4fbf6df8dc7f09603d5c4f20
+  metadata.gz: 6446ec9cb86573ed497ee010b2aa05b1e36b62e3cc9a9cd97afdfc2fd2df6620baed984339fa52f0cffe169b8ba1e38e7b3aff9f42a663e8ce3ed4ac0b89cb34
+  data.tar.gz: 3b188ae9c37bcc7a1921a5ac008263a03c55867b322c5c4bb71bb67bf2347d6feed7b73513ad8cf2ec1b53fd82ea2b397ea8ed1d1afc0e861f0b422bb5491fcf

data/app/assets/stylesheets/foreman_ansible/foreman-ansible.css

@@ -0,0 +1,3 @@
+.report-json-viewer * {
+  background: transparent !important;
+}

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -2,29 +2,94 @@ 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']
+    ANSIBLE_META_KEYS = %w[
+      _ansible_parsed _ansible_no_log _ansible_item_result
+      _ansible_ignore_errors _ansible_verbose_always _ansible_verbose_override
+    ].freeze
+    ANSIBLE_HIDDEN_KEYS = %w[
+      invocation module_args results ansible_facts
+      stdout stderr
+    ].freeze
+
+    def ansible_module_name(log)
+      source_value = log.source.value
+      name = source_value.split(':')[0].strip if source_value.include?(':')
+      name
     end
 
-    def module_args(log)
-      JSON.parse(log.source.value)['module_args']
+    def ansible_module_args(log)
+      report_json_viewer module_invocations parsed_message_json(log)
     end
 
     def ansible_module_message(log)
-      paragraph_style = 'margin:0px;font-family:Menlo,Monaco,Consolas,monospace'
-      safe_join(
-        JSON.parse(log.message.value).except('invocation').map do |name, value|
-          next if value.blank?
-          content_tag(:p, "#{name}: #{value}", :style => paragraph_style)
-        end
-      )
+      report_json_viewer hash_with_keys_removed parsed_message_json(log)
+    end
+
+    def ansible_report_origin_icon
+      'foreman_ansible/Ansible.png'
+    end
+
+    def ansible_report_origin_partial
+      'foreman_ansible/config_reports/ansible'
     end
 
     def ansible_report?(log)
       module_name(log).present?
-      # Failures when parsing the log indicates it's not an Ansible report
     rescue StandardError
       false
     end
+
+    def report_json_viewer(json)
+      uid = "reportjson-viewer-#{json.object_id}"
+      viewer = content_tag :div, '', :id => uid
+      viewer << mount_react_component('ReportJsonViewer',
+                                      "##{uid}", json.to_json)
+    end
+
+    private
+
+    def module_invocations(hash)
+      invocations = []
+      invocations << hash.delete('invocation')
+      results = hash.delete('results')
+      invocations << results
+      invocations = invocations.compact.flatten.map do |ih|
+        ih.is_a?(Hash) ? remove_keys(ih) : ih
+      end
+      invocations
+    end
+
+    def pretty_print_hash(hash)
+      prettyp = JSON.pretty_generate(remove_keys(hash))
+      prettyp.gsub!(/{\n*/, "\n")
+      prettyp.gsub!(/},*\n*/, "\n")
+      prettyp.gsub!(/^(\[|\])/, '')
+      prettyp.gsub!(/^[\s]*$\n/, '')
+      paragraph_style = 'white-space:pre;padding: 2em 0'
+      content_tag(:p, prettyp, :style => paragraph_style)
+    end
+
+    def hash_with_keys_removed(hash)
+      new_hash = remove_keys(hash)
+      remove_keys(new_hash, ANSIBLE_HIDDEN_KEYS)
+    end
+
+    def remove_keys(hash, keys = ANSIBLE_META_KEYS)
+      hash.each do |key, value|
+        if value.is_a? Array
+          value.each { |h| remove_keys(h) if h.is_a? Hash }
+        elsif value.is_a? Hash
+          remove_keys(value)
+        end
+        hash.delete(key) if keys.include? key
+      end
+    end
+
+    def parsed_message_json(log)
+      JSON.parse(log.message.value)
+    rescue StandardError => e
+      logger.error e
+      false
+    end
   end
 end

data/app/models/concerns/foreman_ansible/has_many_ansible_roles.rb

@@ -6,7 +6,9 @@ module ForemanAnsible
 
     included do
       def all_ansible_roles
-        (ansible_roles + inherited_ansible_roles).uniq
+        result = (ansible_roles + inherited_ansible_roles).uniq
+        result += host_ansible_roles if is_a? Hostgroup
+        result
       end
     end
   end

data/app/models/concerns/foreman_ansible/hostgroup_extensions.rb

@@ -14,6 +14,10 @@ module ForemanAnsible
           roles + hostgroup.ansible_roles
         end.uniq
       end
+
+      def host_ansible_roles
+        hosts.all.includes(:ansible_roles).flat_map(&:ansible_roles)
+      end
     end
   end
 end

data/app/models/setting/ansible.rb

@@ -63,6 +63,16 @@ class Setting
                  ' it is ready after a reboot.'),
               '360',
               N_('Post-provision timeout')
+            ),
+            set(
+              'top_level_ansible_vars',
+              N_('Whether to put Ansible parameters in the "hostvars" '\
+                 'top-level key of the inventory. By default it is true, so '\
+                 'that Host Parameters can be used directly in the playbooks.'\
+                 'When false, Host Parameters can only be accessed through'\
+                 'foreman_params["host_parameter"] in the playbooks.'),
+              true,
+              N_('Top level Ansible variables')
             )
           ].compact.each do |s|
             create(s.update(:category => 'Setting::Ansible'))

data/app/services/foreman_ansible/ansible_report_scanner.rb

@@ -0,0 +1,21 @@
+module ForemanAnsible
+  # Scans ConfigReports after import for indicators of an Ansible report and
+  # sets the origin of the report to 'Ansible'
+  class AnsibleReportScanner
+    class << self
+      def scan(report, logs)
+        if (is_ansible = ansible_report?(logs))
+          report.origin = 'Ansible'
+        end
+        is_ansible
+      end
+
+      def ansible_report?(logs)
+        logs.any? do |log|
+          log['log'].fetch('messages', {}).
+            fetch('message', '') =~ /"_ansible_parsed"/
+        end
+      end
+    end
+  end
+end

data/app/services/foreman_ansible/insights_plan_runner.rb

@@ -0,0 +1,68 @@
+if defined?(RedhatAccess)
+  module ForemanAnsible
+    # Fetch information about a plan from RH Insights and run it
+    class InsightsPlanRunner
+      include RedhatAccess::Telemetry::LookUps
+
+      def initialize(organization, plan_id)
+        @organization = organization
+        @plan_id = plan_id
+      end
+
+      def run_playbook
+        rules = playbook
+        hostname_rules_relation = hostname_rules(rules)
+        hosts = hostname_rules_relation.keys.map do |hostname|
+          Host::Managed.find_by(:name => hostname)
+        end
+
+        composer = JobInvocationComposer.for_feature(
+          :ansible_run_insights_plan,
+          hosts,
+          :organization_id => @organization.id, :plan_id => @plan_id
+        )
+        composer.save
+        composer.trigger
+      end
+
+      # Fetches the playbook from the Red Hat Insights API
+      def playbook
+        resource = RestClient::Resource.new(
+          "#{insights_api_host}/r/insights/"\
+          "v3/maintenance/#{@plan_id}/playbook",
+          get_ssl_options_for_org(@organization, nil)
+        )
+        response = resource.get
+        YAML.safe_load(response.body)
+      end
+
+      # This method creates a hash like this:
+      #  {
+      #    hostname1 => [rule1,rule2,rule3],
+      #    hostname2 => [rule1,rule3],
+      #  }
+      #
+      #  Rules are distinguished by name and saved without the 'hosts' field
+      #  as it's irrelevant in the Foreman REX context ('hosts: all' is used
+      #  so that all=job invocation targets)
+      def rules_to_hash(rules)
+        result = {}
+        rules.map do |rule|
+          rule['hosts'] = 'all'
+          result[rule['name']] = rule
+        end
+        result
+      end
+
+      def hostname_rules(rules)
+        result = Hash.new { |h, k| h[k] = [] }
+        rules.each do |rule|
+          rule['hosts'].split(',').each do |host|
+            result[host] << rule['name']
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/app/services/foreman_ansible/inventory_creator.rb

@@ -22,6 +22,7 @@ module ForemanAnsible
       hosts = @hosts.map do |h|
         RemoteExecutionProvider.find_ip_or_hostname(h)
       end
+
       { 'all' => { 'hosts' => hosts,
                    'vars'  => template_inputs(@template_invocation) },
         '_meta' => { 'hostvars' => hosts_vars } }
@@ -36,11 +37,15 @@ module ForemanAnsible
     end
 
     def host_vars(host)
-      {
+      result = {
         'foreman' => host_attributes(host),
         'foreman_params' => host_params(host),
         'foreman_ansible_roles' => host_roles(host)
       }.merge(connection_params(host))
+      if Setting['top_level_ansible_vars']
+        result = result.merge(host_params(host))
+      end
+      result
     end
 
     def connection_params(host)
@@ -89,7 +94,6 @@ module ForemanAnsible
         'ansible_become' => @template_invocation.effective_user,
         'ansible_user' => host_setting(host, 'remote_execution_ssh_user'),
         'ansible_ssh_pass' => rex_ssh_password(host),
-        'ansible_ssh_private_key_file' => ansible_or_rex_ssh_private_key(host),
         'ansible_port' => host_setting(host, 'remote_execution_ssh_port')
       }
       # Backward compatibility for Ansible 1.x
@@ -111,15 +115,6 @@ module ForemanAnsible
         host_setting(host, 'remote_execution_ssh_password')
     end
 
-    def ansible_or_rex_ssh_private_key(host)
-      ansible_private_file = host_setting(host, 'ansible_ssh_private_key_file')
-      if !ansible_private_file.empty?
-        ansible_private_file
-      else
-        ForemanRemoteExecutionCore.settings[:ssh_identity_key_file]
-      end
-    end
-
     private
 
     def render_rabl(host, template)

data/app/services/foreman_ansible/renderer_methods.rb

@@ -0,0 +1,21 @@
+module ForemanAnsible
+  # Macro to fetch RH Insights plan playbook
+  module RendererMethods
+    extend ActiveSupport::Concern
+
+    def insights_remediation(plan_id, organization_id = Organization.current.id)
+      insights_plan = ForemanAnsible::InsightsPlanRunner.new(
+        Organization.find(organization_id),
+        plan_id
+      )
+      rules = insights_plan.playbook
+      hostname_rules_relation = insights_plan.hostname_rules(rules)
+      global_rules = insights_plan.rules_to_hash(rules)
+      host_playbooks = hostname_rules_relation[@host.name].
+                       reduce([]) do |acc, cur|
+        acc << global_rules[cur]
+      end
+      host_playbooks.to_yaml
+    end
+  end
+end

data/app/views/foreman_ansible/ansible_roles/_hostgroup_ansible_roles_button.erb

@@ -1,14 +1,13 @@
 <%=
-if hostgroup.all_ansible_roles.empty?
+  play_roles = if hostgroup.all_ansible_roles.empty?
+    "<a title='No Roles assigned' href=\"#\">#{_('Play Roles')}</a>".html_safe
+  else
+    display_link_if_authorized(_('Play Roles'),   hash_for_play_roles_hostgroup_path(:id => hostgroup),   :'data-no-turbolink' => true)
+  end
+
   action_buttons(
               display_link_if_authorized(_('Nest'),    hash_for_nest_hostgroup_path(:id => hostgroup)),
               display_link_if_authorized(_('Clone'),   hash_for_clone_hostgroup_path(:id => hostgroup)),
+              play_roles,
               display_delete_if_authorized(hash_for_hostgroup_path(:id => hostgroup).merge(:auth_object => hostgroup, :authorizer => authorizer), :data => { :confirm => warning_message(hostgroup) }))
-else
-  action_buttons(
-              display_link_if_authorized(_('Nest'),    hash_for_nest_hostgroup_path(:id => hostgroup)),
-              display_link_if_authorized(_('Clone'),   hash_for_clone_hostgroup_path(:id => hostgroup)),
-              display_link_if_authorized(_('Play Roles'),   hash_for_play_roles_hostgroup_path(:id => hostgroup),   :'data-no-turbolink' => true),
-              display_delete_if_authorized(hash_for_hostgroup_path(:id => hostgroup).merge(:auth_object => hostgroup, :authorizer => authorizer), :data => { :confirm => warning_message(hostgroup) }))
-end
 %>

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

@@ -1,4 +1,7 @@
-<table id='report_log' class="table table-bordered table-striped">
+<%= webpacked_plugins_js_for :foreman_ansible %>
+<%= stylesheet 'foreman_ansible/foreman-ansible' %>
+
+<table id='report_log' class="<%= table_css_classes %>">
   <thead>
     <tr>
       <th><%= _("Level") %></th>
@@ -11,8 +14,8 @@
     <% 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_name(log) %></td>
+        <td><%= ansible_module_args(log) %></td>
         <td><%= ansible_module_message(log) %></td>
       </tr>
     <% end %>

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

@@ -3,7 +3,6 @@ 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.
 -->

data/app/views/foreman_ansible/job_templates/ansible_roles_-_ansible_default.erb

@@ -0,0 +1,21 @@
+<%#
+name: Ansible Roles - Ansible Default
+job_category: Ansible Playbook
+description_format: Run Ansible roles
+feature: ansible_run_host
+snippet: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - name: Display all parameters known for the Foreman host
+      debug:
+        var: foreman_params
+  roles:
+<%- if @host.all_ansible_roles.present? -%>
+<%=   @host.all_ansible_roles.map { |role| "    - #{role.name.strip}" }.join("\n") %>
+<%- end -%>

data/app/views/foreman_ansible/job_templates/ansible_roles_-_install_from_galaxy.erb

@@ -0,0 +1,32 @@
+<%#
+name: Ansible Roles - Install from Galaxy
+job_category: Ansible Galaxy
+description_format: Install roles '%{ansible_roles_list}' from Galaxy
+snippet: false
+template_inputs:
+- name: ansible_roles_list
+  required: true
+  input_type: user
+  description: "List of roles in Ansible Galaxy to install, separated by commas, e.g:
+    \"mysql, nginx\"\r\n\r\nThe default location is the 'roles_path' configured on
+    /etc/ansible/ansible.cfg, you may override it by filling the 'location' input.
+    Click on \"Advanced\" to see it."
+  advanced: false
+- name: location
+  required: false
+  input_type: user
+  description: A particular directory where you want the downloaded roles to be placed.
+  advanced: true
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - command: ansible-galaxy install {{ item }} <% "-p #{input('location')}" if input('location').present? %>
+      register: out
+      with_items:
+        - <%= input('ansible_roles_list') %>
+    - debug: var=out

data/app/views/foreman_ansible/job_templates/ansible_roles_-_install_from_git.erb

@@ -0,0 +1,28 @@
+<%#
+name: Ansible Roles - Install from git
+job_category: Ansible Roles Installation
+description_format: Clone roles from git repository to %{location}
+snippet: false
+template_inputs:
+- name: git_repository
+  required: true
+  input_type: user
+  description: "URL to the git repository containing the roles, e.g:\r\nhttps://github.com/theforeman/foreman_role_1"
+  advanced: false
+- name: location
+  required: true
+  input_type: user
+  description: For example, '/etc/ansible/roles/foobar' . Look at '/etc/ansible/ansible.cfg'
+    roles_path option to find what is your roles_path
+  advanced: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - command: git clone <%= input('git_repository') %> <%= input('location') %>
+      register: out
+    - debug: var=out

data/app/views/foreman_ansible/job_templates/maintenance_plan.erb

@@ -0,0 +1,19 @@
+<%#
+kind: job_template
+name: Ansible - Run insights maintenance plan
+job_category: Ansible Playbook
+description_format: 'Insights maintenance plan for host'
+feature: ansible_run_insights_plan
+template_inputs:
+- name: plan_id
+  description: The playbook for the rule coming from insights.
+  input_type: user
+  required: true
+- name: organization_id
+  description: The Foreman organization associated with the Insights account
+  input_type: user
+  required: true
+provider_type: Ansible
+%>
+
+<%= insights_remediation(input(:plan_id), input(:organization_id)) %>

data/app/views/foreman_ansible/job_templates/package_action_-_ansible_default.erb

@@ -0,0 +1,45 @@
+<%#
+name: Package Action - Ansible Default
+job_category: Ansible Packages
+description_format: 'Package %{name}: %{state}'
+snippet: false
+template_inputs:
+- name: state
+  required: true
+  input_type: user
+  description: Whether to install (present, latest), or remove (absent) a package.
+  options: "present\r\nabsent\r\nlatest"
+  advanced: false
+- name: name
+  required: true
+  input_type: user
+  description: "Package name, or package specifier with version, like name-1.0.\r\nBe
+    aware that packages are not always named the same and this module will not 'translate'
+    them per distro."
+  advanced: false
+- name: pre_script
+  description: A script to run prior to the package action
+  input_type: user
+  required: false
+  advanced: true
+- name: post_script
+  description: A script to run after the package action
+  input_type: user
+  required: false
+  advanced: true
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+# For Windows targets use the win_package module instead.
+---
+- hosts: all
+  pre_tasks:
+    - shell: "<%= input('pre_script') %>"
+  tasks:
+    - package:
+        name: <%= input('name') %>
+        state: <%= input('state') %>
+  post_tasks:
+    - shell: "<%= input('post_script') %>"

data/app/views/foreman_ansible/job_templates/power_action_-_ansible_default.erb

@@ -0,0 +1,28 @@
+<%#
+name: Power Action - Ansible Default
+job_category: Power
+description_format: "%{action} host"
+snippet: false
+template_inputs:
+- name: action
+  required: true
+  input_type: user
+  description: Action to perform on the service
+  options: "restart\r\nshutdown"
+  advanced: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - command: |
+        echo <%= input('action') %> host && sleep 3
+        <%= case input('action')
+          when 'restart'
+            'reboot'
+          else
+            'shutdown -h now'
+          end %>

data/app/views/foreman_ansible/job_templates/puppet_run_once_-_ansible_default.erb

@@ -0,0 +1,21 @@
+<%#
+name: Puppet Run Once - Ansible Default
+job_category: Puppet
+description_format: 'Run Puppet once with "%{puppet_options}"'
+snippet: false
+template_inputs:
+- name: puppet_options
+  required: false
+  input_type: user
+  description: Additional options to pass to Puppet
+  advanced: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - command: |
+        puppet agent --onetime --no-usecacheonfailure --no-daemonize <%= input("puppet_options") %>

data/app/views/foreman_ansible/job_templates/run_command_-_ansible_default.erb

@@ -0,0 +1,22 @@
+<%#
+name: Run Command - Ansible Default
+job_category: Ansible Commands
+description_format: Run %{command}
+snippet: false
+template_inputs:
+- name: command
+  required: true
+  input_type: user
+  description: "Command to run on the host, e.g: \r\n\r\nmkdir helloworld"
+  advanced: false
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+---
+- hosts: all
+  tasks:
+    - command: <%= input('command') %>
+      register: out
+    - debug: var=out

data/app/views/foreman_ansible/job_templates/service_action_-_ansible_default.erb

@@ -0,0 +1,61 @@
+<%#
+name: Service Action - Ansible Default
+job_category: Ansible Service
+description_format: "%{state} service %{name}"
+snippet: false
+template_inputs:
+- name: state
+  required: true
+  input_type: user
+  description: started/stopped are idempotent actions that will not run commands unless
+    necessary. restarted will always bounce the service. reloaded will always reload.
+    At least one of state and enabled are required. Note that reloaded will start
+    the service if it is not already started, even if your chosen init system wouldn't
+    normally.
+  options: "started\r\nstopped\r\nrestarted\r\nreloaded"
+  advanced: false
+- name: name
+  required: true
+  input_type: user
+  description: Name of the service.
+  advanced: false
+- name: pattern
+  required: false
+  input_type: user
+  description: If the service does not respond to the status command, name a substring
+    to look for as would be found in the output of the ps command as a stand-in for
+    a status result. If the string is found, the service will be assumed to be running.
+  advanced: true
+- name: sleep
+  required: false
+  input_type: user
+  description: If the service is being restarted then sleep this many seconds between
+    the stop and start command. This helps to workaround badly behaving init scripts
+    that exit immediately after signaling a process to stop.
+  advanced: true
+- name: enabled
+  required: false
+  input_type: user
+  description: Whether the service should start on boot.
+  advanced: true
+- name: args
+  required: false
+  input_type: user
+  description: Additional arguments provided on the command line
+  advanced: true
+provider_type: Ansible
+kind: job_template
+model: JobTemplate
+%>
+
+# For Windows targets, we should use win_service
+---
+- hosts: all
+  tasks:
+  - service:
+      name: <%= input('name') %>
+      state: <%= input('state') %>
+      <%= "enabled: #{input('enabled')}" if input('enabled').present? %>
+      <%= "args: #{input('args')}" if input('args').present? %>
+      <%= "pattern: #{input('pattern')}" if input('pattern').present? %>
+      <%= "sleep: #{input('sleep')}" if input('sleep').present? %>

data/lib/foreman_ansible/engine.rb

@@ -56,7 +56,8 @@ module ForemanAnsible
     initializer 'foreman_ansible.configure_assets', :group => :assets do
       SETTINGS[:foreman_ansible] = {
         :assets => {
-          :precompile => ['foreman_ansible/Ansible.png']
+          :precompile => ['foreman_ansible/Ansible.png',
+                          'foreman_ansible/foreman-ansible.css']
         }
       }
     end
@@ -109,4 +110,5 @@ module ForemanAnsible
       end
     end
   end
+  # rubocop:enable ClassLength
 end

data/lib/foreman_ansible/register.rb

@@ -33,6 +33,8 @@ Foreman::Plugin.register :foreman_ansible do
         :import_ansible_roles]
 
   add_all_permissions_to_default_roles
+  extend_template_helpers ForemanAnsible::RendererMethods
+  allowed_template_helpers :insights_remediation
 
   role_assignment_params = { :ansible_role_ids => [],
                              :ansible_roles => [] }
@@ -48,5 +50,10 @@ Foreman::Plugin.register :foreman_ansible do
   apipie_documented_controllers [
     "#{ForemanAnsible::Engine.root}/app/controllers/api/v2/*.rb"
   ]
+
+  # For backwards compatiblity with 1.17
+  if respond_to?(:register_report_scanner)
+    register_report_scanner ForemanAnsible::AnsibleReportScanner
+  end
 end
 # rubocop:enable BlockLength

data/lib/foreman_ansible/remote_execution.rb

@@ -17,6 +17,13 @@ module ForemanAnsible
         :description => N_('Runs an Ansible playbook which contains all'\
                            ' the roles defined for a host')
       )
+      RemoteExecutionFeature.register(
+        :ansible_run_insights_plan,
+        N_('Ansible: Run Insights maintenance plan'),
+        :description => N_('Runs a given maintenance plan from Red Hat '\
+                           'Access Insights given an ID.'),
+        :provided_inputs => %w[organization_id plan_id]
+      )
     end
   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 = '2.0.4'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "foreman_ansible",
+  "version": "1.0.0",
+  "description": "[![Code Climate](https://codeclimate.com/github/theforeman/foreman_ansible/badges/gpa.svg)](https://codeclimate.com/github/theforeman/foreman_ansible) [![Gem Version](https://badge.fury.io/rb/foreman_ansible.svg)](https://badge.fury.io/rb/foreman_ansible) [![GPL License](https://img.shields.io/github/license/theforeman/foreman_ansible.svg)](https://github.com/theforeman/foreman_ansible/blob/master/LICENSE)",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {
+    "react-json-tree": "^0.11.0"
+  },
+  "devDependencies": {
+    "babel-eslint": "^8.2.1",
+    "babel-preset-env": "^1.6.0",
+    "babel-preset-react": "^6.24.1",
+    "babel-plugin-lodash": "^3.3.2",
+    "babel-plugin-transform-object-assign": "^6.22.0",
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "eslint": "^4.18.1",
+    "eslint-config-airbnb": "^16.0.0",
+    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-jest": "^21.2.0",
+    "eslint-plugin-jsx-a11y": "^6.0.2",
+    "eslint-plugin-react": "^7.4.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bastilian/foreman_ansible.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/bastilian/foreman_ansible/issues"
+  },
+  "homepage": "https://github.com/bastilian/foreman_ansible#readme"
+}

data/test/fixtures/report.json

@@ -0,0 +1,26 @@
+{
+  "reported_at":"2018-01-15 17:31:36 521275",
+  "metrics": {
+    "time":
+      { "total":37 }
+  },
+  "host": "io.local",
+  "status": {
+    "applied": 0,
+    "failed": 0,
+    "skipped": 0
+  },
+  "logs": [
+    {
+      "log": {
+        "sources": {
+          "source": "common : Install Common packages"
+        },
+        "messages": {
+          "message": "{\"msg\": \"All items completed\", \"changed\": false, \"results\": [{\"_ansible_parsed\": true, \"changed\": false, \"_ansible_no_log\": false, \"cache_updated\": false, \"_ansible_item_result\": true, \"failed\": false, \"item\": \"git\", \"invocation\": {\"module_args\": {\"dpkg_options\": \"force-confdef,force-confold\", \"upgrade\": null, \"force\": false, \"force_apt_get\": false, \"package\": [\"git\"], \"autoclean\": false, \"name\": \"git\", \"purge\": false, \"allow_unauthenticated\": false, \"state\": \"present\", \"autoremove\": false, \"update_cache\": null, \"default_release\": null, \"only_upgrade\": false, \"cache_valid_time\": 0, \"deb\": null, \"install_recommends\": null}}, \"_ansible_ignore_errors\": null, \"cache_update_time\": 1515797094}, {\"_ansible_parsed\": true, \"changed\": false, \"_ansible_no_log\": false, \"cache_updated\": false, \"_ansible_item_result\": true, \"failed\": false, \"item\": \"htop\", \"invocation\": {\"module_args\": {\"dpkg_options\": \"force-confdef,force-confold\", \"upgrade\": null, \"force\": false, \"force_apt_get\": false, \"package\": [\"htop\"], \"autoclean\": false, \"name\": \"htop\", \"purge\": false, \"allow_unauthenticated\": false, \"state\": \"present\", \"autoremove\": false, \"update_cache\": null, \"default_release\": null, \"only_upgrade\": false, \"cache_valid_time\": 0, \"deb\": null, \"install_recommends\": null}}, \"_ansible_ignore_errors\": null, \"cache_update_time\": 1515797094}, {\"_ansible_parsed\": true, \"changed\": false, \"_ansible_no_log\": false, \"cache_updated\": false, \"_ansible_item_result\": true, \"failed\": false, \"item\": \"zsh\", \"invocation\": {\"module_args\": {\"dpkg_options\": \"force-confdef,force-confold\", \"upgrade\": null, \"force\": false, \"force_apt_get\": false, \"package\": [\"zsh\"], \"autoclean\": false, \"name\": \"zsh\", \"purge\": false, \"allow_unauthenticated\": false, \"state\": \"present\", \"autoremove\": false, \"update_cache\": null, \"default_release\": null, \"only_upgrade\": false, \"cache_valid_time\": 0, \"deb\": null, \"install_recommends\": null}}, \"_ansible_ignore_errors\": null, \"cache_update_time\": 1515797094}]}"},"level":"info"}},{"log":{"sources":{"source":"common : Copy default motd"},"messages":{"message":"{\"_ansible_parsed\": true, \"group\": \"root\", \"uid\": 0, \"checksum\": \"0a381ff6a86081af6dc957a77c7e2017a3244c4c\", \"changed\": false, \"owner\": \"root\", \"state\": \"file\", \"gid\": 0, \"mode\": \"0644\", \"diff\": {\"after\": {\"path\": \"/etc/motd\"}, \"before\": {\"path\": \"/etc/motd\"}}, \"invocation\": {\"module_args\": {\"directory_mode\": null, \"force\": false, \"remote_src\": null, \"path\": \"/etc/motd\", \"owner\": \"root\", \"follow\": false, \"group\": \"root\", \"unsafe_writes\": null, \"state\": \"file\", \"content\": null, \"serole\": null, \"diff_peek\": null, \"setype\": null, \"dest\": \"/etc/motd\", \"selevel\": null, \"original_basename\": \"motd.txt\", \"regexp\": null, \"validate\": null, \"src\": \"motd.txt\", \"seuser\": null, \"recurse\": false, \"delimiter\": null, \"mode\": null, \"attributes\": null, \"backup\": null}}, \"path\": \"/etc/motd\", \"size\": 1090, \"_ansible_no_log\": false}"
+        },
+        "level": "info"
+      }
+    }
+  ]
+}

data/test/test_plugin_helper.rb

@@ -1,11 +1,15 @@
 require 'test_helper'
 require 'facets'
 
+def ansible_fixture_file(filename)
+  File.join(
+    ForemanAnsible::Engine.root, 'test', 'fixtures', filename
+  )
+end
+
 def sample_facts_file
   File.read(
-    File.join(
-      ForemanAnsible::Engine.root, 'test', 'fixtures', 'sample_facts.json'
-    )
+    ansible_fixture_file('sample_facts.json')
   )
 end
 

data/test/unit/concerns/config_reports_extensions_test.rb

@@ -0,0 +1,23 @@
+require 'test_plugin_helper'
+
+# Tests for the behavior of Host with roles, checks inheritance, etc
+class ConfigReportExtensionsTest < ActiveSupport::TestCase
+  let(:example_report) do
+    JSON.parse(File.read(ansible_fixture_file('report.json')))
+  end
+
+  describe '.import' do
+    it 'sets an origin for Ansible reports' do
+      report = ConfigReport.import(example_report)
+      assert_equal 'Ansible', report.origin
+    end
+
+    it 'sets no origin for other reports' do
+      report = ConfigReport.import(
+        'host' => 'io.local',
+        'reported_at' => Time.now.utc.to_s
+      )
+      assert_nil report.origin
+    end
+  end
+end

data/test/unit/helpers/ansible_reports_helper_test.rb

@@ -0,0 +1,46 @@
+require 'test_plugin_helper'
+
+class AnsibleReportsHelperTest < ActiveSupport::TestCase
+  include ForemanAnsible::AnsibleReportsHelper
+  include ActionView::Helpers::TagHelper
+
+  test 'is able to print a string instead of a hash' do
+    log_value = <<-ANSIBLELOG.strip_heredoc
+  {"_ansible_parsed": true, "_ansible_no_log": false, "changed": false, "results": ["ntp-4.2.8p10-3.fc27.x86_64 providing ntp is already installed"], "rc": 0, "invocation": {"module_args": {"allow_downgrade": false, "name": ["ntp"], "list": null, "disable_gpg_check": false, "conf_file": null, "install_repoquery": true, "state": "installed", "disablerepo": null, "update_cache": false, "enablerepo": null, "exclude": null, "security": false, "validate_certs": true, "installroot": "/", "skip_broken": false}}, "msg": ""}
+ANSIBLELOG
+    message = FactoryBot.build(:message)
+    message.value = log_value
+    log = FactoryBot.build(:log)
+    log.message = message
+    assert_match(
+      /ntp-4.2.8p10-3.fc27.x86_64 providing ntp is already installed/,
+      module_invocations(parsed_message_json(log)).to_s
+    )
+  end
+
+  test 'pretty print is able to print a hash' do
+    hash = {
+      'allow_downgrade' => false,
+      'name' => ['ntp'],
+      'list' => nil,
+      'disable_gpg_check' => false,
+      'conf_file' => nil,
+      'install_repoquery' => true,
+      'state' => 'installed',
+      'disablerepo' => nil,
+      'update_cache' => false,
+      'enablerepo' => nil,
+      'exclude' => nil,
+      'security' => false,
+      'validate_certs' => true,
+      'installroot' => '/',
+      'skip_broken' => false
+    }
+    assert_equal(
+      hash,
+      remove_keys(
+        hash
+      )
+    )
+  end
+end

data/test/unit/services/inventory_creator_test.rb

@@ -25,6 +25,7 @@ module ForemanAnsible
       @host.expects(:host_params).returns(extra_options).at_least_once
       inventory = ForemanAnsible::InventoryCreator.new(@host,
                                                        @template_invocation)
+
       assert_empty extra_options.to_a - inventory.connection_params(@host).to_a
     end
 
@@ -61,8 +62,6 @@ module ForemanAnsible
                    connection_params['ansible_user']
       refute_equal Setting['remote_execution_ssh_port'],
                    connection_params['ansible_port']
-      assert_equal ForemanRemoteExecutionCore.settings[:ssh_identity_key_file],
-                   connection_params['ansible_ssh_private_key_file']
       assert_equal extra_options['ansible_port'],
                    connection_params['ansible_port']
       assert_equal Setting['remote_execution_ssh_password'],
@@ -78,22 +77,6 @@ module ForemanAnsible
                    inventory.rex_ssh_password(@host))
     end
 
-    test 'ssh private key is passed when available' do
-      host = FactoryBot.build(:host)
-      path_to_key = '/path/to/private/key'
-      inventory = ForemanAnsible::InventoryCreator.new(host,
-                                                       @template_invocation)
-      host.params.expects(:[]).with('ansible_ssh_private_key_file')
-          .returns(path_to_key)
-      host.params.expects(:[]).with('remote_execution_ssh_user')
-          .returns('root')
-      host.params.expects(:[]).with('remote_execution_ssh_port')
-          .returns('2222')
-      connection_params = inventory.connection_params(host)
-      assert_equal path_to_key,
-                   connection_params['ansible_ssh_private_key_file']
-    end
-
     test 'template invocation inputs are sent as Ansible variables' do
       job_template = FactoryBot.build(
         :job_template,

data/webpack/components/ReportJsonViewer.js

@@ -0,0 +1,17 @@
+import React from 'react';
+import JSONTree from 'react-json-tree';
+
+const theme = {
+  scheme: 'foreman',
+  backgroundColor: 'rgba(0, 0, 0, 255)',
+  base00: 'rgba(0, 0, 0, 0)',
+};
+
+class ReportJsonViewer extends React.Component {
+  render() {
+    return <div className="report-json-viewer">
+      <JSONTree data={this.props.data} hideRoot theme={theme} />
+    </div>;
+  }
+}
+export default ReportJsonViewer;

data/webpack/index.js

@@ -0,0 +1,4 @@
+import componentRegistry from 'foremanReact/components/componentRegistry';
+import ReportJsonViewer from './components/ReportJsonViewer';
+
+componentRegistry.register({ name: 'ReportJsonViewer', type: ReportJsonViewer });

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,6 +38,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dynflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.14
 - !ruby/object:Gem::Dependency
   name: foreman-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +59,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +69,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: foreman_ansible_core
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +117,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/images/foreman_ansible/Ansible.png
+- app/assets/stylesheets/foreman_ansible/foreman-ansible.css
 - app/controllers/ansible_roles_controller.rb
 - app/controllers/api/v2/ansible_roles_controller.rb
 - app/controllers/foreman_ansible/api/v2/hostgroups_controller_extensions.rb
@@ -124,13 +145,16 @@ files:
 - app/overrides/hostgroup_ansible_roles_tab.rb
 - app/overrides/hostgroup_play_roles.rb
 - app/overrides/report_output.rb
+- app/services/foreman_ansible/ansible_report_scanner.rb
 - app/services/foreman_ansible/api_roles_importer.rb
 - app/services/foreman_ansible/fact_importer.rb
 - app/services/foreman_ansible/fact_parser.rb
 - app/services/foreman_ansible/fact_sparser.rb
+- app/services/foreman_ansible/insights_plan_runner.rb
 - app/services/foreman_ansible/inventory_creator.rb
 - app/services/foreman_ansible/playbook_creator.rb
 - app/services/foreman_ansible/proxy_selector.rb
+- app/services/foreman_ansible/renderer_methods.rb
 - app/services/foreman_ansible/roles_importer.rb
 - app/services/foreman_ansible/structured_fact_importer.rb
 - app/services/foreman_ansible/ui_roles_importer.rb
@@ -150,7 +174,15 @@ files:
 - app/views/foreman_ansible/api/v2/ansible_roles/show.json.rabl
 - app/views/foreman_ansible/config_reports/_ansible.html.erb
 - app/views/foreman_ansible/config_reports/_output.html.erb
-- app/views/foreman_ansible/job_templates/ansible_roles.erb
+- app/views/foreman_ansible/job_templates/ansible_roles_-_ansible_default.erb
+- app/views/foreman_ansible/job_templates/ansible_roles_-_install_from_galaxy.erb
+- app/views/foreman_ansible/job_templates/ansible_roles_-_install_from_git.erb
+- app/views/foreman_ansible/job_templates/maintenance_plan.erb
+- app/views/foreman_ansible/job_templates/package_action_-_ansible_default.erb
+- app/views/foreman_ansible/job_templates/power_action_-_ansible_default.erb
+- app/views/foreman_ansible/job_templates/puppet_run_once_-_ansible_default.erb
+- app/views/foreman_ansible/job_templates/run_command_-_ansible_default.erb
+- app/views/foreman_ansible/job_templates/service_action_-_ansible_default.erb
 - config/routes.rb
 - db/migrate/20160705082036_create_ansible_role.rb
 - db/migrate/20160706074540_create_join_table_hosts_ansible_roles.rb
@@ -170,8 +202,10 @@ files:
 - locale/en/foreman_ansible.po
 - locale/foreman_ansible.pot
 - locale/gemspec.rb
+- package.json
 - test/factories/ansible_proxy.rb
 - test/factories/ansible_roles.rb
+- test/fixtures/report.json
 - test/fixtures/sample_facts.json
 - test/functional/ansible_roles_controller_test.rb
 - test/functional/api/v2/ansible_roles_controller_test.rb
@@ -182,9 +216,10 @@ files:
 - test/unit/actions/run_ansible_job_test.rb
 - test/unit/actions/run_proxy_ansible_command_test.rb
 - test/unit/ansible_role_test.rb
+- test/unit/concerns/config_reports_extensions_test.rb
 - test/unit/concerns/host_managed_extensions_test.rb
 - test/unit/concerns/hostgroup_extensions_test.rb
-- test/unit/helpers/foreman_ansible/ansible_reports_helper_test.rb
+- test/unit/helpers/ansible_reports_helper_test.rb
 - test/unit/host_ansible_role_test.rb
 - test/unit/hostgroup_ansible_role_test.rb
 - test/unit/lib/foreman_ansible_core/playbook_runner_test.rb
@@ -199,6 +234,8 @@ files:
 - test/unit/services/roles_importer_test.rb
 - test/unit/services/structured_fact_importer_test.rb
 - test/unit/services/ui_roles_importer_test.rb
+- webpack/components/ReportJsonViewer.js
+- webpack/index.js
 homepage: https://github.com/theforeman/foreman_ansible
 licenses:
 - GPL-3.0
@@ -232,6 +269,7 @@ test_files:
 - test/functional/ansible_roles_controller_test.rb
 - test/functional/hosts_controller_test.rb
 - test/unit/ansible_role_test.rb
+- test/unit/concerns/config_reports_extensions_test.rb
 - test/unit/concerns/host_managed_extensions_test.rb
 - test/unit/concerns/hostgroup_extensions_test.rb
 - test/unit/lib/foreman_ansible_core/playbook_runner_test.rb
@@ -241,15 +279,16 @@ test_files:
 - test/unit/services/fact_importer_test.rb
 - test/unit/services/fact_parser_test.rb
 - test/unit/services/fact_sparser_test.rb
+- test/unit/services/inventory_creator_test.rb
 - test/unit/services/proxy_selector_test.rb
 - test/unit/services/roles_importer_test.rb
 - test/unit/services/structured_fact_importer_test.rb
 - test/unit/services/ui_roles_importer_test.rb
-- test/unit/services/inventory_creator_test.rb
 - test/unit/actions/run_ansible_job_test.rb
 - test/unit/actions/run_proxy_ansible_command_test.rb
+- test/unit/helpers/ansible_reports_helper_test.rb
 - test/unit/host_ansible_role_test.rb
 - test/unit/hostgroup_ansible_role_test.rb
-- test/unit/helpers/foreman_ansible/ansible_reports_helper_test.rb
 - test/fixtures/sample_facts.json
+- test/fixtures/report.json
 - test/test_plugin_helper.rb

data/app/views/foreman_ansible/job_templates/ansible_roles.erb

@@ -1,17 +0,0 @@
-<%#
-kind: job_template
-name: Ansible Roles - Ansible Default
-job_category: Ansible Playbook
-description_format: 'Run Ansible roles for host'
-feature: ansible_run_host
-provider_type: Ansible
-%>
-
----
-- hosts: <%= @host.name %>
-  tasks:
-    - debug: msg=These are the parameters "{{ foreman_params }}"
-  roles:
-    <% if @host.all_ansible_roles.present? -%>
-    - <%= @host.all_ansible_roles.map { |role| role.name.strip }.join("\n    - ") %>
-    <% end -%>

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

@@ -1,24 +0,0 @@
-require 'test_plugin_helper'
-
-module ForemanAnsible
-  module Helpers
-    # Tests for the view helper that concerns the Ansible reports styles
-    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?(FactoryBot.build(:log))
-      end
-
-      test 'ansible_report? returns true when log contains module_name' do
-        log = FactoryBot.build(:log)
-        log.source.value = '{ "module_name" : "foo" }'
-        assert ansible_report?(log)
-      end
-    end
-  end
-end