foreman_rh_cloud 3.0.21.1 → 4.0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87599d8ef67eeeaa3e17e720dc990b58d4085caf7fb6491dab093c54770c8fd
-  data.tar.gz: 04b52a7412dddf8e6829d61555ec9315c7f3856fde32e976eb8c50638082a3bc
+  metadata.gz: 97882071192995f2da93032050b9ecdfa616dba407c8d032bfd29f6741ea9d56
+  data.tar.gz: 88bca49cea9ee2abac2d2dc9d608a33329ad9e214d57035424e8e24984691537
 SHA512:
-  metadata.gz: 4ca381e6bcbf74d21a23ae825ebb6556be1afbe98c193fb33e58ef7fee6027142a809ed79b8cbcb3c8dce95200b0bd4528d497597a1f0411f703172ce1f9c123
-  data.tar.gz: 945faf0852d9ebce259e4da1bcebd079ef5a4fad87f503fc9ee694f4eae7e3ab36a7dc2390d54879a7da57d176aa22d8030a168d2715fe1f54a521b2258fbb37
+  metadata.gz: 67dd2ada55ac862b2d57ddf893e7408d002c40c2f89a141e6bf8c115d6eeee32d19b156e7668751f591665f948fa04d628719e5f6f5ab9e4609c02f0a14a93f4
+  data.tar.gz: 54ded7bb163e4a38cd3fa4a62dfe101484b98e87c016514b985190f77a07c7556e980dd8574dc5fb70cacb3fcc521a37a1f4f2325e5360cdbb2ddd6f38816804

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

@@ -10,27 +10,28 @@ module InsightsCloud::Api
 
     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 +70,14 @@ 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/')
+
+      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))
+    end
   end
 end

data/app/models/insights_client_report_status.rb

@@ -0,0 +1,58 @@
+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
+
+  def self.status_name
+    N_('Insights')
+  end
+
+  def to_label(_options = {})
+    case status
+      when REPORTING
+        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
+
+  def to_global(_options = {})
+    case status
+      when REPORTING
+        ::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
+
+    data ? NOT_MANAGED_WITH_DATA : NOT_MANAGED
+  end
+
+  private
+
+  def in_interval?
+    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/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/lib/foreman_inventory_upload/generators/slice.rb

@@ -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_rh_cloud/engine.rb

@@ -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,

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '3.0.21.1'.freeze
+  VERSION = '4.0.21.1'.freeze
 end

data/package.json

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

data/test/jobs/insights_full_sync_test.rb

@@ -1,6 +1,9 @@
 require 'test_helper'
+require 'foreman_tasks/test_helpers'
 
 class InsightsFullSyncTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
   setup do
     InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_rules_sync)
     InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_notifications)

data/test/jobs/insights_resolutions_sync_test.rb

@@ -1,6 +1,9 @@
 require 'test_helper'
+require 'foreman_tasks/test_helpers'
 
 class InsightsResolutionsSyncTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
   setup do
     @resolutions = {
       "advisor:ansible_deprecated_repo|ANSIBLE_DEPRECATED_REPO" => {

data/test/jobs/insights_rules_sync_test.rb

@@ -1,6 +1,9 @@
 require 'test_helper'
+require 'foreman_tasks/test_helpers'
 
 class InsightsRulesSyncTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
   setup do
     rules_json = <<-'RULES_JSON'
     {

data/test/jobs/inventory_full_sync_test.rb

@@ -1,6 +1,9 @@
 require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
 
 class InventoryFullSyncTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
   setup do
     User.current = User.find_by(login: 'secret_admin')
 

data/test/models/insights_client_report_status_test.rb

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

data/test/unit/slice_generator_test.rb

@@ -296,6 +296,13 @@ class SliceGeneratorTest < ActiveSupport::TestCase
     @host.hostgroup = hostgroup
     @host.save!
 
+    ForemanInventoryUpload::Generators::Tags.any_instance.expects(:generate_parameters).returns(
+      [
+        ['bool_param', true],
+        ['int_param', 1],
+      ]
+    )
+
     Foreman.expects(:instance_id).twice.returns('satellite-id')
     batch = Host.where(id: @host.id).in_batches.first
     generator = create_generator(batch)
@@ -316,6 +323,8 @@ class SliceGeneratorTest < ActiveSupport::TestCase
     assert_tag(@host.location.name, actual_host, 'location')
     assert_tag(@host.organization.name, actual_host, 'organization')
     assert_tag(@host.hostgroup.name, actual_host, 'hostgroup')
+    assert_tag('true', actual_host, 'bool_param', 'satellite_parameter')
+    assert_tag('1', actual_host, 'int_param', 'satellite_parameter')
 
     assert_equal false, satellite_facts['is_hostname_obfuscated']
 
@@ -632,8 +641,8 @@ class SliceGeneratorTest < ActiveSupport::TestCase
     generator
   end
 
-  def assert_tag(expected_value, host, tag_id)
-    actual_tag = host['tags'].find { |tag| tag['namespace'] == 'satellite' && tag['key'] == tag_id }
+  def assert_tag(expected_value, host, tag_id, namespace = 'satellite')
+    actual_tag = host['tags'].find { |tag| tag['namespace'] == namespace && tag['key'] == tag_id }
     assert_not_nil actual_tag
     assert_equal expected_value, actual_tag['value']
   end

data/webpack/ForemanInventoryUpload/Components/FullScreenModal/FullScreenModal.js

@@ -12,7 +12,7 @@ const FullScreenModal = ({
   terminalProps,
 }) => (
   <Modal
-    id="full-screen-terminal"
+    id="rh-cloud-inventory-full-screen-terminal"
     show={showFullScreen}
     onHide={toggleFullScreen}
   >

data/webpack/ForemanInventoryUpload/Components/FullScreenModal/__tests__/__snapshots__/FullScreenModal.test.js.snap

@@ -8,7 +8,7 @@ exports[`FullScreenModal rendering render without Props 1`] = `
   bsClass="modal"
   dialogComponentClass={[Function]}
   enforceFocus={true}
-  id="full-screen-terminal"
+  id="rh-cloud-inventory-full-screen-terminal"
   keyboard={true}
   manager={
     ModalManager {

data/webpack/ForemanInventoryUpload/Components/FullScreenModal/fullScreenModal.scss

@@ -1,21 +1,19 @@
-.rh-cloud-inventory-page {
-  #full-screen-terminal {
-    .modal-dialog {
-      width: 95%;
-      height: 95%;
-      margin: 30px 0 0 30px;
+#rh-cloud-inventory-full-screen-terminal {
+  .modal-dialog {
+    width: 95%;
+    height: 95%;
+    margin: 30px 0 0 30px;
 
-      .modal-body {
-        padding: 0;
-        display: flex;
-        height: -webkit-fill-available;
-        height: -moz-available;
-        height: fill-available;
+    .modal-body {
+      padding: 0;
+      display: flex;
+      height: -webkit-fill-available;
+      height: -moz-available;
+      height: fill-available;
 
-        .terminal {
-          margin: 0 -20px;
-          height: 100%;
-        }
+      .rh-cloud-inventory-terminal {
+        margin: 0 -20px;
+        height: 100%;
       }
     }
   }

data/webpack/ForemanInventoryUpload/Components/Terminal/Terminal.js

@@ -72,7 +72,7 @@ class Terminal extends React.Component {
     return (
       <Grid.Col sm={12}>
         <div
-          className="terminal"
+          className="rh-cloud-inventory-terminal"
           ref={this.terminal}
           onScroll={this.handleScroll}
         >

data/webpack/ForemanInventoryUpload/Components/Terminal/__tests__/Terminal.test.js

@@ -29,6 +29,6 @@ describe('Terminal', () => {
     const text = 'some-string-log';
     const modifiedProps = { ...props, logs: text };
     const wrapper = mount(<Terminal {...modifiedProps} />);
-    expect(wrapper.find('.terminal p').text()).toEqual(text);
+    expect(wrapper.find('.rh-cloud-inventory-terminal p').text()).toEqual(text);
   });
 });

data/webpack/ForemanInventoryUpload/Components/Terminal/__tests__/__snapshots__/Terminal.test.js.snap

@@ -7,7 +7,7 @@ exports[`Terminal rendering render with props 1`] = `
   sm={12}
 >
   <div
-    className="terminal"
+    className="rh-cloud-inventory-terminal"
     onScroll={[Function]}
   >
     <Grid
@@ -65,7 +65,7 @@ exports[`Terminal rendering render without Props 1`] = `
   sm={12}
 >
   <div
-    className="terminal"
+    className="rh-cloud-inventory-terminal"
     onScroll={[Function]}
   >
     <Grid

data/webpack/ForemanInventoryUpload/Components/Terminal/terminal.scss

@@ -1,34 +1,32 @@
-.rh-cloud-inventory-page {
-  .terminal {
-    height: 200px;
-    background-color: #222;
-    padding: 10px 0;
-    margin-bottom: 20px;
-    overflow-y: scroll;
-    overflow-x: hidden;
+.rh-cloud-inventory-terminal {
+  height: 200px;
+  background-color: #222;
+  padding: 10px 0;
+  margin-bottom: 20px;
+  overflow-y: scroll;
+  overflow-x: hidden;
 
-    p {
-      font-family: monospace;
-      font-size: 16px;
-      color: #22da26;
-      overflow-wrap: anywhere;
+  p {
+    font-family: monospace;
+    font-size: 16px;
+    color: #22da26;
+    overflow-wrap: anywhere;
 
-      &.terminal_error {
-        color: #f00;
-      }
+    &.terminal_error {
+      color: #f00;
     }
+  }
 
-    &::-webkit-scrollbar {
-      width: 12px;
-      height: 12px;
-      background: #aaa;
-    }
+  &::-webkit-scrollbar {
+    width: 12px;
+    height: 12px;
+    background: #aaa;
+  }
 
-    &::-webkit-scrollbar-thumb {
-      background: #222;
-      border-radius: 6px;
-      border: 3px solid transparent;
-      background-clip: content-box;
-    }
+  &::-webkit-scrollbar-thumb {
+    background: #222;
+    border-radius: 6px;
+    border: 3px solid transparent;
+    background-clip: content-box;
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 3.0.21.1
+  version: 4.0.21.1
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katello
@@ -160,6 +160,7 @@ files:
 - app/helpers/foreman_inventory_upload_helper.rb
 - app/helpers/foreman_inventory_upload_host_helper.rb
 - app/models/concerns/rh_cloud_host.rb
+- app/models/insights_client_report_status.rb
 - app/models/insights_facet.rb
 - app/models/insights_hit.rb
 - app/models/insights_resolution.rb
@@ -174,6 +175,7 @@ files:
 - app/services/foreman_rh_cloud/cloud_request_forwarder.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
@@ -245,6 +247,7 @@ files:
 - test/jobs/insights_rules_sync_test.rb
 - test/jobs/inventory_full_sync_test.rb
 - test/jobs/upload_report_job_test.rb
+- test/models/insights_client_report_status_test.rb
 - test/test_plugin_helper.rb
 - test/unit/archived_report_generator_test.rb
 - test/unit/fact_helpers_test.rb
@@ -666,6 +669,7 @@ test_files:
 - test/jobs/insights_rules_sync_test.rb
 - test/jobs/inventory_full_sync_test.rb
 - test/jobs/upload_report_job_test.rb
+- test/models/insights_client_report_status_test.rb
 - test/test_plugin_helper.rb
 - test/unit/archived_report_generator_test.rb
 - test/unit/fact_helpers_test.rb