From 128fe95c9abaaf7a42dc03a68374ba35792e201a Mon Sep 17 00:00:00 2001 From: Partha Aji Date: Thu, 13 Jul 2023 15:47:04 -0400 Subject: [PATCH] Refs #36540 - Removed the unnecessary enablement migrator in master This file was only needed for upgrading from 4.7/4.8 to 4.9 It is no longer needed for future updates. So removing from master --- .../util/default_enablement_migrator.rb | 183 ------------------ db/seeds.d/111-upgrade_tasks.rb | 3 +- .../update_custom_products_enablement.rake | 11 -- .../util/default_enablement_migrator_test.rb | 49 ----- 4 files changed, 1 insertion(+), 245 deletions(-) delete mode 100644 app/lib/katello/util/default_enablement_migrator.rb delete mode 100644 lib/katello/tasks/upgrades/4.9/update_custom_products_enablement.rake delete mode 100644 test/lib/util/default_enablement_migrator_test.rb diff --git a/app/lib/katello/util/default_enablement_migrator.rb b/app/lib/katello/util/default_enablement_migrator.rb deleted file mode 100644 index a4469c5a839..00000000000 --- a/app/lib/katello/util/default_enablement_migrator.rb +++ /dev/null @@ -1,183 +0,0 @@ -module Katello - module Util - class DefaultEnablementMigrator # used in lib/katello/tasks/upgrades/4.9/update_custom_products_enablement.rake - include ActionView::Helpers::TextHelper - - def execute! - ds_errors = create_disabled_overrides_for_non_sca_org_hosts - dsak_errors = create_disabled_overrides_for_non_sca_org_activation_keys - ak_errors = create_activation_key_overrides - consumer_errors = create_consumer_overrides - cp_errors = update_enablement_in_candlepin - kt_errors = update_enablement_in_katello - - total_errors = ds_errors + dsak_errors + ak_errors + consumer_errors + cp_errors + kt_errors - finish_message = "Finished updating custom products enablement; #{total_errors == 0 ? "no errors" : "#{pluralize(total_errors, "error")}"}" - Rails.logger.info finish_message - Rails.logger.info("#{pluralize(ds_errors, "error")} updating disabled overrides for unsubscribed content; see log messages above") if ds_errors > 0 - Rails.logger.info("#{pluralize(dsak_errors, "error")} updating disabled overrides for unsubscribed content in activation keys; see log messages above") if dsak_errors > 0 - Rails.logger.info("#{pluralize(ak_errors, "error")} updating activation key overrides; see log messages above") if ak_errors > 0 - Rails.logger.info("#{pluralize(consumer_errors, "error")} updating consumer overrides; see log messages above") if consumer_errors > 0 - Rails.logger.info("#{pluralize(cp_errors, "error")} updating default enablement in Candlepin; see log messages above") if cp_errors > 0 - Rails.logger.info("#{pluralize(kt_errors, "error")} updating default enablement in Katello; see log messages above") if kt_errors > 0 - 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 - ) - unsubscribed_content = content_finder.custom_content_labels - subscribed_content_finder.custom_content_labels - 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 - errors = 0 - Organization.all.each do |org| - next if org.simple_content_access? # subscription attachment is meaningless with SCA - Rails.logger.info("Creating disabled overrides for unsubscribed content in org #{org.name}") - hosts_to_update = org.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.info("Failed to update host #{host.name}: #{e.message}") - end - rescue => e - errors += 1 - Rails.logger.info("Error while creating host overrides: #{e.message}") - end - errors - end - - def create_disabled_overrides_for_non_sca_org_activation_keys - errors = 0 - Organization.all.each do |org| - next if org.simple_content_access? # subscription attachment is meaningless with SCA - Rails.logger.info("Creating disabled overrides for unsubscribed content in activation keys in org #{org.name}") - aks_to_update = org.activation_keys - aks_to_update.each do |ak| - create_disabled_overrides_for_non_sca(consumable: ak) - rescue => e - errors += 1 - Rails.logger.info("Failed to update activation key #{activation key.name}: #{e.message}") - end - rescue => e - errors += 1 - Rails.logger.info("Error while creating non-SCA activation key overrides: #{e.message}") - end - errors - end - - def create_overrides(consumable_id:, candlepin_resource:, all_repos:) - repos_with_existing_overrides = candlepin_resource.content_overrides(consumable_id).map do |override| - override[:contentLabel] - end - new_overrides = (all_repos - repos_with_existing_overrides).map do |repo_label| - ::Katello::ContentOverride.new( - repo_label, - { name: "enabled", value: "1" } # Override to enabled - ) - end - return if new_overrides.blank? - - candlepin_resource.update_content_overrides( - consumable_id, - new_overrides.map(&:to_entitlement_hash) - ) - end - - def create_activation_key_overrides - Rails.logger.info "Creating content overrides for all activation keys" - ak_errors = 0 - cp_aks_to_update = ::Katello::Resources::Candlepin::ActivationKey.get.map { |ak| ak['id'] } - Organization.all.each do |org| - all_repos = ::Katello::RootRepository.custom.in_organization(org).map(&:custom_content_label) # update all custom repos - - org_aks_to_update = ::Katello::ActivationKey.where(organization: org, cp_id: cp_aks_to_update) - org_aks_to_update.each do |ak| - Rails.logger.info "Updating activation key #{ak.name}" - create_overrides(consumable_id: ak.cp_id, candlepin_resource: ::Katello::Resources::Candlepin::ActivationKey, all_repos: all_repos) - rescue => e - ak_errors += 1 - Rails.logger.info("Failed to update activation key #{ak.name}: #{e.message}") - end - rescue => e - ak_errors += 1 - Rails.logger.info("Error while creating activation key overrides: #{e.message}") - end - ak_errors - end - - def create_consumer_overrides - consumer_errors = 0 - Rails.logger.info "Creating content overrides for all Candlepin consumers" - consumers_to_update = ::Katello::Resources::Candlepin::Consumer.all_uuids - # ["Default_Organization_Custom_Custom_Repo", "Default_Organization_TestProd2_TestRepo2"] - all_repos = ::Katello::RootRepository.custom.map(&:custom_content_label) # update all custom repos - - consumers_to_update.each do |consumer_uuid| - Rails.logger.info "Updating consumer #{consumer_uuid}" - create_overrides(consumable_id: consumer_uuid, candlepin_resource: ::Katello::Resources::Candlepin::Consumer, all_repos: all_repos) - rescue => e - consumer_errors += 1 - Rails.logger.info("Failed to update consumer #{consumer_uuid}: #{e.message}") - end - Rails.logger.info("Updated #{pluralize(consumers_to_update.count, 'consumer')} and #{pluralize(all_repos.count, 'repo')}") - consumer_errors - end - - def update_enablement_in_candlepin - cp_errors = 0 - Rails.logger.info "Updating custom products enablement in Candlepin" - ::Katello::ProductContent.custom.each do |product_content| - ::Katello::Resources::Candlepin::Product.add_content( - product_content.product.organization.label, - product_content.product.cp_id, - product_content.content.cp_content_id, - ::Actions::Candlepin::Product::ContentAdd::DEFAULT_ENABLEMENT - ) - rescue => e - cp_errors += 1 - Rails.logger.info("Failed to update ProductContent #{product_content.id}: #{e.message}") - end - cp_errors - end - - def update_enablement_in_katello - kt_errors = 0 - Rails.logger.info "Updating custom products enablement in Katello" - ::Katello::ProductContent.custom.each do |product_content| - product_content.set_enabled_from_candlepin! - rescue => e - kt_errors += 1 - Rails.logger.info("Failed to update ProductContent #{product_content.id}: #{e.message}") - end - kt_errors - end - end - end -end diff --git a/db/seeds.d/111-upgrade_tasks.rb b/db/seeds.d/111-upgrade_tasks.rb index 118a0f85232..b4a30bc2ec9 100644 --- a/db/seeds.d/111-upgrade_tasks.rb +++ b/db/seeds.d/111-upgrade_tasks.rb @@ -9,7 +9,6 @@ {:name => 'katello:upgrades:4.2:remove_checksum_values'}, {:name => 'katello:upgrades:4.4:publish_import_cvvs'}, {:name => 'katello:upgrades:4.8:fix_incorrect_providers'}, - {:name => 'katello:upgrades:4.8:regenerate_imported_repository_metadata'}, - {:name => 'katello:upgrades:4.9:update_custom_products_enablement'} + {:name => 'katello:upgrades:4.8:regenerate_imported_repository_metadata'} ] end diff --git a/lib/katello/tasks/upgrades/4.9/update_custom_products_enablement.rake b/lib/katello/tasks/upgrades/4.9/update_custom_products_enablement.rake deleted file mode 100644 index cc00fd2fe8d..00000000000 --- a/lib/katello/tasks/upgrades/4.9/update_custom_products_enablement.rake +++ /dev/null @@ -1,11 +0,0 @@ -namespace :katello do - namespace :upgrades do - namespace '4.9' do - desc "Update custom products enablement" - task :update_custom_products_enablement => ['environment'] do - migrator = Katello::Util::DefaultEnablementMigrator.new - migrator.execute! - end - end - end -end diff --git a/test/lib/util/default_enablement_migrator_test.rb b/test/lib/util/default_enablement_migrator_test.rb deleted file mode 100644 index be5e525a473..00000000000 --- a/test/lib/util/default_enablement_migrator_test.rb +++ /dev/null @@ -1,49 +0,0 @@ -require 'katello_test_helper' - -module Katello - module Util - class DefaultEnablementMigratorTest < ActiveSupport::TestCase - def setup - @migrator = Katello::Util::DefaultEnablementMigrator.new - end - - def test_execute! - @migrator.expects(:create_disabled_overrides_for_non_sca_org_hosts).returns(0) - @migrator.expects(:create_disabled_overrides_for_non_sca_org_activation_keys).returns(0) - @migrator.expects(:create_activation_key_overrides).returns(0) - @migrator.expects(:create_consumer_overrides).returns(0) - @migrator.expects(:update_enablement_in_candlepin).returns(0) - @migrator.expects(:update_enablement_in_katello).returns(0) - Rails.logger.expects(:info).with("Finished updating custom products enablement; no errors") - @migrator.execute! - end - - def test_execute_with_errors - @migrator.expects(:create_disabled_overrides_for_non_sca_org_hosts).returns(1) - @migrator.expects(:create_disabled_overrides_for_non_sca_org_activation_keys).returns(2) - @migrator.expects(:create_activation_key_overrides).returns(3) - @migrator.expects(:create_consumer_overrides).returns(4) - @migrator.expects(:update_enablement_in_candlepin).returns(5) - @migrator.expects(:update_enablement_in_katello).returns(6) - Rails.logger.expects(:info).with("Finished updating custom products enablement; 21 errors") - Rails.logger.expects(:info).with("1 error updating disabled overrides for unsubscribed content; see log messages above") - Rails.logger.expects(:info).with("2 errors updating disabled overrides for unsubscribed content in activation keys; see log messages above") - Rails.logger.expects(:info).with("3 errors updating activation key overrides; see log messages above") - Rails.logger.expects(:info).with("4 errors updating consumer overrides; see log messages above") - Rails.logger.expects(:info).with("5 errors updating default enablement in Candlepin; see log messages above") - Rails.logger.expects(:info).with("6 errors updating default enablement in Katello; see log messages above") - @migrator.execute! - end - - def test_update_enablement_in_candlepin - ::Katello::Resources::Candlepin::Product.expects(:add_content) - @migrator.update_enablement_in_candlepin - end - - def test_update_enablement_in_katello - ::Katello::ProductContent.any_instance.expects(:set_enabled_from_candlepin!) - @migrator.update_enablement_in_katello - end - end - end -end