foreman_rh_cloud 12.1.2 → 12.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca9c35b5c31e2f8d00889ae5c4f57a3245e038f2ff106e708c9f45909e1340d2
-  data.tar.gz: 7b151bcccb350ff1cb748aeca126656d8e7e2712e7878ea0522b7db719c6594f
+  metadata.gz: 6bc60ead37485cf4bb034dd6ccbd416ca9ad957c37123553c1cf529a2a948d48
+  data.tar.gz: 7490a0bf69893145965f99d692735dca1ad3786439efb306e99423f555c83ad0
 SHA512:
-  metadata.gz: ec35e323ea4ff1e5af20ee9a6185c83f5cf43e011a1f4879d696050381265c474cbf2b1435f72f53e43c785c797f5de013513f7efbf49e19fd87b9d2c58fe279
-  data.tar.gz: 109928813b8f2e70ee7107d44470e04fff2fad1e9fd356f2b15f7f57092bb06c003277de931c5d5dfa84a4a379de36e4e14fd7ea2898b3070d310c4c7311e5c0
+  metadata.gz: 68a8fcbff3c147991ee6c05699a9a0be941552dd97bcd94fb8230635120c40302a06b1ed4d2428a16ad71b353da2a56696e045eca29a3beda0b3df2877bd2206
+  data.tar.gz: 00ae0a4cafbad304e4da6ff962c8214c67aecc0e7af37a8c2dbd1be1f889dbca095cf93f4c6222441cef08298d333758ff8c2f942358736aca8473cc813fee34

data/db/seeds.d/200_features.rb

@@ -0,0 +1,4 @@
+ForemanRhCloud.on_prem_smart_proxy_features.each do |feature_name|
+  f = Feature.where(:name => feature_name).first_or_create
+  raise "Unable to create proxy feature: #{SeedHelper.format_errors f}" if f.nil? || f.errors.any?
+end

data/lib/foreman_inventory_upload/generators/tags.rb

@@ -41,7 +41,10 @@ module ForemanInventoryUpload
       end
 
       def organizations
-        [['organization', @host.organization.name]]
+        [
+          ['organization', @host.organization.name],
+          ['organization_label', @host.organization.label],
+        ]
       end
 
       def content_data

data/lib/foreman_rh_cloud/engine.rb

@@ -210,6 +210,30 @@ module ForemanRhCloud
       )
     end
 
+    # Ideally this code belongs to an initializer. The problem is that Katello controllers are not initialized completely until after the end of the to_prepare blocks
+    # This means I can patch the controller only in the after_initialize block that is promised to run after the to_prepare
+    # initializer 'foreman_rh_cloud.allow_smart_proxy_actions', :before => :finisher_hook, :after => 'katello.register_plugin'  do |_app|
+    # end
+    config.after_initialize do
+      # skip overrides in migrations, since the controller initialization depends on tables existense
+      if defined?(Katello) && !Foreman.in_setup_db_rake?
+        Katello::Api::V2::OrganizationsController.include Foreman::Controller::SmartProxyAuth
+        # patch the callbacks order for :download_debug_certificate, since local_find_taxonomy has to run after the user is already initialized
+        Katello::Api::V2::OrganizationsController.skip_before_action(:local_find_taxonomy, only: :download_debug_certificate)
+        Katello::Api::V2::OrganizationsController.add_smart_proxy_filters(
+          [:index, :download_debug_certificate],
+          features: ForemanRhCloud.on_prem_smart_proxy_features
+        )
+        Katello::Api::V2::OrganizationsController.before_action(:local_find_taxonomy, only: :download_debug_certificate)
+
+        Katello::Api::V2::RepositoriesController.include Foreman::Controller::SmartProxyAuth
+        Katello::Api::V2::RepositoriesController.add_smart_proxy_filters(
+          :index,
+          features: ForemanRhCloud.on_prem_smart_proxy_features
+        )
+      end
+    end
+
     rake_tasks do
       Rake::Task['db:seed'].enhance do
         ForemanRhCloud::Engine.load_seed
@@ -231,4 +255,8 @@ module ForemanRhCloud
       ::SETTINGS[:ssl_ca_file]
     end
   end
+
+  def self.on_prem_smart_proxy_features
+    ['Insights']
+  end
 end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '12.1.2'.freeze
+  VERSION = '12.1.3'.freeze
 end

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": "12.1.2",
+  "version": "12.1.3",
   "description": "Inventory Upload =============",
   "main": "index.js",
   "scripts": {

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

@@ -51,8 +51,7 @@ module InsightsCloud::Api
       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
+        host_ids.sort == [host1.id, host2.id].sort
       end.returns(mock_composer)
       mock_composer.expects(:trigger!)
       mock_composer.expects(:job_invocation)

data/test/unit/rh_cloud_http_proxy_test.rb

@@ -4,6 +4,7 @@ class RhCloudHttpProxyTest < ActiveSupport::TestCase
   setup do
     @global_content_proxy_mock = 'http://global:content@localhost:80'
     @global_foreman_proxy_mock = 'http://global:foreman@localhost:80'
+    ForemanRhCloud.stubs(:with_local_advisor_engine?).returns(false)
   end
 
   test 'selects global content proxy' do
@@ -18,6 +19,13 @@ class RhCloudHttpProxyTest < ActiveSupport::TestCase
     assert_equal @global_foreman_proxy_mock, ForemanRhCloud.proxy_setting
   end
 
+  test 'returns empty string in on-prem setup' do
+    ForemanRhCloud.unstub(:with_local_advisor_engine?)
+    ForemanRhCloud.stubs(:with_local_advisor_engine?).returns(true)
+
+    assert_empty ForemanRhCloud.proxy_setting
+  end
+
   def setup_global_content_proxy
     http_proxy = FactoryBot.create(:http_proxy, url: @global_content_proxy_mock)
     HttpProxy.stubs(:default_global_content_proxy).returns(http_proxy)

data/test/unit/tags_generator_test.rb

@@ -61,6 +61,7 @@ class TagsGeneratorTest < ActiveSupport::TestCase
     assert_equal @host.content_views.pluck(:name).max, actual['content_view'].map(&:second).max
     assert_equal Foreman.instance_id, actual['satellite_instance_id'].first.last
     assert_equal @host.organization_id.to_s, actual['organization_id'].first.last
+    assert_equal @host.organization.label, actual['organization_label'].first.last
   end
 
   test 'filters tags with empty values' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_rh_cloud
 version: !ruby/object:Gem::Version
-  version: 12.1.2
+  version: 12.1.3
 platform: ruby
 authors:
 - Foreman Red Hat Cloud team
@@ -173,6 +173,7 @@ files:
 - db/migrate/20241220184900_change_sync_insights_recommendations_to_true.rb
 - db/seeds.d/179_ui_notifications.rb
 - db/seeds.d/189_add_host_inventory_param.rb
+- db/seeds.d/200_features.rb
 - db/seeds.d/50_job_templates.rb
 - lib/foreman_inventory_upload.rb
 - lib/foreman_inventory_upload/async/async_helpers.rb