foreman_ansible 14.0.0 → 14.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173634631b4f95f6e86f02775e026c17ba5a9a9f57d99e3f5491b57c89d8c9ca
-  data.tar.gz: 7dc19084e2cae6883903ef8cbb17fa221e9aea972efa851da351022989e603c8
+  metadata.gz: b4a545f421f2f2c43e19e841ccef12f519600a76d635455a78384bec421a5a83
+  data.tar.gz: 55ddd534490d785646a7cf7c88ba36c9e9e16502f8542615a184ecd1e00a2f02
 SHA512:
-  metadata.gz: e16ac25e290b715368ea2d5a315aca31bd8c6723f9f19a974efedd926710c145c3f8532e33259599117d36497d7d0899783c324fa7db6ab3c2f035b2dfa4ecff
-  data.tar.gz: b492b84c46d9633770d1f75a7c151f7e4d55c52c1da465d834184248e66b0b1e6fe5a709376916142b29669f4bdb704ed9d5f2271be534387a3bdb86a7249adb
+  metadata.gz: 6d82a845c26ec335af11b373929b017cc112ef412463298c74d80efe432feb2062d51da39deacd4adc17eccc8ba17a1ac77ebd5915aaac222580b0f9d729b899
+  data.tar.gz: 317d0658cb5b25ae49036cddef2781b46c99bd380ebf3a59066ee6d2ee94ac6e32d7364ac0593ec7f6884bf738f7310a3ca0d4633f85bd015091b8dc8404eff8

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/ansible_roles/index.html.erb

@@ -1,7 +1,7 @@
 <% title _("Ansible Roles") %>
 
 <% title_actions ansible_proxy_import(hash_for_import_ansible_roles_path),
-  documentation_button('#4.1ImportingRoles', :root_url => ansible_doc_url) %>
+  documentation_button('Managing_Configurations_Ansible', type: 'docs', chapter: 'Importing_Ansible_Roles_and_Variables_ansible') %>
 
 <table class="<%= table_css_classes 'table-fixed' %>">
   <thead>

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

@@ -7,7 +7,7 @@
   <p><%= _('No Ansible Roles were found in Foreman. If you want to assign roles to your hosts,
              you have to import them first.').html_safe %>
   </p>
-  <p><%= link_to(_('Learn more about this in the documentation.'), documentation_url('#4.1ImportingRoles', :root_url => ansible_doc_url), target: '_blank') %></p>
+  <p><%= link_to(_('Learn more about this in the documentation.'), documentation_url('Managing_Configurations_Ansible', type: 'docs',  chapter: 'Importing_Ansible_Roles_and_Variables_ansible'), target: '_blank') %></p>
   <div class="blank-slate-pf-secondary-action">
     <%= ansible_proxy_import(hash_for_import_ansible_roles_path) %>
   </div>

data/app/views/ansible_variables/_fields.erb

@@ -65,7 +65,7 @@
     </fieldset>
     </br>
     <fieldset>
-      <h2><%= _("Specify Matchers") %>  <%= documentation_button('4.2.6SmartMatchers') %></h2>
+      <h2><%= _("Specify Matchers") %>  <%= documentation_button('Managing_Configurations_Ansible', type: 'docs', chapter: 'Overriding_Ansible_Variables_in_foreman_ansible') %></h2>
       <div class="children_fields lookup_values">
         <%= render 'lookup_keys/values', :f => f, :is_param => false %>
       </div>

data/app/views/ansible_variables/index.html.erb

@@ -2,8 +2,7 @@
 <%= stylesheet 'foreman_ansible/foreman-ansible' %>
 
 <%= title_actions display_link_if_authorized(_('New Ansible Variable'), hash_for_new_ansible_variable_path, :class => "btn btn-default no-float"),
-      documentation_button('#4.3Variables', :root_url => ansible_doc_url)
-       %>
+      documentation_button('Managing_Configurations_Ansible', type: 'docs', chapter: 'Importing_Ansible_Roles_and_Variables_ansible') %>
 
 <table class="<%= table_css_classes 'table-fixed' %>">
   <thead>

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/convert_to_rhel.erb

@@ -19,22 +19,6 @@ template_inputs:
   options: "yes\r\nno"
   advanced: false
   value_type: plain
-  resource_type: Katello::ActivationKey
-  hidden_value: false
-- name: Data telemetry
-  required: true
-  input_type: user
-  description: "The convert2rhel utility uploads the following data about the system
-    conversion to Red Hat servers for the purpose of the utility usage analysis:<br>\r\n-
-    The convert2rhel command as executed<br>\r\n- The convert2rhel RPM version and
-    GPG signature<br>\r\n- Success or failure status of the conversion<br>\r\n- Conversion
-    start and end timestamps<br>\r\n- Source OS vendor and version<br>\r\n- Target
-    RHEL version<br>\r\n- convert2rhel related environment variables<br>"
-  options: "yes\r\nno"
-  advanced: false
-  value_type: plain
-  resource_type: Katello::ActivationKey
-  default: 'yes'
   hidden_value: false
 model: JobTemplate
 job_category: Convert 2 RHEL
@@ -43,21 +27,34 @@ kind: job_template
 %>
 ---
 - hosts: all
-<%- if input('Data telemetry') != "yes" -%>
   environment:
-    CONVERT2RHEL_DISABLE_TELEMETRY: 1
-<%- end -%>
+    CONVERT2RHEL_THROUGH_FOREMAN: 1
   tasks:
     - name: Install convert2rhel
       ansible.builtin.package:
         name: convert2rhel
         state: present
+
+    - name: Gather package facts
+      package_facts:
+        manager: auto
+
+    - name: Set fact for package version
+      set_fact:
+        convert2rhel_version: "{{ ansible_facts.packages['convert2rhel'][0].version }}"
+      when: "'convert2rhel' in ansible_facts.packages"
+      no_log: true
+
     - name: Prepopulate katello-ca-consumer
       get_url:
         url: <%= subscription_manager_configuration_url(@host) %>
         dest: /usr/share/convert2rhel/subscription-manager/katello-ca-consumer-latest.noarch.rpm
+      when:
+        - "convert2rhel_version is version('2.0.0', '<')"
+
     - name: Start convert2rhel
-      command: convert2rhel -y --activationkey "<%= input_resource('Activation Key').name %>" --org "<%= @host.organization.label %>" --keep-rhsm
+      command: convert2rhel -y --activationkey "<%= input_resource('Activation Key').name %>" --org "<%= @host.organization.label %>"
+
 <%- if input('Restart') == "yes" -%>
     - name: Reboot the machine
       reboot:

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

@@ -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 = '14.0.0'
+  VERSION = '14.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ansible
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 14.1.1
 platform: ruby
 authors:
 - Daniel Lobato Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-07-31 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
@@ -500,7 +495,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Ansible integration with Foreman (theforeman.org)
@@ -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