foreman_ansible 13.0.6 → 14.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78a598c4115838d6d1c9894d431755931e6ae6741d688031215b254d5f1c80be
-  data.tar.gz: fbe12bcb0d253149468c7d89820780768c2cdfd843047eda5a13f9845a6a6348
+  metadata.gz: '022826891f9116dddddd19920939b158e53bea4dc5ef646ca21d7004fa359b11'
+  data.tar.gz: 7fcb1aa461c5cdfb79984e4e257e30590418aceff8c8d8b623ad38207e3d3722
 SHA512:
-  metadata.gz: 46ebd9739a430b8d173c4311b4535ca1f32fa05dbb41bcb4e65ee9d538b79445cd545646c9db2804149a4b73aa7d720c817871990e115a332ca16b2c18da90d8
-  data.tar.gz: 847832cea55007df47f64baaeecc9965e0d6ad2df1935a95c468a785061bdf2cf4f993233a3b1abd4d431d72b8bcb7c4e2c24c75105b336fddf8b5fca1c3e0ef
+  metadata.gz: c1bd359f9025fd7d9a110decc493c75f03785f2a0ffe08a49ae58cdcf934182e87633d4a6b161383637903054aec59d743f941534731f3afbba9f39adb688def
+  data.tar.gz: 4ed0e468a309542c89867fc626fa88628e43b0a5ece64ee22d9c94cb86ee346ff738dfc768d138b5a8b06c78170d49bd9544742693d35fbd8e0ec916fddf7e30

data/app/controllers/ui_ansible_roles_controller.rb

@@ -8,7 +8,7 @@ class UiAnsibleRolesController < ::Api::V2::BaseController
   end
 
   # restore original method from find_common to ignore resource nesting
-  def resource_scope(options = {})
-    @resource_scope ||= scope_for(resource_class, options)
+  def resource_scope(**kwargs)
+    @resource_scope ||= scope_for(resource_class, **kwargs)
   end
 end

data/app/views/ansible_roles/import.html.erb

@@ -1,6 +1,5 @@
 <% title _("Changed Ansible roles") %>
 <%= webpacked_plugins_js_for :foreman_ansible %>
-<%= webpacked_plugins_css_for :foreman_ansible %>
 
 
 <%= react_component(

data/app/views/foreman_ansible/ansible_roles/_select_tab_content.html.erb

@@ -1,5 +1,4 @@
 <%= webpacked_plugins_js_for :foreman_ansible %>
-<%= webpacked_plugins_css_for :foreman_ansible %>
 
 <div class='tab-pane' id='ansible_roles'>
   <% class_name = f.object.is_a?(Hostgroup) ? 'Hostgroup' : 'Host' %>

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

@@ -30,8 +30,7 @@ template_inputs:
 provider_type: Ansible
 kind: job_template
 model: JobTemplate
-%>
-
+-%>
 # For Windows targets use the win_package module instead.
 ---
 - hosts: all
@@ -41,7 +40,7 @@ model: JobTemplate
   <%- end -%>
   tasks:
     - package:
-        name: <%= input('name') %>
+<%= indent(8) { to_yaml({"name" => input('name')}).gsub(/---\n/, '') } -%>
         state: <%= input('state') %>
   <%- if input('post_script').present? -%>
   post_tasks:

data/db/seeds.d/90_notification_blueprints.rb

@@ -1,19 +1,6 @@
 # frozen_string_literal: true
 
 blueprints = [
-  {
-    :group => N_('Jobs'),
-    :name => 'insights_remediation_successful',
-    :message => N_('Insights remediation on %{hosts_count}' \
-                   ' host(s) has finished successfully'),
-    :level => 'success',
-    :actions => {
-      :links => [
-        :path_method => :job_invocation_path,
-        :title => N_('Job Details')
-      ]
-    }
-  },
   {
     :group => N_('Roles'),
     :name => 'Sync_roles_and_variables_successfully',

data/lib/foreman_ansible/register.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Foreman::Plugin.register :foreman_ansible do
-  requires_foreman '>= 3.8.1'
+  requires_foreman '>= 3.10.0'
   register_gettext
 
   settings do
@@ -178,8 +178,6 @@ Foreman::Plugin.register :foreman_ansible do
        'Permissions required for the user which is used by Ansible Tower Dynamic Inventory Item'
 
   add_all_permissions_to_default_roles
-  extend_template_helpers ForemanAnsible::RendererMethods
-  allowed_template_helpers :insights_remediation
 
   base_role_assignment_params = { :ansible_role_ids => [],
                                   :ansible_roles => [] }

data/lib/foreman_ansible/remote_execution.rb

@@ -22,14 +22,6 @@ module ForemanAnsible
                            ' the roles defined for a host'),
         :host_action_button => true
       )
-      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],
-        :notification_builder => ForemanAnsible::InsightsNotificationBuilder
-      )
       RemoteExecutionFeature.register(
         :ansible_run_playbook,
         N_('Run playbook'),

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 = '13.0.6'
+  VERSION = '14.1.0'
 end

data/webpack/testHelper.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, { useState } from 'react';
 import { Provider } from 'react-redux';
 import thunk from 'redux-thunk';
 import { applyMiddleware, createStore, compose, combineReducers } from 'redux';
@@ -42,20 +42,21 @@ export const withReactRouter = Component => props => {
 };
 
 export const withMockedProvider = Component => props => {
-  const ForemanContext = getForemanContext(ctx);
-  // eslint-disable-next-line react/prop-types
-  const { mocks, ...rest } = props;
-
-  const ctx = {
+  const [context, setContext] = useState({
     metadata: {
       UISettings: {
         perPage: 20,
       },
     },
-  };
+  });
+  const contextData = { context, setContext };
+  const ForemanContext = getForemanContext(contextData);
+
+  // eslint-disable-next-line react/prop-types
+  const { mocks, ...rest } = props;
 
   return (
-    <ForemanContext.Provider value={ctx}>
+    <ForemanContext.Provider value={contextData}>
       <MockedProvider mocks={mocks}>
         <Component {...rest} />
       </MockedProvider>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 13.0.6
+  version: 14.1.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_list
@@ -171,14 +171,11 @@ files:
 - app/services/foreman_ansible/import_playbooks_success_notification.rb
 - app/services/foreman_ansible/import_roles_and_variables_error_notification.rb
 - app/services/foreman_ansible/import_roles_and_variables_success_notification.rb
-- app/services/foreman_ansible/insights_notification_builder.rb
-- app/services/foreman_ansible/insights_plan_runner.rb
 - app/services/foreman_ansible/inventory_creator.rb
 - app/services/foreman_ansible/override_resolver.rb
 - app/services/foreman_ansible/playbook_creator.rb
 - app/services/foreman_ansible/playbooks_importer.rb
 - app/services/foreman_ansible/proxy_api.rb
-- app/services/foreman_ansible/renderer_methods.rb
 - app/services/foreman_ansible/roles_importer.rb
 - app/services/foreman_ansible/ui_roles_importer.rb
 - app/services/foreman_ansible/variables_importer.rb
@@ -222,7 +219,6 @@ files:
 - app/views/foreman_ansible/job_templates/ansible_windows_updates.erb
 - app/views/foreman_ansible/job_templates/capsule_upgrade_-_ansible_default.erb
 - app/views/foreman_ansible/job_templates/convert_to_rhel.erb
-- app/views/foreman_ansible/job_templates/maintenance_plan.erb
 - app/views/foreman_ansible/job_templates/module_action_-_ansible_default.erb
 - app/views/foreman_ansible/job_templates/package_action_-_ansible_default.erb
 - app/views/foreman_ansible/job_templates/power_action_-_ansible_default.erb
@@ -350,7 +346,6 @@ files:
 - test/unit/services/ansible_report_importer_test.rb
 - test/unit/services/ansible_variables_importer_test.rb
 - test/unit/services/api_roles_importer_test.rb
-- test/unit/services/insights_plan_runner_test.rb
 - test/unit/services/inventory_creator_test.rb
 - test/unit/services/override_resolver_test.rb
 - test/unit/services/roles_importer_test.rb
@@ -546,7 +541,6 @@ test_files:
 - test/unit/services/ansible_report_importer_test.rb
 - test/unit/services/ansible_variables_importer_test.rb
 - test/unit/services/api_roles_importer_test.rb
-- test/unit/services/insights_plan_runner_test.rb
 - test/unit/services/inventory_creator_test.rb
 - test/unit/services/override_resolver_test.rb
 - test/unit/services/roles_importer_test.rb

data/app/services/foreman_ansible/insights_notification_builder.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module ForemanAnsible
-  # A class that builds custom notificaton for REX job if it's insights
-  # remediation feature
-  class InsightsNotificationBuilder < ::UINotifications::RemoteExecutionJobs::BaseJobFinish
-    def deliver!
-      ::Notification.create!(
-        :audience => Notification::AUDIENCE_USER,
-        :notification_blueprint => blueprint,
-        :initiator => initiator,
-        :message => message,
-        :subject => subject,
-        :actions => {
-          :links => links
-        }
-      )
-    end
-
-    def blueprint
-      name = 'insights_remediation_successful'
-      @blueprint ||= NotificationBlueprint.unscoped.find_by(:name => name)
-    end
-
-    def hosts_count
-      @hosts_count ||= subject.template_invocations_hosts.size
-    end
-
-    def message
-      UINotifications::StringParser.new(blueprint.message,
-                                        :hosts_count => hosts_count)
-    end
-
-    def links
-      job_links + insights_links
-    end
-
-    def insights_links
-      pattern_template = subject.pattern_template_invocations.first
-      plan_id = pattern_template.input_values.
-                joins(:template_input).
-                where('template_inputs.name' => 'plan_id').
-                first.try(:value)
-      return [] if plan_id.nil?
-
-      [
-        {
-          :href => "/redhat_access/insights/planner/#{plan_id}",
-          :title => _('Remediation Plan')
-        }
-      ]
-    end
-
-    def job_links
-      UINotifications::URLResolver.new(
-        subject,
-        :links => [{
-          :path_method => :job_invocation_path,
-          :title => _('Job Details')
-        }]
-      ).actions[:links]
-    end
-  end
-end

data/app/services/foreman_ansible/insights_plan_runner.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-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).\
-            merge(:proxy => get_portal_http_proxy)
-        )
-        @raw_playbook = resource.get.body
-        YAML.safe_load(@raw_playbook)
-      end
-
-      # To parse the disclaimer we iterate over the first lines of the
-      # playbook (all comments) until we get to a line that looks like
-      # "Generated by Red Hat Insights on..."
-      def parse_disclaimer(playbook = @raw_playbook)
-        return '' if playbook.blank?
-        disclaimer = []
-        playbook.split("\n").each do |line|
-          next if line == '---'
-          break unless line[0] == '#'
-          disclaimer << line
-          break if /Generated by Red Hat Insights on/ =~ line
-        end
-        disclaimer.join("\n")
-      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/renderer_methods.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module ForemanAnsible
-  # Macro to fetch RH Insights plan playbook
-  module RendererMethods
-    extend ActiveSupport::Concern
-    extend ApipieDSL::Module
-
-    apipie :class, 'Macros related to Ansible playbooks' do
-      name 'Ansible'
-      sections only: %w[all jobs]
-    end
-
-    apipie :method, 'Returns Insights maintenance plan for host' do
-      required :plan_id, String, desc: 'The playbook for the rule coming from insights'
-      optional :organization_id, Integer, desc: 'The Foreman organization associated with the Insights account', default: 'Current organization ID'
-      returns String, desc: 'Insights maintenance plan for host'
-    end
-    def insights_remediation(plan_id, organization_id = Organization.current.id)
-      return "$INSIGHTS_REMEDIATION[#{plan_id}, #{organization_id}]" if preview?
-
-      cached("insights_#{plan_id}_#{organization_id}") do
-        Rails.logger.debug 'cache miss for insights plan fetching'
-        insights_plan = ForemanAnsible::InsightsPlanRunner.new(
-          Organization.find(organization_id),
-          plan_id
-        )
-        rules = insights_plan.playbook
-        disclaimer = insights_plan.parse_disclaimer
-        hostname_rules_relation = insights_plan.hostname_rules(rules)
-        global_rules = insights_plan.rules_to_hash(rules)
-        host_playbooks = individual_host_playbooks(hostname_rules_relation,
-                                                   global_rules)
-        "#{disclaimer}\n#{host_playbooks.to_yaml}"
-      end
-    end
-
-    private
-
-    def individual_host_playbooks(hostname_rules_relation, global_rules)
-      hostname_rules_relation[@host.name].reduce([]) do |acc, cur|
-        acc << global_rules[cur]
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-<%#
-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/test/unit/services/insights_plan_runner_test.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_plugin_helper'
-
-if defined? RedhatAccess
-  module ForemanAnsible
-    # Tests for the RH Insights plan runner. Mostly about checking whether
-    # the playbook can be parsed properly
-    class InsightsPlanRunnerTest < ActiveSupport::TestCase
-      test 'disclaimer is saved as raw_playbook' do
-        disclaimer = <<-DISCLAIMER.strip_heredoc.strip
-  # Red Hat Insights has recommended one or more actions for you, a system administrator, to review and if you
-  # deem appropriate, deploy on your systems running Red Hat software. Based on the analysis, we have automatically
-  # generated an Ansible Playbook for you. Please review and test the recommended actions and the Playbook as
-  # they may contain configuration changes, updates, reboots and/or other changes to your systems. Red Hat is not
-  # responsible for any adverse outcomes related to these recommendations or Playbooks.
-  #
-  # Addresses maintenance plan 38439429 (demo)
-  # https://access.redhat.com/insights/planner/438294928
-  # Generated by Red Hat Insights on Wed, 18 Apr 2018 07:54:18 GMT
-        DISCLAIMER
-
-        playbook = File.read(ansible_fixture_file('insights_playbook.yaml'))
-        planner = ::ForemanAnsible::InsightsPlanRunner.new(
-          FactoryBot.build(:organization), rand
-        )
-        assert_empty planner.parse_disclaimer
-        planner.expects(:insights_api_host).returns('')
-        planner.expects(:get_ssl_options_for_org).returns(nil)
-        RestClient::Resource.any_instance.expects(:get).returns(
-          OpenStruct.new(:body => playbook)
-        )
-        planner.playbook
-        assert_equal disclaimer, planner.parse_disclaimer
-      end
-    end
-  end
-end