foreman_ansible 10.4.1 → 10.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6036f9a1d90705a4459c56093084b63c953a7c657a125f4f04ca878fb9bc7552
-  data.tar.gz: 5354e5227c4eccf6fcee0f721b3e03a10d0d119354d3dc3b2aa742ad44105023
+  metadata.gz: 43677522138ced457422019bc60d466cc4ff22956ce56cf35c6fad5bc6227aae
+  data.tar.gz: a1523c4616c40ee68cd0209668d34f6a8ae20a817742181ca71f54580b38706f
 SHA512:
-  metadata.gz: a29b28a5c665e8af6f52b9b5b2e7ff94f88f87912795ef54c5eedbb7347c666796a42c09456bcd6b50ed30e1d17a1e28f25ab23929fad6b34a4b51ceb87f5131
-  data.tar.gz: 482d9f6ee4f9c1367a45d87cd4158c29ef88ca2860b6183cdf159123a5a9cf88c7bcca18549b7d448cfff9a5094a3eda24f782f7cd1339e0d0d1fd9abfb1b28c
+  metadata.gz: a513cd384608bf244807afc825d8f0db7e1984fbd1acc836cff5d4a35fbbcdb2163d56dea7927f5ff76c3b49dc3c2d9a84c21a0e0946f821058944054b15ba9a
+  data.tar.gz: 271871a432184fc08437e02cac8fc5a7389f9cb1a475727d96aa2870fe8beb9b11e35b926771946d48df9e13de34e01130b4294f9b1a54bf6a7644a5fe43559d

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_hostgroups_helper.rb

@@ -4,18 +4,38 @@ module ForemanAnsible
   module AnsibleHostgroupsHelper
     def ansible_hostgroups_actions(hostgroup)
       actions = []
-      play_roles = if hostgroup.all_ansible_roles.empty?
-                     { action: { content: (link_to _('Run all Ansible roles'), 'javascript:void(0);', disabled: true, title: 'No roles assigned', class: 'disabled'), options: { class: 'disabled' } }, priority: 31 }
-                   else
-                     { action: display_link_if_authorized(_('Run all Ansible roles'), hash_for_play_roles_hostgroup_path(id: hostgroup), 'data-no-turbolink': true, title: _('Run all Ansible roles on hosts belonging to this host group')), priority: 31 }
-                   end
+      is_hostgroup_empty = hostgroup.all_ansible_roles.empty? || hostgroup.hosts_count.zero?
 
-      assign_jobs = { action: { content: (link_to _('Configure Ansible Job'), "/ansible/hostgroups/#{hostgroup.id}", class: 'la') }, priority: 32 }
+      if User.current.can?(:create_job_invocations)
+        actions << {
+          action: if is_hostgroup_empty
+                    disabled_action_link(_('Run all Ansible roles'))
+                  else
+                    display_link_if_authorized(_('Run all Ansible roles'), hash_for_play_roles_hostgroup_path(id: hostgroup), 'data-no-turbolink': true, title: _('Run all Ansible roles on hosts belonging to this host group'))
+                  end,
+          priority: 31
+        }
+      end
 
-      actions.push play_roles if User.current.can?(:create_job_invocations)
-      actions.push assign_jobs if User.current.can?(:view_job_invocations) && User.current.can?(:view_recurring_logics)
+      if User.current.can?(:view_job_invocations) && User.current.can?(:view_recurring_logics)
+        actions << {
+          action: if is_hostgroup_empty
+                    disabled_action_link(_('Configure Ansible Job'))
+                  else
+                    link_to(_('Configure Ansible Job'), "/ansible/hostgroups/#{hostgroup.id}", class: 'la')
+                  end,
+          priority: 32
+        }
+      end
 
       actions
     end
+
+    def disabled_action_link(text)
+      {
+        content: link_to(text, 'javascript:void(0);', disabled: true, title: _('No roles/hosts assigned'), class: 'disabled'),
+        options: { class: 'disabled' }
+      }
+    end
   end
 end

data/app/helpers/foreman_ansible/smart_proxies_helper.rb

@@ -27,7 +27,13 @@ module ForemanAnsible
     end
 
     def proxy_update_button(proxy)
-      feature = RemoteExecutionFeature.feature(:ansible_run_capsule_upgrade)
+      name = if Foreman::Plugin.find('foreman_theme_satellite').present?
+               :ansible_run_capsule_upgrade
+             else
+               :ansible_run_smart_proxy_upgrade
+             end
+
+      feature = RemoteExecutionFeature.feature(name)
       return if feature.nil?
 
       path = new_job_invocation_path(:host_ids => proxy.infrastructure_host_facets.pluck(:host_id),

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/job_templates/capsule_upgrade_-_ansible_default.erb

@@ -1,5 +1,5 @@
 <%#
-name: Smart Proxy Upgrade Playbook
+name: Capsule Upgrade Playbook
 snippet: false
 template_inputs:
 - name: target_version
@@ -26,8 +26,8 @@ feature: ansible_run_capsule_upgrade
 - hosts: all
   vars:
     target_version: "<%= input('target_version').present? ? input('target_version') : product_short_version %>"
-<% if plugin_present?('foreman_theme_satellite') -%>
   tasks:
+<% if plugin_present?('foreman_theme_satellite') -%>
     - name: Gather the rpm package facts
       package_facts:
         manager: auto
@@ -75,35 +75,7 @@ feature: ansible_run_capsule_upgrade
           fail:
             msg: "Failed! Capsule server upgrade failed. See /var/log/foreman-installer/capsule.log in the Capsule server for more information"
 <% else -%>
-  tasks:
-    - name: Gather the rpm package facts
-      package_facts:
-        manager: auto
-
-    - name: Fail if the target server is a Foreman server
+    - name: Fail if foreman_theme_satellite is missing
       fail:
-        msg: "This playbook cannot be executed on a Foreman server. Use only on a Smart Proxy server."
-      when: "'foreman' in ansible_facts.packages"
-
-    - name: Install foreman release gpg key
-      rpm_key:
-        state: present
-        key: http://yum.theforeman.org/releases/{{ target_version }}/RPM-GPG-KEY-foreman
-      when: target_version != "nightly"
-
-    - name: Update foreman repositories
-      package:
-        name: https://yum.theforeman.org/releases/{{ target_version }}/el{{ ansible_distribution_major_version }}/{{ ansible_architecture }}/foreman-release.rpm
-        state: installed
-
-    - name: Clean yum metadata
-      command: yum clean all
-
-    - name: Update all packages
-      package:
-        name: '*'
-        state: latest
-
-    - name: Run the installer
-      shell: foreman-installer
+        msg: "Failed! The plugin foreman_theme_satellite is not present. This playbook is only for use with Satellite."
 <% end -%>

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

@@ -0,0 +1,59 @@
+<%#
+name: Smart Proxy Upgrade Playbook
+snippet: false
+template_inputs:
+- name: target_version
+  required: false
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: false
+- name: whitelist_options
+  required: false
+  input_type: user
+  advanced: false
+  value_type: plain
+  hidden_value: false
+model: JobTemplate
+job_category: Maintenance Operations
+description_format: "%{template_name}"
+provider_type: Ansible
+kind: job_template
+feature: ansible_run_smart_proxy_upgrade
+%>
+
+---
+- hosts: all
+  vars:
+    target_version: "<%= input('target_version').present? ? input('target_version') : product_short_version %>"
+  tasks:
+    - name: Gather the rpm package facts
+      package_facts:
+        manager: auto
+
+    - name: Fail if the target server is a Foreman server
+      fail:
+        msg: "This playbook cannot be executed on a Foreman server. Use only on a Smart Proxy server."
+      when: "'foreman' in ansible_facts.packages"
+
+    - name: Install foreman release gpg key
+      rpm_key:
+        state: present
+        key: http://yum.theforeman.org/releases/{{ target_version }}/RPM-GPG-KEY-foreman
+      when: target_version != "nightly"
+
+    - name: Update foreman repositories
+      package:
+        name: https://yum.theforeman.org/releases/{{ target_version }}/el{{ ansible_distribution_major_version }}/{{ ansible_architecture }}/foreman-release.rpm
+        state: installed
+
+    - name: Clean yum metadata
+      command: yum clean all
+
+    - name: Update all packages
+      package:
+        name: '*'
+        state: latest
+
+    - name: Run the installer
+      shell: foreman-installer

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.where(id: rex_feature.job_template_id).update_all(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

@@ -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.1'
+  VERSION = '10.4.3'
 end

data/test/integration/hostgroup_js_test.rb

@@ -10,21 +10,23 @@ class HostgroupJsTest < IntegrationTestWithJavascript
     FactoryBot.create(:host, :hostgroup_id => hostgroup_with_roles.id)
   end
 
-  test 'hostgroup without roles should have disabled link' do
+  test 'hostgroup without roles should have disabled links' do
     visit hostgroups_path(search: hostgroup.name)
 
     first_row = page.find('table > tbody > tr:nth-child(1)')
     first_row.find('td:nth-child(4) > div > a').click
 
     assert_includes first(:link, 'Run all Ansible roles')[:class], 'disabled'
+    assert_includes first(:link, 'Configure Ansible Job')[:class], 'disabled'
   end
 
-  test 'hostgroup with roles should have clickable link' do
+  test 'hostgroup with roles should have clickable links' do
     visit hostgroups_path(search: hostgroup_with_roles.name)
 
     first_row = page.find('table > tbody > tr:nth-child(1)')
     first_row.find('td:nth-child(4) > div > a').click
 
     assert_not first(:link, 'Run all Ansible roles')[:class].include?('disabled')
+    assert_not first(:link, 'Configure Ansible Job')[:class].include?('disabled')
   end
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 10.4.1
+  version: 10.4.3
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_list
@@ -86,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
@@ -172,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
@@ -198,6 +201,9 @@ 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/foreman_ansible/job_templates/smart_proxy_upgrade_-_ansible_default.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
@@ -217,6 +223,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
@@ -492,9 +499,9 @@ test_files:
 - test/test_plugin_helper.rb
 - test/unit/ansible_role_test.rb
 - test/unit/ansible_variable_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/concerns/config_reports_extensions_test.rb
 - test/unit/helpers/ansible_reports_helper_test.rb
 - test/unit/host_ansible_role_test.rb
 - test/unit/hostgroup_ansible_role_test.rb