foreman_rh_cloud 3.0.21.1 → 3.0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87599d8ef67eeeaa3e17e720dc990b58d4085caf7fb6491dab093c54770c8fd
-  data.tar.gz: 04b52a7412dddf8e6829d61555ec9315c7f3856fde32e976eb8c50638082a3bc
+  metadata.gz: 0157c9f96dcbfa67895f62e292af8f9171c6d90a60f3eb8fdca5de57bd42918c
+  data.tar.gz: 24c8de05e245d54d789bacbed59bf7bd8c85d40f7252a59b60b599ab8941f5e9
 SHA512:
-  metadata.gz: 4ca381e6bcbf74d21a23ae825ebb6556be1afbe98c193fb33e58ef7fee6027142a809ed79b8cbcb3c8dce95200b0bd4528d497597a1f0411f703172ce1f9c123
-  data.tar.gz: 945faf0852d9ebce259e4da1bcebd079ef5a4fad87f503fc9ee694f4eae7e3ab36a7dc2390d54879a7da57d176aa22d8030a168d2715fe1f54a521b2258fbb37
+  metadata.gz: cd9e22b6176184b7c40d64229170458a59d2e70fbca128b892d299359c3e531afae0ebf760d07f57ba304bc042d86a601ef13472e8e8c3686eb670620185ee70
+  data.tar.gz: ca49d14fb99c6de0480cf180b1f38d7a70cca26808ef141cc6c504fbfc08daeda3f89127def3cc18e6d8ed2afbef835704d48ef4011442b33f7ec407def79fea

data/app/controllers/api/v2/rh_cloud/inventory_controller.rb

@@ -0,0 +1,50 @@
+module Api
+  module V2
+    module RhCloud
+      class InventoryController < ::Api::V2::BaseController
+        include ::Api::Version2
+        include InventoryUpload::ReportActions
+        include InventoryUpload::TaskActions
+
+        api :GET, "/organizations/:organization_id/rh_cloud/report", N_("Download latest report")
+        def download_file
+          filename, file = report_file(params[:organization_id])
+
+          send_file file, disposition: 'attachment', filename: filename
+        rescue InventoryUpload::ReportActions::ReportMissingError => error
+          render json: { message: error.message }, status: :not_found
+        end
+
+        api :POST, "/organizations/:organization_id/rh_cloud/report", N_("Start report generation")
+        def generate_report
+          organization_id = params[:organization_id]
+
+          start_report_generation(organization_id)
+
+          render json: {
+            action_status: 'success',
+          }, status: :ok
+        end
+
+        api :POST, "/organizations/:organization_id/rh_cloud/inventory_sync", N_("Start inventory synchronization")
+        def sync_inventory_status
+          selected_org = Organization.find(params[:organization_id])
+
+          task = start_inventory_sync(selected_org)
+
+          render json: {
+            task: task,
+          }, status: :ok
+        rescue InventoryUpload::TaskActions::NothingToSyncError => error
+          render json: { message: error.message }, status: :bad_request
+        end
+
+        api :POST, "rh_cloud/enable_connector", N_("Enable cloud connector")
+        def enable_cloud_connector
+          cloud_connector = ForemanRhCloud::CloudConnector.new
+          render json: cloud_connector.install.to_json
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/inventory_upload/report_actions.rb

@@ -0,0 +1,26 @@
+module InventoryUpload
+  module ReportActions
+    extend ActiveSupport::Concern
+
+    class ReportMissingError < Foreman::Exception
+      MESSAGE = N_("The report file %{filename} doesn't exist")
+
+      def initialize(**params)
+        super(self.class::MESSAGE % params, params)
+      end
+    end
+
+    def start_report_generation(organization_id)
+      ForemanInventoryUpload::Async::GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization_id)
+    end
+
+    def report_file(organization_id)
+      filename = ForemanInventoryUpload.facts_archive_name(organization_id)
+      files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
+
+      raise ReportMissingError.new(filename: filename) if files.empty?
+
+      [filename, files.first]
+    end
+  end
+end

data/app/controllers/concerns/inventory_upload/task_actions.rb

@@ -0,0 +1,25 @@
+module InventoryUpload
+  module TaskActions
+    extend ActiveSupport::Concern
+
+    class NothingToSyncError < Foreman::Exception
+      MESSAGE = N_('Nothing to sync, there are no hosts with subscription for this organization.')
+
+      def initialize(**params)
+        super(self.class::MESSAGE, params)
+      end
+    end
+
+    def start_inventory_sync(selected_org)
+      subscribed_hosts = ForemanInventoryUpload::Generators::Queries.for_slice(
+        Host.unscoped.where(organization: selected_org)
+      )
+
+      if subscribed_hosts.empty?
+        raise NothingToSyncError
+      end
+
+      ForemanTasks.async_task(InventorySync::Async::InventoryFullSync, selected_org)
+    end
+  end
+end

data/app/controllers/foreman_inventory_upload/reports_controller.rb

@@ -2,6 +2,8 @@
 
 module ForemanInventoryUpload
   class ReportsController < ::ApplicationController
+    include InventoryUpload::ReportActions
+
     def last
       label = ForemanInventoryUpload::Async::GenerateReportJob.output_label(params[:organization_id])
       output = ForemanInventoryUpload::Async::ProgressOutput.get(label)&.full_output
@@ -20,7 +22,7 @@ module ForemanInventoryUpload
     def generate
       organization_id = params[:organization_id]
 
-      ForemanInventoryUpload::Async::GenerateReportJob.perform_later(ForemanInventoryUpload.generated_reports_folder, organization_id)
+      start_report_generation(organization_id)
 
       render json: {
         action_status: 'success',

data/app/controllers/foreman_inventory_upload/tasks_controller.rb

@@ -1,25 +1,17 @@
 module ForemanInventoryUpload
   class TasksController < ::ApplicationController
+    include InventoryUpload::TaskActions
+
     def create
       selected_org = Organization.current
-      subscribed_hosts_ids = Set.new(
-        ForemanInventoryUpload::Generators::Queries.for_slice(
-          Host.unscoped.where(organization: selected_org)
-        ).pluck(:id)
-      )
 
-      if subscribed_hosts_ids.empty?
-        return render json: {
-          message: N_('Nothing to sync, there are no hosts with subscription for this organization.'),
-        }, status: :method_not_allowed
-      else
-        task = ForemanTasks.async_task(InventorySync::Async::InventoryFullSync, selected_org)
-      end
-      return render json: { message: N_('there was an issue triggering the task') }, status: :internal_server_error unless task
+      task = start_inventory_sync(selected_org)
 
       render json: {
         task: task,
       }, status: :ok
+    rescue InventoryUpload::TaskActions::NothingToSyncError => error
+      render json: { message: error.message }, status: :internal_server_error
     end
 
     def show

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -1,5 +1,7 @@
 module ForemanInventoryUpload
   class UploadsController < ::ApplicationController
+    include InventoryUpload::ReportActions
+
     def last
       label = ForemanInventoryUpload::Async::UploadReportJob.output_label(params[:organization_id])
       output = ForemanInventoryUpload::Async::ProgressOutput.get(label)&.full_output
@@ -10,11 +12,9 @@ module ForemanInventoryUpload
     end
 
     def download_file
-      filename = ForemanInventoryUpload.facts_archive_name(params[:organization_id])
-      files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
+      filename, file = report_file(params[:organization_id])
 
-      return send_file files.first, disposition: 'attachment', filename: filename unless files.empty?
-      raise ::Foreman::Exception.new("The report file doesn't exist")
+      send_file file, disposition: 'attachment', filename: filename
     end
 
     def enable_cloud_connector

data/app/controllers/insights_cloud/api/machine_telemetries_controller.rb

@@ -5,32 +5,34 @@ module InsightsCloud::Api
     include ::InsightsCloud::ClientAuthentication
     include ::InsightsCloud::CandlepinCache
 
+    before_action :set_admin_user, only: [:forward_request]
     before_action :cert_uuid, :ensure_org, :ensure_branch_id, :only => [:forward_request, :branch_info]
     before_action :ensure_telemetry_enabled_for_consumer, :only => [:forward_request]
 
     skip_after_action :log_response_body, :only => [:forward_request]
     skip_before_action :check_media_type, :only => [:forward_request]
+    after_action :update_host_insights_status, only: [:forward_request]
 
     # The method that "proxies" requests over to Cloud
     def forward_request
       certs = candlepin_id_cert @organization
-      cloud_response = ::ForemanRhCloud::CloudRequestForwarder.new.forward_request(request, controller_name, @branch_id, certs)
+      @cloud_response = ::ForemanRhCloud::CloudRequestForwarder.new.forward_request(request, controller_name, @branch_id, certs)
 
-      if cloud_response.code == 401
+      if @cloud_response.code == 401
         return render json: {
           :message => 'Authentication to the Insights Service failed.',
           :headers => {},
         }, status: :bad_gateway
       end
 
-      if cloud_response.headers[:content_disposition]
-        return send_data cloud_response, disposition: cloud_response.headers[:content_disposition], type: cloud_response.headers[:content_type]
+      if @cloud_response.headers[:content_disposition]
+        return send_data @cloud_response, disposition: @cloud_response.headers[:content_disposition], type: @cloud_response.headers[:content_type]
       end
 
-      assign_header(response, cloud_response, :x_resource_count, true)
-      assign_header(response, cloud_response, :x_rh_insights_request_id, false)
+      assign_header(response, @cloud_response, :x_resource_count, true)
+      assign_header(response, @cloud_response, :x_rh_insights_request_id, false)
 
-      render json: cloud_response, status: cloud_response.code
+      render json: @cloud_response, status: @cloud_response.code
     end
 
     def branch_info
@@ -69,5 +71,16 @@ module InsightsCloud::Api
       @branch_id = cp_owner_id(@organization)
       return render_message "Branch ID not found for organization #{@organization.title}", :status => 400 unless @branch_id
     end
+
+    def update_host_insights_status
+      return unless request.path == '/redhat_access/r/insights/platform/ingress/v1/upload' ||
+                    request.path.include?('/redhat_access/r/insights/uploads/')
+
+      return unless @cloud_response.code.to_s.start_with?('2')
+
+      # create insights status if it wasn't there in the first place and refresh its reporting date
+      @host.get_status(InsightsClientReportStatus).refresh!
+      @host.refresh_global_status!
+    end
   end
 end

data/app/controllers/insights_cloud/hits_controller.rb

@@ -3,7 +3,7 @@ module InsightsCloud
     include Foreman::Controller::AutoCompleteSearch
 
     def index
-      hits = resource_base_search_and_page.where(host: Host.authorized).preload(:host, :rule)
+      hits = resource_base_search_and_page.preload(:host, :rule)
 
       render json: {
         hasToken: !Setting[:rh_cloud_token].empty?,
@@ -23,9 +23,9 @@ module InsightsCloud
 
     def resolutions
       if remediation_all_selected_param
-        hits = InsightsHit.with_playbook.search_for(params[:query])
+        hits = resource_base.with_playbook.search_for(params[:query])
       else
-        hits = resource_base_search_and_page.where(id: remediation_ids_param)
+        hits = resource_base_search_and_page.with_playbook.where(id: remediation_ids_param)
       end
 
       hits.preload(:host, rule: :resolutions)
@@ -74,5 +74,9 @@ module InsightsCloud
     def remediation_all_selected_param
       ActiveModel::Type::Boolean.new.cast(params[:isAllSelected])
     end
+
+    def resource_base
+      super.where(host: Host.authorized)
+    end
   end
 end

data/app/helpers/foreman_insights_deprecations_helper.rb

@@ -0,0 +1,9 @@
+module ForemanInsightsDeprecationsHelper
+  def old_plugin_deprecation_warning
+    alert(
+      class: 'alert-warning',
+      close: false,
+      text: _('redhat_access plugin is deprecated and will be removed in Satellite 6.10. You can find recommendations for your hosts on hosts index and details pages.')
+    )
+  end
+end

data/app/helpers/foreman_insights_host_helper.rb

@@ -0,0 +1,19 @@
+module ForemanInsightsHostHelper
+  def insights_host_overview_buttons(host)
+    search_condition = "hostname=#{host.fqdn}"
+    [
+      {
+        button: link_to_if_authorized(
+          _("Recommendations"),
+          hash_for_foreman_rh_cloud_insights_cloud_path(
+            search: search_condition,
+            select_all: true
+          ),
+          title: _("Host Insights recommendations"),
+          class: 'btn btn-default'
+        ),
+        priority: 1000,
+      },
+    ]
+  end
+end

data/app/models/insights_client_report_status.rb

@@ -0,0 +1,47 @@
+class InsightsClientReportStatus < HostStatus::Status
+  REPORT_INTERVAL = 48.hours
+
+  REPORTING             = 0
+  NO_REPORT             = 1
+
+  scope :stale, -> { where.not(reported_at: (Time.now - REPORT_INTERVAL)..Time.now) }
+  scope :reporting, -> { where(status: REPORTING) }
+
+  def self.status_name
+    N_('Insights')
+  end
+
+  def to_label(_options = {})
+    case status
+      when REPORTING
+        N_('Reporting')
+      when NO_REPORT
+        N_('Not reporting')
+    end
+  end
+
+  def to_global(_options = {})
+    case status
+      when REPORTING
+        ::HostStatus::Global::OK
+      when NO_REPORT
+        ::HostStatus::Global::ERROR
+    end
+  end
+
+  def to_status
+    in_interval? ? REPORTING : NO_REPORT
+  end
+
+  # prevent creation of the status on global refresh, but show it if the record already exists
+  def relevant?(_options = {})
+    persisted?
+  end
+
+  private
+
+  def in_interval?
+    return false unless reported_at
+    (Time.now.utc - reported_at).to_i < REPORT_INTERVAL.to_i
+  end
+end

data/app/overrides/old_plugin_deprecation.rb

@@ -0,0 +1,20 @@
+Deface::Override.new(
+  virtual_path: 'redhat_access/analytics_dashboard/welcome',
+  name: 'deprecation_warning',
+  insert_before: 'div#welcome',
+  text: '<%= old_plugin_deprecation_warning %>'
+)
+
+Deface::Override.new(
+  virtual_path: 'redhat_access/analytics_dashboard/index',
+  name: 'deprecation_warning_index_not_met',
+  insert_before: 'article#content',
+  text: '<%= old_plugin_deprecation_warning %>'
+)
+
+Deface::Override.new(
+  virtual_path: 'redhat_access/analytics_dashboard/index',
+  name: 'deprecation_warning_index_met',
+  insert_before: 'div.main-content',
+  text: '<%= old_plugin_deprecation_warning %>'
+)

data/app/services/foreman_rh_cloud/cloud_auth.rb

@@ -2,6 +2,8 @@ module ForemanRhCloud
   module CloudAuth
     extend ActiveSupport::Concern
 
+    include CloudRequest
+
     def rh_credentials
       @rh_credentials ||= query_refresh_token
     end
@@ -24,5 +26,15 @@ module ForemanRhCloud
       Foreman::Logging.exception('Unable to authenticate using rh_cloud_token setting', e)
       raise ::Foreman::WrappedException.new(e, N_('Unable to authenticate using rh_cloud_token setting'))
     end
+
+    def execute_cloud_request(params)
+      final_params = {
+        headers: {
+          Authorization: "Bearer #{rh_credentials}",
+        },
+      }.deep_merge(params)
+
+      super(final_params)
+    end
   end
 end

data/app/services/foreman_rh_cloud/cloud_request.rb

@@ -0,0 +1,14 @@
+module ForemanRhCloud
+  module CloudRequest
+    extend ActiveSupport::Concern
+
+    def execute_cloud_request(params)
+      final_params = {
+        verify_ssl: ForemanRhCloud.verify_ssl_method,
+        proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
+      }.deep_merge(params)
+
+      RestClient::Request.execute(final_params)
+    end
+  end
+end

data/app/services/foreman_rh_cloud/cloud_request_forwarder.rb

@@ -2,7 +2,7 @@ require 'rest-client'
 
 module ForemanRhCloud
   class CloudRequestForwarder
-    include ::ForemanRhCloud::CloudAuth
+    include ForemanRhCloud::CloudRequest
 
     def forward_request(original_request, controller_name, branch_id, certs)
       forward_params = prepare_forward_params(original_request, branch_id)
@@ -22,7 +22,6 @@ module ForemanRhCloud
     def prepare_request_opts(original_request, forward_payload, forward_params, certs)
       base_params = {
         method: original_request.method,
-        verify_ssl: ForemanRhCloud.verify_ssl_method,
         payload: forward_payload,
         headers: {
           params: forward_params,
@@ -33,10 +32,6 @@ module ForemanRhCloud
       base_params.merge(path_params(original_request.path, certs))
     end
 
-    def execute_cloud_request(request_opts)
-      RestClient::Request.execute request_opts
-    end
-
     def prepare_forward_payload(original_request, controller_name)
       forward_payload = original_request.request_parameters[controller_name]
 
@@ -61,10 +56,6 @@ module ForemanRhCloud
 
     def path_params(request_path, certs)
       case request_path
-      when metadata_request?
-        {
-          url: ForemanRhCloud.base_url + request_path.sub('/redhat_access/r/insights', '/api'),
-        }
       when platform_request?
         {
           url: ForemanRhCloud.cert_base_url + request_path.sub('/redhat_access/r/insights/platform', '/api'),
@@ -81,10 +72,6 @@ module ForemanRhCloud
       end
     end
 
-    def metadata_request?
-      ->(request_path) { request_path.include? '/static' }
-    end
-
     def platform_request?
       ->(request_path) { request_path.include? '/platform' }
     end