katello 3.8.1 → 3.9.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93cb21818ee2cbe71bd6c1397c5bcb3e654be074
-  data.tar.gz: 1e38b306b83721ab0dbd4ccdf775a75086eb8b2f
+  metadata.gz: ae72ca66136fbca345cde1526c87cda188886924
+  data.tar.gz: '018374e21b0767a004eb0a29d3a257b8f34c7b65'
 SHA512:
-  metadata.gz: 7b963f48b6f230b4cd16b47863186afc3912be25fd40feb4527fb64cc72c09a9727081b50b3ab410a97baa0f02d1b34881422e1cd8c9f3395b17461456b7b467
-  data.tar.gz: b84f6c7e67ad83144190bb5c14e9373db5a327f2899eb49efc931d4f6fcfa7c6dc41ae0244b872fffda803bf93ae827cabe66479adb661c1f415f138403cac9f
+  metadata.gz: 365920a445e5c8559ccb8e4a8d03bd22d18d6aeab5c37cf89251d9e3f660a37eeb8fb9e6070d83978cd8d0f2f470a32c48df735c14c5ce248e6075c5d492ba23
+  data.tar.gz: 6d6c00d08aba4e7f9e2405e28ccd7feab44f81af1d393eec683d63667c04914367bc81fc6c787b45b2656665a223a5648d995dd355f400bcac9c8b3e1a4f736b

data/README.md

@@ -1,6 +1,6 @@
 # Katello
 
-[![Build Status](https://ci.theforeman.org/buildStatus/icon?job=test_katello)](https://ci.theforeman.org/job/test_katello)
+[![Build Status](https://ci.theforeman.org/buildStatus/icon?job=katello-nightly-release)](https://ci.theforeman.org/job/katello-nightly-release/)
 [![Code Climate](https://codeclimate.com/github/Katello/katello/badges/gpa.svg)](https://codeclimate.com/github/Katello/katello)
 
 Full documentation is at https://www.theforeman.org/plugins/katello/
@@ -19,18 +19,18 @@ Linux based systems.
 ## Development
 
 The most common way to set up Katello for development is to use
-[katello-deploy](https://github.com/Katello/katello-deploy#development-deployment).
-This will set up a Vagrant instance with the Katello codebase checked out. You
-can also run `setup.rb` directly with katello-deploy if you prefer to not use
-Vagrant.
+[forklift](https://github.com/theforeman/forklift).
+This will set up a virtual machine with the Katello codebase checked out.
+Please use the forklift documentation found in the repository for how
+to get started with forklift.
 
 There is also
 [katello-devel-installer](https://github.com/Katello/katello-installer#development-usage)
 if you would like to use that.
 
 If you have questions or issues with any of the above methods, feel free to ask
-for assistance on #theforeman-dev IRC channel or via the foreman-dev mailing
-list.
+for assistance on #theforeman-dev IRC channel on freenode or via the 
+[community forum](https://community.theforeman.org/)
 
 ### Test Run
 

data/app/controllers/katello/api/registry/registry_proxies_controller.rb

@@ -3,13 +3,15 @@ module Katello
   class Api::Registry::RegistryProxiesController < Api::V2::ApiController
     before_action :disable_strong_params
     before_action :confirm_settings
+    before_action :confirm_push_settings, only: [:start_upload_blob, :upload_blob, :finish_upload_blob,
+                                                 :chunk_upload_blob, :push_manifest]
     skip_before_action :authorize
     before_action :optional_authorize, only: [:token]
     before_action :registry_authorize, except: [:token, :v1_search]
     before_action :authorize_repository_read, only: [:pull_manifest, :tags_list]
     before_action :authorize_repository_write, only: [:push_manifest]
-    skip_before_action :check_content_type, :only => [:start_upload_blob, :upload_blob, :finish_upload_blob,
-                                                      :chunk_upload_blob, :push_manifest]
+    skip_before_action :check_content_type, only: [:start_upload_blob, :upload_blob, :finish_upload_blob,
+                                                   :chunk_upload_blob, :push_manifest]
     skip_after_action :log_response_body, :only => [:pull_blob]
 
     wrap_parameters false
@@ -89,8 +91,7 @@ module Katello
     # Also include repositories in lifecycle environments with registry_unauthenticated_pull=true
     def readable_repositories
       table_name = Repository.table_name
-      in_products = Repository.where(:product_id => Katello::Product.authorized(:view_products))
-                      .select(:id)
+      in_products = Repository.in_product(Katello::Product.authorized(:view_products)).select(:id)
       in_environments = Repository.where(:environment_id => Katello::KTEnvironment.authorized(:view_lifecycle_environments)).select(:id)
       in_unauth_environments = Repository.joins(:environment).where("#{Katello::KTEnvironment.table_name}.registry_unauthenticated_pull" => true).select(:id)
       in_content_views = Repository.joins(:content_view_repositories).where("#{ContentViewRepository.table_name}.content_view_id" => Katello::ContentView.readable).select(:id)
@@ -100,9 +101,9 @@ module Katello
 
     def find_readable_repository
       return nil unless params[:repository]
-      repository = Repository.docker_type.find_by_container_repository_name(params[:repository])
+      repository = Repository.docker_type.find_by(container_repository_name: params[:repository])
       if repository && !repository.environment.registry_unauthenticated_pull
-        repository = readable_repositories.docker_type.find_by_container_repository_name(params[:repository])
+        repository = readable_repositories.docker_type.find_by(container_repository_name: params[:repository])
       end
       repository
     end
@@ -284,8 +285,9 @@ module Katello
       params[:per_page] = params[:n] || 25
       params[:search] = params[:q]
 
-      search_results = scoped_search(readable_repositories.where(content_type: 'docker').distinct,
+      search_results = scoped_search(readable_repositories.docker_type.distinct,
                                      :container_repository_name, :asc, options)
+
       results = {
         num_results: search_results[:subtotal],
         query: params[:search]
@@ -449,10 +451,15 @@ module Katello
     end
 
     def confirm_settings
-      return true if SETTINGS[:katello][:container_image_registry]
+      return true if SETTINGS.dig(:katello, :container_image_registry)
       render_error('custom_error', :status => :not_found,
                    :locals => { :message => "Registry not configured" })
-      false
+    end
+
+    def confirm_push_settings
+      return true if SETTINGS.dig(:katello, :container_image_registry, :allow_push)
+      render_error('custom_error', :status => :not_found,
+                   :locals => { :message => "Registry push not supported" })
     end
 
     def request_url

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

@@ -417,7 +417,7 @@ module Katello
     end
 
     def rhsm_params
-      params.slice(:name, :type, :facts, :installedProducts, :autoheal, :releaseVer, :serviceLevel, :uuid, :capabilities, :guestIds, :lastCheckin).to_h
+      params.slice(:name, :type, :facts, :installedProducts, :autoheal, :releaseVer, :usage, :role, :addOns, :serviceLevel, :uuid, :capabilities, :guestIds, :lastCheckin).to_h
     end
 
     def logger

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

@@ -22,10 +22,8 @@ module Katello
       param :per_page, :number, :desc => N_("Number of results per page to return")
       param :order, String, :desc => N_("Sort field and order, eg. 'id DESC'")
       param :full_result, :bool, :desc => N_("Whether or not to show all results")
-      param :sort, Hash, :desc => N_("Hash version of 'order' param") do
-        param :by, String, :desc => N_("Field to sort the results on")
-        param :order, String, :desc => N_("How to order the sorted results (e.g. ASC for ascending)")
-      end
+      param :sort_by, String, :desc => N_("Field to sort the results on")
+      param :sort_order, String, :desc => N_("How to order the sorted results (e.g. ASC for ascending)")
     end
 
     param :object_root, String, :desc => N_("root-node of single-resource responses (optional)")
@@ -54,6 +52,9 @@ module Katello
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/PerceivedComplexity
     def scoped_search(query, default_sort_by, default_sort_order, options = {})
+      params[:sort_by] ||= default_sort_by
+      params[:sort_order] ||= default_sort_order
+
       resource = options[:resource_class] || resource_class
       includes = options.fetch(:includes, [])
       group = options.fetch(:group, nil)
@@ -62,33 +63,21 @@ module Katello
 
       if params[:order]
         (params[:sort_by], params[:sort_order]) = params[:order].split(' ')
-      end
-
-      sort_attr = (params[:sort_by] || default_sort_by).to_s.downcase
-
-      if sort_attr.present? && !resource.column_names.include?(sort_attr)
-        fail ScopedSearch::QueryNotSupported, _("the field (%s) in the order statement is not valid field for search") % sort_attr
+      else
+        params[:order] = "#{params[:sort_by]} #{params[:sort_order]}"
       end
 
       total = scoped_search_total(query, group)
 
-      unless empty_search_query?
-        query = query.pluck(:id) if query.respond_to?(:pluck)
-        query = resource.search_for(*search_options).where("#{resource.table_name}.id" => query)
-      end
+      query = query.select(:id) if query.respond_to?(:select)
+      query = resource.search_for(*search_options).where("#{resource.table_name}.id" => query)
 
       query = self.final_custom_index_relation(query) if self.respond_to?(:final_custom_index_relation)
 
       query = query.select(group).group(group) if group
       sub_total = total.zero? ? 0 : scoped_search_total(query, group)
 
-      if sort_attr.present?
-        sort_order = (params[:sort_order] || default_sort_order).to_s.downcase
-        sort_order = default_sort_order unless ['desc', 'asc'].include?(sort_order)
-        query = query.order(sort_attr => sort_order.to_sym)
-        params[:sort_by] = sort_attr
-        params[:sort_order] = sort_order
-      elsif options[:custom_sort]
+      if options[:custom_sort]
         query = options[:custom_sort].call(query)
       end
       query = query.order("#{query.table_name}.id DESC") unless group #secondary order to ensure sort is deterministic
@@ -111,7 +100,7 @@ module Katello
         message = _('Your search query was invalid. Please revise it and try again. The full error has been sent to the application logs.')
       end
 
-      scoped_search_results(blank_query, sub_total, total, page, per_page, message)
+      scoped_search_results(blank_query, 0, 0, page, per_page, message)
     end
 
     protected
@@ -178,6 +167,15 @@ module Katello
       return Organization.find_by(:id => org_id)
     end
 
+    def csv_response(resources, columns = csv_columns, header = nil, filename = nil)
+      if filename || Organization.current.blank?
+        super
+      else
+        filename = "#{Organization.current.label}-#{controller_name}-#{Date.today}.csv"
+        super(resources, columns, header, filename)
+      end
+    end
+
     def find_default_organization_and_or_environment
       return if (params.keys & %w(organization_id owner environment_id host_collection_id)).any?
 

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

@@ -69,7 +69,7 @@ module Katello
       @lifecycle_environments = @capsule_content.lifecycle_environments(@organization)
     end
 
-    api :DELETE, '/capsules/:id/content/sync', N_('Cancel running smart proxy synchronization.')
+    api :DELETE, '/capsules/:id/content/sync', N_('Cancel running smart proxy synchronization')
     param :id, Integer, :desc => N_('Id of the smart proxy'), :required => true
     def cancel_sync
       tasks = capsule_content.cancel_sync

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

@@ -5,13 +5,17 @@ module Katello
 
     api :GET, "/content_view_filters/:content_view_filter_id/rules", N_("List filter rules")
     param :content_view_filter_id, :number, :desc => N_("filter identifier"), :required => true
+    param :name, String, :desc => N_("name of the content view filter rule"), :required => false
+    param :errata_id, String, :desc => N_("errata_id of the content view filter rule"), :required => false
     param_group :search, Api::V2::ApiController
     def index
-      respond(collection: scoped_search(index_relation, :name, :asc, resource_class: ContentViewFilter.rule_class_for(@filter)))
+      respond(collection: scoped_search(index_relation, :id, :asc, resource_class: ContentViewFilter.rule_class_for(@filter)))
     end
 
     def index_relation
       query = ContentViewFilter.rule_class_for(@filter).where(content_view_filter_id: @filter.id)
+      query = query.where(:name => params[:name]) if params[:name]
+      query = query.where(:errata_id => params[:errata_id]) if params[:errata_id]
       query
     end
 

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

@@ -7,7 +7,7 @@ module Katello
     api :GET, "/content_views/:id/history", N_("Show a content view's history")
     param :id, :number, :desc => N_("content view numeric identifier"), :required => true
     def index
-      respond_for_index :collection => scoped_search(index_relation.distinct, :katello_content_view_version_id, :asc, :resource_class => ContentViewHistory)
+      respond_for_index :collection => scoped_search(index_relation.distinct, :content_view_version_id, :asc, :resource_class => ContentViewHistory)
     end
 
     def index_relation

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

@@ -24,10 +24,9 @@ module Katello
     param_group :search, Api::V2::ApiController
     def index
       options = {
-        :includes => [:content_view, :environments, :composite_content_views, :history => :task],
-        :custom_sort => lambda { |query| query.order("#{ContentViewVersion.table_name}.major desc, #{ContentViewVersion.table_name}.minor desc") }
+        :includes => [:content_view, :environments, :composite_content_views, :history => :task]
       }
-      respond(:collection => scoped_search(index_relation.distinct, nil, nil, options))
+      respond(:collection => scoped_search(index_relation.distinct, :version, :desc, options))
     end
 
     def index_relation
@@ -65,7 +64,7 @@ module Katello
       respond_for_async :resource => task
     end
 
-    api :PUT, "/content_view_versions/:id", N_("Update a content view version.")
+    api :PUT, "/content_view_versions/:id", N_("Update a content view version")
     param :id, :number, :desc => N_("Content view version identifier"), :required => true
     param :description, String, :desc => N_("The description for the content view version"), :required => true
     def update
@@ -79,19 +78,20 @@ module Katello
       end
     end
 
-    api :PUT, "/content_view_versions/:id/republish_repositories", N_("Forces a republish of the version's repositories' metadata.")
+    api :PUT, "/content_view_versions/:id/republish_repositories", N_("Forces a republish of the version's repositories' metadata")
     param :id, :number, :desc => N_("Content view version identifier"), :required => true
     def republish_repositories
       task = async_task(::Actions::Katello::ContentViewVersion::RepublishRepositories, @version)
       respond_for_async :resource => task
     end
 
-    api :POST, "/content_view_versions/:id/export", N_("Export a content view version")
+    api :POST, "/content_view_versions/:id/export", N_("Export a content view version"), :deprecated => true
     param :id, :number, :desc => N_("Content view version identifier"), :required => true
     param :export_to_iso, :bool, :desc => N_("Export to ISO format"), :required => false
     param :iso_mb_size, :number, :desc => N_("maximum size of each ISO in MB"), :required => false
     param :since, Date, :desc => N_("Optional date of last export (ex: 2010-01-01T12:00:00Z)"), :required => false
     def export
+      ::Foreman::Deprecation.api_deprecation_warning("Export is being deprecated and will be removed in a future version of Katello. Use hammer content-view version export instead.")
       if params[:export_to_iso].blank? && params[:iso_mb_size].present?
         fail HttpErrors::BadRequest, _("ISO export must be enabled when specifying ISO size")
       end
@@ -125,15 +125,15 @@ module Katello
     api :POST, "/content_view_versions/incremental_update", N_("Perform an Incremental Update on one or more Content View Versions")
     param :content_view_version_environments, Array do
       param :content_view_version_id, :number, :desc => N_("Content View Version Ids to perform an incremental update on.  May contain composites as well as one or more components to update.")
-      param :environment_ids, Array, :desc => N_("The list of environments to promote the specified Content View Version to (replacing the older version).")
+      param :environment_ids, Array, :desc => N_("The list of environments to promote the specified Content View Version to (replacing the older version)")
     end
     param :description, String, :desc => N_("The description for the new generated Content View Versions")
-    param :resolve_dependencies, :bool, :desc => N_("If true, when adding the specified errata or packages, any needed dependencies will be copied as well.")
-    param :propagate_all_composites, :bool, :desc => N_("If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment.")
+    param :resolve_dependencies, :bool, :desc => N_("If true, when adding the specified errata or packages, any needed dependencies will be copied as well")
+    param :propagate_all_composites, :bool, :desc => N_("If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment")
     param :add_content, Hash do
-      param :errata_ids, Array, :desc => "Errata ids or uuids to copy into the new versions."
-      param :package_ids, Array, :desc => "Package ids or uuids to copy into the new versions."
-      param :puppet_module_ids, Array, :desc => "Puppet Module ids or uuids to copy into the new versions."
+      param :errata_ids, Array, :desc => "Errata ids or uuids to copy into the new versions"
+      param :package_ids, Array, :desc => "Package ids or uuids to copy into the new versions"
+      param :puppet_module_ids, Array, :desc => "Puppet Module ids or uuids to copy into the new versions"
     end
     param :update_hosts, Hash, :desc => N_("After generating the incremental update, apply the changes to the specified hosts.  Only Errata are supported currently.") do
       param :included, Hash, :required => true, :action_aware => true do

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

@@ -79,9 +79,23 @@ module Katello
     param :description, String, :desc => N_("Description for the new published content view version")
     param :force_yum_metadata_regeneration, :bool, :desc => N_("Force yum metadata regeneration on the repositories " \
                                                            "in the content view version")
+    param :major, :number, :desc => N_("Override the major version number"), :required => false
+    param :minor, :number, :desc => N_("Override the minor version number"), :required => false
+
+    param :repos_units, Array, :desc => N_("Specify the list of units in each repo"), :required => false do
+      param :label, String, :desc => N_("repo label"), :required => true
+      param :rpm_filenames, Array, of: String, :desc => N_("list of rpm filename strings to include in published version"), :required => true
+    end
     def publish
+      if params[:repos_units].present? && @view.composite?
+        fail HttpErrors::BadRequest, _("Directly setting package lists on composite content views is not allowed. Please " \
+                                     "update the components, then re-publish the composite.")
+      end
       task = async_task(::Actions::Katello::ContentView::Publish, @view, params[:description],
-                        :force_yum_metadata_regeneration => params[:force_yum_metadata_regeneration])
+                        :force_yum_metadata_regeneration => params[:force_yum_metadata_regeneration],
+                        :major => params[:major],
+                        :minor => params[:minor],
+                        :repos_units => params[:repos_units])
       respond_for_async :resource => task
     end
 

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

@@ -27,7 +27,7 @@ module Katello
         fail _("Either both parameters 'content_view_id' and 'environment_id' should be specified or neither should be specified")
       end
 
-      collection = scoped_search(index_relation, 'updated_at', 'desc', :resource_class => Erratum, :includes => [:cves])
+      collection = scoped_search(index_relation, 'updated', 'desc', :resource_class => Erratum, :includes => [:cves])
 
       @installable_errata_ids = []
       if @host.content_facet

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

@@ -17,7 +17,10 @@ module Katello
     def_param_group :subscription_facet_attributes do
       param :release_version, String, :desc => N_("Release version for this Host to use (7Server, 7.1, etc)")
       param :autoheal, :bool, :desc => N_("Sets whether the Host will autoheal subscriptions upon checkin")
-      param :service_level, Integer, :desc => N_("Service level to be used for autoheal.")
+      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 :service_level, Integer, :desc => N_("Service level to be used for autoheal")
       param :hypervisor_guest_uuids, Array, :desc => N_("List of hypervisor guest uuids")
       param :installed_products_attributes, Array, :desc => N_("List of products installed on the host") do
         param_group :installed_products
@@ -64,7 +67,7 @@ module Katello
       respond_for_destroy(:resource => @host)
     end
 
-    api :POST, "/hosts/subscriptions/", N_("Register a host with subscription and information.")
+    api :POST, "/hosts/subscriptions/", N_("Register a host with subscription and information")
     param :name, String, :desc => N_("Name of the host"), :required => true
     param :uuid, String, :desc => N_("UUID to use for registered host, random uuid is generated if not provided")
     param :facts, Hash, :desc => N_("Key-value hash of subscription-manager facts, nesting uses a period delimiter (.)")
@@ -90,6 +93,9 @@ module Katello
     def params_to_rhsm_params
       rhsm_params = params.slice(:facts, :uuid, :name).to_unsafe_h
       rhsm_params[:releaseVer] = params['release_version'] if params['release_version']
+      rhsm_params[:usage] = parms['purpose_usage'] if params['purpose_usage']
+      rhsm_params[:role] = parms['purpose_role'] if params['purpose_role']
+      rhsm_params[:addOns] = params['purpose_addons'] if params['purpose_addons']
       rhsm_params[:serviceLevel] = params['service_level'] if params['service_level']
       rhsm_params[:guestIds] = params['hypervisor_guest_uuids'] if params[:hypervisor_guest_uuids]
       rhsm_params[:type] = Katello::Candlepin::Consumer::SYSTEM
@@ -220,10 +226,12 @@ module Katello
     end
 
     def action_permission
-      if ['add_subscriptions', 'remove_subscriptions', 'auto_attach', 'content_override'].include?(params[:action])
+      if ['add_subscriptions', 'destroy', 'remove_subscriptions', 'auto_attach', 'content_override'].include?(params[:action])
         :edit
-      elsif ['index', 'events', 'product_content'].include?(params[:action])
+      elsif ['index', 'events', 'product_content', 'available_release_versions'].include?(params[:action])
         :view
+      else
+        fail ::Foreman::Exception.new(N_("unknown permission for %s"), "#{params[:controller]}##{params[:action]}")
       end
     end
   end

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

@@ -248,6 +248,18 @@ module Katello
       respond_for_index :collection => response, :template => :available_incremental_updates
     end
 
+    api :POST, "/hosts/bulk/module_streams",
+        N_("Fetch available module streams for hosts.")
+    param_group :bulk_params
+    def module_streams
+      options = {}
+      options[:group] = [:name, :stream]
+      options[:resource_class] = Katello::ModuleStream
+      host_module_streams = Katello::ModuleStream.available_for_hosts(@hosts)
+      respond_for_index(collection: scoped_search(host_module_streams, :name, :asc, options),
+                        template: '../../../api/v2/module_streams/name_streams')
+    end
+
     private
 
     def find_errata

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

@@ -0,0 +1,49 @@
+module Katello
+  class Api::V2::ModuleStreamsController < Api::V2::ApiController
+    extend ::Apipie::DSL::Concern
+    apipie_concern_subst(:a_resource => N_("a module stream"), :resource => "module_streams")
+    include Katello::Concerns::Api::V2::RepositoryContentController
+
+    before_action :check_params, :only => :index
+
+    update_api(:index) do
+      param :host_ids, Array, :desc => N_("List of host id to list available module streams for")
+      param :name_stream_only, :boolean, :desc => N_("Return name and stream information only)")
+    end
+    def index
+      if @name_stream_only
+        sort_by, sort_order, options = sort_options
+        options[:group] = [:name, :stream]
+        respond(:collection => scoped_search(index_relation, sort_by, sort_order, options),
+                :template => 'name_streams')
+      else
+        super
+      end
+    end
+
+    def custom_index_relation(collection)
+      if @host_ids
+        collection.available_for_hosts(@host_ids)
+      else
+        collection
+      end
+    end
+
+    def default_sort
+      %w(name asc)
+    end
+
+    private
+
+    def check_params
+      @name_stream_only = ::Foreman::Cast.to_bool(params[:name_stream_only])
+
+      if params[:host_ids]
+        @host_ids = params[:host_ids].is_a?(Array) ? params[:host_ids] : params[:host_ids].split(",")
+        if ::Host::Managed.authorized("view_hosts").where(:id => @host_ids).count != @host_ids.count
+          fail HttpErrors::NotFound, _('One or more hosts not found')
+        end
+      end
+    end
+  end
+end