foreman_rh_cloud 4.0.24 → 4.0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73f3b045ed5bcbba051801155232d62a0884b30da8e461328a17e509fe0f0ec
-  data.tar.gz: 2cc1a0c73e193de7d26b368e9a78760ee302f78ecafeef6c27e18165293d0d2d
+  metadata.gz: 5de90e40ec6d14cf5483a2f92e46c61488c01a921a89feaa8194015f09c6fd0d
+  data.tar.gz: 3ac8ba217d2356211e25c1f1de144ad72578ba0be29116ce1d611817302fc097
 SHA512:
-  metadata.gz: 2eb0bb9cdb4d2aefa66acec328c98467a7db33de69e0256f966cca0f929756fb9100a5880d8d9a03f358cfafaf6e5aa32cf9896125c0eab8e3de9b9ebbb09269
-  data.tar.gz: 12e435965a84de5c538e98463fcdacbacd70eefd692822782cdb5ec4ed1e9f91e6d31f65466cffaa4b415c4491ff62e393a1e2f716f4542b03e5911fe6a34b97
+  metadata.gz: 051caa1c8e5d69a8dad5aa77570b79854854d5ae10f810afe2f57dc6d0f2be0a8de1090caab8ceb0a3faea06b2cb42bad3beda18097792b62e191caa6bb3b41d
+  data.tar.gz: 5f53fcc4bfdcc134afe56d19ac8a6c46822b2a6aeab832296eb0c7ffbe462d3a0510f2aaf2d0548f4b0f212f2b44e893fb12a04dace6c35fdc039071a7dd70b2

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

@@ -76,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/models/insights_client_report_status.rb

@@ -1,14 +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) }
-  scope :not_managed_with_data, -> { where(status: NOT_MANAGED_WITH_DATA) }
 
   def self.status_name
     N_('Insights')
@@ -20,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
 
@@ -33,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
@@ -55,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/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/db/migrate/20210720000001_remove_old_insights_statuses.foreman_rh_cloud.rb

@@ -0,0 +1,6 @@
+class RemoveOldInsightsStatuses < ActiveRecord::Migration[5.2]
+  def up
+    InsightsClientReportStatus.where(status: 2).update_all(status: InsightsClientReportStatus::NO_REPORT)
+    InsightsClientReportStatus.where(status: 3).update_all(status: InsightsClientReportStatus::REPORTING)
+  end
+end

data/lib/foreman_rh_cloud/engine.rb

@@ -93,8 +93,6 @@ module ForemanRhCloud
         register_custom_status InventorySync::InventoryStatus
         register_custom_status InsightsClientReportStatus
 
-        subscribe 'host_created.event.foreman', ForemanRhCloud::InsightsSubscriber
-
         describe_host do
           overview_buttons_provider :insights_host_overview_buttons
         end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '4.0.24'.freeze
+  VERSION = '4.0.24.1'.freeze
 end

data/lib/insights_cloud/async/insights_client_status_aging.rb

@@ -4,9 +4,15 @@ module InsightsCloud
       include ::Actions::RecurringAction
 
       def run
-        # update all stale records to "not reporting" counterpart
-        InsightsClientReportStatus.stale.reporting.update_all(status: InsightsClientReportStatus::NO_REPORT)
-        InsightsClientReportStatus.stale.not_managed_with_data.update_all(status: InsightsClientReportStatus::NOT_MANAGED)
+        host_ids = InsightsClientReportStatus.stale.reporting.pluck(:host_id)
+
+        # update all stale records
+        InsightsClientReportStatus.where(host_id: host_ids).update_all(status: InsightsClientReportStatus::NO_REPORT)
+
+        # refresh global status
+        Host.where(id: host_ids).preload(:host_statuses).find_in_batches do |hosts|
+          hosts.each { |host| host.refresh_global_status! }
+        end
       end
 
       def logger

data/lib/tasks/insights.rake

@@ -4,4 +4,19 @@ namespace :rh_cloud_insights do
     ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
     puts "Synchronized Insights hosts hits data"
   end
+
+  desc "Remove insights client report statuses by searching on host criteria"
+  task clean_statuses: [:environment] do
+    hosts_search = ENV['SEARCH']
+
+    if hosts_search.empty?
+      puts 'Must specify SEARCH= criteria for hosts search'
+      next
+    end
+
+    cleaner = ForemanRhCloud::InsightsStatusCleaner.new
+    deleted_count = cleaner.clean(hosts_search)
+
+    puts "Deleted #{deleted_count} insights statuses"
+  end
 end

data/package.json

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

data/test/jobs/insights_client_status_aging_test.rb

@@ -16,18 +16,18 @@ class InsightsClientStatusAgingTest < ActiveSupport::TestCase
   end
 
   test 'stale statuses should change' do
-    InsightsClientReportStatus.find_or_initialize_by(host_id: @host1.id).update(status: InsightsClientReportStatus::REPORTING, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
-    InsightsClientReportStatus.find_or_initialize_by(host_id: @host2.id).update(status: InsightsClientReportStatus::NO_REPORT, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
-    InsightsClientReportStatus.find_or_initialize_by(host_id: @host3.id).update(status: InsightsClientReportStatus::NOT_MANAGED, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
-    InsightsClientReportStatus.find_or_initialize_by(host_id: @host4.id).update(status: InsightsClientReportStatus::NOT_MANAGED_WITH_DATA, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host1.id).update(status: InsightsClientReportStatus::REPORTING, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL + 1.day)
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host2.id).update(status: InsightsClientReportStatus::NO_REPORT, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL + 1.day)
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host3.id).update(status: InsightsClientReportStatus::REPORTING, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host4.id).update(status: InsightsClientReportStatus::NO_REPORT, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL - 1.day)
 
     ForemanTasks.sync_task(InsightsCloud::Async::InsightsClientStatusAging)
 
     @hosts.each(&:reload)
 
-    assert_equal InsightsClientReportStatus::NO_REPORT, @host1.get_status(InsightsClientReportStatus).status
+    assert_equal InsightsClientReportStatus::REPORTING, @host1.get_status(InsightsClientReportStatus).status
     assert_equal InsightsClientReportStatus::NO_REPORT, @host2.get_status(InsightsClientReportStatus).status
-    assert_equal InsightsClientReportStatus::NOT_MANAGED, @host3.get_status(InsightsClientReportStatus).status
-    assert_equal InsightsClientReportStatus::NOT_MANAGED, @host4.get_status(InsightsClientReportStatus).status
+    assert_equal InsightsClientReportStatus::NO_REPORT, @host3.get_status(InsightsClientReportStatus).status
+    assert_equal InsightsClientReportStatus::NO_REPORT, @host4.get_status(InsightsClientReportStatus).status
   end
 end

data/test/models/insights_client_report_status_test.rb

@@ -1,77 +1,75 @@
 require 'test_plugin_helper'
 
 class InsightsClientReportStatusTest < ActiveSupport::TestCase
-  describe 'to_status' do
-    let(:host) { FactoryBot.create(:host, :managed) }
-
-    setup do
-      CommonParameter.where(name: 'host_registration_insights').destroy_all
-    end
-
-    test 'host_registration_insights = true & is getting data' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: true)
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-
-      assert_equal 0, host_status.to_status(data: true)
-    end
-
-    test 'host_registration_insights = true & no data in less than 48 hours' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: true)
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      host_status.update(reported_at: 1.day.ago)
-      assert_equal 0, host_status.to_status
-    end
-
-    test 'host_registration_insights = true & no data in more than 48 hours' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: true)
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      host_status.update(reported_at: 3.days.ago)
-      assert_equal 1, host_status.to_status
-    end
-
-    test 'host_registration_insights = false & no data' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: false)
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      assert_equal 2, host_status.to_status
-    end
-
-    test 'host_registration_insights = false & getting data' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: false)
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      assert_equal 3, host_status.to_status(data: true)
-    end
-
-    test 'host_registration_insights = nil & is getting data' do
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      assert_equal 3, host_status.to_status(data: true)
-    end
-
-    test 'host_registration_insights = nil & no data in less than 48 hours' do
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      host_status.update(reported_at: 1.day.ago)
-      assert_equal 2, host_status.to_status
-    end
-
-    test 'host_registration_insights = nil & no data in more than 48 hours' do
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      host_status.update(reported_at: 3.days.ago)
-      assert_equal 2, host_status.to_status
-    end
-
-    test 'override param on host level from `false` to `true`' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: false)
-      FactoryBot.create(:host_parameter, name: 'host_registration_insights', key_type: 'boolean', value: true, host: host)
-
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      assert_equal 0, host_status.to_status(data: true)
-    end
-
-    test 'override param on host level from `true` to `false`' do
-      FactoryBot.create(:common_parameter, name: 'host_registration_insights', key_type: 'boolean', value: true)
-      FactoryBot.create(:host_parameter, name: 'host_registration_insights', key_type: 'boolean', value: false, host: host)
-
-      host_status = Host.find_by_name(host.name).reload.get_status(InsightsClientReportStatus)
-      assert_equal 2, host_status.to_status
-    end
+  setup do
+    @host = FactoryBot.create(:host, :managed)
+  end
+
+  test 'fresh host does not have insights status' do
+    @host.reload
+
+    refute @host.host_statuses.where(type: 'InsightsClientReportStatus').exists?
+    insights_status = @host.get_status(InsightsClientReportStatus)
+    refute insights_status.relevant?
+  end
+
+  test 'host can refresh all its statuses' do
+    @host.refresh_statuses
+    @host.reload
+
+    refute @host.host_statuses.where(type: 'InsightsClientReportStatus').exists?
+  end
+
+  test 'host with correct report status sets global status to OK' do
+    global_status = @host.get_status(HostStatus.find_status_by_humanized_name('Global'))
+    # Status has to be OK before action
+    assert_equal HostStatus::Global::OK, global_status.status
+
+    # force create record
+    @host.get_status(InsightsClientReportStatus).refresh!
+    # now refresh should work
+    @host.refresh_statuses([InsightsClientReportStatus])
+
+    @host.reload
+    global_status = @host.get_status(HostStatus.find_status_by_humanized_name('Global'))
+    # Status has to be OK after the action too
+    assert_equal HostStatus::Global::OK, global_status.status
+
+    insights_status = @host.get_status(InsightsClientReportStatus)
+    # assert the status would be displayed
+    assert insights_status.relevant?
+  end
+
+  test 'host will return to OK once the status is refreshed' do
+    global_status = @host.get_status(HostStatus.find_status_by_humanized_name('Global'))
+    # Status has to be OK before action
+    assert_equal HostStatus::Global::OK, global_status.status
+
+    insights_status = @host.get_status(InsightsClientReportStatus)
+    insights_status.status = InsightsClientReportStatus::NO_REPORT
+    insights_status.save!
+    @host.refresh_global_status!
+    global_status = @host.global_status
+    assert_equal HostStatus::Global::ERROR, global_status
+
+    @host.refresh_statuses([InsightsClientReportStatus])
+
+    @host.reload
+    # Status has to be OK after the action too
+    assert_equal HostStatus::Global::OK, @host.global_status
+  end
+
+  test 'host with stale status would set global to ERROR' do
+    global_status = @host.get_status(HostStatus.find_status_by_humanized_name('Global'))
+    # Status has to be OK before action
+    assert_equal HostStatus::Global::OK, global_status.status
+
+    insights_status = @host.get_status(InsightsClientReportStatus)
+    insights_status.status = InsightsClientReportStatus::NO_REPORT
+    insights_status.save!
+    @host.refresh_global_status!
+    @host.reload
+
+    assert_equal HostStatus::Global::ERROR, @host.global_status
   end
 end

data/test/unit/services/foreman_rh_cloud/insights_status_cleaner_test.rb

@@ -0,0 +1,31 @@
+require 'test_plugin_helper'
+
+class InsightsStatusCleanerTest < ActiveSupport::TestCase
+  setup do
+    @host1 = FactoryBot.create(:host)
+    @host2 = FactoryBot.create(:host)
+
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host1.id).update(status: InsightsClientReportStatus::NO_REPORT, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL + 1.day)
+    InsightsClientReportStatus.find_or_initialize_by(host_id: @host2.id).update(status: InsightsClientReportStatus::NO_REPORT, reported_at: Time.now - InsightsClientReportStatus::REPORT_INTERVAL + 1.day)
+
+    @host1.refresh_global_status!
+    @host2.refresh_global_status!
+  end
+
+  test 'Cleans hosts by search condition' do
+    assert_equal HostStatus::Global::ERROR, @host1.global_status
+    assert_equal HostStatus::Global::ERROR, @host2.global_status
+
+    instance = ForemanRhCloud::InsightsStatusCleaner.new
+    actual_count = instance.clean("name = #{@host1.name}")
+
+    @host1.reload
+    @host2.refresh_global_status!
+
+    assert_equal 1, actual_count
+    assert_equal HostStatus::Global::OK, @host1.global_status
+    assert_equal HostStatus::Global::ERROR, @host2.global_status
+    assert InsightsClientReportStatus.where(host_id: @host1.id).empty?
+    refute InsightsClientReportStatus.where(host_id: @host2.id).empty?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 4.0.24
+  version: 4.0.24.1
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katello
@@ -178,9 +178,9 @@ files:
 - app/services/foreman_rh_cloud/cloud_connector.rb
 - app/services/foreman_rh_cloud/cloud_request.rb
 - app/services/foreman_rh_cloud/cloud_request_forwarder.rb
+- app/services/foreman_rh_cloud/insights_status_cleaner.rb
 - app/services/foreman_rh_cloud/remediations_retriever.rb
 - app/services/foreman_rh_cloud/template_renderer_helper.rb
-- app/subscribers/foreman_rh_cloud/insights_subscriber.rb
 - app/views/hosts/_insights_tab.html.erb
 - app/views/job_templates/rh_cloud_remediations.erb
 - app/views/layouts/foreman_rh_cloud/application.html.erb
@@ -198,6 +198,7 @@ files:
 - db/migrate/20210214000002_add_rule_id_to_hits.foreman_rh_cloud.rb
 - db/migrate/20210307000001_add_unique_to_insights_facet.foreman_rh_cloud.rb
 - db/migrate/20210404000001_change_resolutions.foreman_rh_cloud.rb
+- db/migrate/20210720000001_remove_old_insights_statuses.foreman_rh_cloud.rb
 - db/seeds.d/179_ui_notifications.rb
 - db/seeds.d/50_job_templates.rb
 - lib/foreman_inventory_upload.rb
@@ -269,6 +270,7 @@ files:
 - test/unit/rh_cloud_http_proxy_test.rb
 - test/unit/services/foreman_rh_cloud/branch_info_test.rb
 - test/unit/services/foreman_rh_cloud/cloud_request_forwarder_test.rb
+- test/unit/services/foreman_rh_cloud/insights_status_cleaner_test.rb
 - test/unit/services/foreman_rh_cloud/remediations_retriever_test.rb
 - test/unit/services/foreman_rh_cloud/template_renderer_helper_test.rb
 - test/unit/shell_process_job_test.rb
@@ -699,6 +701,7 @@ test_files:
 - test/unit/rh_cloud_http_proxy_test.rb
 - test/unit/services/foreman_rh_cloud/branch_info_test.rb
 - test/unit/services/foreman_rh_cloud/cloud_request_forwarder_test.rb
+- test/unit/services/foreman_rh_cloud/insights_status_cleaner_test.rb
 - test/unit/services/foreman_rh_cloud/remediations_retriever_test.rb
 - test/unit/services/foreman_rh_cloud/template_renderer_helper_test.rb
 - test/unit/shell_process_job_test.rb

data/app/subscribers/foreman_rh_cloud/insights_subscriber.rb

@@ -1,9 +0,0 @@
-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