foreman_rh_cloud 5.0.37 → 5.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1fcbb6ac1367f8d83a29a6723c9244314b70cd3d8fb675747cdf44ae312a27
-  data.tar.gz: c9adec3a0002212f49e8ab7a30e793431809076e9b204a43725001b0a9e391ee
+  metadata.gz: 4520a12619aad77a5d0ddeafd83203d8281e0ff7d3e9fcc2eef10a2a779bad27
+  data.tar.gz: 7e6d55970f4c0742328e5a5e9159b084a391cc98305cf67cff6555a1575b6fe1
 SHA512:
-  metadata.gz: db98fee746e070be33b584993e56479290df9b462ab9277a66f43c3b5c0af37a9ba3a765f66c4d3fc03f114d300b4ce206db3a8228e0417544c9a092f0e25e23
-  data.tar.gz: '09dd3108525df34ef72654cf8f9030af5fc2a6996b806d78b026e56d493b3d49cb5794852733b63dd500102878049e6e4e9f96d16428aa52f55ad8c1c727a610'
+  metadata.gz: f55b1b61ed73778bc62c7cf1819b1eac363417a6f929cbc1f6e9b8043f45904b2dec26f1c9294ab68e1b175a4cbda091ef7091d755180649d0f2e242784092c5
+  data.tar.gz: 5b7fe9198f6c0172f93638f8315274158471169033de6f6c9113aa94dd2de8ab5ac0a0c9b32b0c1bb374cfb3303ab9d7915519139919799d9a88531bb280f024

data/app/controllers/api/v2/rh_cloud/cloud_request_controller.rb

@@ -27,16 +27,18 @@ module Api::V2::RhCloud
     private
 
     def metadata
-      params['metadata']
+      params['Metadata'] || params['metadata']
     end
 
     def content
+      content = params['Content'] || params['content']
+
       # the content received as base 64 of the string in double quotes
-      Base64.decode64(params['content']).tr('"', '')
+      Base64.decode64(content).tr('"', '')
     end
 
     def directive
-      params['directive']
+      params['Directive'] || params['directive']
     end
 
     def handle_run_playbook_request
@@ -44,9 +46,13 @@ module Api::V2::RhCloud
       logger.error("Reporting URL is not valid: #{metadata['return_url']}") && return unless valid_url?(metadata['return_url'])
 
       hosts = metadata['hosts'].split(',')
-      host_ids = host_ids(hosts)
 
-      logger.warn("Some hosts were not found. Looked for: #{hosts}, found ids: #{host_ids}") unless host_ids.length == hosts.length
+      # select hosts from the metadata list that are not disabled by the parameter.
+      host_ids = Host.search_for("not params.#{InsightsCloud.enable_cloud_remediations_param} = f")
+                     .where(id: host_ids(hosts))
+                     .pluck(:id)
+
+      logger.warn("Some hosts were not found/ignored. Looked for: #{hosts}, found ids: #{host_ids}") unless host_ids.length == hosts.length
 
       logger.error("sat_org_id is not present in the metadata") && return unless metadata['sat_org_id']
       org_id = metadata['sat_org_id'].to_i

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -18,13 +18,6 @@ module ForemanInventoryUpload
     end
 
     def enable_cloud_connector
-      Organization.unscoped.each do |org|
-        presence = ForemanRhCloud::CloudPresence.new(org, logger)
-        presence.announce_to_sources
-      rescue StandardError => ex
-        logger.warn(ex)
-      end
-
       cloud_connector = ForemanRhCloud::CloudConnector.new
       render json: cloud_connector.install.to_json
     end

data/app/controllers/insights_cloud/settings_controller.rb

@@ -9,6 +9,20 @@ module InsightsCloud
       render_setting(:insightsSyncEnabled, :allow_auto_insights_sync)
     end
 
+    def set_org_parameter
+      parameter = params.require(:parameter)
+      new_value = ActiveModel::Type::Boolean.new.cast(params.require(:value))
+      org_id = params.require(:organization_id)
+
+      organization = Organization.authorized.find(org_id)
+
+      org_param = organization.organization_parameters.find_or_create_by(name: parameter) do |org_param|
+        org_param.name = parameter
+      end
+      org_param.value = new_value
+      org_param.save!
+    end
+
     private
 
     def render_setting(node_name, setting)

data/config/routes.rb

@@ -25,6 +25,8 @@ Rails.application.routes.draw do
       end
     end
     match 'hits/:host_id', to: 'hits#show', via: :get
+
+    post ':organization_id/parameter', to: 'settings#set_org_parameter', constraints: { organization_id: %r{[^\/]+} }
   end
 
   namespace :foreman_rh_cloud do

data/lib/foreman_inventory_upload/async/generate_all_reports_job.rb

@@ -32,6 +32,10 @@ module ForemanInventoryUpload
       def plan_generate_report(folder, organization)
         plan_action(ForemanInventoryUpload::Async::GenerateReportJob, folder, organization.id)
       end
+
+      def logger
+        action_logger
+      end
     end
   end
 end

data/lib/foreman_rh_cloud/engine.rb

@@ -83,9 +83,13 @@ module ForemanRhCloud
             :dispatch_cloud_requests,
             'api/v2/rh_cloud/cloud_request': [:update]
           )
+          permission(
+            :control_organization_insights,
+            'insights_cloud/settings': [:set_org_parameter]
+          )
         end
 
-        plugin_permissions = [:view_foreman_rh_cloud, :generate_foreman_rh_cloud, :view_insights_hits, :dispatch_cloud_requests]
+        plugin_permissions = [:view_foreman_rh_cloud, :generate_foreman_rh_cloud, :view_insights_hits, :dispatch_cloud_requests, :control_organization_insights]
 
         role 'ForemanRhCloud', plugin_permissions, 'Role granting permissions to view the hosts inventory,
                                                     generate a report, upload it to the cloud and download it locally'

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '5.0.37'.freeze
+  VERSION = '5.0.41'.freeze
 end

data/lib/insights_cloud/async/cloud_connector_announce_task.rb

@@ -0,0 +1,44 @@
+module InsightsCloud
+  module Async
+    class CloudConnectorAnnounceTask < ::Actions::EntryAction
+      def self.subscribe
+        Actions::RemoteExecution::RunHostsJob
+      end
+
+      def self.connector_feature_id
+        @connector_feature_id ||= RemoteExecutionFeature.feature!(ForemanRhCloud::CloudConnector::CLOUD_CONNECTOR_FEATURE).id
+      end
+
+      def plan(job_invocation)
+        return unless connector_playbook_job?(job_invocation)
+
+        plan_self
+      end
+
+      def finalize
+        Organization.unscoped.each do |org|
+          presence = ForemanRhCloud::CloudPresence.new(org, logger)
+          presence.announce_to_sources
+        rescue StandardError => ex
+          logger.warn(ex)
+        end
+      end
+
+      def rescue_strategy_for_self
+        Dynflow::Action::Rescue::Skip
+      end
+
+      def connector_playbook_job?(job_invocation)
+        job_invocation&.remote_execution_feature_id == connector_feature_id
+      end
+
+      def connector_feature_id
+        self.class.connector_feature_id
+      end
+
+      def logger
+        action_logger
+      end
+    end
+  end
+end

data/lib/insights_cloud/async/connector_playbook_execution_reporter_task.rb

@@ -137,6 +137,7 @@ module InsightsCloud
 
       def report_job_progress(invocation_status)
         generator = InsightsCloud::Generators::PlaybookProgressGenerator.new(correlation_id)
+        all_hosts_success = true
 
         invocation_status.each do |host_name, status|
           # skip host if the host already reported that it's finished
@@ -151,9 +152,10 @@ module InsightsCloud
           if status['state'] == 'stopped'
             generator.host_finished_message(host_name, status['exit_status'])
             status['report_done'] = true
+            all_hosts_success &&= status['exit_status'] == 0
           end
         end
-        generator.job_finished_message if done?(invocation_status)
+        generator.job_finished_message(all_hosts_success) if done?(invocation_status)
 
         send_report(generator.generate)
       end

data/lib/insights_cloud/generators/playbook_progress_generator.rb

@@ -30,12 +30,12 @@ module InsightsCloud
         }
       end
 
-      def job_finished_message
+      def job_finished_message(success)
         @messages << {
           "type": "playbook_run_completed",
           "version": 3,
           "correlation_id": correlation_id,
-          "status": "success",
+          "status": success ? 'success' : 'failure',
         }
       end
 

data/lib/insights_cloud.rb

@@ -28,4 +28,8 @@ module InsightsCloud
   def self.enable_client_param
     'host_registration_insights'
   end
+
+  def self.enable_cloud_remediations_param
+    'enable_cloud_remediations'
+  end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foreman_rh_cloud",
-  "version": "5.0.37",
+  "version": "5.0.41",
   "description": "Inventory Upload =============",
   "main": "index.js",
   "scripts": {
@@ -22,14 +22,14 @@
     "url": "http://projects.theforeman.org/projects/foreman_rh_cloud/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": "~8.16.0"
+    "@theforeman/vendor": ">= 8.16.0"
   },
   "devDependencies": {
     "@babel/core": "~7.7.0",
-    "@theforeman/builder": "~8.16.0",
-    "@theforeman/stories": "~8.16.0",
-    "@theforeman/test": "~8.16.0",
-    "@theforeman/eslint-plugin-foreman": "~8.16.0",
+    "@theforeman/builder": ">= 8.16.0",
+    "@theforeman/stories": ">= 8.16.0",
+    "@theforeman/test": ">= 8.16.0",
+    "@theforeman/eslint-plugin-foreman": ">= 8.16.0",
     "babel-eslint": "~10.0.0",
     "eslint": "~6.7.2",
     "eslint-plugin-spellcheck": "~0.0.17",

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

@@ -40,6 +40,33 @@ module InsightsCloud::Api
       assert_response :success
     end
 
+    test 'Starts playbook run for correct directive with capitalized keys' do
+      host1 = FactoryBot.create(:host, :with_insights_hits)
+      host1.insights.uuid = 'TEST_UUID1'
+      host1.insights.save!
+      host2 = FactoryBot.create(:host, :with_insights_hits)
+      host2.insights.uuid = 'TEST_UUID2'
+      host2.insights.save!
+
+      mock_composer = mock('composer')
+      ::JobInvocationComposer.expects(:for_feature).with do |feature, host_ids, params|
+        feature == :rh_cloud_connector_run_playbook &&
+        host_ids.first == host1.id &&
+        host_ids.last == host2.id
+      end.returns(mock_composer)
+      mock_composer.expects(:trigger!)
+      mock_composer.expects(:job_invocation)
+
+      params = run_playbook_request
+      params['Directive'] = params.delete('directive')
+      params['Metadata'] = params.delete('metadata')
+      params['Content'] = params.delete('content')
+
+      post :update, params: run_playbook_request
+
+      assert_response :success
+    end
+
     private
 
     def run_playbook_request

data/test/controllers/insights_sync/settings_controller_test.rb

@@ -27,4 +27,21 @@ class SettingsControllerTest < ActionController::TestCase
     assert_equal true, actual['insightsSyncEnabled']
     assert_equal true, Setting[:allow_auto_insights_sync]
   end
+
+  test 'Should update an organization parameter' do
+    FactoryBot.create(:common_parameter, name: InsightsCloud.enable_cloud_remediations_param, value: false)
+    host = FactoryBot.create(:host)
+
+    # make sure the parameter is there
+    assert_equal false, host.host_params[InsightsCloud.enable_cloud_remediations_param]
+
+    post :set_org_parameter, params: { parameter: InsightsCloud.enable_cloud_remediations_param, value: true, organization_id: host.organization.id }, session: set_session_user
+
+    # needed for properly access host_params
+    User.as_anonymous_admin do
+      # refresh the host record
+      host = Host.find(host.id)
+      assert_equal true, host.host_params[InsightsCloud.enable_cloud_remediations_param]
+    end
+  end
 end

data/test/jobs/cloud_connector_announce_task_test.rb

@@ -0,0 +1,125 @@
+require 'json'
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+require "#{ForemanTasks::Engine.root}/test/support/dummy_dynflow_action"
+
+class CloudConnectorAnnounceTaskTest < ActiveSupport::TestCase
+  include ForemanTasks::TestHelpers::WithInThreadExecutor
+
+  setup do
+    RemoteExecutionFeature.register(
+      :ansible_configure_cloud_connector,
+      N_('Configure Cloud Connector on given hosts'),
+      :description => N_('Configure Cloud Connector on given hosts'),
+      :proxy_selector_override => ::RemoteExecutionProxySelector::INTERNAL_PROXY
+    )
+
+    @job_invocation = generate_job_invocation(:ansible_configure_cloud_connector)
+
+    # reset connector feature ID cache
+    InsightsCloud::Async::CloudConnectorAnnounceTask.instance_variable_set(:@connector_feature_id, nil)
+  end
+
+  test 'It executes cloud presence announcer' do
+    ForemanRhCloud::CloudPresence.any_instance.expects(:announce_to_sources).times(Organization.unscoped.count)
+
+    ForemanTasks.sync_task(InsightsCloud::Async::CloudConnectorAnnounceTask, @job_invocation)
+  end
+
+  private
+
+  def generate_job_invocation(feature_name)
+    job_template = FactoryBot.build(
+      :job_template,
+      :template => 'BLEH'
+    )
+    feature = RemoteExecutionFeature.feature!(feature_name).id
+
+    job_invocation = FactoryBot.create(
+      :job_invocation,
+      remote_execution_feature_id: feature,
+      task_id: FactoryBot.create(:dynflow_task).id
+    )
+
+    job_template.template_inputs << playbook_url_input = FactoryBot.build(:template_input,
+      :name => 'playbook_url',
+      :input_type => 'user',
+      :required => true)
+    job_template.template_inputs << report_url_input = FactoryBot.build(:template_input,
+      :name => 'report_url',
+      :input_type => 'user',
+      :required => true)
+    job_template.template_inputs << correlation_id_input = FactoryBot.build(:template_input,
+      :name => 'correlation_id',
+      :input_type => 'user',
+      :required => true)
+    job_template.template_inputs << report_interval_input = FactoryBot.build(:template_input,
+      :name => 'report_interval',
+      :input_type => 'user',
+      :required => true)
+
+    template_invocation = FactoryBot.build(:template_invocation,
+      :template => job_template,
+      :job_invocation => job_invocation
+    )
+
+    template_invocation.input_values << FactoryBot.create(
+      :template_invocation_input_value,
+      :template_invocation => template_invocation,
+      :template_input => playbook_url_input,
+      :value => 'http://example.com/TEST_PLAYBOOK'
+    )
+    template_invocation.input_values << FactoryBot.create(
+      :template_invocation_input_value,
+      :template_invocation => template_invocation,
+      :template_input => report_url_input,
+      :value => 'http://example.com/TEST_REPORT'
+    )
+    template_invocation.input_values << FactoryBot.create(
+      :template_invocation_input_value,
+      :template_invocation => template_invocation,
+      :template_input => correlation_id_input,
+      :value => 'TEST_CORRELATION'
+    )
+    template_invocation.input_values << FactoryBot.create(
+      :template_invocation_input_value,
+      :template_invocation => template_invocation,
+      :template_input => report_interval_input,
+      :value => '1'
+    )
+
+    @host1 = FactoryBot.create(:host, :with_insights_hits, name: 'host1')
+    @host1.insights.uuid = 'TEST_UUID1'
+    @host1.insights.save!
+    @host2 = FactoryBot.create(:host, :with_insights_hits, name: 'host2')
+    @host2.insights.uuid = 'TEST_UUID2'
+    @host2.insights.save!
+
+    targeting = FactoryBot.create(:targeting, hosts: [@host1, @host2])
+    job_invocation.targeting = targeting
+    job_invocation.save!
+
+    job_invocation.template_invocations << FactoryBot.create(
+      :template_invocation,
+      run_host_job_task: FactoryBot.create(:dynflow_task),
+      host_id: @host1.id
+    )
+    job_invocation.template_invocations << FactoryBot.create(
+      :template_invocation,
+      run_host_job_task: FactoryBot.create(:dynflow_task),
+      host_id: @host2.id
+    )
+
+    fake_output = (1..5).map do |i|
+      { 'timestamp' => (Time.now - (5 - i)).to_f, 'output' => "#{i}\n" }
+    end
+    Support::DummyDynflowAction.any_instance.stubs(:live_output).returns(fake_output)
+    Support::DummyDynflowAction.any_instance.stubs(:exit_status).returns(0)
+
+    job_invocation
+  end
+
+  def read_jsonl(jsonl)
+    jsonl.lines.map { |l| JSON.parse(l) }
+  end
+end

data/test/unit/playbook_progress_generator_test.rb

@@ -51,7 +51,7 @@ class PlaybookProgressGeneratorTest < ActiveSupport::TestCase
   end
 
   test 'Outputs job finished message' do
-    @generator.job_finished_message
+    @generator.job_finished_message(true)
 
     actual = @generator.generate
     actual_message = JSON.parse(actual)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 5.0.37
+  version: 5.0.41
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katello
@@ -221,6 +221,7 @@ files:
 - lib/foreman_rh_cloud/engine.rb
 - lib/foreman_rh_cloud/version.rb
 - lib/insights_cloud.rb
+- lib/insights_cloud/async/cloud_connector_announce_task.rb
 - lib/insights_cloud/async/connector_playbook_execution_reporter_task.rb
 - lib/insights_cloud/async/insights_client_status_aging.rb
 - lib/insights_cloud/async/insights_full_sync.rb
@@ -255,6 +256,7 @@ files:
 - test/controllers/uploads_settings_controller_test.rb
 - test/factories/insights_factories.rb
 - 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/insights_client_status_aging_test.rb
 - test/jobs/insights_full_sync_test.rb
@@ -672,7 +674,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Summary of ForemanRhCloud.
@@ -688,33 +690,34 @@ test_files:
 - test/controllers/uploads_settings_controller_test.rb
 - test/factories/insights_factories.rb
 - test/factories/inventory_upload_factories.rb
-- test/jobs/insights_client_status_aging_test.rb
-- test/jobs/inventory_scheduled_sync_test.rb
-- test/jobs/upload_report_job_test.rb
+- test/jobs/cloud_connector_announce_task_test.rb
 - test/jobs/connector_playbook_execution_reporter_task_test.rb
+- test/jobs/insights_client_status_aging_test.rb
 - test/jobs/insights_full_sync_test.rb
 - test/jobs/insights_resolutions_sync_test.rb
 - test/jobs/insights_rules_sync_test.rb
 - test/jobs/inventory_full_sync_test.rb
 - test/jobs/inventory_hosts_sync_test.rb
+- test/jobs/inventory_scheduled_sync_test.rb
 - test/jobs/inventory_self_host_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
+- test/unit/foreman_rh_cloud_self_host_test.rb
 - test/unit/insights_facet_test.rb
 - test/unit/metadata_generator_test.rb
+- test/unit/playbook_progress_generator_test.rb
 - test/unit/rh_cloud_http_proxy_test.rb
 - test/unit/rh_cloud_permissions_test.rb
 - test/unit/services/foreman_rh_cloud/branch_info_test.rb
-- test/unit/services/foreman_rh_cloud/insights_status_cleaner_test.rb
 - test/unit/services/foreman_rh_cloud/cloud_request_forwarder_test.rb
 - test/unit/services/foreman_rh_cloud/cloud_status_service_test.rb
 - test/unit/services/foreman_rh_cloud/hit_remediations_retriever_test.rb
+- test/unit/services/foreman_rh_cloud/insights_status_cleaner_test.rb
 - test/unit/services/foreman_rh_cloud/template_renderer_helper_test.rb
 - test/unit/services/foreman_rh_cloud/url_remediations_retriever_test.rb
 - test/unit/shell_process_job_test.rb
 - test/unit/slice_generator_test.rb
 - test/unit/tags_generator_test.rb
-- test/unit/foreman_rh_cloud_self_host_test.rb
-- test/unit/playbook_progress_generator_test.rb