foreman_rh_cloud 3.0.19 → 3.0.20

data/lib/insights_cloud/async/insights_rules_sync.rb

@@ -2,13 +2,21 @@ require 'rest-client'
 
 module InsightsCloud
   module Async
-    class InsightsRulesSync < ::ApplicationJob
+    class InsightsRulesSync < ::Actions::EntryAction
       include ::ForemanRhCloud::CloudAuth
 
-      def perform
+      def plan
+        plan_self
+        plan_resolutions
+      end
+
+      def plan_resolutions
+        plan_action InsightsResolutionsSync
+      end
+
+      def run
         offset = 0
         InsightsRule.transaction do
-          InsightsResolution.delete_all
           InsightsRule.delete_all
           loop do
             api_response = query_insights_rules(offset)
@@ -16,13 +24,14 @@ module InsightsCloud
             logger.debug("Downloaded #{offset + results.count} of #{results.total}")
             write_rules_page(results.rules)
             offset += results.count
+            output[:rules_count] = results.total
             break if offset >= results.total
           end
         end
       end
 
       def logger
-        Foreman::Logging.logger('background')
+        action_logger
       end
 
       private
@@ -43,12 +52,8 @@ module InsightsCloud
 
       def write_rules_page(rules)
         rules_attributes = rules.map { |rule| to_rule_hash(rule) }
-        resolutions_attributes = rules.map do |rule|
-          rule['resolution_set'].map { |resolution| to_resolution_hash(rule['rule_id'], resolution) }
-        end.flatten
 
         InsightsRule.create(rules_attributes)
-        InsightsResolution.create(resolutions_attributes)
       end
 
       def to_rule_hash(rule_hash)
@@ -66,15 +71,6 @@ module InsightsCloud
           rating:  rule_hash['rating'],
         }
       end
-
-      def to_resolution_hash(rule_id, resolution_hash)
-        {
-          rule_id: rule_id,
-          system_type: resolution_hash['system_type'],
-          resolution: resolution_hash['resolution'],
-          has_playbook: resolution_hash['has_playbook'],
-        }
-      end
     end
   end
 end

data/lib/insights_cloud/async/insights_scheduled_sync.rb

@@ -10,7 +10,7 @@ module InsightsCloud
           return
         end
 
-        InsightsFullSync.perform_later()
+        ForemanTasks.async_task InsightsFullSync
       ensure
         self.class.set(:wait => 24.hours).perform_later
       end

data/lib/tasks/rh_cloud_inventory.rake

@@ -54,7 +54,7 @@ namespace :rh_cloud_inventory do
 
   desc "Synchronize Insights hosts hits"
   task sync: :environment do
-    InsightsCloud::Async::InsightsFullSync.perform_now()
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
     puts "Synchronized Insights hosts hits data"
   end
 end

data/package.json

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

data/test/factories/insights_factories.rb

@@ -19,6 +19,28 @@ FactoryBot.define do
     sequence(:results_url) { |n| "https://cloud.redhat.com/insights/overview/stability/test_rule%7CTEST_RULE/accdf444-5628-451d-bf3e-cf909ad7275#{n}/" }
     rule_id { "test_rule|TEST_RULE" }
   end
+
+  factory :insights_rule do
+    sequence(:rule_id) { |n| "test_rule#{n}|TEST_RULE#{n}" }
+    description { 'test rule description' }
+    category_name { 'Testing' }
+    impact_name { 'Testing error' }
+    summary { 'Testing summary' }
+    generic { 'Testing generic' }
+    reason { 'No apparent reason' }
+    total_risk { -1 }
+    reboot_required { true }
+    more_info { 'more test info' }
+    rating { 0 }
+  end
+
+  factory :insights_resolution do
+    sequence(:rule_id) { |n| "test_rule#{n}|TEST_RULE#{n}" }
+    description { 'fix the issue on the fly' }
+    needs_reboot { false }
+    resolution_risk { 1 }
+    resolution_type { 'fix' }
+  end
 end
 
 FactoryBot.modify do

data/test/jobs/insights_full_sync_test.rb

@@ -1,7 +1,9 @@
 require 'test_helper'
 
-class InsightsFullSyncTest < ActiveJob::TestCase
+class InsightsFullSyncTest < ActiveSupport::TestCase
   setup do
+    InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_rules_sync)
+
     uuid1 = 'accdf444-5628-451d-bf3e-cf909ad72756'
     @host1 = FactoryBot.create(:host, :managed, name: 'host1')
     FactoryBot.create(:insights_facet, host_id: @host1.id, uuid: uuid1)
@@ -56,8 +58,9 @@ class InsightsFullSyncTest < ActiveJob::TestCase
   test 'Hits data is replaced with data from cloud' do
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).returns(@hits)
 
-    ForemanTasks.expects(:sync_task).with(InventorySync::Async::InventoryHostsSync)
-    InsightsCloud::Async::InsightsFullSync.perform_now()
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_hosts_sync)
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_rules_sync)
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
 
     @host1.reload
     @host2.reload
@@ -68,11 +71,12 @@ class InsightsFullSyncTest < ActiveJob::TestCase
 
   test 'Hits counters are reset correctly' do
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).returns(@hits).twice
-    ForemanTasks.stubs(:sync_task)
 
-    InsightsCloud::Async::InsightsFullSync.perform_now()
+    InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_hosts_sync)
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
     # Invoke again
-    InsightsCloud::Async::InsightsFullSync.perform_now()
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
 
     @host1.reload
     @host2.reload
@@ -101,10 +105,10 @@ class InsightsFullSyncTest < ActiveJob::TestCase
     HITS_JSON
     hits = JSON.parse(hits_json)
 
-    ForemanTasks.stubs(:sync_task)
+    InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_hosts_sync)
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).returns(hits)
 
-    InsightsCloud::Async::InsightsFullSync.perform_now()
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync)
 
     @host1.reload
     @host2.reload

data/test/jobs/insights_resolutions_sync_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+class InsightsResolutionsSyncTest < ActiveSupport::TestCase
+  setup do
+    @resolutions = {
+      "advisor:ansible_deprecated_repo|ANSIBLE_DEPRECATED_REPO" => {
+        "id" => "advisor:ansible_deprecated_repo|ANSIBLE_DEPRECATED_REPO",
+        "resolution_risk" => 1,
+        "resolutions" => [
+          {
+            "description" => "Enable ansible repo and update ansible package",
+            "id" => "fix",
+            "needs_reboot" => false,
+            "resolution_risk" => 1,
+          },
+        ],
+      },
+      "advisor:hardening_logging_auditd|HARDENING_LOGGING_5_AUDITD" => {
+        "id" => "advisor:hardening_logging_auditd|HARDENING_LOGGING_5_AUDITD",
+        "resolution_risk" => 1,
+        "resolutions" => [
+          {
+            "description" => "Install and enable auditd",
+            "id" => "fix",
+            "needs_reboot" => false,
+            "resolution_risk" => 1,
+          },
+        ],
+      },
+      "advisor:network_manager_dhcp_client_network_issue|NETWORK_MANAGER_DHCP_CLIENT_NETWORK_ISSUE" => {
+        "id" => "advisor:network_manager_dhcp_client_network_issue|NETWORK_MANAGER_DHCP_CLIENT_NETWORK_ISSUE",
+        "resolution_risk" => 1,
+        "resolutions" => [
+          {
+            "description" => "Update the NetworkManager package to fix this issue",
+            "id" => "fix",
+            "needs_reboot" => false,
+            "resolution_risk" => 1,
+          },
+        ],
+      },
+      "advisor:network_tcp_connection_hang|NETWORK_TCP_CONNECTION_HANG_WARN" => {
+        "id" => "advisor:network_tcp_connection_hang|NETWORK_TCP_CONNECTION_HANG_WARN",
+        "resolution_risk" => 3,
+        "resolutions" => [
+          {
+            "description" => "Update system to the latest kernel and reboot",
+            "id" => "kernel_update",
+            "needs_reboot" => true,
+            "resolution_risk" => 3,
+          },
+          {
+            "description" => "Run in panic and scream",
+            "id" => "panic",
+            "needs_reboot" => true,
+            "resolution_risk" => 10,
+          },
+        ],
+      },
+    }
+
+    @rule = FactoryBot.create(:insights_rule, rule_id: 'network_tcp_connection_hang|NETWORK_TCP_CONNECTION_HANG_WARN')
+  end
+
+  test 'Resolutions data is replaced with data from cloud' do
+    InsightsCloud::Async::InsightsResolutionsSync.any_instance.stubs(:query_insights_resolutions).returns(@resolutions)
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsResolutionsSync)
+    @rule.reload
+
+    assert_equal 5, InsightsResolution.all.count
+    assert_equal 2, @rule.resolutions.count
+  end
+end

data/test/jobs/insights_rules_sync_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class InsightsRulesSyncTest < ActiveJob::TestCase
+class InsightsRulesSyncTest < ActiveSupport::TestCase
   setup do
     rules_json = <<-'RULES_JSON'
     {
@@ -107,12 +107,14 @@ class InsightsRulesSyncTest < ActiveJob::TestCase
     @rules = JSON.parse(rules_json)
     @host = FactoryBot.create(:host, :managed, name: 'host1')
     @hit = FactoryBot.create(:insights_hit, host_id: @host.id)
+
+    InsightsCloud::Async::InsightsRulesSync.any_instance.stubs(:plan_resolutions)
   end
 
   test 'Hits data is replaced with data from cloud' do
     InsightsCloud::Async::InsightsRulesSync.any_instance.expects(:query_insights_rules).returns(@rules)
 
-    InsightsCloud::Async::InsightsRulesSync.perform_now()
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsRulesSync)
     @hit.reload
 
     assert_equal 2, InsightsRule.all.count
@@ -191,7 +193,7 @@ class InsightsRulesSyncTest < ActiveJob::TestCase
     InsightsCloud::Async::InsightsRulesSync.any_instance.
       stubs(:query_insights_rules).returns(@rules).then.returns(@last_rule)
 
-    InsightsCloud::Async::InsightsRulesSync.perform_now()
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsRulesSync)
 
     assert_equal 3, InsightsRule.all.count
   end

data/test/jobs/inventory_full_sync_test.rb

@@ -1,6 +1,6 @@
 require 'test_plugin_helper'
 
-class InventoryFullSyncTest < ActiveJob::TestCase
+class InventoryFullSyncTest < ActiveSupport::TestCase
   setup do
     User.current = User.find_by(login: 'secret_admin')
 

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

@@ -0,0 +1,49 @@
+require 'test_plugin_helper'
+
+class RemediationsRetrieverTest < ActiveSupport::TestCase
+  setup do
+    @host1 = FactoryBot.create(:host)
+    @host2 = FactoryBot.create(:host)
+  end
+  test 'groups hosts together' do
+    rule1 = FactoryBot.create(:insights_rule)
+    rule1_remediation1 = FactoryBot.create(:insights_resolution, rule_id: rule1.rule_id, resolution_type: 'fix')
+
+    FactoryBot.create(:insights_facet, uuid: 'HOST1', host_id: @host1.id)
+    host1_hit1 = FactoryBot.create(:insights_hit, rule_id: rule1.rule_id, host_id: @host1.id)
+
+    FactoryBot.create(:insights_facet, uuid: 'HOST2', host_id: @host2.id)
+    host2_hit1 = FactoryBot.create(:insights_hit, rule_id: rule1.rule_id, host_id: @host2.id)
+
+    pairs = [{'hit_id' => host1_hit1.id, 'resolution_id' => rule1_remediation1.id}, {'hit_id' => host2_hit1.id, 'resolution_id' => rule1_remediation1.id}]
+    retriever = ForemanRhCloud::RemediationsRetriever.new(pairs)
+
+    actual_request = retriever.send(:playbook_request)
+
+    assert_not_nil (issues = actual_request[:issues])
+    assert_not_nil (resolution = issues.first)
+    assert_equal 'fix', resolution[:resolution]
+    assert_equal "advisor:#{rule1.rule_id}", resolution[:id]
+    assert_same_elements ['HOST1', 'HOST2'], resolution[:systems]
+  end
+
+  test 'does not group different resolutions' do
+    rule1 = FactoryBot.create(:insights_rule)
+    rule1_remediation1 = FactoryBot.create(:insights_resolution, rule_id: rule1.rule_id, resolution_type: 'fix')
+    rule1_remediation2 = FactoryBot.create(:insights_resolution, rule_id: rule1.rule_id, resolution_type: 'panic')
+
+    FactoryBot.create(:insights_facet, uuid: 'HOST1', host_id: @host1.id)
+    host1_hit1 = FactoryBot.create(:insights_hit, rule_id: rule1.rule_id, host_id: @host1.id)
+
+    FactoryBot.create(:insights_facet, uuid: 'HOST2', host_id: @host2.id)
+    host2_hit1 = FactoryBot.create(:insights_hit, rule_id: rule1.rule_id, host_id: @host2.id)
+
+    pairs = [{'hit_id' => host1_hit1.id, 'resolution_id' => rule1_remediation1.id}, {'hit_id' => host2_hit1.id, 'resolution_id' => rule1_remediation2.id}]
+    retriever = ForemanRhCloud::RemediationsRetriever.new(pairs)
+
+    actual_request = retriever.send(:playbook_request)
+
+    assert_not_nil (issues = actual_request[:issues])
+    assert_equal 2, issues.count
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'test_plugin_helper'
+
+class TemplateRendererHelperTest < ActiveSupport::TestCase
+  include ForemanRhCloud::TemplateRendererHelper
+
+  setup do
+    response = mock('respone')
+    response.stubs(:body).returns('TEST PLAYBOOK')
+    ForemanRhCloud::RemediationsRetriever.any_instance.stubs(:query_playbook).returns(response)
+    @host1 = FactoryBot.create(:host)
+  end
+
+  test 'Generates a playbook for hit and remediation' do
+    rule = FactoryBot.create(:insights_rule)
+    hit = FactoryBot.create(:insights_hit, rule: rule, host_id: @host1.id)
+    remediation = FactoryBot.create(:insights_resolution, rule: rule)
+
+    pairs = [{hit_id: hit.id, remediation_id: remediation.id}].to_json
+
+    actual_playbook = remediations_playbook(pairs)
+
+    assert_equal 'TEST PLAYBOOK', actual_playbook
+  end
+
+  def template_logger
+    Logger.new(IO::NULL)
+  end
+end

data/webpack/ForemanInventoryUpload/Components/InventorySettings/AdvancedSetting/AdvancedSettingsConstants.js

@@ -3,7 +3,7 @@ import { translate as __ } from 'foremanReact/common/I18n';
 export const settingsDict = {
   autoUploadEnabled: {
     name: 'allow_auto_inventory_upload',
-    label: __('Auto upload'),
+    label: __('Automatic inventory upload'),
     tooltip: __(
       'Enable automatic upload of your hosts inventory to the Red Hat cloud'
     ),
@@ -20,7 +20,9 @@ export const settingsDict = {
   },
   excludePackagesEnabled: {
     name: 'exclude_installed_packages',
-    label: __('Exclude Packages'),
-    tooltip: __('Exclude packages from being uploaded to the Red Hat cloud'),
+    label: __('Exclude installed Packages'),
+    tooltip: __(
+      'Exclude installed packages from being uploaded to the Red Hat cloud'
+    ),
   },
 };

data/webpack/ForemanInventoryUpload/Components/PageHeader/components/PageDescription/PageDescription.js

@@ -10,14 +10,27 @@ export const PageDescription = () => (
     </p>
     <p>
       {__(
-        'In order to utilize these services, you can set the auto upload in the settings to "ON".'
+        'You can toggle the Auto upload switch to the ON position to enable Satellite to automatically upload your host inventory once a day.'
       )}
     </p>
     <p>
       {__(
-        'You can also trigger the upload manually by opening the relevant organization card, and clicking on the "Restart" button'
+        'Click Restart to upload your host inventory to Red Hat Insights. Perform this step for each organization from which you want to manually upload a host inventory.'
       )}
     </p>
+    <p>
+      {__(
+        'Enabling inventory uploads is required by subscription watch. For more information about subscription watch see link:'
+      )}
+      &nbsp;
+      <a
+        href="https://access.redhat.com/documentation/en-us/subscription_central/2020-04/html/getting_started_with_subscription_watch/assembly-about-subscriptionwatch"
+        target="_blank"
+        rel="noopener noreferrer"
+      >
+        About subscription watch
+      </a>
+    </p>
   </div>
 );
 

data/webpack/ForemanInventoryUpload/Components/PageHeader/components/PageDescription/__tests__/__snapshots__/PageDescription.test.js.snap

@@ -8,10 +8,21 @@ exports[`PageDescription rendering render without Props 1`] = `
     Red Hat Insights is a set of cloud services which provide unified subscription reporting, predictive analysis and remediation of issues through this Satellite instance.
   </p>
   <p>
-    In order to utilize these services, you can set the auto upload in the settings to "ON".
+    You can toggle the Auto upload switch to the ON position to enable Satellite to automatically upload your host inventory once a day.
   </p>
   <p>
-    You can also trigger the upload manually by opening the relevant organization card, and clicking on the "Restart" button
+    Click Restart to upload your host inventory to Red Hat Insights. Perform this step for each organization from which you want to manually upload a host inventory.
+  </p>
+  <p>
+    Enabling inventory uploads is required by subscription watch. For more information about subscription watch see link:
+     
+    <a
+      href="https://access.redhat.com/documentation/en-us/subscription_central/2020-04/html/getting_started_with_subscription_watch/assembly-about-subscriptionwatch"
+      rel="noopener noreferrer"
+      target="_blank"
+    >
+      About subscription watch
+    </a>
   </p>
 </div>
 `;