foreman_rh_cloud 3.0.19 → 4.0.22

data/app/subscribers/foreman_rh_cloud/insights_subscriber.rb

@@ -0,0 +1,9 @@
+module ForemanRhCloud
+  class InsightsSubscriber < ::Foreman::BaseSubscriber
+    def call(*args)
+      host = args.first.payload[:object]
+      host_status = host.get_status(InsightsClientReportStatus)
+      host_status.update(status: host_status.to_status)
+    end
+  end
+end

data/app/views/job_templates/rh_cloud_remediations.erb

@@ -0,0 +1,14 @@
+<%#
+kind: job_template
+name: Run remediations based on Insights recommendations
+job_category: Red Hat Insights
+description_format: 'Insights remediations for selected issues'
+feature: rh_cloud_remediate_hosts
+template_inputs:
+- name: hit_remediation_pairs
+  description: Pairs of issues and selected remediation
+  input_type: user
+  required: true
+provider_type: Ansible
+%>
+<%= remediations_playbook(input('hit_remediation_pairs')) %>

data/config/routes.rb

@@ -19,6 +19,7 @@ Rails.application.routes.draw do
     resources :hits, except: %i[show] do
       collection do
         get 'auto_complete_search'
+        get 'resolutions', to: 'hits#resolutions'
       end
     end
     match 'hits/:host_id', to: 'hits#show', via: :get

data/db/migrate/20210404000001_change_resolutions.foreman_rh_cloud.rb

@@ -0,0 +1,10 @@
+class ChangeResolutions < ActiveRecord::Migration[5.2]
+  def change
+    remove_column :insights_resolutions, :system_type, :integer
+    remove_column :insights_resolutions, :has_playbook, :boolean
+    rename_column :insights_resolutions, :resolution, :description
+    add_column :insights_resolutions, :needs_reboot, :boolean
+    add_column :insights_resolutions, :resolution_risk, :integer
+    add_column :insights_resolutions, :resolution_type, :string
+  end
+end

data/db/seeds.d/179_ui_notifications.rb

@@ -0,0 +1,11 @@
+blueprints = [
+  {
+    group: N_('Red Hat Insights'),
+    name: 'insights_satellite_hits',
+    message: N_('Satellite server has %{hits_count} recommendations by Red Hat'),
+    level: 'warning',
+  },
+]
+
+blueprints.each { |blueprint| UINotifications::Seed.new(blueprint).configure }
+

data/db/seeds.d/50_job_templates.rb

@@ -0,0 +1,14 @@
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
+User.as_anonymous_admin do
+  JobTemplate.without_auditing do
+    Dir[File.join("#{ForemanRhCloud::Engine.root}/app/views/job_templates/**/*.erb")].each do |template|
+      template = JobTemplate.import_raw!(File.read(template),
+      :default => true,
+      :lock => true,
+      :update => true)
+      template.organizations = organizations if template.present?
+      template.locations = locations if template.present?
+    end
+  end
+end

data/lib/foreman_inventory_upload.rb

@@ -57,10 +57,14 @@ module ForemanInventoryUpload
   end
 
   def self.slice_size
-    # for testing set ENV to 'https://ci.cloud.redhat.com/api/ingress/v1/upload'
     @slice_size ||= (ENV['SATELLITE_INVENTORY_SLICE_SIZE'] || '1000').to_i
   end
 
+  def self.max_org_size
+    # Set max amount of hosts per organization for automatic uploads
+    @max_org_size ||= (ENV['SATELLITE_INVENTORY_MAX_ORG_SIZE'] || 150_000).to_i
+  end
+
   def self.ensure_folder(folder)
     FileUtils.mkdir_p(folder)
     folder

data/lib/foreman_inventory_upload/async/generate_all_reports_job.rb

@@ -13,8 +13,14 @@ module ForemanInventoryUpload
         organizations = Organization.unscoped.all
 
         organizations.map do |organization|
-          GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization.id)
-        end
+          total_hosts = ForemanInventoryUpload::Generators::Queries.for_org(organization.id, use_batches: false).count
+
+          if total_hosts <= ForemanInventoryUpload.max_org_size
+            GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization.id)
+          else
+            logger.info("Skipping automatic uploads for organization #{organization.name}, too many hosts (#{total_hosts}/#{ForemanInventoryUpload.max_org_size})")
+          end
+        end.compact
       ensure
         self.class.set(:wait => 24.hours).perform_later
       end

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -10,6 +10,8 @@ module ForemanInventoryUpload
       CLOUD_AZURE = 'azure'
       CLOUD_ALIBABA = 'alibaba'
 
+      UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+
       def fact_value(host, fact_name)
         value_record = host.fact_values.find do |fact_value|
           fact_value.fact_name_id == ForemanInventoryUpload::Generators::Queries.fact_names[fact_name]
@@ -104,6 +106,23 @@ module ForemanInventoryUpload
       def obfuscate_ip(ip, ips_dict)
         "10.230.230.#{ips_dict.count + 1}"
       end
+
+      def bios_uuid(host)
+        value = fact_value(host, 'dmi::system::uuid') || ''
+        uuid_value(value)
+      end
+
+      def uuid_value(value)
+        uuid_match = UUID_REGEX.match(value)
+        uuid_match&.to_s
+      end
+
+      def uuid_value!(value)
+        uuid = uuid_value(value)
+        raise Foreman::Exception.new(N_('Value %{value} is not a valid UUID') % {value: value}) if value && uuid.empty?
+
+        uuid
+      end
     end
   end
 end

data/lib/foreman_inventory_upload/generators/queries.rb

@@ -49,8 +49,9 @@ module ForemanInventoryUpload
         for_org(org_ids)
       end
 
-      def self.for_org(organization_id)
-        for_slice(Host.unscoped.where(organization_id: organization_id)).in_batches(of: ForemanInventoryUpload.slice_size)
+      def self.for_org(organization_id, use_batches: true)
+        base_query = for_slice(Host.unscoped.where(organization_id: organization_id))
+        use_batches ? base_query.in_batches(of: ForemanInventoryUpload.slice_size) : base_query
       end
 
       def self.organizations_for_user(portal_user)

data/lib/foreman_inventory_upload/generators/slice.rb

@@ -25,7 +25,7 @@ module ForemanInventoryUpload
 
       def report_slice(hosts_batch)
         @stream.object do
-          @stream.simple_field('report_slice_id', @slice_id)
+          @stream.simple_field('report_slice_id', uuid_value!(@slice_id))
           @stream.array_field('hosts', :last) do
             first = true
             hosts_batch.each do |host|
@@ -45,10 +45,10 @@ module ForemanInventoryUpload
         @stream.object do
           @stream.simple_field('fqdn', fqdn(host))
           @stream.simple_field('account', account_id(host.organization).to_s)
-          @stream.simple_field('subscription_manager_id', host.subscription_facet&.uuid)
-          @stream.simple_field('satellite_id', host.subscription_facet&.uuid)
-          @stream.simple_field('bios_uuid', fact_value(host, 'dmi::system::uuid'))
-          @stream.simple_field('vm_uuid', fact_value(host, 'virt::uuid'))
+          @stream.simple_field('subscription_manager_id', uuid_value!(host.subscription_facet&.uuid))
+          @stream.simple_field('satellite_id', uuid_value!(host.subscription_facet&.uuid))
+          @stream.simple_field('bios_uuid', bios_uuid(host))
+          @stream.simple_field('vm_uuid', uuid_value(fact_value(host, 'virt::uuid')))
           report_ip_addresses(host, host_ips_cache)
           report_mac_addresses(host)
           @stream.object_field('system_profile') do
@@ -85,7 +85,7 @@ module ForemanInventoryUpload
         @stream.object do
           @stream.simple_field('namespace', namespace)
           @stream.simple_field('key', key)
-          @stream.simple_field('value', value, :last)
+          @stream.simple_field('value', value.to_s, :last)
         end
         @stream.comma unless last
       end

data/lib/foreman_inventory_upload/generators/tags.rb

@@ -6,12 +6,14 @@ module ForemanInventoryUpload
       end
 
       def generate
-        locations +
-        hostgroups +
-        host_collections +
-        organizations +
-        content_data +
-        satellite_server_data
+        (
+          locations +
+          hostgroups +
+          host_collections +
+          organizations +
+          content_data +
+          satellite_server_data
+        ).reject { |key, value| value.empty? }
       end
 
       def generate_parameters

data/lib/foreman_rh_cloud.rb

@@ -38,12 +38,25 @@ module ForemanRhCloud
   end
 
   def self.proxy_setting(logger: Foreman::Logging.logger('background'))
+    fix_port(proxy_string(logger: logger))
+  end
+
+  def self.proxy_string(logger: Foreman::Logging.logger('background'))
     HttpProxy.default_global_content_proxy&.full_url ||
     ForemanRhCloud.cdn_proxy(logger: logger) ||
     ForemanRhCloud.global_foreman_proxy ||
     ''
   end
 
+  def self.fix_port(uri_string)
+    return '' if uri_string.empty?
+
+    uri = URI(uri_string)
+    uri.send(:define_singleton_method, :default_port, -> { nil })
+
+    uri.to_s
+  end
+
   def self.cdn_proxy(logger: Foreman::Logging.logger('app'))
     proxy_config = SETTINGS[:katello][:cdn_proxy]
     return nil unless proxy_config
@@ -82,4 +95,9 @@ module ForemanRhCloud
 
     transformed_uri.to_s
   end
+
+  # For testing purposes we can override the default hostname with an environment variable SATELLITE_RH_CLOUD_FOREMAN_HOST
+  def self.foreman_host
+    @foreman_host ||= ::Host.unscoped.friendly.find(ENV['SATELLITE_RH_CLOUD_FOREMAN_HOST'] || ::SmartProxy.default_capsule.name)
+  end
 end

data/lib/foreman_rh_cloud/engine.rb

@@ -48,7 +48,7 @@ module ForemanRhCloud
             :view_insights_hits,
             {
               '/foreman_rh_cloud/insights_cloud': [:index], # for bookmarks and later for showing the page
-              'insights_cloud/hits': [:index, :show, :auto_complete_search],
+              'insights_cloud/hits': [:index, :show, :auto_complete_search, :resolutions],
               'insights_cloud/settings': [:index, :show],
               'react': [:index],
             },
@@ -78,7 +78,10 @@ module ForemanRhCloud
 
         register_global_js_file 'global'
 
-        register_custom_status(InventorySync::InventoryStatus)
+        register_custom_status InventorySync::InventoryStatus
+        register_custom_status InsightsClientReportStatus
+
+        subscribe 'host_created.event.foreman', ForemanRhCloud::InsightsSubscriber
 
         extend_page 'hosts/show' do |context|
           context.add_pagelet :main_tabs,
@@ -87,6 +90,9 @@ module ForemanRhCloud
             id: 'insights',
             onlyif: proc { |host| host.insights }
         end
+
+        extend_template_helpers ForemanRhCloud::TemplateRendererHelper
+        allowed_template_helpers :remediations_playbook
       end
 
       ::Katello::UINotifications::Subscriptions::ManifestImportSuccess.include ForemanInventoryUpload::Notifications::ManifestImportSuccessNotificationOverride if defined?(Katello)
@@ -114,5 +120,33 @@ module ForemanRhCloud
       locale_domain = 'foreman_rh_cloud'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
+
+    config.to_prepare do
+      # skip database manipulations while tables do not exist, like in migrations
+      if ActiveRecord::Base.connection.data_source_exists?(ForemanTasks::Task.table_name) &&
+
+        RemoteExecutionFeature.register(
+          :rh_cloud_remediate_hosts,
+          N_('Apply Insights recommendations'),
+          description: N_('Run remediation playbook generated by Insights'),
+          host_action_button: false
+        )
+        # skip object creation when admin user is not present, for example in test DB
+        if User.unscoped.find_by_login(User::ANONYMOUS_ADMIN).present?
+          ::ForemanTasks.dynflow.config.on_init(false) do |world|
+            unless ForemanTasks::RecurringLogic.joins(:tasks).merge(
+              ForemanTasks::Task.where(label: 'InventorySync::Async::InventoryScheduledSync')
+            ).exists?
+              User.as_anonymous_admin do
+                recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline("0 0 * * *")
+                recurring_logic.save!
+                recurring_logic.start(InventorySync::Async::InventoryScheduledSync)
+              end
+            end
+          end
+        end
+      end
+    rescue ActiveRecord::NoDatabaseError
+    end
   end
 end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '3.0.19'.freeze
+  VERSION = '4.0.22'.freeze
 end

data/lib/insights_cloud.rb

@@ -16,4 +16,16 @@ module InsightsCloud
   def self.rules_url(limit: ForemanRhCloud.query_limit, offset: 0)
     ForemanRhCloud.base_url + "/api/insights/v1/rule/?impacting=true&rule_status=enabled&has_playbook=true&limit=#{limit}&offset=#{offset}"
   end
+
+  def self.resolutions_url
+    ForemanRhCloud.base_url + '/api/remediations/v1/resolutions'
+  end
+
+  def self.playbook_url
+    ForemanRhCloud.base_url + '/api/remediations/v1/playbook'
+  end
+
+  def self.remediation_rule_id(rule_id)
+    "advisor:#{rule_id}"
+  end
 end

data/lib/insights_cloud/async/insights_full_sync.rb

@@ -2,17 +2,24 @@ require 'rest-client'
 
 module InsightsCloud
   module Async
-    class InsightsFullSync < ::ApplicationJob
+    class InsightsFullSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CloudAuth
 
-      def perform
-        # This can be turned off when we enable automatic status syncs
-        # This step will query cloud inventory to retrieve inventory uuids for each host
-        ForemanTasks.sync_task(InventorySync::Async::InventoryHostsSync)
+      def plan
+        sequence do
+          # This can be turned off when we enable automatic status syncs
+          # This step will query cloud inventory to retrieve inventory uuids for each host
+          plan_hosts_sync
+          plan_self
+          concurrence do
+            plan_rules_sync
+            plan_notifications
+          end
+        end
+      end
 
+      def run
         perform_hits_sync
-
-        InsightsRulesSync.perform_later
       end
 
       def perform_hits_sync
@@ -25,34 +32,36 @@ module InsightsCloud
       end
 
       def logger
-        Foreman::Logging.logger('background')
+        action_logger
       end
 
       private
 
+      def plan_hosts_sync
+        plan_action InventorySync::Async::InventoryHostsSync
+      end
+
+      def plan_rules_sync
+        plan_action InsightsRulesSync
+      end
+
+      def plan_notifications
+        plan_action InsightsGenerateNotifications
+      end
+
       def query_insights_hits
-        hits_response = RestClient::Request.execute(
+        hits_response = execute_cloud_request(
           method: :get,
-          url: InsightsCloud.hits_export_url,
-          verify_ssl: ForemanRhCloud.verify_ssl_method,
-          proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
-          headers: {
-            Authorization: "Bearer #{rh_credentials}",
-          }
+          url: InsightsCloud.hits_export_url
         )
 
         JSON.parse(hits_response)
       end
 
       def query_insights_rules
-        rules_response = RestClient::Request.execute(
+        rules_response = execute_cloud_request(
           method: :get,
-          url: InsightsCloud.rules_url,
-          verify_ssl: ForemanRhCloud.verify_ssl_method,
-          proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
-          headers: {
-            Authorization: "Bearer #{rh_credentials}",
-          }
+          url: InsightsCloud.rules_url
         )
 
         JSON.parse(rules_response)

data/lib/insights_cloud/async/insights_generate_notifications.rb

@@ -0,0 +1,58 @@
+require 'rest-client'
+
+module InsightsCloud
+  module Async
+    class InsightsGenerateNotifications < ::Actions::EntryAction
+      # cache blueprint on class level, so it won't be reloaded on subsequent calls
+      def self.blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'insights_satellite_hits')
+      end
+
+      def run
+        add_satellite_notifications
+      end
+
+      def add_satellite_notifications
+        hits_count = InsightsHit.where(host_id: foreman_host.id).count
+
+        # Remove stale notifications
+        blueprint.notifications.destroy_all
+
+        if hits_count > 0
+          add_notification(hits_count)
+        end
+      end
+
+      private
+
+      def logger
+        action_logger
+      end
+
+      def foreman_host
+        ForemanRhCloud.foreman_host
+      end
+
+      def blueprint
+        self.class.blueprint
+      end
+
+      def add_notification(hits_count)
+        Notification.create!(
+          initiator: User.anonymous_admin,
+          audience: ::Notification::AUDIENCE_ADMIN,
+          message: UINotifications::StringParser.new(blueprint.message, {hits_count: hits_count}).to_s,
+          notification_blueprint: blueprint,
+          actions: {
+            links: [
+              {
+                href: Rails.application.routes.url_helpers.foreman_rh_cloud_insights_cloud_path(search: "hostname=#{foreman_host.name}"),
+                title: _('Fix host'),
+              },
+            ],
+          }
+        )
+      end
+    end
+  end
+end