foreman_ansible 6.3.4 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ef5c59ee6bba3f3b62db1288f39776cf0661b2e12c7145212345e7e291b8cf
-  data.tar.gz: bb25459005a758c693a97cfcd6ef202ddffb8831374417be1588073f7ef97ff5
+  metadata.gz: 05c975cb77fe5add41b7281dfa1c2451bb22a09ab5dc6251ab06fd4d00b834e2
+  data.tar.gz: 86613f4be767b5af80a06f83b9e13f8f030cd80bc362d866323111b61a0b23a9
 SHA512:
-  metadata.gz: c2a37f0db636e45970d8c3c34584d44912e5d0569af15915112a7ab9438717651e3fbe3291e7fcc82a052ea985833beb393e30347dcf8b2e83341ed5d1cd2377
-  data.tar.gz: 2fae33324c5c41462ad4375f68344e34872b45085a64c91f08f5a2465cd77e08c22b1087fb17a5f06299bb887ada63c40f0953de8e012e960ae2bf74b0e1c66f
+  metadata.gz: dc27695cef374e8b709ddc3c3882056587cbf975ac7d497c1fec5aaa1885f85bcb3677c2c7fd3f2602f529cba0a6736017703f6d7ca413eb5f2ed7a6de112a94
+  data.tar.gz: ba0c5f9b94a51b7328cc0df73bfcc0f47831b1004b275be935fa73a83ae9c6f12b81086071ebe69292c8aa5ad436c5389a6a6f1ac457720bcefe034b456c0ec8

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -4,21 +4,19 @@ module ForemanAnsible
   # This module takes the config reports stored in Foreman for Ansible and
   # modifies them to be properly presented in views
   module AnsibleReportsHelper
-    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 ansible_task_name(log)
+      source_value = log.source&.value
+      return source_value || no_data_message unless source_value.include? ':'
+      name = source_value.split(':')[1].strip if source_value.include?(':')
+      name || no_data_message
+    end
+
     def ansible_run_in_check_mode?(log)
       log.message&.value == 'check_mode_enabled' if check_mode_log?(log)
     end
@@ -27,12 +25,36 @@ module ForemanAnsible
       log.source&.value == 'check_mode'
     end
 
-    def ansible_module_args(log)
-      report_json_viewer module_invocations parsed_message_json(log)
+    def ansible_module_message(log)
+      msg_json = parsed_message_json(log)
+      module_action = msg_json['module']
+      case module_action
+      when 'package'
+        msg_json['results'].empty? ? msg_json['msg'] : msg_json['results']
+      when 'template'
+        module_args = msg_json['invocation']['module_args']
+        _("Rendered template #{module_args['_original_basename']} to #{msg_json['dest']}")
+      when 'service'
+        _("Service #{msg_json['name']} #{msg_json['state']} (enabled: #{msg_json['enabled']})")
+      when 'group'
+        _("User group #{msg_json['name']} #{msg_json['state']}, gid: #{msg_json['gid']}")
+      when 'user'
+        _("User #{msg_json['name']} #{msg_json['state']}, uid: #{msg_json['uid']}")
+      when 'cron'
+        module_args = msg_json['invocation']['module_args']
+        _("Cron job: #{module_args['minute']} #{module_args['hour']} #{module_args['day']} #{module_args['month']} #{module_args['weekday']} #{module_args['job']} (disabled: #{module_args['disabled']})")
+      when 'copy'
+        module_args = msg_json['invocation']['module_args']
+        _("Copy #{module_args['_original_basename']} to #{msg_json['dest']}")
+      when 'command', 'shell'
+        msg_json['stdout_lines']
+      else
+        no_data_message
+      end
     end
 
-    def ansible_module_message(log)
-      report_json_viewer hash_with_keys_removed parsed_message_json(log)
+    def no_data_message
+      _('No additional data')
     end
 
     def ansible_report_origin_icon
@@ -49,49 +71,8 @@ module ForemanAnsible
       false
     end
 
-    def report_json_viewer(json)
-      react_component('ReportJsonViewer', data: 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'
-      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

data/app/helpers/foreman_ansible/ansible_roles_data_preparations.rb

@@ -2,22 +2,22 @@
 
 module ForemanAnsible
   module AnsibleRolesDataPreparations
-    VARIABLE_ACTION_NAMES = { 'new' => _('Add'), 'obsolete' => _('Remove'), 'update' => _('Update') }.freeze
-    ROLE_ACTION_NAMES = { 'new' => _('Import Role'), 'obsolete' => _('Remove Role'), 'old' => _('Update Role Variables') }.freeze
+    VARIABLE_ACTION_NAMES = { 'new' => N_('Add'), 'obsolete' => N_('Remove'), 'update' => N_('Update') }.freeze
+    ROLE_ACTION_NAMES = { 'new' => N_('Import Role'), 'obsolete' => N_('Remove Role'), 'old' => N_('Update Role Variables') }.freeze
 
-    def variable_action_name(kind)
-      VARIABLE_ACTION_NAMES[kind]
+    def get_variable_action(kind)
+      _(VARIABLE_ACTION_NAMES[kind])
     end
 
-    def role_action_name(kind)
-      ROLE_ACTION_NAMES[kind]
+    def get_role_action(kind)
+      _(ROLE_ACTION_NAMES[kind])
     end
 
     def get_old_roles_variables(imported_variables, role)
-      variables = { 'new' => [], 'obsolete' => [], 'update' => [] }
+      variables = { 'Add' => [], 'Remove' => [], 'Update' => [] }
       imported_variables.each do |kind, temp_variables|
         temp_variables.each do |temp_variable|
-          variables[kind].append(temp_variable.key) if temp_variable.ansible_role_id == role.id
+          variables[get_variable_action(kind)].append(temp_variable.key) if temp_variable.ansible_role_id == role.id
         end
       end
       variables
@@ -26,16 +26,16 @@ module ForemanAnsible
     def variables_to_s(variables)
       str = ''
       variables.each do |action, temp_variables|
-        str += "#{variable_action_name action}: #{temp_variables.size}, " unless temp_variables.empty?
+        str += "#{action}: #{temp_variables.size}, " unless temp_variables.empty?
       end
       str[0..-3]
     end
 
     def get_roles_variables(imported_variables, variables_importer, kind, role)
       if kind == 'new'
-        variables = { 'new' => variables_importer.get_variables_names(role.name) }
+        variables = { 'Add' => variables_importer.get_variables_names(role.name) }
       elsif kind == 'obsolete'
-        variables = { 'obsolete' => role.ansible_variables.map(&:key) }
+        variables = { 'Remove' => role.ansible_variables.map(&:key) }
       elsif kind == 'old'
         variables = get_old_roles_variables(imported_variables, role)
       end
@@ -51,25 +51,24 @@ module ForemanAnsible
       match.to_s.empty? ? nil : match
     end
 
-    def prepare_api_row(role, kind, variables)
+    def prepare_api_row(role, kind, variables, role_action)
       {
         name: role.name,
         id: role.id,
-        role_action: role_action_name(kind),
+        role_action: role_action,
         variables: variables,
-        hosts_count: kind == 'obsolete' ? role.hosts.count : '',
-        hostgroup_count: kind == 'obsolete' ? role.hostgroups.count : '',
+        hosts_count: role_action == 'Remove Role' ? role.hosts.count : '',
+        hostgroup_count: role_action == 'Remove Role' ? role.hostgroups.count : '',
         kind: kind
       }
     end
 
-    def prepare_ui_row(role, kind, variables)
+    def prepare_ui_row(role, kind, variables, role_action)
       { cells: [
         role.name,
-        role_action_name(kind),
-        variables,
-        kind == 'obsolete' ? role.hosts.count : '',
-        kind == 'obsolete' ? role.hostgroups.count : ''
+        role_action, variables,
+        role_action == 'Remove Role' ? role.hosts.count : '',
+        role_action == 'Remove Role' ? role.hostgroups.count : ''
       ],
         role: role, kind: kind, id: role.name }
     end
@@ -82,10 +81,11 @@ module ForemanAnsible
           next if role_match_excluded_roles(role.name)
           variables = get_roles_variables(imported_variables, variables_importer, kind, role)
           next if variables.empty? && kind['old']
+          role_action = get_role_action(kind)
           if is_ui
-            rows.append(prepare_ui_row(role, kind, variables))
+            rows.append(prepare_ui_row(role, kind, variables, role_action))
           else
-            rows.append(prepare_api_row(role, kind, variables))
+            rows.append(prepare_api_row(role, kind, variables, role_action))
           end
         end
       end

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

@@ -6,7 +6,7 @@ module ForemanAnsible
     extend ActiveSupport::Concern
 
     included do
-      has_many :hostgroup_ansible_roles, -> { order('hostgroup_ansible_roles.position ASC') }, :foreign_key => :hostgroup_id
+      has_many :hostgroup_ansible_roles, :foreign_key => :hostgroup_id
       has_many :ansible_roles,
                -> { order('hostgroup_ansible_roles.position ASC') },
                :through => :hostgroup_ansible_roles,

data/app/models/foreman_ansible/ansible_provider.rb

@@ -18,6 +18,10 @@ if defined? ForemanRemoteExecution
           'Ansible'
         end
 
+        def provider_input_namespace
+          :ansible
+        end
+
         def proxy_command_options(template_invocation, host)
           super(template_invocation, host).merge(
             'ansible_inventory' => ::ForemanAnsible::InventoryCreator.new(
@@ -34,7 +38,6 @@ if defined? ForemanRemoteExecution
 
         def secrets(host)
           {
-            :key_passphrase => Setting[:remote_execution_ssh_key_passphrase],
             'per-host' => {
               host.name => {
                 'ansible_password' => rex_ssh_password(host),
@@ -52,16 +55,65 @@ if defined? ForemanRemoteExecution
           host_setting(host, 'remote_execution_effective_user_password')
         end
 
+        def host_setting(host, setting)
+          host.params[setting.to_s] || Setting[setting]
+        end
+
         def supports_effective_user?
           true
         end
 
+        def provider_inputs
+          [
+            ForemanRemoteExecution::ProviderInput.new(
+              name: 'tags',
+              label: _('Tags'),
+              value: '',
+              value_type: 'plain',
+              description: 'Tags used for Ansible execution'
+            ),
+            ForemanRemoteExecution::ProviderInput.new(
+              name: 'tags_flag',
+              label: _('Include/Exclude Tags'),
+              value: 'include',
+              description: 'Option whether to include or exclude tags',
+              options: "include\nexclude"
+            )
+          ]
+        end
+
+        def provider_inputs_doc
+          opts = provider_inputs.find { |input| input.name == 'tags_flag' }.options.split("\n")
+          {
+            :namespace => provider_input_namespace,
+            :opts => { :desc => N_('Ansible provider specific inputs') },
+            :children => [
+              {
+                :name => :tags,
+                :type => Array,
+                :opts => { :required => false, :desc => N_('A comma separated list of tags to use for Ansible run') }
+              },
+              {
+                :name => :tags_flag,
+                :type => opts,
+                :opts => { :required => false, :desc => N_('Include\Exclude tags for Ansible run') }
+              }
+            ]
+          }
+        end
+
+        def proxy_command_provider_inputs(template_invocation)
+          tags = template_invocation.provider_input_values.find_by(:name => 'tags')&.value || ''
+          tags_flag = template_invocation.provider_input_values.find_by(:name => 'tags_flag')&.value || ''
+          { :tags => tags, :tags_flag => tags_flag }
+        end
+
         def proxy_operation_name
           'ansible-runner'
         end
 
         def proxy_action_class
-          'ForemanAnsibleCore::TaskLauncher::Playbook::PlaybookRunnerAction'
+          'Proxy::Ansible::TaskLauncher::Playbook::PlaybookRunnerAction'
         end
 
         private

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

@@ -10,8 +10,7 @@
   <thead>
     <tr>
       <th><%= _("Level") %></th>
-      <th><%= _("Module") %></th>
-      <th><%= _("Arguments") %></th>
+      <th><%= _("Task") %></th>
       <th><%= _("Message") %></th>
     </tr>
   </thead>
@@ -20,9 +19,19 @@
       <% unless check_mode_log?(log) %>
         <tr>
           <td><span <%= report_tag log.level %>><%= h log.level %></span></td>
-          <td><%= ansible_module_name(log) %></td>
-          <td><%= ansible_module_args(log) %></td>
-          <td><%= ansible_module_message(log) %></td>
+          <td><span title=<%= ansible_module_name(log) %>><%= ansible_task_name(log) %></span></td>
+          <td>
+            <% log_message = ansible_module_message(log) %>
+            <% if log_message.is_a? Array %>
+              <ul>
+                <% log_message.each do |message_line| %>
+                  <li><%= message_line %></li>
+                <% end %>
+              </ul>
+            <% else %>
+              <%= log_message %>
+          <% end %>
+          </td>
         </tr>
       <% end %>
     <% end %>

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

@@ -15,10 +15,14 @@ model: JobTemplate
     - name: Display all parameters known for the Foreman host
       debug:
         var: foreman
+      tags:
+        - always
   tasks:
     - name: Apply roles
       include_role:
         name: "{{ role }}"
+      tags:
+        - always
       loop: "{{ foreman_ansible_roles }}"
       loop_control:
         loop_var: role

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

@@ -34,7 +34,7 @@ kind: job_template
         url: <%= subscription_manager_configuration_url(@host) %>
         dest: /usr/share/convert2rhel/subscription-manager/katello-ca-consumer-latest.noarch.rpm
     - name: Start convert2rhel
-      command: convert2rhel -y --activationkey "<%= input('Activation Key') %>" --org "<%= @host.organization.label %>" --keep-rhsm
+      command: convert2rhel -y --activationkey "<%= input('Activation Key') %>" --org "<%= @host.organization.label %>" > /root/convert2rhel.log
 <%- if input('Restart') == "yes" -%>
     - name: Reboot the machine
       reboot:

data/lib/foreman_ansible/engine.rb

@@ -4,7 +4,6 @@ require 'deface'
 require 'acts_as_list'
 require 'fast_gettext'
 require 'gettext_i18n_rails'
-require 'foreman_ansible_core' if Rails.env.test?
 require 'foreman_ansible/remote_execution'
 
 module ForemanAnsible

data/lib/foreman_ansible/register.rb

@@ -76,10 +76,9 @@ Foreman::Plugin.register :foreman_ansible do
 
   role 'Ansible Roles Manager',
        [:play_roles_on_host, :play_roles_on_hostgroup,
-        :create_job_invocations, :view_job_templates,      # to allow the play_roles
-        :create_template_invocations, :view_smart_proxies, # ...
         :view_ansible_roles, :destroy_ansible_roles,
-        :import_ansible_roles, :view_ansible_variables,
+        :import_ansible_roles,
+        :view_ansible_variables,
         :create_ansible_variables, :import_ansible_variables,
         :edit_ansible_variables, :destroy_ansible_variables]
 
@@ -97,6 +96,8 @@ Foreman::Plugin.register :foreman_ansible do
   parameter_filter Host::Managed, base_role_assignment_params.merge(:host_ansible_roles_attributes => {})
   parameter_filter Hostgroup, base_role_assignment_params.merge(:hostgroup_ansible_roles_attributes => {})
 
+  register_global_js_file 'global'
+
   divider :top_menu, :caption => N_('Ansible'), :parent => :configure_menu
   menu :top_menu, :ansible_roles,
        :caption => N_('Roles'),

data/lib/foreman_ansible/version.rb

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

data/package.json

@@ -14,16 +14,18 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^6.0.0",
-    "@theforeman/eslint-plugin-foreman": "6.0.0",
-    "@theforeman/test": "^6.0.0",
-    "@theforeman/vendor-dev": "^6.0.0",
+    "@theforeman/builder": "^8.4.1",
+    "@theforeman/eslint-plugin-foreman": "^8.4.1",
+    "@theforeman/find-foreman": "^8.4.1",
+    "@theforeman/stories": "^8.4.1",
+    "@theforeman/test": "^8.4.1",
+    "@theforeman/vendor-dev": "^8.4.1",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "prettier": "^1.13.5"
   },
   "scripts": {
-    "test": "tfm-test --plugin",
+    "test": "tfm-test --plugin --config jest.config.js",
     "lint": "tfm-lint --plugin -d webpack"
   },
   "repository": {

data/test/unit/ansible_provider_test.rb

@@ -30,11 +30,14 @@ class AnsibleProviderTest < ActiveSupport::TestCase
     end
 
     context 'when using secrets' do
-      let(:host) { FactoryBot.create(:host) }
+      let(:host) { FactoryBot.build(:host) }
 
       it 'generates secrets properly' do
-        host.parameters << HostParameter.new(name: 'remote_execution_ssh_password', value: 'password')
-        host.parameters << HostParameter.new(name: 'remote_execution_effective_user_password', value: 'letmein')
+        params = {
+          'remote_execution_ssh_password' => 'password',
+          'remote_execution_effective_user_password' => 'letmein'
+        }
+        host.expects(:params).twice.returns(params)
         secrets = ForemanAnsible::AnsibleProvider.secrets(host)
         host_secrets = secrets['per-host'][host.name]
         assert_equal host_secrets['ansible_password'], 'password'

data/test/unit/helpers/ansible_reports_helper_test.rb

@@ -6,43 +6,17 @@ class AnsibleReportsHelperTest < ActiveSupport::TestCase
   include ForemanAnsible::AnsibleReportsHelper
   include ActionView::Helpers::TagHelper
 
-  test 'is able to print a string instead of a hash' do
+  test 'module message extraction' 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": ""}
+    {"msg": "Nothing to do", "changed": false, "results": [], "rc": 0, "invocation": {"module_args": {"name": ["openssh"], "state": "present", "allow_downgrade": false, "autoremove": false, "bugfix": false, "disable_gpg_check": false, "disable_plugin": [], "disablerepo": [], "download_only": false, "enable_plugin": [], "enablerepo": [], "exclude": [], "installroot": "/", "install_repoquery": true, "install_weak_deps": true, "security": false, "skip_broken": false, "update_cache": false, "update_only": false, "validate_certs": true, "lock_timeout": 30, "conf_file": null, "disable_excludes": null, "download_dir": null, "list": null, "releasever": null}}, "_ansible_no_log": false, "failed": false, "module": "package"}
 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
-      )
+      /Nothing to do/,
+      ansible_module_message(log).to_s
     )
   end
 end

data/test/unit/hostgroup_ansible_role_test.rb

@@ -19,17 +19,4 @@ class HostgroupAnsibleRoleTest < ActiveSupport::TestCase
     end
     should validate_uniqueness_of(:ansible_role_id).scoped_to(:hostgroup_id)
   end
-
-  describe 'ordering' do
-    test 'should list roles in correct order' do
-      hg = FactoryBot.create(:hostgroup)
-      5.times do |idx|
-        HostgroupAnsibleRole.create(:hostgroup => hg, :ansible_role => FactoryBot.create(:ansible_role), :position => idx)
-      end
-
-      hg.hostgroup_ansible_roles.each_with_index do |item, idx|
-        assert_equal(item.position, idx + 1)
-      end
-    end
-  end
 end

data/webpack/components/AnsibleHostDetail/AnsibleHostDetail.js

@@ -0,0 +1,35 @@
+import React, { useState } from 'react';
+import { Tabs, Tab, TabTitleText, Label } from '@patternfly/react-core';
+import { InfoCircleIcon } from '@patternfly/react-icons';
+
+import { translate as __ } from 'foremanReact/common/I18n';
+
+import './AnsibleHostDetail.scss';
+
+const AnsibleHostDetail = props => {
+  // https://projects.theforeman.org/issues/32398
+  const [activeTab] = useState('variables');
+
+  return (
+    <Tabs activeKey={activeTab} isSecondary>
+      <Tab
+        eventKey="variables"
+        title={<TabTitleText>{__('Variables')}</TabTitleText>}
+      >
+        <div className="host-details-tab-item">
+          <div className="ansible-host-detail">
+            <Label
+              color="blue"
+              icon={<InfoCircleIcon />}
+              style={{ marginTop: '1.5rem' }}
+            >
+              Ansible Variables coming soon!
+            </Label>
+          </div>
+        </div>
+      </Tab>
+    </Tabs>
+  );
+};
+
+export default AnsibleHostDetail;

data/webpack/components/AnsibleHostDetail/AnsibleHostDetail.scss

@@ -0,0 +1,6 @@
+@import '~@patternfly/patternfly/base/patternfly-variables';
+
+.ansible-host-detail {
+  background-color: $pf-color-white;
+  padding: 1.8rem;
+}

data/webpack/components/AnsibleHostDetail/AnsibleHostDetail.test.js

@@ -0,0 +1,14 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+
+import AnsibleHostDetail from './';
+
+describe('AnsibleHostDetail', () => {
+  it('should show content', () => {
+    render(<AnsibleHostDetail />);
+    expect(
+      screen.getByText('Ansible Variables coming soon!')
+    ).toBeInTheDocument();
+  });
+});

data/webpack/components/AnsibleHostDetail/index.js

@@ -0,0 +1,6 @@
+import React from 'react';
+import AnsibleHostDetail from './AnsibleHostDetail';
+
+const WrappedAnsibleHostDetail = props => <AnsibleHostDetail {...props} />;
+
+export default WrappedAnsibleHostDetail;

data/webpack/components/AnsibleRolesSwitcher/components/__snapshots__/AnsiblePermissionDenied.test.js.snap

@@ -2,6 +2,7 @@
 
 exports[`AnsiblePermissionDenied should render 1`] = `
 <EmptyStatePattern
+  action={null}
   description={
     <span>
       You are not authorized to perform this action.
@@ -22,5 +23,6 @@ exports[`AnsiblePermissionDenied should render 1`] = `
   header="Permission Denied"
   icon="lock"
   iconType="fa"
+  secondaryActions={Array []}
 />
 `;

data/webpack/components/AnsibleRolesSwitcher/components/__snapshots__/AssignedRolesList.test.js.snap

@@ -1,13 +1,13 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`AssignedRolesList should render 1`] = `
-<DndProvider
+<Memo(DndProvider)
   backend={[Function]}
 >
   <ListView
     className=""
   >
-    <Component
+    <DropTarget(DragSource(Orderable(AnsibleRole)))
       icon="fa fa-minus-circle"
       index={0}
       key="1"
@@ -21,7 +21,7 @@ exports[`AssignedRolesList should render 1`] = `
         }
       }
     />
-    <Component
+    <DropTarget(DragSource(Orderable(AnsibleRole)))
       icon="fa fa-minus-circle"
       index={1}
       key="2"
@@ -60,5 +60,5 @@ exports[`AssignedRolesList should render 1`] = `
       }
     />
   </div>
-</DndProvider>
+</Memo(DndProvider)>
 `;

data/webpack/components/AnsibleRolesSwitcher/components/__snapshots__/AvailableRolesList.test.js.snap

@@ -8,9 +8,14 @@ exports[`AvailableRolesList should render 1`] = `
     className="sticky-pagination"
   >
     <PaginationWrapper
+      className=""
+      disableNext={false}
+      disablePrev={false}
       dropdownButtonId="available-ansible-roles-pagination-row-dropdown"
       itemCount={2}
       onChange={[Function]}
+      onPageSet={[Function]}
+      onPerPageSelect={[Function]}
       pagination={
         Object {
           "page": 1,

data/webpack/global_index.js

@@ -0,0 +1,12 @@
+import React from 'react';
+
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+
+import AnsibleHostDetail from './components/AnsibleHostDetail';
+
+addGlobalFill(
+  'host-details-page-tabs',
+  'Ansible',
+  <AnsibleHostDetail key="ansible-host-detail" />,
+  500
+);

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 6.3.4
+  version: 6.4.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: foreman_ansible_core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: acts_as_list
   requirement: !ruby/object:Gem::Requirement
@@ -302,9 +288,6 @@ files:
 - test/unit/hostgroup_ansible_role_test.rb
 - test/unit/ignore_roles_test.rb
 - test/unit/import_roles_and_variables.rb
-- test/unit/lib/foreman_ansible_core/ansible_runner_test.rb
-- test/unit/lib/foreman_ansible_core/command_creator_test.rb
-- test/unit/lib/foreman_ansible_core/playbook_runner_test.rb
 - test/unit/lib/proxy_api/ansible_test.rb
 - test/unit/services/ansible_report_importer_test.rb
 - test/unit/services/ansible_variables_importer_test.rb
@@ -317,12 +300,10 @@ 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/__mocks__/foremanReact/common/I18n.js
-- webpack/__mocks__/foremanReact/common/helpers.js
-- webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js
-- webpack/__mocks__/foremanReact/components/common/EmptyState.js
-- webpack/__mocks__/foremanReact/components/common/forms/OrderableSelect/helpers.js
-- webpack/__mocks__/foremanReact/redux/API.js
+- webpack/components/AnsibleHostDetail/AnsibleHostDetail.js
+- webpack/components/AnsibleHostDetail/AnsibleHostDetail.scss
+- webpack/components/AnsibleHostDetail/AnsibleHostDetail.test.js
+- webpack/components/AnsibleHostDetail/index.js
 - webpack/components/AnsibleRolesAndVariables/AnsibleRolesAndVariables.js
 - webpack/components/AnsibleRolesAndVariables/AnsibleRolesAndVariables.scss
 - webpack/components/AnsibleRolesAndVariables/AnsibleRolesAndVariablesActions.js
@@ -368,13 +349,14 @@ files:
 - webpack/components/AnsibleRolesSwitcher/components/withProtectedView.js
 - webpack/components/AnsibleRolesSwitcher/index.js
 - webpack/components/ReportJsonViewer.js
+- webpack/global_index.js
 - webpack/index.js
 - webpack/reducer.js
 homepage: https://github.com/theforeman/foreman_ansible
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -390,7 +372,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ansible integration with Foreman (theforeman.org)
 test_files:
@@ -399,8 +381,8 @@ test_files:
 - test/factories/ansible_roles.rb
 - test/factories/host_ansible_enhancements.rb
 - test/fixtures/insights_playbook.yaml
-- test/fixtures/report.json
 - test/fixtures/sample_facts.json
+- test/fixtures/report.json
 - test/functional/ansible_roles_controller_test.rb
 - test/functional/api/v2/ansible_inventories_controller_test.rb
 - test/functional/api/v2/ansible_variables_controller_test.rb
@@ -419,24 +401,21 @@ test_files:
 - test/unit/concerns/host_managed_extensions_test.rb
 - test/unit/concerns/hostgroup_extensions_test.rb
 - test/unit/helpers/ansible_reports_helper_test.rb
-- test/unit/lib/foreman_ansible_core/command_creator_test.rb
-- test/unit/lib/foreman_ansible_core/ansible_runner_test.rb
-- test/unit/lib/foreman_ansible_core/playbook_runner_test.rb
 - test/unit/lib/proxy_api/ansible_test.rb
 - test/unit/services/ansible_report_importer_test.rb
-- test/unit/services/fact_importer_test.rb
 - test/unit/services/fact_sparser_test.rb
 - test/unit/services/insights_plan_runner_test.rb
 - test/unit/services/roles_importer_test.rb
 - test/unit/services/structured_fact_importer_test.rb
+- test/unit/services/fact_importer_test.rb
 - test/unit/services/ansible_variables_importer_test.rb
 - test/unit/services/ui_roles_importer_test.rb
 - test/unit/services/api_roles_importer_test.rb
 - test/unit/services/fact_parser_test.rb
 - test/unit/services/inventory_creator_test.rb
+- test/unit/ansible_provider_test.rb
 - test/unit/host_ansible_role_test.rb
+- test/unit/hostgroup_ansible_role_test.rb
 - test/unit/import_roles_and_variables.rb
 - test/unit/ignore_roles_test.rb
-- test/unit/hostgroup_ansible_role_test.rb
-- test/unit/ansible_provider_test.rb
 - test/foreman_ansible/helpers/ansible_roles_helper_test.rb

data/test/unit/lib/foreman_ansible_core/ansible_runner_test.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-module ForemanAnsibleCore
-  module Runner
-    class AnsibleRunnerTest < ActiveSupport::TestCase
-      describe AnsibleRunner do
-        it 'parses files without event data' do
-          content = <<~JSON
-            {"uuid": "a29d8592-f805-4d0e-b73d-7a53cc35a92e", "stdout": " [WARNING]: Consider using the yum module rather than running 'yum'.  If you", "counter": 8, "end_line": 8, "runner_ident": "e2d9ae11-026a-4f9f-9679-401e4b852ab0", "start_line": 7, "event": "verbose"}
-          JSON
-
-          File.expects(:read).with('fake.json').returns(content)
-          runner = AnsibleRunner.allocate
-          runner.expects(:handle_broadcast_data)
-          assert runner.send(:handle_event_file, 'fake.json')
-        end
-      end
-
-      describe '#rebuild_secrets' do
-        let(:inventory) do
-          { 'all' => { 'hosts' => ['foreman.example.com'] },
-            '_meta' => { 'hostvars' => { 'foreman.example.com' => {} } } }
-        end
-        let(:input) do
-          host_secrets = { 'ansible_password' => 'letmein', 'ansible_become_password' => 'iamroot' }
-          secrets = { 'per-host' => { 'foreman.example.com' => host_secrets } }
-          host_input = { 'input' => { 'action_input' => { 'secrets' => secrets } } }
-          { 'foreman.example.com' => host_input }
-        end
-        let(:runner) { ForemanAnsibleCore::Runner::AnsibleRunner.allocate }
-
-        test 'uses secrets from inventory' do
-          test_inventory = inventory.merge('ssh_password' => 'sshpass', 'effective_user_password' => 'mypass')
-          rebuilt = runner.send(:rebuild_secrets, test_inventory, input)
-          host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
-          assert_equal 'sshpass', host_vars['ansible_password']
-          assert_equal 'mypass', host_vars['ansible_become_password']
-        end
-
-        test 'host secrets are used when not overriden by inventory secrest' do
-          rebuilt = runner.send(:rebuild_secrets, inventory, input)
-          host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
-          assert_equal 'letmein', host_vars['ansible_password']
-          assert_equal 'iamroot', host_vars['ansible_become_password']
-        end
-      end
-    end
-  end
-end

data/test/unit/lib/foreman_ansible_core/command_creator_test.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class CommandCreatorTest < ActiveSupport::TestCase
-  let(:inventory_file) { 'test_inventory' }
-  let(:playbook_file) { 'test_palybook.yml' }
-  subject do
-    ForemanAnsibleCore::CommandCreator.new(inventory_file, playbook_file, {})
-  end
-
-  test 'returns a command array including the ansible-playbook command' do
-    assert command_parts.include?('ansible-playbook')
-  end
-
-  test 'the last argument is the playbook_file' do
-    assert command_parts.last == playbook_file
-  end
-
-  describe 'environment variables' do
-    let(:environment_variables) { subject.command.first }
-
-    test 'has a JSON_INVENTORY_FILE set' do
-      assert environment_variables['JSON_INVENTORY_FILE']
-    end
-
-    test 'has no ANSIBLE_CALLBACK_WHITELIST set by default' do
-      assert_not environment_variables['ANSIBLE_CALLBACK_WHITELIST']
-    end
-
-    test 'with a REX command it sets ANSIBLE_CALLBACK_WHITELIST to empty' do
-      set_command_options(:remote_execution_command, true)
-      assert environment_variables['ANSIBLE_CALLBACK_WHITELIST']
-    end
-  end
-
-  describe 'command options' do
-    it 'can have verbosity set' do
-      level = '3'
-      level_string = Array.new(level.to_i).map { 'v' }.join
-      set_command_options(:verbosity_level, level)
-      assert command_parts.any? do |part|
-        part == "-#{level_string}"
-      end
-    end
-
-    it 'can have a timeout set' do
-      timeout = '5555'
-      set_command_options(:timeout, timeout)
-      assert command_parts.include?(timeout)
-    end
-  end
-
-  private
-
-  def command_parts
-    subject.command.flatten.map(&:to_s)
-  end
-
-  def set_command_options(option, value)
-    subject.instance_eval("@options[:#{option}] = \"#{value}\"",
-                          __FILE__, __LINE__ - 1)
-  end
-end

data/test/unit/lib/foreman_ansible_core/playbook_runner_test.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-# Playbook Runner - this class uses foreman_tasks_core
-# to run playbooks
-class PlaybookRunnerTest < ActiveSupport::TestCase
-  context 'roles dir' do
-    test 'reads default when none provided' do
-      ForemanAnsibleCore::Runner::Playbook.any_instance.stubs(:unknown_hosts).
-        returns([])
-      File.expects(:exist?).with(Dir.home).returns(true)
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
-      runner = ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
-      assert '/etc/ansible', runner.instance_variable_get('@ansible_dir')
-    end
-  end
-
-  context 'working_dir' do
-    setup do
-      ForemanAnsibleCore::Runner::Playbook.any_instance.stubs(:unknown_hosts).
-        returns([])
-    end
-
-    test 'creates temp one if not provided' do
-      Dir.expects(:mktmpdir)
-      File.expects(:exist?).with(Dir.home).returns(true)
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
-      ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
-    end
-
-    test 'reads it when provided' do
-      settings = { :working_dir => '/foo', :ansible_dir => '/etc/foo' }
-      ForemanAnsibleCore.expects(:settings).returns(settings)
-      File.expects(:exist?).with(settings[:ansible_dir]).returns(true)
-      Dir.expects(:mktmpdir).never
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(nil)
-      runner = ForemanAnsibleCore::Runner::Playbook.new(nil, nil, :suspended_action => nil)
-      assert '/foo', runner.instance_variable_get('@working_dir')
-    end
-  end
-
-  context 'TOFU policy' do # Trust On First Use
-    setup do
-      @inventory = { 'all' => { 'hosts' => ['foreman.example.com'] } }
-      @output = StringIO.new
-      logger = Logger.new(@output)
-      ForemanAnsibleCore::Runner::Playbook.any_instance.stubs(:logger).
-        returns(logger)
-    end
-
-    test 'ignores known hosts' do
-      Net::SSH::KnownHosts.expects(:search_for).
-        with('foreman.example.com').returns(['somekey'])
-      ForemanAnsibleCore::Runner::Playbook.any_instance.
-        expects(:add_to_known_hosts).never
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
-      ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
-    end
-
-    test 'adds unknown hosts to known_hosts' do
-      Net::SSH::KnownHosts.expects(:search_for).
-        with('foreman.example.com').returns([])
-      ForemanAnsibleCore::Runner::Playbook.any_instance.
-        expects(:add_to_known_hosts).with('foreman.example.com')
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
-      ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
-    end
-
-    test 'logs error when it cannot add to known_hosts' do
-      Net::SSH::KnownHosts.expects(:search_for).
-        with('foreman.example.com').returns([])
-      Net::SSH::Transport::Session.expects(:new).with('foreman.example.com').
-        raises(Net::Error)
-      ForemanAnsibleCore::Runner::Playbook.any_instance.expects(:rebuild_secrets).returns(@inventory)
-      ForemanAnsibleCore::Runner::Playbook.new(@inventory, nil, :suspended_action => nil)
-      assert_match(
-        /ERROR.*Failed to save host key for foreman.example.com: Net::Error/,
-        @output.string
-      )
-    end
-  end
-
-  context 'rebuild secrets' do
-    let(:inventory) do
-      { 'all' => { 'hosts' => ['foreman.example.com'] },
-        '_meta' => { 'hostvars' => { 'foreman.example.com' => {} } } }
-    end
-    let(:secrets) do
-      host_secrets = { 'ansible_password' => 'letmein', 'ansible_become_password' => 'iamroot' }
-      { 'per-host' => { 'foreman.example.com' => host_secrets } }
-    end
-    let(:runner) { ForemanAnsibleCore::Runner::Playbook.allocate }
-
-    test 'uses secrets from inventory' do
-      test_inventory = inventory.merge('ssh_password' => 'sshpass', 'effective_user_password' => 'mypass')
-      rebuilt = runner.send(:rebuild_secrets, test_inventory, secrets)
-      host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
-      assert_equal 'sshpass', host_vars['ansible_password']
-      assert_equal 'mypass', host_vars['ansible_become_password']
-    end
-
-    test 'host secrets are used when not overriden by inventory secrest' do
-      rebuilt = runner.send(:rebuild_secrets, inventory, secrets)
-      host_vars = rebuilt.dig('_meta', 'hostvars', 'foreman.example.com')
-      assert_equal 'letmein', host_vars['ansible_password']
-      assert_equal 'iamroot', host_vars['ansible_become_password']
-    end
-  end
-end

data/webpack/__mocks__/foremanReact/common/I18n.js

@@ -1 +0,0 @@
-export const translate = s => s;

data/webpack/__mocks__/foremanReact/common/helpers.js

@@ -1,13 +0,0 @@
-import { camelCase } from 'lodash';
-
-export const propsToCamelCase = ob =>
-  propsToCase(camelCase, 'propsToCamelCase only takes objects', ob);
-
-const propsToCase = (casingFn, errorMsg, ob) => {
-  if (typeof ob !== 'object') throw Error(errorMsg);
-
-  return Object.keys(ob).reduce((memo, key) => {
-    memo[casingFn(key)] = ob[key];
-    return memo;
-  }, {});
-};

data/webpack/__mocks__/foremanReact/components/Pagination/PaginationWrapper.js

@@ -1,2 +0,0 @@
-const PaginationWrapper = () => jest.fn();
-export default PaginationWrapper;

data/webpack/__mocks__/foremanReact/components/common/EmptyState.js

@@ -1,5 +0,0 @@
-const EmptyState = () => jest.fn();
-
-export const EmptyStatePattern = () => jest.fn();
-
-export default EmptyState;

data/webpack/__mocks__/foremanReact/components/common/forms/OrderableSelect/helpers.js

@@ -1,5 +0,0 @@
-import React from 'react';
-
-export const orderable = (Component, orderableProps) => props => (
-  <Component {...orderableProps} {...props} />
-);

data/webpack/__mocks__/foremanReact/redux/API.js

@@ -1,7 +0,0 @@
-export const API = {
-  get: jest.fn(),
-  put: jest.fn(),
-  post: jest.fn(),
-  delete: jest.fn(),
-  patch: jest.fn(),
-};