foreman_rh_cloud 4.0.21.1 → 4.0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97882071192995f2da93032050b9ecdfa616dba407c8d032bfd29f6741ea9d56
-  data.tar.gz: 88bca49cea9ee2abac2d2dc9d608a33329ad9e214d57035424e8e24984691537
+  metadata.gz: 5de90e40ec6d14cf5483a2f92e46c61488c01a921a89feaa8194015f09c6fd0d
+  data.tar.gz: 3ac8ba217d2356211e25c1f1de144ad72578ba0be29116ce1d611817302fc097
 SHA512:
-  metadata.gz: 67dd2ada55ac862b2d57ddf893e7408d002c40c2f89a141e6bf8c115d6eeee32d19b156e7668751f591665f948fa04d628719e5f6f5ab9e4609c02f0a14a93f4
-  data.tar.gz: 54ded7bb163e4a38cd3fa4a62dfe101484b98e87c016514b985190f77a07c7556e980dd8574dc5fb70cacb3fcc521a37a1f4f2325e5360cdbb2ddd6f38816804
+  metadata.gz: 051caa1c8e5d69a8dad5aa77570b79854854d5ae10f810afe2f57dc6d0f2be0a8de1090caab8ceb0a3faea06b2cb42bad3beda18097792b62e191caa6bb3b41d
+  data.tar.gz: 5f53fcc4bfdcc134afe56d19ac8a6c46822b2a6aeab832296eb0c7ffbe462d3a0510f2aaf2d0548f4b0f212f2b44e893fb12a04dace6c35fdc039071a7dd70b2

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,6 +5,7 @@ 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]
 
@@ -75,9 +76,11 @@ module InsightsCloud::Api
       return unless request.path == '/redhat_access/r/insights/platform/ingress/v1/upload' ||
                     request.path.include?('/redhat_access/r/insights/uploads/')
 
-      data = @cloud_response.code.to_s.start_with?('2')
-      host_status = @host.get_status(InsightsClientReportStatus)
-      host_status.update(reported_at: Time.now.utc, status: host_status.to_status(data: data))
+      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_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

@@ -1,10 +1,11 @@
 class InsightsClientReportStatus < HostStatus::Status
   REPORT_INTERVAL = 48.hours
 
-  REPORTING             = 0 # host_registration_insights = true & getting data
-  NO_REPORT             = 1 # host_registration_insights = true & not getting data
-  NOT_MANAGED           = 2 # host_registration_insights = false
-  NOT_MANAGED_WITH_DATA = 3 # host_registration_insights = false & getting data
+  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')
@@ -16,10 +17,6 @@ class InsightsClientReportStatus < HostStatus::Status
         N_('Reporting')
       when NO_REPORT
         N_('Not reporting')
-      when NOT_MANAGED
-        N_('Not reporting (not set by registration)')
-      when NOT_MANAGED_WITH_DATA
-        N_('Reporting (not set by registration)')
     end
   end
 
@@ -29,20 +26,16 @@ class InsightsClientReportStatus < HostStatus::Status
         ::HostStatus::Global::OK
       when NO_REPORT
         ::HostStatus::Global::ERROR
-      when NOT_MANAGED
-        ::HostStatus::Global::OK
-      when NOT_MANAGED_WITH_DATA
-        ::HostStatus::Global::WARN
     end
   end
 
-  def to_status(data: false)
-    if insights_param
-      return REPORTING if data
-      return in_interval? ? REPORTING : NO_REPORT
-    end
+  def to_status
+    in_interval? ? REPORTING : NO_REPORT
+  end
 
-    data ? NOT_MANAGED_WITH_DATA : NOT_MANAGED
+  # prevent creation of the status on global refresh, but show it if the record already exists
+  def relevant?(_options = {})
+    persisted?
   end
 
   private
@@ -51,8 +44,4 @@ class InsightsClientReportStatus < HostStatus::Status
     return false unless reported_at
     (Time.now.utc - reported_at).to_i < REPORT_INTERVAL.to_i
   end
-
-  def insights_param
-    host.host_params_hash.dig('host_registration_insights', :value)
-  end
 end

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

data/app/services/foreman_rh_cloud/insights_status_cleaner.rb

@@ -0,0 +1,17 @@
+module ForemanRhCloud
+  class InsightsStatusCleaner
+    def clean(host_search)
+      host_ids = Host.search_for(host_search).pluck(:id)
+
+      # delete all insights status records for the hosts
+      deleted_count = InsightsClientReportStatus.where(host_id: host_ids).delete_all
+
+      # refresh global status
+      Host.where(id: host_ids).preload(:host_statuses).find_in_batches do |hosts|
+        hosts.each { |host| host.refresh_global_status! }
+      end
+
+      deleted_count
+    end
+  end
+end

data/app/services/foreman_rh_cloud/remediations_retriever.rb

@@ -62,14 +62,11 @@ module ForemanRhCloud
     end
 
     def query_playbook
-      RestClient::Request.execute(
+      execute_cloud_request(
         method: :post,
         url: InsightsCloud.playbook_url,
-        verify_ssl: ForemanRhCloud.verify_ssl_method,
-        proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
         headers: {
           content_type: :json,
-          Authorization: "Bearer #{rh_credentials}",
         },
         payload: playbook_request.to_json
       )