katello 3.18.0.rc1 → 4.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7163fd6dce0ae11188b016225be2effa59131c5bcc4a4b3482a749dfba7ef545
-  data.tar.gz: 202f81621e52adce6d318faa95fa9a527c0e3fc0f25bab3c3cb2ca7133cb12e3
+  metadata.gz: 3942a71eb36eb3e5c9e6adcf139e30a2443a038eea11c417e55c6b590580465f
+  data.tar.gz: f59fa795ac9c2298450020e4c8f90409691374acc1f09e1c49a88e661d06cdd6
 SHA512:
-  metadata.gz: 29f15645418ab0683328f83b804dc3fdf45d7f93ce4d23578a558310e0f1ad3cb7f2d98fe74ba3d16181505df56f081092aacb2bb028364995ac15413674862a
-  data.tar.gz: 99b0a150d0d689951d63b2acb37a0bbab702bfb5a13739572e764f9b49eeda60bb3451b6cc6a7aae4c20886755b499637213afef91eb565a92e2c887a4dcc376
+  metadata.gz: ff801d6c4540553020d70162d030def3a7782771f58fe8e85a81def49dd1abdb4abeab3b039ce56a2741636e745bba0887e0713ae534809e952ab0fc0482ba23
+  data.tar.gz: 4920f4ab7232331cc2d79a56f05625811a71f334e8909bab61a7d74cbbb8fbf345a9394a888bf44ca94dac9ae17dd4f53a069f6a7fd822926377dd8b9dc1c6ed

data/app/controllers/katello/api/rhsm/candlepin_dynflow_proxy_controller.rb

@@ -4,8 +4,6 @@ module Katello
     include ForemanTasks::Triggers
     include AbstractController::Callbacks
 
-    before_action :deprecated, only: :deb_package_profile
-
     skip_before_action :authorize, :only => [:upload_package_profile, :upload_profiles, :deb_package_profile]
     before_action :find_host, :only => [:upload_package_profile, :upload_profiles, :deb_package_profile]
     before_action :authorize_client_or_user, :only => [:upload_package_profile, :upload_profiles, :deb_package_profile]
@@ -31,19 +29,6 @@ module Katello
       render :json => Resources::Candlepin::Consumer.get(@host.subscription_facet.uuid)
     end
 
-    api :PUT, "/systems/:id/deb_package_profile", N_("Update installed deb packages")
-    param :deb_package_profile, Hash, :required => true do
-      param :deb_packages, Array, :required => true do
-        param :name, String, :required => true
-        param :architecture, String, :required => true
-        param :version, String, :required => true
-      end
-    end
-    param :id, String, :desc => N_("UUID of the system"), :required => true
-    def deb_package_profile
-      upload_profiles
-    end
-
     def find_host(uuid = nil)
       params = request.path_parameters
       uuid ||= params[:id]
@@ -65,9 +50,5 @@ module Katello
       authorized = (User.current.uuid == @host.subscription_facet.uuid) if @host && User.consumer?
       authorized
     end
-
-    def deprecated
-      ::Foreman::Deprecation.api_deprecation_warning("it will be removed in Katello 4.0. Please use /consumers/:id/profiles instead.")
-    end
   end
 end

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

@@ -41,8 +41,6 @@ module Katello
             body_json['displayMessage'] = body_json['message']
           end
           response.body = body_json.to_s
-
-        # rubocop:disable Lint/SuppressedException
         rescue JSON::ParserError
           # Not a json response, leave as-is
         end
@@ -370,7 +368,7 @@ module Katello
 
       if (ak_names = params[:activation_keys])
         fail HttpErrors::NotFound, _("Organization not found") if organization.nil?
-        ak_names        = ak_names.split(",")
+        ak_names        = ak_names.split(",").uniq.compact
         activation_keys = ak_names.map do |ak_name|
           activation_key = organization.activation_keys.find_by(:name => ak_name)
           fail HttpErrors::NotFound, _("Couldn't find activation key '%s'") % ak_name unless activation_key

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

@@ -39,8 +39,7 @@ module Katello
     end
 
     def deprecate_katello_agent
-      ::Foreman::Deprecation.api_deprecation_warning("Remote actions using katello-agent are deprecated and will be removed in Katello 4.0.  " \
-                                                         "You may consider switching to Remote Execution.")
+      ::Foreman::Deprecation.api_deprecation_warning("Katello-agent is deprecated and will be removed in a future release.")
     end
 
     def full_result_response(collection)

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

@@ -93,14 +93,14 @@ module Katello
 
     def find_editable_capsule
       @capsule = SmartProxy.unscoped.authorized(:manage_capsule_content).find(params[:id])
-      unless @capsule&.has_feature?(SmartProxy::PULP_NODE_FEATURE)
+      unless @capsule&.pulp_mirror?
         fail _("This request may only be performed on a Smart proxy that has the Pulp Node feature.")
       end
     end
 
     def find_capsule
       @capsule = SmartProxy.unscoped.authorized(:view_capsule_content).find(params[:id])
-      unless @capsule&.has_feature?(SmartProxy::PULP_NODE_FEATURE)
+      unless @capsule&.pulp_mirror?
         fail _("This request may only be performed on a Smart proxy that has the Pulp Node feature.")
       end
     end

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

@@ -10,9 +10,9 @@ module Katello
     end
 
     def_param_group :content_credential do
-      param :name, :identifier, :action_aware => true, :required => true, :desc => N_("identifier of the content credential")
-      param :content_type, String, :action_aware => true, :required => true, :desc => N_("type of content")
-      param :content, String, :action_aware => true, :required => true, :desc => N_("public key block in DER encoding or certificate content")
+      param :name, :identifier, :action_aware => true, :required => true, :desc => N_('Name of the Content Credential')
+      param :content_type, String, :action_aware => true, :required => true, :desc => N_('Type of content: "cert", "gpg_key"')
+      param :content, String, :action_aware => true, :required => true, :desc => N_('Public key block in DER encoding or certificate content')
     end
 
     resource_description do
@@ -22,13 +22,13 @@ module Katello
         Content Credentials are used to store credentials like GPG Keys and Certificates for the authentication
         to Products / Repositories.
       DESC
-      api_version "v2"
+      api_version 'v2'
     end
 
-    api :GET, "/content_credentials", N_("List content credentials")
-    param :organization_id, :number, :desc => N_("organization identifier"), :required => true
-    param :name, String, :desc => N_("name of the Content Credential"), :required => false
-    param :content_type, String, :desc => N_("type of content"), :required => false
+    api :GET, "/content_credentials", N_('List Content Credentials')
+    param :organization_id, :number, :desc => N_('Organization identifier'), :required => true
+    param :name, String, :desc => N_('Name of the Content Credential'), :required => false
+    param :content_type, String, :desc => N_('Type of content'), :required => false
     param_group :search, Api::V2::ApiController
     def index
       respond(:collection => scoped_search(index_relation.distinct, :name, :asc))
@@ -41,15 +41,15 @@ module Katello
       query
     end
 
-    api :POST, "/content_credentials", N_("Create a content credential")
-    param :organization_id, :number, :desc => N_("organization identifier"), :required => true
+    api :POST, "/content_credentials", N_('Create a Content Credential')
+    param :organization_id, :number, :desc => N_('Organization identifier'), :required => true
     param_group :content_credential, :as => :create
     def create
       filepath = params.try(:[], :file_path).try(:path)
 
       content = nil
       if filepath
-        content = File.open(filepath, "rb") { |file| file.read }
+        content = File.open(filepath, 'rb') { |file| file.read }
       else
         content = params[:content]
       end
@@ -58,45 +58,45 @@ module Katello
       respond_for_create(:resource => content_credential)
     end
 
-    api :GET, "/content_credentials/:id", N_("Show a content credential")
-    param :id, :number, :desc => N_("content credential numeric identifier"), :required => true
+    api :GET, "/content_credentials/:id", N_('Show a Content Credential')
+    param :id, :number, :desc => N_('Content Credential numeric identifier'), :required => true
     def show
       respond_for_show(:resource => @content_credential)
     end
 
-    api :PUT, "/content_credentials/:id", N_("Update a content credential")
-    param :id, :number, :desc => N_("content credential numeric identifier"), :required => true
+    api :PUT, "/content_credentials/:id", N_('Update a Content Credential')
+    param :id, :number, :desc => N_('Content Credential ID'), :required => true
     param_group :content_credential
     def update
       sync_task(::Actions::Katello::GpgKey::Update, @content_credential, content_credential_params.to_h)
       respond_for_show(:resource => @content_credential)
     end
 
-    api :DELETE, "/content_credentials/:id", N_("Destroy a content credential")
-    param :id, :number, :desc => N_("content credential numeric identifier"), :required => true
+    api :DELETE, "/content_credentials/:id", N_('Destroy a Content Credential')
+    param :id, :number, :desc => N_('Content Credential ID'), :required => true
     def destroy
       @content_credential.destroy
       respond_for_destroy
     end
 
-    api :GET, "/content_credentials/:id/content", N_("Return the content of a content credential, used directly by yum")
+    api :GET, "/content_credentials/:id/content", N_('Return the content of a Content Credential, used directly by yum')
     param :id, :number, :required => true
     def content
       render(:plain => @content_credential.content, :layout => false)
     end
 
-    api :POST, "/content_credentials/:id/content", N_("Upload content credential contents")
-    param :id, :number, :desc => N_("content credential numeric identifier"), :required => true
-    param :content, File, :desc => N_("file contents"), :required => true
+    api :POST, "/content_credentials/:id/content", N_('Upload Content Credential contents')
+    param :id, :number, :desc => N_('Content Credential ID'), :required => true
+    param :content, File, :desc => N_('File contents'), :required => true
     def set_content
       filepath = params.try(:[], :content).try(:path)
 
       if filepath
-        content = File.open(filepath, "rb") { |file| file.read }
+        content = File.open(filepath, 'rb') { |file| file.read }
         @content_credential.update!(:content => content)
-        render :json => {:status => "success"}
+        render :json => {:status => 'success'}
       else
-        fail HttpErrors::BadRequest, _("No file uploaded")
+        fail HttpErrors::BadRequest, _('No file uploaded')
       end
     end
 

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

@@ -0,0 +1,98 @@
+module Katello
+  class Api::V2::ContentExportIncrementalsController < Api::V2::ApiController
+    before_action :fail_if_not_pulp3, :only => [:version, :library]
+    before_action :find_exportable_organization, :only => [:library]
+    before_action :find_exportable_content_view_version, :only => [:version]
+    before_action :find_library_export_view, :only => [:library]
+    before_action :find_history, :only => [:version, :library]
+
+    api :POST, "/content_export_incrementals/version", N_("Performs an incremental-export of a content view version.")
+    param :id, :number, :desc => N_("Content view version identifier"), :required => true
+    param :destination_server, String, :desc => N_("Destination Server name"), :required => false
+    param :chunk_size_mb, :number, :desc => N_("Split the exported content into archives "\
+                                               "no greater than the specified size in megabytes."), :required => false
+    param :from_history_id, :number, :desc => N_("Export history identifier used for incremental export. "\
+                                                 "If not provided the most recent export history will be used."), :required => false
+    param :fail_on_missing_content, :bool, :desc => N_("Fails if any of the repositories belonging to this version"\
+                                                         " are unexportable. False by default."), :required => false
+    def version
+      tasks = async_task(::Actions::Pulp3::Orchestration::ContentViewVersion::Export,
+                          content_view_version: @version,
+                          destination_server: params[:destination_server],
+                          chunk_size: params[:chunk_size_mb],
+                          from_history: @history,
+                          fail_on_missing_content: ::Foreman::Cast.to_bool(params[:fail_on_missing_content]))
+
+      respond_for_async :resource => tasks
+    end
+
+    api :POST, "/content_export_incrementals/library", N_("Performs an incremental-export of the repositories in library.")
+    param :organization_id, :number, :desc => N_("Organization identifier"), :required => true
+    param :destination_server, String, :desc => N_("Destination Server name"), :required => false
+    param :chunk_size_mb, :number, :desc => N_("Split the exported content into archives "\
+                                               "no greater than the specified size in megabytes."), :required => false
+    param :from_history_id, :number, :desc => N_("Export history identifier used for incremental export. "\
+                                                 "If not provided the most recent export history will be used."), :required => false
+    param :fail_on_missing_content, :bool, :desc => N_("Fails if any of the repositories belonging to this organization"\
+                                                         " are unexportable. False by default."), :required => false
+    def library
+      tasks = async_task(::Actions::Pulp3::Orchestration::ContentViewVersion::ExportLibrary,
+                          @organization,
+                          destination_server: params[:destination_server],
+                          chunk_size: params[:chunk_size_mb],
+                          from_history: @history,
+                          fail_on_missing_content: ::Foreman::Cast.to_bool(params[:fail_on_missing_content]))
+      respond_for_async :resource => tasks
+    end
+
+    private
+
+    def find_exportable_content_view_version
+      @version = ContentViewVersion.exportable.find_by_id(params[:id])
+      throw_resource_not_found(name: 'content view version', id: params[:id]) if @version.blank?
+      @view = @version.content_view
+    end
+
+    def find_library_export_view
+      @view = ::Katello::Pulp3::ContentViewVersion::Export.find_library_export_view(destination_server: params[:destination_server],
+                                                                organization: @organization,
+                                                                create_by_default: false)
+      if @view.blank?
+        msg = _("Unable to incrementally export. Do a Full Export on the library content "\
+                "before updating from the latest increment.")
+        fail HttpErrors::BadRequest, msg
+      end
+    end
+
+    def find_history
+      if params[:from_history_id].present?
+        @history = ::Katello::ContentViewVersionExportHistory.find(params[:from_history_id])
+        if @history.blank?
+          throw_resource_not_found(name: 'export history',
+                                   id: params[:from_history_id])
+        end
+      else
+        @history = ::Katello::ContentViewVersionExportHistory.
+                      latest(@view,
+                                          destination_server: params[:destination_server])
+        if @history.blank?
+          msg = _("No existing export history was found to perform an incremental export. A full export must be performed")
+          fail HttpErrors::NotFound, msg
+        end
+      end
+    end
+
+    def find_exportable_organization
+      find_organization
+      unless @organization.can_export_library_content?
+        throw_resource_not_found(name: 'organization', id: params[:organization_id])
+      end
+    end
+
+    def fail_if_not_pulp3
+      unless SmartProxy.pulp_primary.pulp3_repository_type_support?(Katello::Repository::YUM_TYPE)
+        fail HttpErrors::BadRequest, _("Invalid usage for Pulp 2 repositories. Use export for Yum repositories")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+module Katello
+  class Api::V2::ContentExportsController < Api::V2::ApiController
+    before_action :fail_if_not_pulp3, :only => [:version, :library]
+    before_action :find_exportable_organization, :only => [:library]
+    before_action :find_exportable_content_view_version, :only => [:version]
+
+    api :GET, "/content_exports", N_("List export histories")
+    param :content_view_version_id, :number, :desc => N_("Content view version identifier"), :required => false
+    param :content_view_id, :number, :desc => N_("Content view identifier"), :required => false
+    param :destination_server, String, :desc => N_("Destination Server name"), :required => false
+    param :organization_id, :number, :desc => N_("Organization identifier"), :required => false
+    param :id, :number, :desc => N_("Content view version export history identifier"), :required => false
+    param :type, ::Katello::ContentViewVersionExportHistory::EXPORT_TYPES,
+                                  :desc => N_("Export Types"),
+                                  :required => false
+    param_group :search, Api::V2::ApiController
+    add_scoped_search_description_for(ContentViewVersionExportHistory)
+    def index
+      history = ContentViewVersionExportHistory.readable
+      history = history.where(:id => params[:id]) unless params[:id].blank?
+      history = history.where(:content_view_version_id => params[:content_view_version_id]) unless params[:content_view_version_id].blank?
+      history = history.where(:destination_server => params[:destination_server]) unless params[:destination_server].blank?
+      history = history.where(:export_type => params[:type]) unless params[:type].blank?
+      history = history.with_organization_id(params[:organization_id]) unless params[:organization_id].blank?
+      history = history.with_content_view_id(params[:content_view_id]) unless params[:content_view_id].blank?
+      respond_with_template_collection("index", 'content_view_version_export_histories',
+                                       :collection => scoped_search(history, 'id', 'asc', resource_class: ContentViewVersionExportHistory))
+    end
+
+    api :GET, "/content_exports/api_status", N_("true if the export api is pulp3 ready and usable. This API is intended for use by hammer-cli only.")
+    def api_status
+      ::Foreman::Deprecation.api_deprecation_warning("/content_exports/api_status is being deprecated and will be removed in a future version of Katello.")
+      render json: { api_usable: SmartProxy.pulp_primary.pulp3_repository_type_support?(Katello::Repository::YUM_TYPE) }, status: :ok
+    end
+
+    api :POST, "/content_exports/version", N_("Performs a full-export of a content view version.")
+    param :id, :number, :desc => N_("Content view version identifier"), :required => true
+    param :destination_server, String, :desc => N_("Destination Server name"), :required => false
+    param :chunk_size_mb, :number, :desc => N_("Split the exported content into archives "\
+                                               "no greater than the specified size in megabytes."), :required => false
+    param :fail_on_missing_content, :bool, :desc => N_("Fails if any of the repositories belonging to this version"\
+                                                         " are unexportable. False by default."), :required => false
+    def version
+      tasks = async_task(::Actions::Pulp3::Orchestration::ContentViewVersion::Export,
+                          content_view_version: @version,
+                          destination_server: params[:destination_server],
+                          chunk_size: params[:chunk_size_mb],
+                          fail_on_missing_content: ::Foreman::Cast.to_bool(params[:fail_on_missing_content]))
+      respond_for_async :resource => tasks
+    end
+
+    api :POST, "/content_exports/library", N_("Performs a full-export of the repositories in library.")
+    param :organization_id, :number, :desc => N_("Organization identifier"), :required => true
+    param :destination_server, String, :desc => N_("Destination Server name"), :required => false
+    param :chunk_size_mb, :number, :desc => N_("Split the exported content into archives "\
+                                               "no greater than the specified size in megabytes."), :required => false
+    param :fail_on_missing_content, :bool, :desc => N_("Fails if any of the repositories belonging to this organization"\
+                                                         " are unexportable. False by default."), :required => false
+    def library
+      tasks = async_task(::Actions::Pulp3::Orchestration::ContentViewVersion::ExportLibrary,
+                          @organization,
+                          destination_server: params[:destination_server],
+                          chunk_size: params[:chunk_size_mb],
+                          fail_on_missing_content: ::Foreman::Cast.to_bool(params[:fail_on_missing_content]))
+      respond_for_async :resource => tasks
+    end
+
+    private
+
+    def find_exportable_content_view_version
+      @version = ContentViewVersion.exportable.find_by_id(params[:id])
+      throw_resource_not_found(name: 'content view version', id: params[:id]) if @version.blank?
+    end
+
+    def find_exportable_organization
+      find_organization
+      unless @organization.can_export_library_content?
+        throw_resource_not_found(name: 'organization', id: params[:organization_id])
+      end
+    end
+
+    def fail_if_not_pulp3
+      unless SmartProxy.pulp_primary.pulp3_repository_type_support?(Katello::Repository::YUM_TYPE)
+        fail HttpErrors::BadRequest, _("Invalid usage for Pulp 2 repositories. Use export for Yum repositories")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Katello
+  class Api::V2::ContentImportsController < Api::V2::ApiController
+    before_action :find_publishable_content_view, :only => [:version]
+    before_action :find_importable_organization, :only => [:library]
+    before_action :find_default_content_view, :only => [:library]
+
+    api :POST, "/content_imports/version", N_("Import a content view version")
+    param :content_view_id, :number, :desc => N_("Content view identifier"), :required => true
+    param :path, String, :desc => N_("Directory containing the exported Content View Version"), :required => true
+    param :metadata, Hash, :desc => N_("Metadata taken from the upstream export history for this Content View Version"), :required => true
+    def version
+      if @view.default?
+        fail HttpErrors::BadRequest, _("Cannot use this end point for importing to library. "\
+                                       "If you intented to upload to library, use the library endpoint.")
+      end
+
+      task = async_task(::Actions::Katello::ContentViewVersion::Import, @view, path: params[:path], metadata: metadata_params.to_h)
+      respond_for_async :resource => task
+    end
+
+    api :POST, "/content_imports/library", N_("Import a content view version to the library")
+    param :organization_id, :number, :desc => N_("Organization identifier"), :required => true
+    param :path, String, :desc => N_("Directory containing the exported Content View Version"), :required => true
+    param :metadata, Hash, :desc => N_("Metadata taken from the upstream export history for this Content View Version"), :required => true
+    def library
+      task = async_task(::Actions::Katello::ContentViewVersion::ImportLibrary, @organization, path: params[:path], metadata: metadata_params.to_h)
+      respond_for_async :resource => task
+    end
+
+    private
+
+    def find_publishable_content_view
+      @view = ContentView.publishable.find(params[:content_view_id])
+      throw_resource_not_found(name: 'content_view', id: params[:content_view_id]) if @view.blank?
+    end
+
+    def find_default_content_view
+      @view = @organization&.default_content_view
+      throw_resource_not_found(name: 'organization', id: params[:organization_id]) if @view.blank?
+    end
+
+    def find_importable_organization
+      find_organization
+      throw_resource_not_found(name: 'organization', id: params[:organization_id]) unless @organization.can_import_library_content?
+    end
+
+    def metadata_params
+      params.require(:metadata).permit(
+        :organization,
+        :content_view,
+        :repository_mapping,
+        :toc,
+        content_view_version: [:major, :minor]
+      ).tap do |nested|
+        nested[:repository_mapping] = params[:metadata].require(:repository_mapping).permit!
+      end
+    end
+  end
+end