foreman_rh_cloud 6.0.43 → 6.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9180080890adb316306a32a93c88fd86153d3ddf3acc9d5182831a325b35ca4
-  data.tar.gz: 6a6d744fda10894d04f630e48b1c27a9bc87d4d6ac6af6324e3c2644b69e6948
+  metadata.gz: 44056fad5c50d5b78e64b5e13a622818525fd5e8176159462825ae8306cd035f
+  data.tar.gz: 6fa455af9f99ea4864c0d813962ecb7fcc9706517daf9459953c378ec547814d
 SHA512:
-  metadata.gz: 39ced1494bc063a49bc6db9917dc067abf9491e5c2f0b1eb5083134dc8cb74ef83cbe4fddabe26cfc2e44204594e3eb48ef23bb5d6c6b987838c3adaacfbc18e
-  data.tar.gz: a84b6d061179e2d9c5a4ab3ba8031c0d3f949bdfd09fe8701435eb3328f87cd1c252602659fe963bfaf22e20feccd9b7242e9dae381a8ccf3ef4b9833c2f42b9
+  metadata.gz: 9fb003eeadd973880052b4d5d04a682d46938e4805a5bd0aad57ae9c22a0ea5cd05488f8e827838db2c5093d04dd5c91d2cc44332f2472a0e5e76bcf2c78126d
+  data.tar.gz: efef456d8ecad910cb36ae64fb82202225733d484a227d6a142e71b145046a5533b626e2349d99d9f257282c03dc026a04de62ff8d436158226dd0f5a7fdcdb8

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

@@ -33,10 +33,6 @@ module InsightsCloud::Api
         }, status: @cloud_response.code
       end
 
-      if @cloud_response.headers[:content_disposition]
-        return send_data @cloud_response, disposition: @cloud_response.headers[:content_disposition], type: @cloud_response.headers[:content_type]
-      end
-
       # Append redhat-specific headers
       @cloud_response.headers.each do |key, value|
         assign_header(response, @cloud_response, key, false) if key.to_s.start_with?('x_rh_')
@@ -45,7 +41,17 @@ module InsightsCloud::Api
       assign_header(response, @cloud_response, :x_resource_count, true)
       headers[Rack::ETAG] = @cloud_response.headers[:etag]
 
-      render json: @cloud_response, status: @cloud_response.code
+      if @cloud_response.headers[:content_disposition]
+        # If there is a Content-Disposition header, it means we are forwarding binary data, send the raw data with proper
+        # content type
+        send_data @cloud_response, disposition: @cloud_response.headers[:content_disposition], type: @cloud_response.headers[:content_type]
+      elsif @cloud_response.headers[:content_type] =~ /zip/
+        # if there is no Content-Disposition, but the content type is binary according the content type,
+        # forward the request as binry too
+        send_data @cloud_response, type: @cloud_response.headers[:content_type]
+      else
+        render json: @cloud_response, status: @cloud_response.code
+      end
     end
 
     def branch_info

data/db/migrate/20221102110254_fix_rh_cloud_settings_category_to_dsl.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FixRhCloudSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  def up
+    Setting.where(category: 'Setting::RhCloud').update_all(category: 'Setting')
+  end
+end

data/lib/foreman_inventory_upload/async/delayed_start.rb

@@ -0,0 +1,51 @@
+module ForemanInventoryUpload
+  module Async
+    module DelayedStart
+      extend ActiveSupport::Concern
+
+      START_WINDOW = 3.hours.seconds
+
+      def after_delay(delay = nil, logger: nil, &block)
+        logger ||= self.logger if respond_to? :logger
+        delay ||= ForemanRhCloud.requests_delay || Random.new.rand(START_WINDOW)
+        delay = delay.to_i
+
+        logger&.debug("planning a delay for #{delay} seconds before the rest of the execution")
+
+        sequence do
+          plan_action(ForemanInventoryUpload::Async::DelayAction, delay)
+          concurrence(&block)
+        end
+      end
+
+      def humanized_name
+        _('Wait and %s' % super)
+      end
+    end
+
+    class DelayAction < ::Actions::EntryAction
+      Wake = Algebrick.atom
+
+      def plan(delay)
+        plan_self(delay: delay)
+      end
+
+      def run(event = nil)
+        case event
+        when nil
+          action_logger.debug("Going to sleep for #{sleep_seconds} seconds")
+          plan_event(Wake, sleep_seconds)
+          suspend
+        when Wake
+          action_logger.debug('Waking up')
+        else
+          action_logger.debug("DelayAction received unknown event #{event}")
+        end
+      end
+
+      def sleep_seconds
+        input[:delay].to_i
+      end
+    end
+  end
+end

data/lib/foreman_inventory_upload/async/generate_all_reports_job.rb

@@ -2,6 +2,7 @@ module ForemanInventoryUpload
   module Async
     class GenerateAllReportsJob < ::Actions::EntryAction
       include ::Actions::RecurringAction
+      include ForemanInventoryUpload::Async::DelayedStart
 
       def plan
         unless Setting[:allow_auto_inventory_upload]
@@ -12,17 +13,19 @@ module ForemanInventoryUpload
           return
         end
 
-        organizations = Organization.unscoped.all
+        after_delay do
+          organizations = Organization.unscoped.all
 
-        organizations.map do |organization|
-          total_hosts = ForemanInventoryUpload::Generators::Queries.for_org(organization.id, use_batches: false).count
+          organizations.map do |organization|
+            total_hosts = ForemanInventoryUpload::Generators::Queries.for_org(organization.id, use_batches: false).count
 
-          if total_hosts <= ForemanInventoryUpload.max_org_size
-            plan_generate_report(ForemanInventoryUpload.generated_reports_folder, organization)
-          else
-            logger.info("Skipping automatic uploads for organization #{organization.name}, too many hosts (#{total_hosts}/#{ForemanInventoryUpload.max_org_size})")
-          end
-        end.compact
+            if total_hosts <= ForemanInventoryUpload.max_org_size
+              plan_generate_report(ForemanInventoryUpload.generated_reports_folder, organization)
+            else
+              logger.info("Skipping automatic uploads for organization #{organization.name}, too many hosts (#{total_hosts}/#{ForemanInventoryUpload.max_org_size})")
+            end
+          end.compact
+        end
       end
 
       def rescue_strategy_for_self

data/lib/foreman_inventory_upload/async/shell_process.rb

@@ -4,13 +4,14 @@ module ForemanInventoryUpload
   module Async
     class ShellProcess < ::Actions::EntryAction
       include AsyncHelpers
+      include ::ForemanRhCloud::Async::ExponentialBackoff
 
       def plan(instance_label, more_inputs = {})
         inputs = more_inputs.merge(instance_label: instance_label)
         plan_self(inputs)
       end
 
-      def run
+      def try_execute
         klass_name = self.class.name
         logger.debug("Starting #{klass_name} with label #{instance_label}")
         progress_output do |progress_output|
@@ -25,6 +26,9 @@ module ForemanInventoryUpload
           end
         end
         logger.debug("Finished job #{klass_name} with label #{instance_label}")
+
+        assert_task_status(ProgressOutput.get(instance_label).status)
+        done!
       end
 
       def command
@@ -58,6 +62,10 @@ module ForemanInventoryUpload
       def instance_label
         input[:instance_label]
       end
+
+      def assert_task_status(status)
+        raise Foreman::Exception.new('Process exited with an unknown status: %{status}', status: status) unless status.match?(/pid \d+ exit 0/)
+      end
     end
   end
 end

data/lib/foreman_inventory_upload/async/upload_report_job.rb

@@ -12,11 +12,12 @@ module ForemanInventoryUpload
         super(label, filename: filename, organization_id: organization_id)
       end
 
-      def run
+      def try_execute
         if content_disconnected?
           progress_output do |progress_output|
             progress_output.write_line('Upload was stopped since disconnected mode setting is enabled for content on this instance.')
             progress_output.status = "Task aborted, exit 1"
+            done!
           end
           return
         end
@@ -26,6 +27,7 @@ module ForemanInventoryUpload
           progress_output do |progress_output|
             progress_output.write_line("Skipping organization #{organization}, no candlepin certificate defined.")
             progress_output.status = "Task aborted, exit 1"
+            done!
           end
           return
         end

data/lib/foreman_rh_cloud/async/exponential_backoff.rb

@@ -0,0 +1,55 @@
+module ForemanRhCloud
+  module Async
+    module ExponentialBackoff
+      extend ActiveSupport::Concern
+      include Dynflow::Action::Polling
+
+      # Use each interval once
+      def attempts_before_next_interval
+        1
+      end
+
+      # define poll intervals in the following way: [1/10..1, 1..10, 10..100] e.t.c.
+      # total count of intervals would be the amount of poll retries.
+      def poll_intervals
+        (1..poll_max_retries).map do |i|
+          base = 10**i
+          random_interval(base)
+        end
+      end
+
+      def done!
+        @done = true
+      end
+
+      def done?
+        @done
+      end
+
+      def invoke_external_task
+        # Call the polling method from task's framework
+        poll_external_task_with_rescue
+        # supress unexpected task output serialization
+        {}
+      end
+
+      def poll_external_task
+        try_execute
+        # supress unexpected task output serialization
+        {}
+      end
+
+      # override this method in the consumng class
+      # This is the action that we expect to retry in case of an exception.
+      def try_execute
+        raise NotImplementedError
+      end
+
+      private
+
+      def random_interval(base)
+        Random.new.rand(base..10 * base)
+      end
+    end
+  end
+end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '6.0.43'.freeze
+  VERSION = '6.0.44'.freeze
 end

data/lib/foreman_rh_cloud.rb

@@ -120,4 +120,8 @@ module ForemanRhCloud
   def self.cloud_url_validator
     @cloud_url_validator ||= Regexp.new(ENV['SATELLITE_RH_CLOUD_VALIDATOR'] || 'redhat.com$')
   end
+
+  def self.requests_delay
+    @requests_delay ||= ENV['SATELLITE_RH_CLOUD_REQUESTS_DELAY']
+  end
 end

data/lib/insights_cloud/async/insights_full_sync.rb

@@ -5,6 +5,7 @@ module InsightsCloud
   module Async
     class InsightsFullSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CertAuth
+      include ::ForemanRhCloud::Async::ExponentialBackoff
 
       def plan(organizations)
         organizations = organizations.select do |organization|
@@ -28,7 +29,7 @@ module InsightsCloud
         end
       end
 
-      def run
+      def try_execute
         organizations.each do |organization|
           unless cert_auth_available?(organization)
             logger.debug("Certificate is not available for org: #{organization.name}, skipping insights sync")
@@ -37,6 +38,7 @@ module InsightsCloud
 
           perform_hits_sync(organization)
         end
+        done!
       end
 
       def perform_hits_sync(organization)

data/lib/insights_cloud/async/insights_resolutions_sync.rb

@@ -4,10 +4,11 @@ module InsightsCloud
   module Async
     class InsightsResolutionsSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CertAuth
+      include ::ForemanRhCloud::Async::ExponentialBackoff
 
       RULE_ID_REGEX = /[^:]*:(?<id>.*)/
 
-      def run
+      def try_execute
         InsightsResolution.transaction do
           InsightsResolution.delete_all
           rule_ids = relevant_rules
@@ -18,6 +19,7 @@ module InsightsCloud
             rule_ids -= Array(written_rules)
           end
         end
+        done!
       end
 
       def logger

data/lib/insights_cloud/async/insights_rules_sync.rb

@@ -4,6 +4,7 @@ module InsightsCloud
   module Async
     class InsightsRulesSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CertAuth
+      include ::ForemanRhCloud::Async::ExponentialBackoff
 
       def plan(organizations)
         # since the tasks are not connected, we need to force sequence execution here
@@ -18,7 +19,7 @@ module InsightsCloud
         plan_action InsightsResolutionsSync
       end
 
-      def run
+      def try_execute
         offset = 0
         InsightsRule.transaction do
           organizations.each do |organization|
@@ -36,6 +37,7 @@ module InsightsCloud
           # Remove all rules that do not have hits associated with them
           cleanup_rules
         end
+        done!
       end
 
       def logger

data/lib/insights_cloud/async/insights_scheduled_sync.rb

@@ -2,6 +2,7 @@ module InsightsCloud
   module Async
     class InsightsScheduledSync < ::Actions::EntryAction
       include ::Actions::RecurringAction
+      include ForemanInventoryUpload::Async::DelayedStart
 
       def plan
         unless Setting[:allow_auto_insights_sync]
@@ -12,7 +13,9 @@ module InsightsCloud
           return
         end
 
-        plan_full_sync
+        after_delay do
+          plan_full_sync
+        end
       end
 
       def plan_full_sync

data/lib/inventory_sync/async/host_result.rb

@@ -11,7 +11,7 @@ module InventorySync
         @per_page = result['per_page']
         @sub_ids = result["results"].map { |host| host['subscription_manager_id'] }
         @uuid_by_sub_id = Hash[result["results"].map { |host| [host['subscription_manager_id'], host['id']] }]
-        @uuid_by_fqdn = Hash[result["results"].map { |host| [host['fqdn'].downcase, host['id']] }]
+        @uuid_by_fqdn = Hash[result["results"].map { |host| [host['fqdn']&.downcase, host['id']] }]
       end
 
       def status_hashes

data/lib/inventory_sync/async/inventory_scheduled_sync.rb

@@ -2,6 +2,7 @@ module InventorySync
   module Async
     class InventoryScheduledSync < ::Actions::EntryAction
       include ::Actions::RecurringAction
+      include ForemanInventoryUpload::Async::DelayedStart
 
       def plan
         unless Setting[:allow_auto_inventory_upload]
@@ -12,8 +13,10 @@ module InventorySync
           return
         end
 
-        Organization.unscoped.each do |org|
-          plan_org_sync(org)
+        after_delay do
+          Organization.unscoped.each do |org|
+            plan_org_sync(org)
+          end
         end
       end
 

data/lib/inventory_sync/async/query_inventory_job.rb

@@ -5,6 +5,7 @@ module InventorySync
     class QueryInventoryJob < ::Actions::EntryAction
       include ActiveSupport::Callbacks
       include ::ForemanRhCloud::CertAuth
+      include ::ForemanRhCloud::Async::ExponentialBackoff
 
       define_callbacks :iteration, :step
 
@@ -18,7 +19,7 @@ module InventorySync
         plan_self(actual_params)
       end
 
-      def run
+      def try_execute
         run_callbacks :iteration do
           organizations.each do |organization|
             if !cert_auth_available?(organization) || organization.manifest_expired?
@@ -43,6 +44,8 @@ module InventorySync
             end
           end
         end
+        # declare the action as finished to stop iterations
+        done!
       end
 
       private

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foreman_rh_cloud",
-  "version": "6.0.43",
+  "version": "6.0.44",
   "description": "Inventory Upload =============",
   "main": "index.js",
   "scripts": {

data/test/controllers/insights_cloud/api/machine_telemetries_controller_test.rb

@@ -72,6 +72,17 @@ module InsightsCloud::Api
         assert_equal etag, @response.headers[Rack::ETAG]
       end
 
+      test "should set content type header to response from cloud" do
+        req = RestClient::Request.new(:method => 'GET', :url => 'http://test.theforeman.org')
+        net_http_resp = Net::HTTPResponse.new(1.0, 200, "OK")
+        net_http_resp[:content_type] = 'application/zip'
+        res = RestClient::Response.create(@body, net_http_resp, req)
+        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:forward_request).returns(res)
+
+        get :forward_request, params: { "path" => "static/v1/release/insights-core.egg" }
+        assert_equal net_http_resp[:content_type], @response.headers['Content-Type']
+      end
+
       test "should handle failed authentication to cloud" do
         net_http_resp = Net::HTTPResponse.new(1.0, 401, "Unauthorized")
         res = RestClient::Response.create(@body, net_http_resp, @http_req)

data/test/jobs/exponential_backoff_test.rb

@@ -0,0 +1,45 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class ExponentialBackoffTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
+  class TestAction < ::Actions::EntryAction
+    include ::ForemanRhCloud::Async::ExponentialBackoff
+
+    def try_execute
+      action_callback&.call(self)
+    end
+
+    # define a method to execute code inside the class context.
+    def action_callback(instance)
+    end
+  end
+
+  test 'executes an action once' do
+    TestAction.any_instance.expects(:action_callback).returns(->(instance) { instance.done! })
+
+    ForemanTasks.sync_task(TestAction)
+  end
+
+  test 'fails after a single excution if done was called' do
+    TestAction.any_instance.expects(:action_callback).returns(
+      lambda do |instance|
+        instance.done!
+        raise ::Foreman::Exception('Foo')
+      end)
+
+    ForemanTasks.sync_task(TestAction)
+  end
+
+  test 'executes the task three times before failing it' do
+    # speed up the execution
+    TestAction.any_instance.stubs(:poll_intervals).returns([0, 0, 0])
+
+    TestAction.any_instance.expects(:action_callback).raises(::Foreman::Exception.new('Foo')).times(3)
+
+    ForemanTasks.sync_task(TestAction)
+  rescue ForemanTasks::TaskError => ex
+    assert ex.aggregated_message =~ /Foo/
+  end
+end

data/webpack/InsightsCloudSync/Components/InsightsTable/InsightsTable.js

@@ -31,6 +31,7 @@ const InsightsTable = ({
   error,
   isAllSelected,
   hideHost,
+  hostname,
 }) => {
   const { perPage: appPerPage } = useForemanSettings();
   const perPage = urlPerPage || appPerPage;
@@ -40,7 +41,7 @@ const InsightsTable = ({
   // acts as componentDidMount
   useEffect(() => {
     fetchInsights({ page, perPage, query, sortBy, sortOrder });
-  }, []);
+  }, [hostname]);
 
   useEffect(() => {
     setRows(
@@ -104,6 +105,7 @@ InsightsTable.propTypes = {
   error: PropTypes.string,
   isAllSelected: PropTypes.bool,
   hideHost: PropTypes.bool,
+  hostname: PropTypes.string,
 };
 
 InsightsTable.defaultProps = {
@@ -118,6 +120,7 @@ InsightsTable.defaultProps = {
   error: '',
   isAllSelected: false,
   hideHost: false,
+  hostname: '',
 };
 
 export default InsightsTable;

data/webpack/InsightsHostDetailsTab/InsightsTotalRiskChart.js

@@ -121,6 +121,7 @@ const InsightsTotalRiskCard = ({ hostDetails: { id } }) => {
       dropdownItems={[
         <DropdownItem
           key="insights-tab"
+          ouiaId="insights-tab-dropdown-item"
           onClick={() => hashHistory.push(`/Insights`)}
         >
           {__('View all recommendations')}
@@ -131,7 +132,9 @@ const InsightsTotalRiskCard = ({ hostDetails: { id } }) => {
         status={status}
         emptyState={
           <Bullseye>
-            <Title headingLevel="h4"> {__('No results found')} </Title>
+            <Title ouiaId="no-results-title" headingLevel="h4">
+              {__('No results found')}
+            </Title>
           </Bullseye>
         }
       >

data/webpack/InsightsHostDetailsTab/NewHostDetailsTab.js

@@ -36,7 +36,7 @@ const NewHostDetailsTab = ({ hostName, router }) => {
     router.push({ pathname: '/foreman_rh_cloud/insights_cloud' });
 
   const dropdownItems = [
-    <DropdownItem key="insights-link">
+    <DropdownItem key="insights-link" ouiaId="insights-link">
       <a onClick={onSatInsightsClick}>{__('Go to Satellite Insights page')}</a>
     </DropdownItem>,
   ];
@@ -44,7 +44,7 @@ const NewHostDetailsTab = ({ hostName, router }) => {
   if (hits.length) {
     const { host_uuid: uuid } = hits[0];
     dropdownItems.push(
-      <DropdownItem key="insights-advisor-link">
+      <DropdownItem key="insights-advisor-link" ouiaId="insights-advisor-link">
         <a
           href={redHatAdvisorSystems(uuid)}
           target="_blank"
@@ -71,6 +71,7 @@ const NewHostDetailsTab = ({ hostName, router }) => {
         <RemediationModal />
         <Dropdown
           className="insights-dropdown"
+          ouiaId="insights-dropdown"
           onSelect={() => setIsDropdownOpen(false)}
           toggle={
             <KebabToggle onToggle={isOpen => setIsDropdownOpen(isOpen)} />
@@ -81,7 +82,7 @@ const NewHostDetailsTab = ({ hostName, router }) => {
         />
       </GridItem>
       <GridItem span={3}>
-        <Pagination variant="top" isCompact />
+        <Pagination ouiaId="insights-pagination" variant="top" isCompact />
       </GridItem>
       <GridItem>
         <InsightsTable hideHost hostname={hostName} />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 6.0.43
+  version: 6.0.44
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katello
@@ -197,10 +197,12 @@ files:
 - db/migrate/20210720000001_remove_old_insights_statuses.foreman_rh_cloud.rb
 - db/migrate/20211027000001_create_task_output.foreman_rh_cloud.rb
 - db/migrate/20220321000001_add_unique_to_insights_rules.foreman_rh_cloud.rb
+- db/migrate/20221102110254_fix_rh_cloud_settings_category_to_dsl.rb
 - db/seeds.d/179_ui_notifications.rb
 - db/seeds.d/50_job_templates.rb
 - lib/foreman_inventory_upload.rb
 - lib/foreman_inventory_upload/async/async_helpers.rb
+- lib/foreman_inventory_upload/async/delayed_start.rb
 - lib/foreman_inventory_upload/async/generate_all_reports_job.rb
 - lib/foreman_inventory_upload/async/generate_report_job.rb
 - lib/foreman_inventory_upload/async/progress_output.rb
@@ -217,6 +219,7 @@ files:
 - lib/foreman_inventory_upload/notifications/manifest_import_success_notification_override.rb
 - lib/foreman_inventory_upload/scripts/uploader.sh.erb
 - lib/foreman_rh_cloud.rb
+- lib/foreman_rh_cloud/async/exponential_backoff.rb
 - lib/foreman_rh_cloud/engine.rb
 - lib/foreman_rh_cloud/settings.rb
 - lib/foreman_rh_cloud/version.rb
@@ -258,6 +261,7 @@ files:
 - test/factories/inventory_upload_factories.rb
 - test/jobs/cloud_connector_announce_task_test.rb
 - test/jobs/connector_playbook_execution_reporter_task_test.rb
+- test/jobs/exponential_backoff_test.rb
 - test/jobs/insights_client_status_aging_test.rb
 - test/jobs/insights_full_sync_test.rb
 - test/jobs/insights_resolutions_sync_test.rb
@@ -693,6 +697,7 @@ test_files:
 - test/factories/inventory_upload_factories.rb
 - test/jobs/cloud_connector_announce_task_test.rb
 - test/jobs/connector_playbook_execution_reporter_task_test.rb
+- test/jobs/exponential_backoff_test.rb
 - test/jobs/insights_client_status_aging_test.rb
 - test/jobs/insights_full_sync_test.rb
 - test/jobs/insights_resolutions_sync_test.rb