foreman_ansible 10.4.2 → 10.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d5fe936def15be1cc84456bb6d1fa5df9a5a895c2aea3da888908dbaa59c6fb
-  data.tar.gz: 7cb834bfefdcfc73743d06c06e70b61965bd49d3b5aa263963ec7998d4ab70dc
+  metadata.gz: fafa20eedfebfae90bd8eb981b1879ef7444f4f3a661d2ddb65231df477d6901
+  data.tar.gz: 60f8a8ad775ade5183c9fe3cf4374210e8e6dc93613970fe8c46a6de6ff58ad9
 SHA512:
-  metadata.gz: 437ca9c045cb2e07982d4ca9a73913d80a8f155c1d5f5324e29f544554a3defddbf1295ee1093ac5cbbf87f60cb18981be394c26df7466c4b53943f77da99f23
-  data.tar.gz: 5eb239a127d53b9b97b9a7bc2a6145f7bb96af3e8d3cb079b6b6e8d546b48ba441273062258429c8b35cfa3c387e993996e91a9d95a18b8300f8d9eaea1ddb80
+  metadata.gz: 64e4ff37e73336ed4cf530d1050ae75f0c6c4a86736e8ed0ea1b89742727672b43a3b8165fd946f0aa0eb75d2b1a514f43ac77f38cc94c436bf27b86e427a671
+  data.tar.gz: cfb54327ff40818064d3225b77d2d8ce89f6f36880323e76df44cf366acd61b7b5fb03e584c1e3119b447a7d3a07690d2c3218d3945fc28e3e514bc23f6a8aed

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/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/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.2'
+  VERSION = '10.4.4'
 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/webpack/components/AnsibleHostDetail/components/AnsibleVariableOverrides/AnsibleVariableOverridesTableHelper.js

@@ -4,8 +4,13 @@ import { sprintf, translate as __ } from 'foremanReact/common/I18n';
 
 import { showToast } from '../../../../toastHelper';
 
-const formatSourceLink = currentValue =>
-  `${__(currentValue.element)}: ${currentValue.elementName}`;
+function formatSourceLink(currentValue) {
+  const element =
+    typeof currentValue.element !== 'string'
+      ? currentValue.element.toString()
+      : currentValue.element;
+  return `${__(element)}: ${currentValue.elementName}`;
+}
 
 export const formatSourceAttr = variable =>
   variable.currentValue

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

@@ -19,7 +19,7 @@ import {
 const TestComponent = withRedux(withMockedProvider(AnsibleVariableOverrides));
 
 describe('AnsibleVariableOverrides', () => {
-  it('should show skeleton when page is loading', () => {
+  it('should show skeleton when page is loading', async () => {
     const { container } = render(
       <TestComponent
         hostId={hostId}
@@ -31,6 +31,8 @@ describe('AnsibleVariableOverrides', () => {
     expect(
       container.getElementsByClassName('react-loading-skeleton')
     ).toHaveLength(5);
+
+    await waitFor(tick);
   });
   it('should load', async () => {
     render(

data/webpack/components/AnsibleRolesSwitcher/AnsibleRolesSwitcher.js

@@ -26,7 +26,6 @@ class AnsibleRolesSwitcher extends React.Component {
       inheritedRoleIds,
       resourceId,
       resourceName,
-      { page: 1, perPage: 10 },
       excludeAssignedRolesSearch(initialAssignedRoles)
     );
   }

data/webpack/components/AnsibleRolesSwitcher/components/AvailableRolesList.js

@@ -19,7 +19,9 @@ const AvailableRolesList = ({
       <Pagination
         viewType="list"
         itemCount={itemCount}
-        pagination={pagination}
+        updateParamsByUrl={false}
+        page={pagination.page}
+        perPage={pagination.perPage}
         onChange={onListingChange}
         dropdownButtonId="available-ansible-roles-pagination-row-dropdown"
       />

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

@@ -16,14 +16,8 @@ exports[`AvailableRolesList should render 1`] = `
       onPerPageSelect={null}
       onSetPage={null}
       page={1}
-      pagination={
-        Object {
-          "page": 1,
-          "perPage": 25,
-        }
-      }
-      perPage={null}
-      updateParamsByUrl={true}
+      perPage={25}
+      updateParamsByUrl={false}
       variant="bottom"
       viewType="list"
     />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 10.4.2
+  version: 10.4.4
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-08-21 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
@@ -199,6 +202,8 @@ files:
 - 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
@@ -218,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
@@ -493,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