foreman_ansible 10.4.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c30c3eac6e4a49a8d43c6a654d84b672ef9fa58bbacb8fe2044cc74f33b5a28
-  data.tar.gz: 8084c75afc69d788093952a8988e3ff883f3726779a94f1de5016c1b857d7435
+  metadata.gz: c401e27d48eec2462af90e4ee0f94668b3615ef5e4ce7df7e95e1f5732364447
+  data.tar.gz: 1644ac60d2f1b352f46ef5409960d00b64c17f2090eb235b528d88579b9fbbc6
 SHA512:
-  metadata.gz: e541db04ed8d5bb3ed65b8239a06366efbda044d57263e4e507534c61a89d566e1270b67593a5c33d423abf13bc7896f76208aa81efc36f58382bd972d40cd7f
-  data.tar.gz: 5df022f589352f580358303a3172f8062e476884607e1dafd21ee8f140646e106a93419c018b896df55b4bc4cac102374bb92bd3c46e8dc9e42998c52c2bb26e
+  metadata.gz: 41fc9d4cf864862b5fa562f5a507407d800962fec4f7a27535dd47850a034ee291b12757a4500ebff1c1649b3c2f83be169f1d537871e00a1472064da5907683
+  data.tar.gz: 858837e2b4314f437b4fd361a66c657cc11ee52d4af798e1a7ac17b32443f18ce36dcd78db4004a9fc8ee1d951f56ff3e144d3fe097b699e6f673c6798bb94c3

data/app/controllers/concerns/foreman/controller/parameters/job_template_extensions.rb

@@ -0,0 +1,17 @@
+module Foreman
+  module Controller
+    module Parameters
+      module JobTemplateExtensions
+        extend ActiveSupport::Concern
+
+        class_methods do
+          def job_template_params_filter
+            super.tap do |filter|
+              filter.permit :ansible_callback_enabled
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_ansible/api/v2/job_templates_controller_extensions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ForemanAnsible
+  module Api
+    module V2
+      # Extends the job_templates api controller to support creating/updating with ansible callback plugin
+      module JobTemplatesControllerExtensions
+        extend Apipie::DSL::Concern
+
+        update_api(:create, :update) do
+          param :job_template, Hash do
+            param :ansible_callback_enabled, :bool, :desc => N_('Enable the callback plugin for this template')
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/foreman_ansible/ansible_reports_helper.rb

@@ -79,6 +79,17 @@ module ForemanAnsible
       false
     end
 
+    def show_full_error_message_value(message_value)
+      tag.div class: 'replace-hidden-value' do
+        link_to_function(icon_text('plus', '', class: 'small'), 'replace_value_control(this, "div")',
+                         title: _('Show full value'),
+                         class: 'replace-hidden-value pull-right') +
+          (tag.span class: 'full-value' do
+            message_value
+          end)
+      end
+    end
+
     private
 
     def get_results(msg_json)

data/app/models/foreman_ansible/ansible_provider.rb

@@ -123,7 +123,7 @@ if defined? ForemanRemoteExecution
 
         def ansible_command?(template)
           template.remote_execution_features.
-            where(:label => 'ansible_run_host').empty?
+            where(:label => 'ansible_run_host').empty? && !template.ansible_callback_enabled
         end
       end
     end

data/app/views/api/v2/job_templates/job_templates.json.rabl

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+attributes :ansible_callback_enabled

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

@@ -29,8 +29,12 @@
                 <% end %>
               </ul>
             <% else %>
-              <%= log_message %>
-          <% end %>
+              <% allowed_length = 150 %>
+              <div class='pull-left'>
+                <%= truncate(log_message, length: allowed_length) %>
+              </div>
+              <%= show_full_error_message_value(log_message) if log_message.length > allowed_length %>
+            <% end %>
           </td>
         </tr>
       <% end %>

data/app/views/job_templates/_job_template_callback_tab_content.html.erb

@@ -0,0 +1,3 @@
+<div class="tab-pane" id="ansible_callback_enabled">
+  <%= checkbox_f f, :ansible_callback_enabled, :label => _('Enable Ansible Callback'), :disabled => @template.locked? %>
+</div>

data/app/views/job_templates/_job_template_callback_tab_headers.html.erb

@@ -0,0 +1,13 @@
+<li><a id="ansible_tab_header" href="#ansible_callback_enabled" data-toggle="tab"><%= _("Ansible") %></a></li>
+<script type="text/javascript">
+    $(document).ready(function () {
+        var provider_type = $('#job_template_provider_type');
+        provider_type.change(setAnsibleTabVisibilityByProvider);
+        provider_type.change();
+
+        function setAnsibleTabVisibilityByProvider() {
+            var tab_header = $("#ansible_tab_header");
+            this.value === 'Ansible' ? tab_header.show() : tab_header.hide();
+        }
+    });
+</script>

data/db/migrate/20221003153000_add_ansible_callback_enabled_to_templates.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class AddAnsibleCallbackEnabledToTemplates < ActiveRecord::Migration[6.0]
+  def change
+    add_column :templates, :ansible_callback_enabled, :boolean, default: false
+    RemoteExecutionFeature.where(label: 'ansible_run_host').each do |rex_feature|
+      Template.find(rex_feature.job_template_id).update(ansible_callback_enabled: true)
+    end
+  end
+end

data/lib/foreman_ansible/engine.rb

@@ -74,6 +74,9 @@ module ForemanAnsible
       ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsControllerExtensions
       ::Api::V2::HostgroupsController.include ForemanAnsible::Api::V2::HostgroupsParamGroupExtensions
       ::ConfigReportImporter.include ForemanAnsible::AnsibleReportImporter
+      ::Api::V2::JobTemplatesController.include ForemanAnsible::Api::V2::JobTemplatesControllerExtensions
+      ::Api::V2::JobTemplatesController.include Foreman::Controller::Parameters::JobTemplateExtensions
+      ::JobTemplatesController.include Foreman::Controller::Parameters::JobTemplateExtensions
       ReportImporter.register_smart_proxy_feature('Ansible')
     rescue StandardError => e
       Rails.logger.warn "Foreman Ansible: skipping engine hook (#{e})"

data/lib/foreman_ansible/register.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_ansible do
-  requires_foreman '>= 3.5'
+  requires_foreman '>= 3.6'
 
   settings do
     category :ansible, N_('Ansible') do
@@ -237,6 +237,8 @@ Foreman::Plugin.register :foreman_ansible do
     register_report_origin 'Ansible', 'ConfigReport'
   end
 
+  extend_rabl_template 'api/v2/job_templates/show', 'api/v2/job_templates/job_templates'
+
   describe_host do
     multiple_actions_provider :ansible_hosts_multiple_actions
   end
@@ -257,4 +259,16 @@ Foreman::Plugin.register :foreman_ansible do
                         :partial => 'foreman/smart_proxies/update_smart_proxy',
                         :onlyif => ->(proxy, view) { view.can_update_proxy?(proxy) }
   end
+  extend_page('templates/_form') do |context|
+    context.add_pagelet :tab_headers,
+                        :name => _('Ansible'),
+                        :partial => 'job_templates/job_template_callback_tab_headers',
+                        :onlyif => ->(subject, _view) { subject.is_a? JobTemplate }
+  end
+  extend_page('templates/_form') do |context|
+    context.add_pagelet :tab_content,
+                        :name => _('Ansible'),
+                        :partial => 'job_templates/job_template_callback_tab_content',
+                        :onlyif => ->(subject, _view) { subject.is_a? JobTemplate }
+  end
 end

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 = '10.4.0'
+  VERSION = '11.1.0'
 end

data/test/unit/ansible_provider_test.rb

@@ -12,16 +12,15 @@ class AnsibleProviderTest < ActiveSupport::TestCase
       assert command_options['ansible_inventory']
     end
 
-    context 'when it is not using the ansible_run_host feature' do
+    context 'when ansible_callback_enabled is set to false' do
       it 'sets enables :remote_execution_command to true' do
         assert command_options[:remote_execution_command]
       end
     end
 
-    context 'when it is using the ansible_run_host feature' do
+    context 'when ansible_callback_enabled is set to true' do
       it 'has remote_execution_command false' do
-        rex_feature = RemoteExecutionFeature.where(:label => 'ansible_run_host', :name => 'Run Ansible roles').first_or_create
-        template_invocation.template.remote_execution_features << rex_feature
+        template_invocation.template.ansible_callback_enabled = true
         assert_not command_options[:remote_execution_command]
       end
     end

data/test/unit/helpers/ansible_reports_helper_test.rb

@@ -20,25 +20,18 @@ ANSIBLELOG
     )
   end
 
-  test 'module message extraction with action' do
-    example_report = JSON.parse(File.read(ansible_fixture_file('report.json'))).second
-    report = ConfigReport.import(example_report)
-    expected_outputs = [
-      'No additional data',
-      ['Cron job: 0 5,2 * * * date > /dev/null (disabled: false)', 'Cron job: 0 5,2 * * * df > /dev/null (disabled: false)'],
-      ['Cron job: 0 5,2 * * * hostname > /dev/null (disabled: false)'],
-      ['Rendered template test1.txt.j2 to /tmp/test1.txt', 'Rendered template test2.txt.j2 to /tmp/test2.txt'],
-      ['Rendered template test3.txt.j2 to /tmp/test3.txt'],
-      ['Copy test4.txt to /tmp/test4.txt', 'Copy test5.txt to /tmp/test5.txt'],
-      ['Copy test6.txt to /tmp/test6.txt'],
-      ['Service chronyd started (enabled: )', 'Service firewalld started (enabled: )'],
-      ['Service chronyd started (enabled: )']
-    ]
-    actual_outputs = []
-    report.logs.each do |log|
-      actual_outputs << ansible_module_message(log)
-    end
-    assert_equal expected_outputs, actual_outputs
+  test 'module message extraction with error' do
+    log_value = <<-ANSIBLELOG.strip_heredoc
+    {"msg": "AnsibleUndefinedVariable", "changed": false, "_ansible_no_log": false, "failed": true, "module": "template", "exception": "raise AnsibleUndefinedVariable"}
+ANSIBLELOG
+    message = FactoryBot.build(:message, value: log_value)
+    log = FactoryBot.build(:log, message: message)
+    log.message = message
+
+    assert_match(
+      'Execution error: AnsibleUndefinedVariable',
+      ansible_module_message(log).to_s
+    )
   end
 
   test 'accepting an almost empty message' do
@@ -79,4 +72,25 @@ ANSIBLELOG
       ansible_module_message(log).to_s
     )
   end
+
+  test 'module message extraction with action' do
+    example_report = JSON.parse(File.read(ansible_fixture_file('report.json'))).second
+    report = ConfigReport.import(example_report)
+    expected_outputs = [
+      'No additional data',
+      ['Cron job: 0 5,2 * * * date > /dev/null (disabled: false)', 'Cron job: 0 5,2 * * * df > /dev/null (disabled: false)'],
+      ['Cron job: 0 5,2 * * * hostname > /dev/null (disabled: false)'],
+      ['Rendered template test1.txt.j2 to /tmp/test1.txt', 'Rendered template test2.txt.j2 to /tmp/test2.txt'],
+      ['Rendered template test3.txt.j2 to /tmp/test3.txt'],
+      ['Copy test4.txt to /tmp/test4.txt', 'Copy test5.txt to /tmp/test5.txt'],
+      ['Copy test6.txt to /tmp/test6.txt'],
+      ['Service chronyd started (enabled: )', 'Service firewalld started (enabled: )'],
+      ['Service chronyd started (enabled: )']
+    ]
+    actual_outputs = []
+    report.logs.each do |log|
+      actual_outputs << ansible_module_message(log)
+    end
+    assert_equal expected_outputs, actual_outputs
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 10.4.0
+  version: 11.1.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_list
@@ -42,22 +42,16 @@ dependencies:
   name: foreman_remote_execution
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '8.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '8.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: foreman-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -92,10 +86,12 @@ files:
 - app/controllers/api/v2/ansible_variables_controller.rb
 - app/controllers/concerns/foreman/controller/parameters/ansible_override_value.rb
 - app/controllers/concerns/foreman/controller/parameters/ansible_variable.rb
+- app/controllers/concerns/foreman/controller/parameters/job_template_extensions.rb
 - app/controllers/foreman_ansible/api/v2/hostgroups_controller_extensions.rb
 - app/controllers/foreman_ansible/api/v2/hostgroups_param_group_extensions.rb
 - app/controllers/foreman_ansible/api/v2/hosts_controller_extensions.rb
 - app/controllers/foreman_ansible/api/v2/hosts_param_group_extensions.rb
+- app/controllers/foreman_ansible/api/v2/job_templates_controller_extensions.rb
 - app/controllers/foreman_ansible/concerns/api_common.rb
 - app/controllers/foreman_ansible/concerns/hostgroups_controller_extensions.rb
 - app/controllers/foreman_ansible/concerns/hosts_controller_extensions.rb
@@ -178,6 +174,7 @@ files:
 - app/views/api/v2/ansible_variables/show.json.rabl
 - app/views/api/v2/hostgroups/ansible_roles.json.rabl
 - app/views/api/v2/hosts/ansible_roles.json.rabl
+- app/views/api/v2/job_templates/job_templates.json.rabl
 - app/views/foreman/smart_proxies/_update_smart_proxy.html.erb
 - app/views/foreman_ansible/ansible_roles/_select_tab_content.html.erb
 - app/views/foreman_ansible/ansible_roles/_select_tab_title.html.erb
@@ -204,6 +201,8 @@ files:
 - app/views/foreman_ansible/job_templates/run_playbook-ansible_default.erb
 - app/views/foreman_ansible/job_templates/service_action_-_ansible_default.erb
 - app/views/foreman_ansible/job_templates/service_action_-_enable_web_console.erb
+- app/views/job_templates/_job_template_callback_tab_content.html.erb
+- app/views/job_templates/_job_template_callback_tab_headers.html.erb
 - app/views/ui_ansible_roles/index.json.rabl
 - app/views/ui_ansible_roles/main.json.rabl
 - app/views/ui_ansible_roles/show.json.rabl
@@ -223,6 +222,7 @@ files:
 - db/migrate/20200421201839_update_ansible_inv_template_name.rb
 - db/migrate/20210120150019_add_position_to_ansible_role.rb
 - db/migrate/20210818083407_fix_ansible_setting_category_to_dsl.rb
+- db/migrate/20221003153000_add_ansible_callback_enabled_to_templates.rb
 - db/migrate/20221031114720_rename_capsule_upgrade_playbook.rb
 - db/seeds.d/100_common_parameters.rb
 - db/seeds.d/62_ansible_proxy_feature.rb