katello 4.7.4 → 4.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58b5925ff8555ac324b96a6ef2586d6f38e09400e6139a8b18d7e4301b1c6595
-  data.tar.gz: c4d40153fc8d19270c842352ce292d9c67f2c829e72791b0903a5d6caf61da7a
+  metadata.gz: fd4bf2aa04a425ae9878634d31f53214b3ea3f0143df8d085621bfc558cadd77
+  data.tar.gz: 84916e97ceb9cecdd2fedd5683294e238c66f1698d74583e31378d93df1cf94c
 SHA512:
-  metadata.gz: 213cea9b546d83bd1bd7fe0e8a912f765bbf110321f7388c29480baf52fbf0c39d7cb8185d453c2adf542bb1748e009952c74cf900ad2cba5a8b1adefd4dd9c5
-  data.tar.gz: 572177ab7ccdf854b3ffe7df6714d6fc920491c5c7c0e424dd03eb0ecf8338aa09e327474ce68a4b10cb37d21b4f65d0577bbaa29c6cfaf2b110a35ac99687d6
+  metadata.gz: 3bd2c0ab5a699d02aeed2c6c614db181e0270c3f05f80273d1bd19d6ac1c279151fe5cee92493a146d4a18c97f3d40b11a85c83b80f048abba51632b7e67060a
+  data.tar.gz: 352f528834b0ed0a45066b689064baac6a2195b6f33b006b80459b11c781ed01fd8d59bf9f5914bc618eaea5263d613f6bc6aaacfcadc3549997bd72739ff73f

data/app/controllers/katello/api/v2/simple_content_access_controller.rb

@@ -26,8 +26,10 @@ module Katello
     api :PUT, "/organizations/:organization_id/simple_content_access/enable",
       N_("Enable simple content access for a manifest")
     param :organization_id, :number, :desc => N_("Organization ID"), :required => true
+    param :auto_create_overrides, :bool, :desc => N_("Automatically create disabled content overrides for custom products which do not have an attached subscription"), :required => false, :default => true
     def enable
-      task = async_task(::Actions::Katello::Organization::SimpleContentAccess::Enable, params[:organization_id])
+      auto_create = params.key?(:auto_create_overrides) ? ::Foreman::Cast.to_bool(params[:auto_create_overrides]) : true
+      task = async_task(::Actions::Katello::Organization::SimpleContentAccess::Enable, params[:organization_id], auto_create_overrides: auto_create)
       respond_for_async :resource => task
     end
 

data/app/lib/actions/katello/organization/simple_content_access/enable.rb

@@ -3,6 +3,16 @@ module Actions
     module Organization
       module SimpleContentAccess
         class Enable < Toggle
+          def plan(organization_id, auto_create_overrides: true)
+            input[:auto_create_overrides] = auto_create_overrides
+            sequence do
+              if auto_create_overrides
+                plan_action(PrepareContentOverrides, organization_id)
+              end
+              super(organization_id) # puts plan_self inside the sequence
+            end
+          end
+
           def content_access_mode_value
             SIMPLE_CONTENT_ACCESS_ENABLED_VALUE
           end

data/app/lib/actions/katello/organization/simple_content_access/prepare_content_overrides.rb

@@ -0,0 +1,36 @@
+module Actions
+  module Katello
+    module Organization
+      module SimpleContentAccess
+        class PrepareContentOverrides < Actions::Base
+          def plan(organization_id)
+            Rails.logger.info "PrepareContentOverrides plan: #{organization_id.inspect}"
+            organization = ::Organization.find(organization_id.to_i)
+            org_name = organization.name
+
+            plan_self(organization_id: organization_id, organization_name: org_name)
+          end
+
+          def run
+            organization = ::Organization.find(input[:organization_id].to_i)
+            migrator = ::Katello::Util::ContentOverridesMigrator.new(organization: organization)
+
+            output[:migrator_result] = migrator.execute_non_sca_overrides!
+          end
+
+          def rescue_strategy
+            Dynflow::Action::Rescue::Skip
+          end
+
+          def humanized_name
+            N_("Prepare content overrides for Simple Content Access")
+          end
+
+          def humanized_input
+            _("for organization %s") % input[:organization_name]
+          end
+        end
+      end
+    end
+  end
+end

data/app/lib/actions/katello/organization/simple_content_access/toggle.rb

@@ -12,9 +12,15 @@ module Actions
           attr_reader :organization
 
           def plan(organization_id)
-            @organization = ::Organization.find(organization_id)
+            organization = ::Organization.find(organization_id.to_i)
+            input[:organization_name] = organization.name
+            input[:organization_label] = organization.label
             action_subject organization
-            ::Katello::Resources::Candlepin::Owner.update(@organization.label, contentAccessMode: content_access_mode_value)
+            plan_self(organization_id: organization_id)
+          end
+
+          def run
+            ::Katello::Resources::Candlepin::Owner.update(input[:organization_label], contentAccessMode: content_access_mode_value)
           end
 
           def failure_notification(plan)
@@ -30,6 +36,10 @@ module Actions
             )
           end
 
+          def humanized_input
+            _("for organization %s") % input[:organization_name]
+          end
+
           private
 
           def consumer

data/app/lib/katello/util/content_overrides_migrator.rb

@@ -0,0 +1,98 @@
+module Katello
+  module Util
+    class ContentOverridesMigrator # used in Actions::Katello::Organization::SimpleContentAccess::PrepareContentOverrides
+      include ActionView::Helpers::TextHelper
+
+      def initialize(organization:)
+        @organization = organization
+      end
+
+      def execute_non_sca_overrides!
+        host_errors = create_disabled_overrides_for_non_sca_org_hosts(organization: @organization)
+        ak_errors = create_disabled_overrides_for_non_sca_org_activation_keys(organization: @organization)
+
+        total_errors = host_errors + ak_errors
+        finish_message = "Finished creating overrides in non-SCA orgs; #{total_errors == 0 ? "no errors" : "#{pluralize(total_errors, "error")}"}"
+        messages = { result: finish_message, errors: total_errors }
+        messages[:host_errors] = "Hosts - #{pluralize(host_errors, "error")} creating disabled overrides for unsubscribed content; see log messages above" if host_errors > 0
+        messages[:ak_errors] = "Activation keys - #{pluralize(ak_errors, "error")} creating disabled overrides for unsubscribed content; see log messages above" if ak_errors > 0
+        messages[:success_message] = "You may now switch all organizations to Simple Content Access mode without any change in access to content." if total_errors == 0
+        Rails.logger.info finish_message
+        Rails.logger.info messages[:host_errors] if messages[:host_errors]
+        Rails.logger.info messages[:ak_errors] if messages[:ak_errors]
+        Rails.logger.info messages[:success_message] if messages[:success_message]
+        messages
+      end
+
+      def create_disabled_overrides_for_non_sca(consumable:)
+        content_finder = ::Katello::ProductContentFinder.new(
+                match_subscription: false,
+                match_environment: false,
+                consumable: consumable
+              )
+        subscribed_content_finder = ::Katello::ProductContentFinder.new(
+          match_subscription: true,
+          match_environment: false,
+          consumable: consumable
+        )
+        candlepin_resource = consumable.is_a?(::Katello::Host::SubscriptionFacet) ? ::Katello::Resources::Candlepin::Consumer : ::Katello::Resources::Candlepin::ActivationKey
+        consumable_id = consumable.is_a?(::Katello::Host::SubscriptionFacet) ? consumable.uuid : consumable.cp_id
+        repos_with_existing_overrides = candlepin_resource.content_overrides(consumable_id).map do |override|
+          override[:contentLabel]
+        end
+        unsubscribed_content = content_finder.custom_content_labels - subscribed_content_finder.custom_content_labels - repos_with_existing_overrides
+        new_overrides = unsubscribed_content.map do |repo_label|
+          ::Katello::ContentOverride.new(
+            repo_label,
+            { name: "enabled", value: "0" } # Override to disabled
+          )
+        end
+        return if new_overrides.blank?
+        if consumable.is_a? ::Katello::Host::SubscriptionFacet
+          ::Katello::Resources::Candlepin::Consumer.update_content_overrides(
+            consumable.uuid,
+            new_overrides.map(&:to_entitlement_hash)
+          )
+        else
+          ::Katello::Resources::Candlepin::ActivationKey.update_content_overrides(
+            consumable.cp_id,
+            new_overrides.map(&:to_entitlement_hash)
+          )
+        end
+      end
+
+      def create_disabled_overrides_for_non_sca_org_hosts(organization:)
+        errors = 0
+        fail _("Organization must be specified") if organization.blank?
+        return 0 if organization.simple_content_access? # subscription attachment is meaningless with SCA
+        Rails.logger.info("Hosts - Creating disabled overrides for unsubscribed content in organization #{organization.name}")
+        # only registered hosts with content!
+        hosts_to_update = organization.hosts.joins(:subscription_facet).where.not("#{Katello::Host::SubscriptionFacet.table_name}.host_id" => nil)
+        hosts_to_update.each do |host|
+          create_disabled_overrides_for_non_sca(consumable: host.subscription_facet)
+        rescue => e
+          errors += 1
+          Rails.logger.error("Failed to update host #{host.name}: #{e.message}")
+          Rails.logger.debug e.backtrace.join("\n")
+        end
+        errors
+      end
+
+      def create_disabled_overrides_for_non_sca_org_activation_keys(organization:)
+        errors = 0
+        fail _("Organization must be specified") if organization.blank?
+        return 0 if organization.simple_content_access? # subscription attachment is meaningless with SCA
+        Rails.logger.info("Activation keys - Creating disabled overrides for unsubscribed content in organization #{organization.name}")
+        aks_to_update = organization.activation_keys
+        aks_to_update.each do |ak|
+          create_disabled_overrides_for_non_sca(consumable: ak)
+        rescue => e
+          errors += 1
+          Rails.logger.error("Failed to update activation key #{ak.name}: #{e.message}")
+          Rails.logger.debug e.backtrace.join("\n")
+        end
+        errors
+      end
+    end
+  end
+end

data/app/models/katello/root_repository.rb

@@ -228,7 +228,7 @@ module Katello
       elsif ignorable_content.any? { |item| !IGNORABLE_CONTENT_UNIT_TYPES.include?(item) }
         errors.add(:ignorable_content, N_("Invalid value specified for ignorable content. Permissible values %s") % IGNORABLE_CONTENT_UNIT_TYPES.join(","))
       elsif self.mirroring_policy == MIRRORING_POLICY_COMPLETE
-        errors.add(:ignorable_content, N_("Ignore SRPMs can not be set in combination with 'Complete Mirroring' mirroring policy."))
+        errors.add(:ignorable_content, N_("Ignore %s can not be set in combination with 'Complete Mirroring' mirroring policy.") % IGNORABLE_CONTENT_UNIT_TYPES.join(","))
       end
     end
 

data/db/migrate/20220110223754_update_disconnected_settings.rb

@@ -1,19 +1,23 @@
 class UpdateDisconnectedSettings < ActiveRecord::Migration[6.0]
+  class FakeSetting < Katello::Model
+    self.table_name = 'settings'
+  end
+
   def up
-    setting_disconnected = Setting.find_by(name: 'content_disconnected')
+    setting_disconnected = FakeSetting.find_by(name: 'content_disconnected')
     setting = Setting.find_by(name: 'subscription_connection_enabled')
 
     setting&.update!(
       value: !setting_disconnected&.value
     )
-    Setting.where(:name => 'content_disconnected').delete_all
+    FakeSetting.where(:name => 'content_disconnected').delete_all
   end
 
   def down
     remove_column :katello_cdn_configurations, :airgapped
     setting_disconnected = Setting.find_by(name: 'subscription_connection_enabled')
-    Setting.set('content_disconnected', N_("A server operating in disconnected mode does not communicate with the Red Hat CDN."),
-               !setting_disconnected.value, N_('Disconnected mode'))
+    FakeSetting.set('content_disconnected', N_("A server operating in disconnected mode does not communicate with the Red Hat CDN."),
+                    !setting_disconnected.value, N_('Disconnected mode'))
 
     Setting.where(:name => 'subscription_connection_enabled').delete_all
   end

data/lib/katello/version.rb

@@ -1,3 +1,3 @@
 module Katello
-  VERSION = "4.7.4".freeze
+  VERSION = "4.7.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katello
 version: !ruby/object:Gem::Version
-  version: 4.7.4
+  version: 4.7.5
 platform: ruby
 authors:
 - N/A
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -941,6 +941,7 @@ files:
 - app/lib/actions/katello/organization/manifest_refresh.rb
 - app/lib/actions/katello/organization/simple_content_access/disable.rb
 - app/lib/actions/katello/organization/simple_content_access/enable.rb
+- app/lib/actions/katello/organization/simple_content_access/prepare_content_overrides.rb
 - app/lib/actions/katello/organization/simple_content_access/toggle.rb
 - app/lib/actions/katello/orphan_cleanup/remove_orphans.rb
 - app/lib/actions/katello/product/content_create.rb
@@ -1208,6 +1209,7 @@ files:
 - app/lib/katello/resources/registry.rb
 - app/lib/katello/util/candlepin_repository_checker.rb
 - app/lib/katello/util/cdn_var_substitutor.rb
+- app/lib/katello/util/content_overrides_migrator.rb
 - app/lib/katello/util/data.rb
 - app/lib/katello/util/deduplication_migrator.rb
 - app/lib/katello/util/docker_manifest_clause_generator.rb