foreman_rh_cloud 10.0.5 → 10.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfabc05d2ec5effb2a007e85471ba31e9d0067495fcbf52d07bb37b4f3c1a15c
-  data.tar.gz: c5f0db2ca590193d014d69358882c0abf98adf523158ceec65536391b454ca23
+  metadata.gz: 65251fdae0087f5b4a2b1601fa9fb40ac63874fb48280614de3efb7fb2807e11
+  data.tar.gz: 654748bf9d1270e27118968d2b7ab8dfa99b133087312006f8cea4a745e94543
 SHA512:
-  metadata.gz: fd794c63904449ceb0f7b4b2d02de6e8b97cdde7745c24a5d6a02d52047fc036d3b995e11bca5aa0cf241a8b2def0f6efda15e810cd2dfdb9a5060e1cfe984bf
-  data.tar.gz: 73d24b976d3a00150696e403d5bd5f134faa1c60ca8b75063a0ac12e57da85427c6a301faf96d502e736f515c60e6bb6b25627c056909698b3fe9fac17751da7
+  metadata.gz: da7ed0469f82a183a824b52a72fc6c85885fea0491bef66b4a473eeb113a6b80aba0b719e91d928ab9dc2b658ebf632f2cb80babaf918002a5f44dd54565ab46
+  data.tar.gz: e8c36cf6761e02085bc28c925095b9581eb5f94718bab25ed7bf083bb8d1cb79c33f3a95249a051379aef29ab38ea623b38e8df194bccdb659ad2a183ef7b5b7

data/README.md

@@ -15,7 +15,7 @@ for how to install Foreman plugins
 
 #### Inventory upload
 
-In UI: Configure -> Inventory Upload -> Restart
+In UI: Insights -> Inventory Upload -> select the organization -> Generate and upload report
 
 From command-line:
 
@@ -38,7 +38,7 @@ From command-line:
 
 #### Fetch hosts remediation data
 
-In UI: Configure -> Insights -> Sync now
+In UI: Insights -> Recommendations -> Sync recommendations (under the vertical ellipsis)
 
 From command-line:
 
@@ -46,7 +46,7 @@ From command-line:
 
 #### Synchronize inventory status
 
-In UI: Configure -> Inventory Upload -> Sync inventory status
+In UI: Insights -> Inventory Upload -> Sync all inventory status
 
 From command-line:
 

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

@@ -16,29 +16,41 @@ module InsightsCloud::Api
     # 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)
+      begin
+        @cloud_response = ::ForemanRhCloud::CloudRequestForwarder.new.forward_request(request, controller_name, @branch_id, certs)
+      rescue RestClient::Exceptions::Timeout => e
+        response_obj = e.response.presence || e.exception
+        return render json: { message: response_obj.to_s, error: response_obj.to_s }, status: :gateway_timeout
+      rescue RestClient::Unauthorized => e
+        logger.warn("Forwarding request auth error: #{e}")
+        message = 'Authentication to the Insights Service failed.'
+        return render json: { message: message, error: message }, status: :unauthorized
+      rescue RestClient::NotModified => e
+        logger.info("Forwarding request not modified: #{e}")
+        message = 'Cloud request not modified'
+        return render json: { message: message, error: message }, status: :not_modified
+      rescue RestClient::ExceptionWithResponse => e
+        response_obj = e.response.presence || e.exception
+        code = response_obj.try(:code) || response_obj.try(:http_code) || 500
+        message = 'Cloud request failed'
 
-      return render json: { message: @cloud_response.to_s }, status: :gateway_timeout if @cloud_response.is_a?(RestClient::Exceptions::OpenTimeout)
-
-      if @cloud_response.code == 401
-        return render json: {
-          :message => 'Authentication to the Insights Service failed.',
-          :headers => {},
-        }, status: :bad_gateway
-      end
-
-      if @cloud_response.code >= 300
         return render json: {
-          :message => 'Cloud request failed',
+          :message => message,
+          :error => response_obj.to_s,
           :headers => {},
-          :response => @cloud_response,
-        }, status: @cloud_response.code
+          :response => response_obj,
+        }, status: code
+      rescue StandardError => e
+        # Catch any other exceptions here, such as Errno::ECONNREFUSED
+        logger.warn("Cloud request failed with exception: #{e}")
+        return render json: { error: e.to_s }, status: :bad_gateway
       end
 
       # Append redhat-specific headers
       @cloud_response.headers.each do |key, value|
         assign_header(response, @cloud_response, key, false) if key.to_s.start_with?('x_rh_')
       end
+
       # Append general headers
       assign_header(response, @cloud_response, :x_resource_count, true)
       headers[Rack::ETAG] = @cloud_response.headers[:etag]
@@ -48,8 +60,8 @@ module InsightsCloud::Api
         # content type
         send_data @cloud_response, disposition: @cloud_response.headers[:content_disposition], type: @cloud_response.headers[:content_type]
       elsif @cloud_response.headers[:content_type] =~ /zip/
-        # if there is no Content-Disposition, but the content type is binary according the content type,
-        # forward the request as binry too
+        # If there is no Content-Disposition, but the content type is binary according to Content-Type, send the raw data
+        # with proper content type
         send_data @cloud_response, type: @cloud_response.headers[:content_type]
       else
         render json: @cloud_response, status: @cloud_response.code

data/app/services/foreman_rh_cloud/cloud_request.rb

@@ -13,9 +13,15 @@ module ForemanRhCloud
       logger.debug("Response headers for request url #{final_params[:url]} are: #{response.headers}")
 
       response
-    rescue RestClient::Exception => ex
-      logger.debug("Failed response with code #{ex.http_code} headers for request url #{final_params[:url]} are: #{ex.http_headers} and body: #{ex.http_body}")
-      raise ex
+    rescue RestClient::Exceptions::Timeout => ex
+      logger.debug("Timeout exception raised for request url #{final_params[:url]}: #{ex}")
+      raise
+    rescue RestClient::ExceptionWithResponse => ex
+      logger.debug("Response headers for request url #{final_params[:url]} with status code #{ex.http_code} are: #{ex.http_headers} and body: #{ex.http_body}")
+      raise
+    rescue StandardError => ex
+      logger.debug("Exception raised for request url #{final_params[:url]}: #{ex}")
+      raise
     end
   end
 end

data/app/services/foreman_rh_cloud/cloud_request_forwarder.rb

@@ -17,8 +17,6 @@ module ForemanRhCloud
       logger.debug("Sending request to: #{request_opts[:url]}")
 
       execute_cloud_request(request_opts)
-    rescue RestClient::ExceptionWithResponse => error_response
-      error_response.response.presence || error_response.exception
     end
 
     def prepare_request_opts(original_request, forward_payload, forward_params, certs)

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '10.0.5'.freeze
+  VERSION = '10.0.7'.freeze
 end

data/lib/insights_cloud/async/insights_full_sync.rb

@@ -9,10 +9,11 @@ module InsightsCloud
 
       def plan(organizations)
         organizations = organizations.select do |organization|
-          if cert_auth_available?(organization)
+          checker = ::Katello::UpstreamConnectionChecker.new(organization)
+          if cert_auth_available?(organization) && !organization.manifest_expired? && checker.can_connect?
             true
           else
-            logger.debug("Certificate is not available for org: #{organization.name}, skipping insights sync")
+            logger.info("A manifest is not available for org: #{organization.name}, or it has expired, or been deleted. skipping insights sync")
             false
           end
         end
@@ -20,19 +21,23 @@ module InsightsCloud
         sequence do
           # This can be turned off when we enable automatic status syncs
           # This step will query cloud inventory to retrieve inventory uuids for each host
-          plan_hosts_sync(organizations)
-          plan_self(organization_ids: organizations.map(&:id))
-          concurrence do
-            plan_rules_sync(organizations)
-            plan_notifications
+          valid_organizations = organizations.reject(&:manifest_expired?)
+          if valid_organizations.any?
+            plan_hosts_sync(organizations)
+            plan_self(organization_ids: organizations.map(&:id))
+            concurrence do
+              plan_rules_sync(organizations)
+              plan_notifications
+            end
           end
         end
       end
 
       def try_execute
         organizations.each do |organization|
-          unless cert_auth_available?(organization)
-            logger.debug("Certificate is not available for org: #{organization.name}, skipping insights sync")
+          checker = ::Katello::UpstreamConnectionChecker.new(organization)
+          if !cert_auth_available?(organization) && organization.manifest_expired && !checker.can_connect?
+            logger.info("A manifest is not available for org: #{organization.name}, or it has expired, or been deleted. skipping insights sync")
             next
           end
 

data/lib/insights_cloud/async/insights_resolutions_sync.rb

@@ -13,7 +13,11 @@ module InsightsCloud
           InsightsResolution.delete_all
           rule_ids = relevant_rules
           Organization.all.each do |organization|
-            next if !cert_auth_available?(organization) || organization.manifest_expired?
+            checker = ::Katello::UpstreamConnectionChecker.new(organization)
+            if !cert_auth_available?(organization) || organization.manifest_expired? || !checker.can_connect?
+              logger.info("A manifest is not available for org: #{organization.name}, or it has expired, or been deleted. skipping resolutions sync")
+              next
+            end
             api_response = query_insights_resolutions(rule_ids, organization) unless rule_ids.empty?
             written_rules = write_resolutions(api_response) if api_response
             rule_ids -= Array(written_rules)

data/lib/tasks/hybrid_cloud.rake

@@ -1,64 +1,132 @@
 require 'io/console'
+require 'uri'
 
-namespace :rh_cloud do |args|
-  desc 'Register Satellite Organization with Hybrid Cloud API. \
-        Specify org_id=x replace your organization ID with x. \
-        Specify SATELLITE_RH_CLOUD_URL=https://x with the Hybrid Cloud endpoint you are connecting to.'
+def logger
+  @logger ||= Logger.new(STDOUT)
+end
+
+namespace :rh_cloud do
+  desc 'Register Satellite Organization with Hybrid Cloud API.'
+  # This task registers the Satellite Organization with the Hybrid Cloud API.
+  # It requires the user to input their organization ID, Insights URL, and token.
+  # The task will then send a POST request to the Hybrid Cloud API to register the organization.
+  # The response will be logged, and any errors will be caught and logged as well.
+  # The task will exit with an error message if the organization does not have a manifest imported or if the token is not entered.
+  # The task will also log a warning if the custom URL is not set and the default one is used.
   task hybridcloud_register: [:environment] do
     include ::ForemanRhCloud::CertAuth
     include ::InsightsCloud::CandlepinCache
 
-    def logger
-      @logger ||= Logger.new(STDOUT)
+    def default_registrations_url
+      URI.join(ForemanRhCloud.base_url, '/api/identity/certificate/registrations').to_s
     end
 
-    def registrations_url
-      logger.warn("Custom url is not set, using the default one: #{ForemanRhCloud.base_url}") if ENV['SATELLITE_RH_CLOUD_URL'].empty?
-      ForemanRhCloud.base_url + '/api/identity/certificate/registrations'
+    # Helper method to get the registrations URL, with a warning for default usage
+    def registrations_url(custom_url)
+      if custom_url.empty?
+        logger.warn("Custom url is not set, using the default one: #{default_registrations_url}")
+        default_registrations_url
+      else
+        if URI(custom_url).scheme.nil?
+          logger.warn("Custom URL lacks a scheme; prepending https:// prefix.")
+          custom_url = "https://" + custom_url
+        end
+        custom_url
+      end
     end
 
-    if ENV['org_id'].nil?
-      logger.error('ERROR: org_id needs to be specified.')
-      exit(1)
+    def get_organization(user_org_id)
+      maybe_organization = Organization.find_by(id: user_org_id)
+      if maybe_organization.nil?
+        logger.error("Organization with ID '#{user_org_id}' not found.")
+        exit(1)
+      end
+      maybe_organization
     end
 
-    @organization = Organization.find_by(id: ENV['org_id'].to_i) # saw this coming in as a string, so making sure it gets passed as an integer.
-    @uid = cp_owner_id(@organization)
-    @hostname = ForemanRhCloud.foreman_host_name
-    logger.error('Organization provided does not have a manifest imported.') + exit(1) if @uid.nil?
-
-    puts 'Paste your token, output will be hidden.'
-    @token = STDIN.noecho(&:gets).chomp
-    logger.error('Token was not entered.') + exit(1) if @token.empty?
-
-    def headers
-      {
-        Authorization: "Bearer #{@token}",
-      }
+    def get_uid(organization)
+      maybe_uid = cp_owner_id(organization)
+      if maybe_uid.nil?
+        logger.error("Organization '#{organization}' does not have a manifest imported.")
+        exit(1)
+      end
+      maybe_uid
     end
 
-    def payload
-      {
-        "uid": @uid,
-        "display_name": "#{@hostname}+#{@organization.label}",
-      }
+    # --- Input Collection ---
+    puts "Paste in your organization ID, this can be retrieved with the command: hammer organization list"
+    loop do
+      input = STDIN.gets.chomp
+      if input.match?(/^\d+$/) # Checks if input consists only of digits
+        @user_org_id = input.to_i
+        break
+      else
+        puts "Invalid input. Please enter a numeric organization ID."
+      end
     end
 
-    def method
-      :post
+    puts "\n" + "-" * 50 + "\n\n"
+    puts "Paste in your custom Insights URL. If nothing is entered, the default will be used (#{default_registrations_url})."
+    insights_user_input = STDIN.gets.chomp
+
+    puts "\n" + "-" * 50 + "\n\n"
+    puts 'Paste in your Hybrid Cloud API token, output will be hidden.'
+    puts 'This token can be retrieved from the Hybrid Cloud console.'
+    token = STDIN.noecho(&:gets).chomp
+    if token.empty?
+      logger.error('Token was not entered.')
+      exit(1)
     end
 
+    # --- Data Preparation ---
+
+    organization = get_organization(@user_org_id)
+    uid = get_uid(organization)
+    hostname = ForemanRhCloud.foreman_host_name
+    insights_url = registrations_url(insights_user_input)
+
+    # --- API Request ---
+
+    headers = {
+      Authorization: "Bearer #{token}",
+    }
+
+    payload = {
+      'uid': uid,
+      "display_name": "#{hostname}+#{organization.label}",
+    }
+
     begin
       response = execute_cloud_request(
-        organization: @organization,
-        method: method,
-        url: registrations_url,
+        organization: organization,
+        method: :post,
+        url: insights_url,
         headers: headers,
         payload: payload.to_json
       )
-      logger.debug(response)
+      logger.debug("Cloud request completed: status=#{response.code}, body_preview=#{response.body&.slice(0, 200)}")
+    rescue RestClient::Unauthorized => _ex
+      # Add a more specific rescue for 401 Unauthorized errors
+      logger.error('Registration failed: Your token is invalid or unauthorized. Please check your token and try again.')
+      # Optionally, you can still log the full debug info if helpful for advanced troubleshooting
+      # logger.debug(ex.backtrace.join("\n"))
+      exit(1)
+    rescue RestClient::ExceptionWithResponse => ex
+      # This catches any RestClient exception that has a response (like 400, 403, 404, 500, etc.)
+      status_code = begin
+        ex.response.code
+      rescue StandardError
+        "unknown"
+      end
+      logger.error("Registration failed with HTTP status #{status_code}: #{ex.message}")
+      logger.debug("Response body (if available): #{ex.response.body}")
+      exit(1)
     rescue StandardError => ex
-      logger.error(ex)
+      # This is the catch-all for any other unexpected errors
+      logger.error("An unexpected error occurred during registration: #{ex.message}")
+      exit(1)
     end
+
+    logger.info("Satellite Organization '#{organization.label}' (ID: #{@user_org_id}) successfully registered.")
   end
 end

data/package.json

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

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

@@ -96,13 +96,46 @@ module InsightsCloud::Api
         assert_equal net_http_resp[:content_type], @response.headers['Content-Type']
       end
 
+      test "should handle StandardError" do
+        error_message = "Connection refused"
+        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:execute_cloud_request).raises(Errno::ECONNREFUSED.new)
+
+        get :forward_request, params: { "path" => "platform/module-update-router/v1/channel" }
+        assert_equal 502, @response.status
+        body = JSON.parse(@response.body)
+        assert_equal error_message, body['error']
+      end
+
+      test "should handle 304 cloud" do
+        net_http_resp = Net::HTTPResponse.new(1.0, 304, "Not Modified")
+        res = RestClient::Response.create(@body, net_http_resp, @http_req)
+
+        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:execute_cloud_request).raises(RestClient::NotModified.new(res))
+
+        get :forward_request, params: { "path" => "platform/module-update-router/v1/channel" }
+        assert_equal 304, @response.status
+        assert_equal 'Cloud request not modified', JSON.parse(@response.body)['message']
+      end
+
+      test "should handle RestClient::Exceptions::Timeout" do
+        timeout_message = "execution expired"
+        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:execute_cloud_request).raises(RestClient::Exceptions::Timeout.new(timeout_message))
+
+        get :forward_request, params: { "path" => "platform/module-update-router/v1/channel" }
+        assert_equal 504, @response.status
+        body = JSON.parse(@response.body)
+        assert_equal timeout_message, body['message']
+        assert_equal timeout_message, body['error']
+      end
+
       test "should handle failed authentication to cloud" do
         net_http_resp = Net::HTTPResponse.new(1.0, 401, "Unauthorized")
         res = RestClient::Response.create(@body, net_http_resp, @http_req)
-        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:forward_request).returns(res)
+
+        ::ForemanRhCloud::CloudRequestForwarder.any_instance.stubs(:execute_cloud_request).raises(RestClient::Unauthorized.new(res))
 
         get :forward_request, params: { "path" => "platform/module-update-router/v1/channel" }
-        assert_equal 502, @response.status
+        assert_equal 401, @response.status
         assert_equal 'Authentication to the Insights Service failed.', JSON.parse(@response.body)['message']
       end
 

data/test/jobs/insights_full_sync_test.rb

@@ -65,6 +65,8 @@ class InsightsFullSyncTest < ActiveSupport::TestCase
   end
 
   test 'Hits data is replaced with data from cloud' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(false)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).returns(@hits)
 
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_hosts_sync)
@@ -79,7 +81,31 @@ class InsightsFullSyncTest < ActiveSupport::TestCase
     assert_equal 1, @host2.insights.hits.count
   end
 
+  test 'Manifest is expired do not run task steps' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(true)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
+
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).never
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_hosts_sync).never
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_self).never
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync, [@host1.organization])
+  end
+
+  test 'Manifest is deleted do not run task steps' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(false)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(false)
+
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).never
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_hosts_sync).never
+    InsightsCloud::Async::InsightsFullSync.any_instance.expects(:plan_self).never
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsFullSync, [@host1.organization])
+  end
+
   test 'Hits counters are reset correctly' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(false)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
     InsightsCloud::Async::InsightsFullSync.any_instance.expects(:query_insights_hits).returns(@hits).twice
 
     InsightsCloud::Async::InsightsFullSync.any_instance.stubs(:plan_hosts_sync)
@@ -97,6 +123,8 @@ class InsightsFullSyncTest < ActiveSupport::TestCase
   end
 
   test 'Hits ignoring non-existent hosts' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(false)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
     hits_json = <<-HITS_JSON
     [
         {

data/test/jobs/insights_resolutions_sync_test.rb

@@ -73,6 +73,7 @@ class InsightsResolutionsSyncTest < ActiveSupport::TestCase
   end
 
   test 'Resolutions data is replaced with data from cloud' do
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
     InsightsCloud::Async::InsightsResolutionsSync.any_instance.stubs(:query_insights_resolutions).returns(@resolutions)
 
     ForemanTasks.sync_task(InsightsCloud::Async::InsightsResolutionsSync)
@@ -82,7 +83,28 @@ class InsightsResolutionsSyncTest < ActiveSupport::TestCase
     assert_equal 2, @rule.resolutions.count
   end
 
+  test 'Manifest is deleted do not run task steps' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(false)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(false)
+    InsightsCloud::Async::InsightsResolutionsSync.any_instance.expects(:query_insights_resolutions).never
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsResolutionsSync)
+
+    assert_equal 0, InsightsResolution.all.count
+  end
+
+  test 'Manifest is expired do not run task steps' do
+    Organization.any_instance.stubs(:manifest_expired?).returns(true)
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
+    InsightsCloud::Async::InsightsResolutionsSync.any_instance.expects(:query_insights_resolutions).never
+
+    ForemanTasks.sync_task(InsightsCloud::Async::InsightsResolutionsSync)
+
+    assert_equal 0, InsightsResolution.all.count
+  end
+
   test 'Skips pinging the cloud if no rule ids were found' do
+    Katello::UpstreamConnectionChecker.any_instance.stubs(:can_connect?).returns(true)
     InsightsCloud::Async::InsightsResolutionsSync.any_instance.expects(:query_insights_resolutions).never
     InsightsRule.all.delete_all
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 10.0.5
+  version: 10.0.7
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman_ansible