foreman_rh_cloud 14.1.2 → 14.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8561ef219578d2be3678f2576fba36e1cb3f2a91aab82b5438369aa08ddd0a05
-  data.tar.gz: 6abcf201d049e27b6dc90fef6f5094a0f6f72d337f49aa6cdf328d8aa92e3516
+  metadata.gz: 89c6b782cc34fb3ffc4f13ad66c435c5729028df995e7bdba1c15e668a72fe89
+  data.tar.gz: 356fb55567950b341b4509f6ee39e30b24127c695b3924765070167800595f44
 SHA512:
-  metadata.gz: cf0448da7b88a0ddca0e2726805b9c0fb6e5356651e64ac09d0a18cd16d05a393dab07f4a19c445948a39fd1a4111e17c275c8ffaf33df974cc80a9af1693ba0
-  data.tar.gz: 7e780f06f64dc1f5042a10ec48f3c397d5b767bc5b6ac2c08ac7d9cc059518df4415ee442b37216777a471a0286d59a73a56142a6b80cb10b04213d477a9c4d7
+  metadata.gz: 8bdb9ff78ed0950bd67f5bcc1483a0f2568af9a3462633ef6fc25d061bf942712d416d717f43e3dcef448dddb11cc6f7b9ad1fe62d6530ad2dbf44af3a3eb4a6
+  data.tar.gz: f55334cb175a624ae8aeb21242b609ce8af3c49061c7e09b460b46fef3d3239cab42232c0c52eb043ed345a661b331409545344f24e89e46e3fb9a782666e1bc

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -106,6 +106,7 @@ module ForemanInventoryUpload
 
       def host_ips(host)
         # Determines and returns the IP addresses associated with a host, applying obfuscation if enabled.
+        return {} if host.nil?
 
         # If IP obfuscation is enabled for the host return a representation of obfuscated IP addresses.
         return obfuscated_ips(host) if obfuscate_ips?(host)
@@ -155,10 +156,29 @@ module ForemanInventoryUpload
 
       def hostname_match
         bash_hostname = `uname -n`.chomp
-        foreman_hostname = ForemanRhCloud.foreman_host&.name
-        if bash_hostname == foreman_hostname
-          fqdn(ForemanRhCloud.foreman_host)
-        elsif Setting[:obfuscate_inventory_hostnames]
+        foreman_host = ForemanRhCloud.foreman_host
+
+        # If bash hostname matches foreman_host, use fqdn
+        if foreman_host && bash_hostname == foreman_host.name
+          return fqdn(foreman_host)
+        end
+
+        # If no foreman_host, try foreman_host_name from Setting[:foreman_url]
+        unless foreman_host
+          foreman_hostname_from_setting = ForemanRhCloud.foreman_host_name
+          if foreman_hostname_from_setting
+            # Apply obfuscation if enabled
+            return obfuscate_fqdn(foreman_hostname_from_setting) if Setting[:obfuscate_inventory_hostnames]
+
+            return foreman_hostname_from_setting
+          end
+          # Otherwise fall through to bash_hostname below
+          # NOTE: Containerized foremanctl setups must configure Setting[:foreman_url]
+          # as bash hostname may not be available or meaningful in containers
+        end
+
+        # Fallback to bash hostname (with obfuscation if enabled)
+        if Setting[:obfuscate_inventory_hostnames]
           obfuscate_fqdn(bash_hostname)
         else
           bash_hostname
@@ -166,6 +186,8 @@ module ForemanInventoryUpload
       end
 
       def bios_uuid(host)
+        return nil if host.nil?
+
         value = fact_value(host, 'dmi::system::uuid') || ''
         uuid_value(value)
       end

data/lib/foreman_inventory_upload.rb

@@ -96,7 +96,14 @@ module ForemanInventoryUpload
   end
 
   def self.inventory_self_url
-    inventory_base_url + "?hostname_or_id=#{ForemanRhCloud.foreman_host.fqdn}"
+    host = ForemanRhCloud.foreman_host
+    hostname = host ? host.fqdn : ForemanRhCloud.foreman_host_name
+    if hostname.nil?
+      Rails.logger.warn("Cannot determine Foreman hostname for inventory sync. " \
+                        "Please configure Setting[:foreman_url]. " \
+                        "Containerized setups must explicitly set this.")
+    end
+    inventory_base_url + "?hostname_or_id=#{hostname}"
   end
 
   def self.host_by_id_url(host_uuid)

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '14.1.2'.freeze
+  VERSION = '14.1.3'.freeze
 end

data/lib/foreman_rh_cloud.rb

@@ -84,23 +84,50 @@ module ForemanRhCloud
 
   # For testing purposes we can override the default hostname with an environment variable SATELLITE_RH_CLOUD_FOREMAN_HOST
   def self.foreman_host
-    @foreman_host ||= begin
-      fullname = foreman_host_name
-      ::Host.unscoped.friendly.find(fullname)
-    rescue ActiveRecord::RecordNotFound
-      # fullname didn't work. Let's try shortname
+    return @foreman_host if defined?(@foreman_host)
+
+    fullname = foreman_host_name
+    return @foreman_host = nil unless fullname
+
+    # Try fullname first
+    host = ::Host.unscoped.friendly.where(name: fullname).first
+
+    # If not found, try shortname
+    if host.nil?
       shortname = /(?<shortname>[^\.]*)\.?.*/.match(fullname)[:shortname]
-      ::Host.unscoped.friendly.find(shortname)
+      host = ::Host.unscoped.friendly.where(name: shortname).first
     end
+
+    @foreman_host = host
   end
 
   def self.foreman_host_name
-    ENV['SATELLITE_RH_CLOUD_FOREMAN_HOST'] || marked_foreman_host&.name || ::SmartProxy.default_capsule.name
+    ENV['SATELLITE_RH_CLOUD_FOREMAN_HOST'] || marked_foreman_host&.name || foreman_url_hostname
+  end
+
+  def self.foreman_url_hostname
+    return nil unless Setting[:foreman_url]
+
+    begin
+      # Ensure setting is a string to avoid TypeError from URI.parse
+      url = Setting[:foreman_url].to_s
+      URI.parse(url).host
+    rescue URI::InvalidURIError, ArgumentError, TypeError => e
+      Rails.logger.warn("Invalid foreman_url setting: #{e.message}")
+      nil
+    end
   end
 
   def self.marked_foreman_host
-    ::Host.unscoped.search_for('infrastructure_facet.foreman = true').first
-  rescue ScopedSearch::QueryNotSupported
+    # Find host with infrastructure_facet.foreman_instance = true
+    # Facets use a special mechanism in Foreman, so we query the facet table directly
+    return nil unless defined?(HostFacets::InfrastructureFacet)
+
+    facet = HostFacets::InfrastructureFacet.find_by(foreman_instance: true)
+    facet&.host
+  rescue ActiveRecord::StatementInvalid => e
+    # Table might not exist yet during migrations
+    Rails.logger.debug("Could not query marked foreman host: #{e.message}")
     nil
   end
 

data/lib/insights_cloud/async/insights_generate_notifications.rb

@@ -13,7 +13,16 @@ module InsightsCloud
       end
 
       def add_satellite_notifications
-        hits_count = InsightsHit.where(host_id: foreman_host.id).count
+        host = foreman_host
+
+        # Skip if no Foreman host record exists
+        unless host
+          logger.debug("Skipping Insights notifications: no Foreman host record found")
+          blueprint&.notifications&.destroy_all
+          return
+        end
+
+        hits_count = InsightsHit.where(host_id: host.id).count
 
         # Remove stale notifications
         blueprint.notifications.destroy_all

data/lib/inventory_sync/async/inventory_self_host_sync.rb

@@ -4,7 +4,14 @@ module InventorySync
       set_callback :step, :around, :create_facets
 
       def plan
-        super(ForemanRhCloud.foreman_host.organization)
+        host = ForemanRhCloud.foreman_host
+
+        if host.nil?
+          logger.warn("Skipping self-host inventory sync: no Foreman host record found.")
+          return
+        end
+
+        super(host.organization)
       end
 
       def create_facets
@@ -22,7 +29,10 @@ module InventorySync
       private
 
       def add_missing_insights_facet(uuids_hash)
-        facet = InsightsFacet.find_or_create_by(host_id: ForemanRhCloud.foreman_host.id) do |facet|
+        host = ForemanRhCloud.foreman_host
+        return unless host # Guard against nil
+
+        facet = InsightsFacet.find_or_create_by(host_id: host.id) do |facet|
           facet.uuid = uuids_hash.values.first
         end
 

data/package.json

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

data/test/jobs/insights_generate_notifications_test.rb

@@ -0,0 +1,26 @@
+require 'test_plugin_helper'
+require 'foreman_tasks/test_helpers'
+
+class InsightsGenerateNotificationsTest < ActiveSupport::TestCase
+  include Dynflow::Testing::Factories
+
+  setup do
+    User.current = User.find_by(login: 'secret_admin')
+  end
+
+  test 'skips notifications when foreman_host is nil' do
+    ForemanRhCloud.stubs(:foreman_host).returns(nil)
+
+    # Ensure blueprint exists or create it
+    NotificationBlueprint.find_or_create_by(name: 'insights_satellite_hits') do |bp|
+      bp.message = 'Test message'
+      bp.level = 'info'
+      bp.expires_in = 7.days
+    end
+
+    plan = ForemanTasks.sync_task(InsightsCloud::Async::InsightsGenerateNotifications)
+
+    # Should not raise an error, task completes successfully
+    assert_includes ['success', 'stopped'], plan.state, "Task should complete without error"
+  end
+end

data/test/jobs/inventory_self_host_sync_test.rb

@@ -106,4 +106,13 @@ class InventorySelfHostSyncTest < ActiveSupport::TestCase
 
     assert_equal @host1_inventory_id, @host1.insights.uuid
   end
+
+  test 'skips sync when foreman_host is nil' do
+    ForemanRhCloud.stubs(:foreman_host).returns(nil)
+
+    plan = ForemanTasks.sync_task(InventorySync::Async::InventorySelfHostSync)
+
+    # Task should be stopped (not executed) when host is nil, not failed
+    assert_equal 'stopped', plan.state
+  end
 end

data/test/unit/foreman_rh_cloud_self_host_test.rb

@@ -2,8 +2,9 @@ require 'test_plugin_helper'
 
 class ForemanRhCloudSelfHostTest < ActiveSupport::TestCase
   setup do
-    # reset cached value
-    ForemanRhCloud.instance_variable_set(:@foreman_host, nil)
+    # reset cached value - must remove the variable entirely, not just set to nil
+    ForemanRhCloud.remove_instance_variable(:@foreman_host) if ForemanRhCloud.instance_variable_defined?(:@foreman_host)
+    ENV.delete('SATELLITE_RH_CLOUD_FOREMAN_HOST')
   end
 
   test 'finds host by fullname' do
@@ -32,4 +33,51 @@ class ForemanRhCloudSelfHostTest < ActiveSupport::TestCase
 
     assert_equal @host, actual
   end
+
+  test 'returns nil when host does not exist' do
+    ForemanRhCloud.expects(:foreman_host_name).returns('nonexistent.example.com')
+
+    actual = ForemanRhCloud.foreman_host
+
+    assert_nil actual
+  end
+
+  test 'returns nil and does not query Host when foreman_host_name is nil' do
+    ForemanRhCloud.stubs(:foreman_host_name).returns(nil)
+    ::Host.unscoped.friendly.expects(:where).never
+
+    assert_nil ForemanRhCloud.foreman_host
+  end
+
+  test 'caches nil value to avoid repeated lookups' do
+    ForemanRhCloud.expects(:foreman_host_name).once.returns('nonexistent.example.com')
+
+    2.times { ForemanRhCloud.foreman_host }
+  end
+
+  test 'extracts hostname from foreman_url setting' do
+    Setting[:foreman_url] = 'https://satellite.example.com'
+
+    actual = ForemanRhCloud.foreman_url_hostname
+
+    assert_equal 'satellite.example.com', actual
+  end
+
+  test 'handles invalid foreman_url gracefully' do
+    # Stub Setting to return invalid URL without validation
+    Setting.stubs(:[]).with(:foreman_url).returns('not a valid url')
+
+    actual = ForemanRhCloud.foreman_url_hostname
+
+    assert_nil actual
+  end
+
+  test 'foreman_host_name uses foreman_url when marked_foreman_host is nil' do
+    ForemanRhCloud.expects(:marked_foreman_host).returns(nil)
+    ForemanRhCloud.expects(:foreman_url_hostname).returns('satellite.example.com')
+
+    actual = ForemanRhCloud.foreman_host_name
+
+    assert_equal 'satellite.example.com', actual
+  end
 end

data/test/unit/metadata_generator_test.rb

@@ -2,7 +2,8 @@ require 'test_plugin_helper'
 
 class MetadataGeneratorTest < ActiveSupport::TestCase
   setup do
-    ForemanRhCloud.instance_variable_set(:@foreman_host, nil)
+    # reset cached value - must remove the variable entirely, not just set to nil
+    ForemanRhCloud.remove_instance_variable(:@foreman_host) if ForemanRhCloud.instance_variable_defined?(:@foreman_host)
   end
 
   test 'generates an empty report' do
@@ -64,4 +65,26 @@ class MetadataGeneratorTest < ActiveSupport::TestCase
     assert_not_nil(slice = slices['test_12345'])
     assert_equal 3, slice['number_hosts']
   end
+
+  test 'generates metadata when foreman_host is nil' do
+    ForemanRhCloud.stubs(:foreman_host).returns(nil)
+    ForemanRhCloud.stubs(:foreman_host_name).returns('satellite.example.com')
+
+    generator = ForemanInventoryUpload::Generators::Metadata.new
+
+    # Should not raise an error
+    json_str = nil
+    assert_nothing_raised do
+      json_str = generator.render do
+      end
+    end
+
+    # Verify hostname is from foreman_host_name
+    actual = JSON.parse(json_str.join("\n"))
+    assert_equal 'satellite.example.com', actual['reporting_host_name']
+    # Verify IP and BIOS UUID fields are nil when host is nil
+    # This is acceptable per SAT-25889 - cloud services don't rely on these fields
+    assert_nil actual['reporting_host_ips']
+    assert_nil actual['reporting_host_bios_uuid']
+  end
 end

data/webpack/ForemanInventoryUpload/Components/AccountList/Components/EmptyResults/__tests__/EmptyResults.test.js

@@ -1,13 +1,14 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
 import EmptyResults from '../EmptyResults';
 
-const fixtures = {
-  'render without Props': {},
-  /** fixtures, props for the component */
-};
-
 describe('EmptyResults', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(EmptyResults, fixtures));
+  it('renders the empty results message', () => {
+    render(<EmptyResults />);
+    expect(
+      screen.getByText(
+        "Oops! Couldn't find organization that matches your query"
+      )
+    ).toBeTruthy();
+  });
 });

data/webpack/ForemanInventoryUpload/Components/AccountList/Components/EmptyState/__tests__/EmptyState.test.js

@@ -1,13 +1,17 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
 import EmptyState from '../EmptyState';
 
-const fixtures = {
-  'render without Props': {},
-  /** fixtures, props for the component */
-};
-
 describe('EmptyState', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(EmptyState, fixtures));
+  it('renders fetching data message', () => {
+    render(<EmptyState />);
+    expect(
+      screen.getByText('Fetching data about your accounts')
+    ).toBeTruthy();
+  });
+
+  it('renders loading indicator', () => {
+    render(<EmptyState />);
+    expect(screen.getByText('Loading...')).toBeTruthy();
+  });
 });

data/webpack/ForemanInventoryUpload/Components/AccountList/Components/ErrorState/__tests__/ErrorState.test.js

@@ -1,13 +1,24 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
 import ErrorState from '../ErrorState';
 
-const fixtures = {
-  'render without Props': {},
-  /** fixtures, props for the component */
-};
-
 describe('ErrorState', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(ErrorState, fixtures));
+  it('renders the error message heading', () => {
+    render(<ErrorState error="Something went wrong" />);
+    expect(
+      screen.getByText(
+        'Encountered an error while trying to access the server:'
+      )
+    ).toBeTruthy();
+  });
+
+  it('renders the error description', () => {
+    render(<ErrorState error="Connection refused" />);
+    expect(screen.getByText('Connection refused')).toBeTruthy();
+  });
+
+  it('renders with empty error by default', () => {
+    const { container } = render(<ErrorState />);
+    expect(container.querySelector('.error_description')).toBeTruthy();
+  });
 });

data/webpack/ForemanInventoryUpload/Components/AccountList/Components/ListItem/__tests__/ListItem.test.js

@@ -1,13 +1,36 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import { Accordion } from '@patternfly/react-core';
 import ListItem from '../ListItem';
-import { props } from '../ListItem.fixtures';
 
-const fixtures = {
-  'render with Props': props,
-};
+jest.mock('../../../../Dashboard', () => () => null);
+
+const renderListItem = props =>
+  render(
+    <Accordion>
+      <ListItem {...props} />
+    </Accordion>
+  );
 
 describe('ListItem', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(ListItem, fixtures));
+  const defaultProps = {
+    label: 'test-org',
+    account: {
+      generated_status: 'unknown',
+      uploaded_status: 'unknown',
+      id: 1,
+    },
+  };
+
+  it('renders the account label', () => {
+    renderListItem(defaultProps);
+    expect(screen.getByText('test-org')).toBeTruthy();
+  });
+
+  it('renders Generated and Uploaded status labels', () => {
+    renderListItem(defaultProps);
+    expect(screen.getByText('Generated')).toBeTruthy();
+    expect(screen.getByText('Uploaded')).toBeTruthy();
+  });
+
 });

data/webpack/ForemanInventoryUpload/Components/AccountList/Components/ListItemStatus/__tests__/ListItemStatus.test.js

@@ -1,14 +1,30 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
 import ListItemStatus from '../ListItemStatus';
-import { props } from '../ListItemStatus.fixtures';
-
-const fixtures = {
-  'render without Props': {},
-  'render with Props': props,
-};
 
 describe('ListItemStatus', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(ListItemStatus, fixtures));
+  it('renders Generated and Uploaded labels', () => {
+    render(<ListItemStatus />);
+    expect(screen.getByText('Generated')).toBeTruthy();
+    expect(screen.getByText('Uploaded')).toBeTruthy();
+  });
+
+  it('shows dash placeholders for unknown status', () => {
+    render(
+      <ListItemStatus
+        account={{ generated_status: 'unknown', uploaded_status: 'unknown' }}
+      />
+    );
+    expect(screen.getAllByText('--')).toHaveLength(2);
+  });
+
+  it('renders with provided account statuses', () => {
+    render(
+      <ListItemStatus
+        account={{ generated_status: 'success', uploaded_status: 'running' }}
+      />
+    );
+    expect(screen.getByText('Generated')).toBeTruthy();
+    expect(screen.getByText('Uploaded')).toBeTruthy();
+  });
 });

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

@@ -1,14 +1,38 @@
-import { testComponentSnapshotsWithFixtures } from '@theforeman/test';
-
+import React from 'react';
+import { render, screen } from '@testing-library/react';
 import AccountList from '../AccountList';
-import { props } from '../AccountList.fixtures';
+import { accounts } from '../AccountList.fixtures';
 
-const fixtures = {
-  'render with props': props,
-  'show empty results': { ...props, filterTerm: 'not_matching_term' },
-};
+jest.mock('../Components/ListItem', () => ({ label }) => (
+  <div>{label}</div>
+));
 
 describe('AccountList', () => {
-  describe('rendering', () =>
-    testComponentSnapshotsWithFixtures(AccountList, fixtures));
+  it('renders account labels', () => {
+    render(<AccountList accounts={accounts} />);
+    Object.keys(accounts).forEach(label => {
+      expect(screen.getByText(label)).toBeTruthy();
+    });
+  });
+
+  it('shows empty results when filterTerm matches nothing', () => {
+    render(<AccountList accounts={accounts} filterTerm="not_matching_term" />);
+    expect(
+      screen.getByText(
+        "Oops! Couldn't find organization that matches your query"
+      )
+    ).toBeTruthy();
+  });
+
+  it('shows empty state when accounts are empty', () => {
+    render(<AccountList accounts={{}} />);
+    expect(
+      screen.getByText('Fetching data about your accounts')
+    ).toBeTruthy();
+  });
+
+  it('shows error state when error is present', () => {
+    render(<AccountList accounts={{}} error="Server error" />);
+    expect(screen.getByText('Server error')).toBeTruthy();
+  });
 });