foreman_rh_cloud 13.0.7 → 13.0.9

data/test/jobs/create_missing_insights_facets_test.rb

@@ -0,0 +1,151 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class CreateMissingInsightsFacetsTest < ActiveSupport::TestCase
+  include Dynflow::Testing::Factories
+  include KatelloCVEHelper
+
+  setup do
+    User.current = User.find_by(login: 'secret_admin')
+    @cve = make_cve
+    @env = @cve.lifecycle_environment
+    @organization = @env.organization
+
+    # Create a host with subscription facet but no insights facet
+    @host_without_facet = FactoryBot.create(
+      :host,
+      :with_subscription,
+      :with_content,
+      content_view: @cve.content_view,
+      lifecycle_environment: @env,
+      organization: @organization
+    )
+
+    # Create a host with both subscription and insights facets
+    @host_with_facet = FactoryBot.create(
+      :host,
+      :with_subscription,
+      :with_content,
+      content_view: @cve.content_view,
+      lifecycle_environment: @env,
+      organization: @organization
+    )
+    @host_with_facet.build_insights(uuid: @host_with_facet.subscription_facet.uuid)
+    @host_with_facet.insights.save!
+  end
+
+  test 'creates insights facets for hosts without them' do
+    assert_nil @host_without_facet.insights
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    action = run_action(action)
+
+    @host_without_facet.reload
+    assert_not_nil @host_without_facet.insights
+    assert_equal @host_without_facet.subscription_facet.uuid, @host_without_facet.insights.uuid
+    assert_match(/Missing Insights facets created: 1/, action.output[:result])
+  end
+
+  test 'does not create duplicate facets for hosts that already have them' do
+    original_uuid = @host_with_facet.insights.uuid
+    original_id = @host_with_facet.insights.id
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    run_action(action)
+
+    @host_with_facet.reload
+    assert_equal original_id, @host_with_facet.insights.id
+    assert_equal original_uuid, @host_with_facet.insights.uuid
+  end
+
+  test 'handles organization with no missing facets' do
+    # Create insights facet for the host that was missing one
+    @host_without_facet.build_insights(uuid: @host_without_facet.subscription_facet.uuid)
+    @host_without_facet.insights.save!
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    action = run_action(action)
+
+    assert_match(/There were no missing Insights facets/, action.output[:result])
+  end
+
+  test 'creates multiple facets when multiple hosts are missing them' do
+    # Remove the insights facet from the host that has one
+    @host_with_facet.insights.destroy
+    @host_with_facet.reload
+
+    assert_nil @host_without_facet.insights
+    assert_nil @host_with_facet.insights
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    action = run_action(action)
+
+    @host_without_facet.reload
+    @host_with_facet.reload
+    assert_not_nil @host_without_facet.insights
+    assert_not_nil @host_with_facet.insights
+    # After the bug fix, the count should correctly show 2 hosts
+    assert_match(/Missing Insights facets created: 2/, action.output[:result])
+  end
+
+  test 'logs result message' do
+    Rails.logger.expects(:debug).with(regexp_matches(/Missing Insights facets created/))
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    run_action(action)
+  end
+
+  test 'correctly counts facets across multiple batches' do
+    # Remove existing insights facet
+    @host_with_facet.insights.destroy
+    @host_with_facet.reload
+
+    # Stub the batch size to force multiple batches with just 2 hosts
+    ForemanInventoryUpload.stubs(:slice_size).returns(1)
+
+    assert_nil @host_without_facet.insights
+    assert_nil @host_with_facet.insights
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+    action = run_action(action)
+
+    @host_without_facet.reload
+    @host_with_facet.reload
+    assert_not_nil @host_without_facet.insights
+    assert_not_nil @host_with_facet.insights
+    # Count should be 2 even though processed in 2 separate batches
+    assert_match(/Missing Insights facets created: 2/, action.output[:result])
+  end
+
+  test 'handles error when InsightsFacet.upsert_all fails' do
+    # Stub upsert_all to raise an exception
+    InsightsFacet.stubs(:upsert_all).raises(StandardError.new('upsert failed'))
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      @organization.id
+    )
+
+    assert_raises(StandardError) do
+      run_action(action)
+    end
+  end
+end

data/test/jobs/exponential_backoff_test.rb

@@ -2,7 +2,7 @@ require 'test_plugin_helper'
 require 'foreman_tasks/test_helpers'
 
 class ExponentialBackoffTest < ActiveSupport::TestCase
-  include ForemanTasks::TestHelpers::WithInThreadExecutor
+  include Dynflow::Testing::Factories
 
   class TestAction < ::Actions::EntryAction
     include ::ForemanRhCloud::Async::ExponentialBackoff
@@ -19,28 +19,29 @@ class ExponentialBackoffTest < ActiveSupport::TestCase
   test 'executes an action once' do
     TestAction.any_instance.expects(:action_callback).returns(->(instance) { instance.done! })
 
-    ForemanTasks.sync_task(TestAction)
+    action = create_and_plan_action(TestAction)
+    run_action(action)
   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')
+        raise StandardError.new('Foo')
       end
     )
 
-    ForemanTasks.sync_task(TestAction)
+    action = create_and_plan_action(TestAction)
+    run_action(action)
   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)
+    TestAction.any_instance.expects(:action_callback).raises(StandardError.new('Foo')).at_least_once
 
-    ForemanTasks.sync_task(TestAction)
-  rescue ForemanTasks::TaskError => ex
-    assert ex.aggregated_message =~ /Foo/
+    action = create_and_plan_action(TestAction)
+    run_action(action)
   end
 end

data/test/jobs/generate_host_report_test.rb

@@ -0,0 +1,100 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class GenerateHostReportTest < ActiveSupport::TestCase
+  include Dynflow::Testing::Factories
+  include FolderIsolation
+
+  let(:organization) { FactoryBot.create(:organization) }
+  let(:base_folder) { @tmpdir }
+  let(:filter) { '' }
+
+  setup do
+    # Stub the ArchivedReport generator
+    @mock_generator = mock('archived_report_generator')
+    @mock_generator.stubs(:render)
+    ForemanInventoryUpload::Generators::ArchivedReport.stubs(:new).returns(@mock_generator)
+  end
+
+  test 'plan sets target path correctly' do
+    expected_archive_name = ForemanInventoryUpload.facts_archive_name(organization.id, filter)
+    expected_target = File.join(base_folder, expected_archive_name)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      filter
+    )
+
+    assert_equal expected_target, action.input[:target]
+  end
+
+  test 'run generates report archive' do
+    expected_target = File.join(base_folder, ForemanInventoryUpload.facts_archive_name(organization.id, filter))
+
+    ForemanInventoryUpload::Generators::ArchivedReport.expects(:new).with(expected_target).returns(@mock_generator)
+    @mock_generator.expects(:render).with(organization: organization.id, filter: filter)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      filter
+    )
+    action = run_action(action)
+
+    assert_match(/Generated #{Regexp.escape(expected_target)} for organization id #{organization.id}/, action.output[:result])
+  end
+
+  test 'generates report with filter' do
+    filter_value = 'id=123'
+    expected_target = File.join(base_folder, ForemanInventoryUpload.facts_archive_name(organization.id, filter_value))
+
+    ForemanInventoryUpload::Generators::ArchivedReport.expects(:new).with(expected_target).returns(@mock_generator)
+    @mock_generator.expects(:render).with(organization: organization.id, filter: filter_value)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      filter_value
+    )
+    action = run_action(action)
+
+    assert_match(/organization id #{organization.id}/, action.output[:result])
+  end
+
+  test 'stores organization_id and filter in input' do
+    filter_value = 'name~test'
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      filter_value
+    )
+
+    assert_equal organization.id, action.input[:organization_id]
+    assert_equal filter_value, action.input[:filter]
+    assert_equal base_folder, action.input[:base_folder]
+  end
+
+  test 'handles ArchivedReport generator failure' do
+    expected_target = File.join(base_folder, ForemanInventoryUpload.facts_archive_name(organization.id, filter))
+
+    ForemanInventoryUpload::Generators::ArchivedReport.expects(:new).with(expected_target).returns(@mock_generator)
+    @mock_generator.expects(:render).with(organization: organization.id, filter: filter).raises(StandardError.new('Report generation failed'))
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      filter
+    )
+
+    assert_raises(StandardError) do
+      run_action(action)
+    end
+  end
+end

data/test/jobs/generate_report_job_test.rb

@@ -0,0 +1,146 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class GenerateReportJobTest < ActiveSupport::TestCase
+  include Dynflow::Testing::Factories
+  include Dynflow::Testing::Assertions
+
+  let(:organization) { FactoryBot.create(:organization) }
+  let(:base_folder) { Dir.mktmpdir }
+
+  setup do
+    # Stub settings
+    Setting.stubs(:[]).with(:subscription_connection_enabled).returns(true)
+    Setting.stubs(:[]).with("foreman_tasks_sync_task_timeout").returns(120)
+    Setting.stubs(:[]).with(:content_default_http_proxy).returns(nil)
+    Setting.stubs(:[]).with(:http_proxy).returns(nil)
+  end
+
+  teardown do
+    FileUtils.remove_entry base_folder if Dir.exist?(base_folder)
+  end
+
+  test 'disconnected parameter defaults to false' do
+    # When disconnected defaults to false and subscription_connection is enabled,
+    # QueueForUploadJob should be scheduled
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id
+    )
+
+    assert_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'disconnected parameter can be set to true explicitly' do
+    # When disconnected is explicitly true, QueueForUploadJob should NOT be scheduled
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      true
+    )
+
+    refute_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'disconnected parameter can be set to false explicitly' do
+    # When disconnected is explicitly false and subscription_connection is enabled,
+    # QueueForUploadJob should be scheduled
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false
+    )
+
+    assert_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'skips upload when subscription_connection_enabled is false' do
+    Setting.stubs(:[]).with(:subscription_connection_enabled).returns(false)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false
+    )
+
+    refute_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'schedules upload when disconnected is false and subscription_connection is enabled' do
+    Setting.stubs(:[]).with(:subscription_connection_enabled).returns(true)
+
+    expected_archive_name = ForemanInventoryUpload.facts_archive_name(organization.id, nil)
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::QueueForUploadJob,
+      base_folder,
+      expected_archive_name,
+      organization.id
+    )
+  end
+
+  test 'handles hosts_filter parameter' do
+    hosts_filter = 'name~test'
+    expected_archive_name = ForemanInventoryUpload.facts_archive_name(organization.id, hosts_filter)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false,
+      hosts_filter
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::QueueForUploadJob,
+      base_folder,
+      expected_archive_name,
+      organization.id
+    )
+  end
+
+  test 'output_label generates correct label' do
+    label = ForemanInventoryUpload::Async::GenerateReportJob.output_label('test_org')
+    assert_equal 'report_for_test_org', label
+  end
+
+  test 'output_label with filter includes parameterized filter' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false,
+      'name~production'
+    )
+
+    # The output label should include organization id and parameterized filter
+    expected_label = "report_for_#{organization.id}[name-production]"
+    assert_equal expected_label, action.input[:instance_label]
+  end
+
+  test 'output_label without filter includes only organization id' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::GenerateReportJob,
+      base_folder,
+      organization.id,
+      false,
+      ''
+    )
+
+    # The output label should include only organization id when filter is empty
+    expected_label = "report_for_#{organization.id}"
+    assert_equal expected_label, action.input[:instance_label]
+  end
+end

data/test/jobs/host_inventory_report_job_test.rb

@@ -0,0 +1,244 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class HostInventoryReportJobTest < ActiveSupport::TestCase
+  include Dynflow::Testing::Factories
+  include Dynflow::Testing::Assertions
+
+  let(:organization) { FactoryBot.create(:organization) }
+  let(:base_folder) { Dir.mktmpdir }
+  let(:hosts_filter) { '' }
+  let(:upload) { true }
+
+  teardown do
+    FileUtils.remove_entry base_folder if Dir.exist?(base_folder)
+  end
+
+  test 'plan schedules GenerateHostReport action' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      upload
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      hosts_filter
+    )
+  end
+
+  test 'plan schedules QueueForUploadJob when upload is true' do
+    expected_archive_name = ForemanInventoryUpload.facts_archive_name(organization.id, hosts_filter)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      true
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::QueueForUploadJob,
+      base_folder,
+      expected_archive_name,
+      organization.id
+    )
+  end
+
+  test 'plan skips QueueForUploadJob when upload is false' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      false
+    )
+
+    refute_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'plan defaults upload to true when not specified' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter
+    )
+
+    assert_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+  end
+
+  test 'plan schedules CreateMissingInsightsFacets when IoP is enabled' do
+    ForemanRhCloud.stubs(:with_iop_smart_proxy?).returns(true)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      upload
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::CreateMissingInsightsFacets,
+      organization.id
+    )
+  end
+
+  test 'plan skips CreateMissingInsightsFacets when IoP is disabled' do
+    ForemanRhCloud.stubs(:with_iop_smart_proxy?).returns(false)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      upload
+    )
+
+    refute_action_planned(action, ForemanInventoryUpload::Async::CreateMissingInsightsFacets)
+  end
+
+  test 'plan schedules all three actions with IoP enabled and upload true' do
+    ForemanRhCloud.stubs(:with_iop_smart_proxy?).returns(true)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      true
+    )
+
+    assert_action_planned(action, ForemanInventoryUpload::Async::GenerateHostReport)
+    assert_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+    assert_action_planned(action, ForemanInventoryUpload::Async::CreateMissingInsightsFacets)
+  end
+
+  test 'plan schedules only generation and facets with IoP enabled and upload false' do
+    ForemanRhCloud.stubs(:with_iop_smart_proxy?).returns(true)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      false
+    )
+
+    assert_action_planned(action, ForemanInventoryUpload::Async::GenerateHostReport)
+    refute_action_planned(action, ForemanInventoryUpload::Async::QueueForUploadJob)
+    assert_action_planned(action, ForemanInventoryUpload::Async::CreateMissingInsightsFacets)
+  end
+
+  test 'humanized_name returns correct string' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      hosts_filter,
+      upload
+    )
+
+    assert_equal 'Host inventory report job', action.humanized_name
+  end
+
+  test 'handles empty hosts_filter parameter' do
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      '',
+      upload
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      ''
+    )
+  end
+
+  test 'handles custom hosts_filter parameter' do
+    custom_filter = 'name~production'
+    expected_archive_name = ForemanInventoryUpload.facts_archive_name(organization.id, custom_filter)
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      custom_filter,
+      upload
+    )
+
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::GenerateHostReport,
+      base_folder,
+      organization.id,
+      custom_filter
+    )
+    assert_action_planned_with(
+      action,
+      ForemanInventoryUpload::Async::QueueForUploadJob,
+      base_folder,
+      expected_archive_name,
+      organization.id
+    )
+  end
+
+  test 'handles invalid hosts_filter parameter' do
+    invalid_filter = 'name~~'
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      invalid_filter,
+      upload
+    )
+
+    # Job should still plan even with invalid filter syntax
+    assert_action_planned(action, ForemanInventoryUpload::Async::GenerateHostReport)
+  end
+
+  test 'handles potentially malicious hosts_filter parameter' do
+    malicious_filter = "'; DROP TABLE hosts; --"
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      malicious_filter,
+      upload
+    )
+
+    # Job should handle malicious input safely (filter is parameterized)
+    assert_action_planned(action, ForemanInventoryUpload::Async::GenerateHostReport)
+  end
+
+  test 'handles non-matching hosts_filter parameter' do
+    non_matching_filter = 'name~doesnotexist'
+
+    action = create_and_plan_action(
+      ForemanInventoryUpload::Async::HostInventoryReportJob,
+      base_folder,
+      organization.id,
+      non_matching_filter,
+      upload
+    )
+
+    # Job should plan successfully even if filter matches no hosts
+    assert_action_planned(action, ForemanInventoryUpload::Async::GenerateHostReport)
+  end
+end

data/test/jobs/insights_client_status_aging_test.rb

@@ -2,7 +2,7 @@ require 'test_plugin_helper'
 require 'foreman_tasks/test_helpers'
 
 class InsightsClientStatusAgingTest < ActiveSupport::TestCase
-  include ForemanTasks::TestHelpers::WithInThreadExecutor
+  include Dynflow::Testing::Factories
 
   setup do
     User.current = User.find_by(login: 'secret_admin')
@@ -21,7 +21,8 @@ class InsightsClientStatusAgingTest < ActiveSupport::TestCase
     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)
+    action = create_and_plan_action(InsightsCloud::Async::InsightsClientStatusAging)
+    run_action(action)
 
     @hosts.each(&:reload)