Fixes #37795 - set multiple Content Views via a single Activation key

Co-authored-by: Jeremy Lenz <[email protected]>

app/controllers/katello/api/rhsm/candlepin_proxies_controller.rb

@@ -390,6 +390,11 @@ def find_activation_keys
           activation_key = organization.activation_keys.find_by(:name => ak_name)
           fail HttpErrors::NotFound, _("Couldn't find activation key '%s'") % ak_name unless activation_key
 
+          if activation_key.multi_content_view_environment? && !Setting['allow_multiple_content_views']
+            fail HttpErrors::BadRequest, _("Activation key '%s' is associated to multiple environments"\
+                                           " and registering to multiple environments is not enabled.") % ak_name
+          end
+
           if !activation_key.unlimited_hosts && activation_key.usage_count >= activation_key.max_hosts
             fail Errors::MaxHostsReachedException, _("Max Hosts (%{limit}) reached for activation key '%{name}'") %
                 { :limit => activation_key.max_hosts, :name => activation_key.name }

app/controllers/katello/api/v2/activation_keys_controller.rb

@@ -1,19 +1,43 @@
 module Katello
-  class Api::V2::ActivationKeysController < Api::V2::ApiController
+  class Api::V2::ActivationKeysController < Api::V2::ApiController  # rubocop:disable Metrics/ClassLength
     include Katello::Concerns::FilteredAutoCompleteSearch
     include Katello::Concerns::Api::V2::ContentOverridesController
     before_action :verify_presence_of_organization_or_environment, :only => [:index]
-    before_action :find_environment, :only => [:index, :create, :update]
     before_action :find_optional_organization, :only => [:index, :create, :show]
-    before_action :find_content_view, :only => [:index]
     before_action :find_authorized_katello_resource, :only => [:show, :update, :destroy, :available_releases,
                                                                :available_host_collections, :add_host_collections, :remove_host_collections,
                                                                :content_override, :add_subscriptions, :remove_subscriptions,
                                                                :subscriptions]
+    before_action :find_content_view_environments, :only => [:create, :update]
     before_action :verify_simple_content_access_disabled, :only => [:add_subscriptions]
     before_action :validate_release_version, :only => [:create, :update]
 
-    wrap_parameters :include => (ActivationKey.attribute_names + %w(host_collection_ids service_level auto_attach purpose_role purpose_usage purpose_addons content_view_environment))
+    wrap_parameters :include => (ActivationKey.attribute_names + %w(host_collection_ids service_level auto_attach purpose_role purpose_usage purpose_addons content_view_environments))
+
+    def_param_group :activation_key do
+      param :organization_id, :number, :desc => N_("organization identifier"), :required => true
+      param :name, String, :desc => N_("name"), :required => true
+      param :description, String, :desc => N_("description")
+      param :max_hosts, :number, :desc => N_("maximum number of registered content hosts")
+      param :unlimited_hosts, :bool, :desc => N_("can the activation key have unlimited hosts")
+      param :release_version, String, :desc => N_("content release version")
+      param :service_level, String, :desc => N_("service level")
+      param :auto_attach, :bool, :desc => N_("auto attach subscriptions upon registration"), deprecated: true
+      param :purpose_usage, String, :desc => N_("Sets the system purpose usage")
+      param :purpose_role, String, :desc => N_("Sets the system purpose usage")
+      param :purpose_addons, Array, :desc => N_("Sets the system add-ons")
+
+      param :environment, Hash, :desc => N_("Hash containing the Id of the single lifecycle environment to be associated with the activation key."), deprecated: true
+      param :content_view_id, Integer, :desc => N_("Id of the single content view to be associated with the activation key.")
+      param :environment_id, Integer, :desc => N_("Id of the single lifecycle environment to be associated with the activation key.")
+      param :content_view_environments, Array, :desc => N_("Comma-separated list of Candlepin environment names to be associated with the activation key,"\
+                                              " in the format of 'lifecycle_environment_label/content_view_label'."\
+                                              " Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified."\
+                                              " Requires allow_multiple_content_views setting to be on.")
+      param :content_view_environment_ids, Array, :desc => N_("Array of content view environment ids to be associated with the activation key."\
+                                              " Ignored if content_view_id and lifecycle_environment_id are specified."\
+                                              " Requires allow_multiple_content_views setting to be on.")
+    end
 
     api :GET, "/activation_keys", N_("List activation keys")
     api :GET, "/environments/:environment_id/activation_keys"
@@ -22,31 +46,26 @@ class Api::V2::ActivationKeysController < Api::V2::ApiController
     param :environment_id, :number, :desc => N_("environment identifier")
     param :content_view_id, :number, :desc => N_("content view identifier")
     param :name, String, :desc => N_("activation key name to filter by")
+    param :content_view_environments, Array, :desc => N_("Comma-separated list of Candlepin environment names associated with the activation key,"\
+                                            " in the format of 'lifecycle_environment_label/content_view_label'."\
+                                            " Ignored if content_view_environment_ids is specified, or if content_view_id and lifecycle_environment_id are specified."\
+                                            " Requires allow_multiple_content_views setting to be on.")
+    param :content_view_environment_ids, Array, :desc => N_("Array of content view environment ids associated with the activation key. " \
+                                            "Ignored if content_view_id and lifecycle_environment_id are specified."\
+                                            "Requires allow_multiple_content_views setting to be on.")
+
     param_group :search, Api::V2::ApiController
     add_scoped_search_description_for(ActivationKey)
     def index
-      activation_key_includes = [:content_view, :environment, :host_collections, :organization]
+      activation_key_includes = [:content_view_environments, :host_collections, :organization]
       respond(:collection => scoped_search(index_relation.distinct, :name, :asc, :includes => activation_key_includes))
     end
 
     api :POST, "/activation_keys", N_("Create an activation key")
-    param :organization_id, :number, :desc => N_("organization identifier"), :required => true
-    param :name, String, :desc => N_("name"), :required => true
-    param :description, String, :desc => N_("description")
-    param :environment, Hash, :desc => N_("environment")
-    param :environment_id, :number, :desc => N_("environment id")
-    param :content_view_id, :number, :desc => N_("content view id")
-    param :max_hosts, :number, :desc => N_("maximum number of registered content hosts")
-    param :unlimited_hosts, :bool, :desc => N_("can the activation key have unlimited hosts")
-    param :release_version, String, :desc => N_("content release version")
-    param :service_level, String, :desc => N_("service level")
-    param :auto_attach, :bool, :desc => N_("auto attach subscriptions upon registration"), deprecated: true
-    param :purpose_usage, String, :desc => N_("Sets the system purpose usage")
-    param :purpose_role, String, :desc => N_("Sets the system purpose usage")
-    param :purpose_addons, Array, :desc => N_("Sets the system add-ons")
+    param_group :activation_key
     def create
       @activation_key = ActivationKey.new(activation_key_params) do |activation_key|
-        activation_key.environment = @environment if @environment
+        activation_key.content_view_environments = @content_view_environments if @content_view_environments
         activation_key.organization = @organization
         activation_key.user = current_user
       end
@@ -57,21 +76,10 @@ def create
     end
 
     api :PUT, "/activation_keys/:id", N_("Update an activation key")
+    param_group :activation_key
     param :id, :number, :desc => N_("ID of the activation key"), :required => true
-    param :organization_id, :number, :desc => N_("organization identifier"), :required => true
-    param :name, String, :desc => N_("name"), :required => false
-    param :description, String, :desc => N_("description")
-    param :environment_id, :number, :desc => N_("environment id")
-    param :content_view_id, :number, :desc => N_("content view id")
-    param :max_hosts, :number, :desc => N_("maximum number of registered content hosts")
-    param :unlimited_hosts, :bool, :desc => N_("can the activation key have unlimited hosts")
-    param :release_version, String, :desc => N_("content release version")
-    param :service_level, String, :desc => N_("service level")
-    param :auto_attach, :bool, :desc => N_("auto attach subscriptions upon registration")
-    param :purpose_usage, String, :desc => N_("Sets the system purpose usage")
-    param :purpose_role, String, :desc => N_("Sets the system purpose usage")
-    param :purpose_addons, Array, :desc => N_("Sets the system add-ons")
     def update
+      @activation_key.update!(content_view_environments: @content_view_environments) if @content_view_environments.present?
       sync_task(::Actions::Katello::ActivationKey::Update, @activation_key, activation_key_params)
       respond_for_show(:resource => @activation_key)
     end
@@ -247,8 +255,9 @@ def index_relation
       activation_keys = ActivationKey.readable
       activation_keys = activation_keys.where(:name => params[:name]) if params[:name]
       activation_keys = activation_keys.where(:organization_id => @organization) if @organization
-      activation_keys = activation_keys.where(:environment_id => @environment) if @environment
-      activation_keys = activation_keys.where(:content_view_id => @content_view) if @content_view
+      activation_keys = activation_keys.with_content_view_environments(@content_view_environments) if @content_view_environments
+      activation_keys = activation_keys.with_content_views(params[:content_view_id]) if params[:content_view_id]
+      activation_keys = activation_keys.with_environments(params[:lifecycle_environments]) if params[:lifecycle_environments]
       activation_keys
     end
 
@@ -266,15 +275,33 @@ def subscription_index
       subscriptions
     end
 
-    def find_environment
+    def find_cve_for_single
       environment_id = params[:environment_id]
-      environment_id = params[:environment][:id] if !environment_id && params[:environment]
-      return unless environment_id
+      environment_id ||= params.dig(:environment, :id)
+      content_view_id = params[:content_view_id]
+      if environment_id.blank? || content_view_id.blank?
+        fail HttpErrors::BadRequest, _("Environment ID and content view ID must be provided together")
+      end
+      cve = ::Katello::ContentViewEnvironment.readable.where(environment_id: environment_id,
+                                                             content_view_id: content_view_id).first
+      if cve.blank?
+        fail HttpErrors::NotFound, _("Couldn't find content view environment with content view ID '%{cv}'"\
+                                    " or environment ID '%{env}'") % { cv: content_view_id, env: environment_id }
+      end
+      @content_view_environments = [cve]
+    end
 
-      @environment = KTEnvironment.readable.find_by(id: environment_id)
-      fail HttpErrors::NotFound, _("Couldn't find environment '%s'") % params[:environment_id] if @environment.nil?
-      @organization = @environment.organization
-      @environment
+    def find_content_view_environments
+      @content_view_environments = []
+      if params[:environment_id] || params[:environment]
+        find_cve_for_single
+      elsif params[:content_view_environments] || params[:content_view_environment_ids]
+        @content_view_environments = ::Katello::ContentViewEnvironment.fetch_content_view_environments(
+              labels: params[:content_view_environments],
+              ids: params[:content_view_environment_ids],
+              organization: @organization || @activation_key&.organization)
+      end
+      @organization ||= @content_view_environments.first&.organization
     end
 
     def find_host_collections
@@ -293,14 +320,6 @@ def verify_presence_of_organization_or_environment
       fail HttpErrors::BadRequest, _("Either organization ID or environment ID needs to be specified")
     end
 
-    def find_content_view
-      if params.include?(:content_view_id)
-        cv_id = params[:content_view_id]
-        @content_view = ContentView.readable.find_by(:id => cv_id)
-        fail HttpErrors::NotFound, _("Couldn't find content view '%s'") % cv_id if @content_view.nil?
-      end
-    end
-
     def permitted_params
       params.require(:activation_key).permit(:name,
                                              :description,
@@ -316,14 +335,15 @@ def permitted_params
                                              :purpose_usage,
                                              :purpose_addon_ids,
                                              :content_overrides => [],
-                                             :host_collection_ids => []).to_h
+                                             :host_collection_ids => [],
+                                             :content_view_environments => [],
+                                             :content_view_environment_ids => []).to_h
     end
 
     def activation_key_params
-      key_params = permitted_params
+      key_params = permitted_params.except(:environment_id, :content_view_id,
+                      :content_view_environments, :content_view_environment_ids)
 
-      key_params[:environment_id] = params[:environment][:id] if params[:environment].try(:[], :id)
-      key_params[:content_view_id] = params[:content_view][:id] if params[:content_view].try(:[], :id)
       unless params[:purpose_addons].nil?
         key_params[:purpose_addon_ids] = params[:purpose_addons].map { |addon| ::Katello::PurposeAddon.find_or_create_by(name: addon).id }
       end

app/controllers/katello/api/v2/hosts_bulk_actions_controller.rb

@@ -232,10 +232,7 @@ def available_incremental_updates
         version_environment[:environments] << cve.environment unless version_environment[:environments].include?(cve.environment)
         version_environment[:next_version] ||= version.next_incremental_version
         version_environment[:content_host_count] ||= 0
-        version_environment[:content_host_count] += content_facets.in_content_views_and_environments(
-          content_views: [cve.content_view],
-          lifecycle_environments: [cve.environment]
-        ).count
+        version_environment[:content_host_count] += content_facets.with_content_view_environments(cve).count
 
         if version.content_view.composite?
           version_environment[:components] = version.components_needing_errata(@errata)

app/controllers/katello/concerns/api/v2/hosts_controller_extensions.rb

@@ -45,23 +45,12 @@ def set_content_view_environments
           content_facet_attributes = params.dig(:host, :content_facet_attributes)
           return if content_facet_attributes.blank? || @host&.content_facet.blank? ||
             (cve_params[:content_view_id].present? && cve_params[:lifecycle_environment_id].present?)
-          new_cves = nil
-          if cve_params[:content_view_environments].present? && cve_params[:content_view_environment_ids].blank?
-            # Must do maps here to ensure CVEs remain in the same order.
-            # Using ActiveRecord .where will return them in a different order.
-            environment_names = cve_params[:content_view_environments].map(&:strip)
-            Rails.logger.debug "new environment names: #{environment_names}"
-            new_cves = environment_names.map do |name|
-              ::Katello::ContentViewEnvironment.with_candlepin_name(name, organization: @host.organization)
-            end
-          end
-          if cve_params[:content_view_environment_ids].present?
-            new_cves = cve_params[:content_view_environment_ids].map do |id|
-              ::Katello::ContentViewEnvironment.find_by(id: id)
-            end
-          end
+          cves = ::Katello::ContentViewEnvironment.fetch_content_view_environments(
+            labels: cve_params[:content_view_environments],
+            ids: cve_params[:content_view_environment_ids],
+            organization: @organization || @host&.organization)
 
-          @host.content_facet.content_view_environments = new_cves.compact if new_cves.present?
+          @host.content_facet.content_view_environments = cves if cves.present?
         end
 
         def cve_params

app/controllers/katello/concerns/authorization/api/v2/content_views_controller.rb

@@ -118,10 +118,7 @@ def authorize_remove_environments(view, options) # rubocop:disable Metrics/Cyclo
       # and also ensure that the environments have the remove permission
       return deny_access unless KTEnvironment.promotable.where(:id => env_ids).count == env_ids.size && view.promotable_or_removable?
 
-      total_count = Katello::Host::ContentFacet.in_content_views_and_environments(
-        :content_views => [view],
-        :lifecycle_environments => ::Katello::KTEnvironment.where(id: env_ids)
-      ).count
+      total_count = Katello::Host::ContentFacet.with_content_views(view).with_environments(env_ids).count
       if total_count > 0
         unless options[:system_content_view_id] && options[:system_environment_id]
           fail _("Unable to reassign content hosts. Please provide system_content_view_id and system_environment_id.")
@@ -135,7 +132,7 @@ def authorize_remove_environments(view, options) # rubocop:disable Metrics/Cyclo
         end
       end
 
-      if Katello::ActivationKey.where(:content_view_id => view, :environment_id => env_ids).count > 0
+      if Katello::ActivationKey.with_content_views(view).with_environments(env_ids).count > 0
         # if we are reassigning activation key environments/ cv
         # make sure the activation key using present environments or cv are editable.
         unless options[:key_content_view_id] && options[:key_environment_id]

app/lib/actions/katello/activation_key/reassign.rb

@@ -3,9 +3,10 @@ module Katello
     module ActivationKey
       class Reassign < Actions::Base
         def plan(activation_key, content_view_id, environment_id)
-          activation_key.content_view_id = content_view_id
-          activation_key.environment_id = environment_id
-          activation_key.save!
+          activation_key.assign_single_environment(
+            content_view: ::Katello::ContentView.find(content_view_id),
+            lifecycle_environment: ::Katello::KTEnvironment.find(environment_id)
+          )
         end
       end
     end