foreman_scc_manager 1.8.8 → 1.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d51eed6c2336237f44aa0fad512060a43f4bc0dae6fd9a93daa2baa555f915a
-  data.tar.gz: 876ebdd4e76443deec6016c657b44ddcb1e60dcc2c8a81631e5f87cccafcc9b1
+  metadata.gz: 18d3ef9cc3c2af2f26b0da68c6abbb88491361ff689ddeb66061dc574f9604b6
+  data.tar.gz: f4a1152c05a14eab317d058f551a738c2e2f676d570e1810b747e05192382c3a
 SHA512:
-  metadata.gz: ef379e703604fc444d312969f4dd389c952b03dc3f3d5ba98d95989941c9b397b7879bef97d309ae54270f70ffb5b1ef50ee1ba214571800dc82f2ea7d301bd7
-  data.tar.gz: 70c8ddeef5a5ad620dfb6fe1ed3b2296e56cef24be9fc3b07223bc2978b5fb0f116d996bddea4e0bc50db1accef6a82ed263183d13fad7d23a56a9c15da077fc
+  metadata.gz: a5f96e7074f6372e072b99c6a49ec300d151e9f0c9b013b254f70ed1f92011849adbe3c5fa9b2c84658f9919030784ced02116682d5f77ca38b316c17bcb8665
+  data.tar.gz: 39d1e30b2ac55968f70fe1653e2f0e32127e5cec6cb3f5072e8c5936980f0df4c53b7fde847c00f0d5f5961d72b8207e43fe2df0d56f77137a38881d47ce2bc4

data/README.md

@@ -1,18 +1,26 @@
-[![Build Status master](https://travis-ci.org/ATIX-AG/foreman_scc_manager.svg?branch=master)](https://travis-ci.org/ATIX-AG/foreman_scc_manager)
+![Rubocop](https://github.com/ATIX-AG/foreman_scc_manager/actions/workflows/rubocop.yaml/badge.svg)
+![Unit Tests](https://github.com/ATIX-AG/foreman_scc_manager/actions/workflows/unit_tests.yaml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/foreman_scc_manager.svg)](https://badge.fury.io/rb/foreman_scc_manager)
 
-# ForemanSccManager
+# Foreman SCC Manager
 
-Foreman plugin to sync SUSE Customer Center products and repositories into Katello
+Foreman plugin to sync SUSE Customer Center products and repositories into Katello.
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
-for how to install Foreman plugins
+This plugin installation is not supported by foreman-installer and has to be installed manually:
+
+```sh
+yum install tfm-rubygem-foreman_scc_manager
+
+foreman-installer
+```
 
 ## Compatibility
 
 | Foreman Version | Katello Version | Plugin Version |
 | --------------- | --------------- | -------------- |
+| 2.3             | 3.18            | ~> 1.8.9       |
 | 2.1             | 3.16            | ~> 1.8.5       |
 | 2.0             | 3.16            | ~> 1.8.4       |
 | 1.24            | 3.14            | ~> 1.8.0       |
@@ -26,7 +34,12 @@ for how to install Foreman plugins
 | 1.15            | 3.4             | ~> 1.1.0       |
 
 ## Documentation
-The plugin documentation can be found at https://docs.orcharhino.com/sources/management_ui/the_content_menu/suse_subscriptions.html.
+
+[Plugin documentation](https://docs.orcharhino.com/or/docs/sources/usage_guides/managing_sles_systems_guide.html#mssg_installing_the_scc_manager_plugin)
+
+## Hammer CLI Extension
+
+[Hammer CLI for Foreman SCC Manager](https://github.com/ATIX-AG/hammer-cli-foreman-scc-manager)
 
 ## Contributing
 
@@ -34,7 +47,7 @@ Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) 2017 ATIX AG - http://www.atix.de
+Copyright (c) 2021 ATIX AG - https://atix.de
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -48,4 +61,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/Rakefile

@@ -35,13 +35,9 @@ end
 
 task default: :test
 
-begin
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
-rescue StandardError => _e
-  puts 'Rubocop not loaded.'
-end
-
-task :default do
-  Rake::Task['rubocop'].execute
+class ForemanSccManager::Engine
+  def self.root
+    File.expand_path('__dir__')
+  end
 end
+import 'lib/tasks/rubocop.rake'

data/app/controllers/api/v2/scc_products_controller.rb

@@ -12,11 +12,22 @@ module Api
 
       before_action :find_resource, :only => [:show, :subscribe]
 
-      api :GET, '/scc_accounts/:scc_account_id/scc_products/', N_('List all products for scc_account')
+      def metadata_subtotal
+        if @scc_products.present?
+          @scc_products.count
+        else
+          super
+        end
+      end
+
+      api :GET, '/scc_accounts/:scc_account_id/scc_products/', N_('List products for an scc_account')
       param :scc_account_id, :identifier_dottable, :required => true
+      param :subscribed_only, :bool, :required => false, :desc => N_('Show subscribed products only')
       param_group :search_and_pagination, ::Api::V2::BaseController
+
       def index
         scope = resource_scope
+        scope = scope.where.not(:product_id => nil) if ::Foreman::Cast.to_bool(params[:subscribed_only])
         scope = scope.where(:organization => params[:organization_id]) if params[:organization_id].present?
         @scc_products = scope.search_for(params[:search], :order => params[:order]).paginate(:page => params[:page])
       end
@@ -47,8 +58,8 @@ module Api
       private
 
       def find_resource
-        @scc_account = ::SccAccount.find_by!(id: params[:scc_account_id])
-        @scc_product = @scc_account.scc_products.find_by!(id: params[:id])
+        @scc_account = ::SccAccount.find(params[:scc_account_id])
+        @scc_product = @scc_account.scc_products.find(params[:id])
       end
 
       def action_permission

data/app/controllers/scc_accounts_controller.rb

@@ -2,7 +2,7 @@ class SccAccountsController < ApplicationController
   helper_method :scc_filtered_products
   before_action :find_organization
   before_action :find_resource, only: %i[show edit update destroy sync bulk_subscribe]
-  before_action :find_available_gpg_keys, only: %i[new edit]
+  before_action :find_available_gpg_keys, only: %i[new edit update create]
   include Foreman::Controller::AutoCompleteSearch
 
   # GET /scc_accounts
@@ -37,7 +37,7 @@ class SccAccountsController < ApplicationController
   # POST /scc_accounts/test_connection
   def test_connection
     @scc_account = SccAccount.new(scc_account_params)
-    @scc_account.password = SccAccount.find_by!(id: params[:scc_account_id]).password if params[:scc_account_id].present? && scc_account_params[:password].empty?
+    @scc_account.password = SccAccount.find(params[:scc_account_id]).password if params[:scc_account_id].present? && scc_account_params[:password].empty?
     respond_to do |format|
       if @scc_account.test_connection
         format.json { render json: nil, status: :ok }
@@ -106,7 +106,7 @@ class SccAccountsController < ApplicationController
 
   def find_organization
     @organization = Organization.current
-    redirect_to '/select_organization?toState=' + request.path unless @organization
+    redirect_to "/select_organization?toState=#{request.path}" unless @organization
   end
 
   # Use callbacks to share common setup or constraints between actions.

data/app/lib/scc_manager.rb

@@ -1,21 +1,17 @@
 module SccManager
   # adapted from https://github.com/SUSE/connect
   def self.get_scc_data(base_url, rest_url, login, password)
-    if SETTINGS[:katello][:cdn_proxy] && SETTINGS[:katello][:cdn_proxy][:host]
-      proxy_config = SETTINGS[:katello][:cdn_proxy]
-      uri = URI('')
-
-      uri.scheme = URI.parse(proxy_config[:host]).scheme
-      uri.host = URI.parse(proxy_config[:host]).host
-      uri.port = proxy_config[:port].try(:to_s)
-      uri.user = proxy_config[:user]
+    if (proxy_config = ::HttpProxy.default_global_content_proxy)
+      uri = URI(proxy_config[:url])
+      uri.user = proxy_config[:username]
       uri.password = proxy_config[:password] if uri.user.present?
 
       RestClient.proxy = uri.to_s
     end
 
     url = base_url + rest_url
-    auth_header = { Authorization: 'Basic ' + Base64.encode64("#{login}:#{password}").chomp,
+    credentials = Base64.encode64("#{login}:#{password}").chomp
+    auth_header = { Authorization: "Basic #{credentials}",
                     Accept: 'application/vnd.scc.suse.com.v4+json' }
     results = []
     loop do

data/app/models/scc_account.rb

@@ -45,12 +45,7 @@ class SccAccount < ApplicationRecord
   end
 
   def sync_date_is_valid_datetime
-    errors.add(:sync_date, 'must be a valid datetime') if interval != NEVER &&
-                                                          sync_date.present? &&
-                                                          !sync_date.respond_to?(:min) &&
-                                                          !sync_date.respond_to?(:hour) &&
-                                                          !sync_date.respond_to?(:wday) &&
-                                                          !sync_date.respond_to?(:day)
+    errors.add(:sync_date, 'must be a valid datetime') if interval != NEVER && sync_date.blank?
   end
 
   def to_s
@@ -104,7 +99,7 @@ class SccAccount < ApplicationRecord
   end
 
   def add_recurring_logic(sync_date, interval)
-    sd = sync_date
+    sd = sync_date.presence || Time.now
 
     raise _('Interval cannot be nil') if interval.nil?
 
@@ -177,7 +172,7 @@ class SccAccount < ApplicationRecord
   def update_scc_repositories(upstream_repositories)
     upstream_repo_ids = []
     # initially invalidate all repositories and validate them during update
-    invalidated_repos = invalidate_subscription_status(scc_repositories)
+    invalidated_repos = invalidate_subscription_status(scc_repositories, save_record: false)
     # import repositories
     upstream_repositories.each do |ur|
       cached_repository = scc_repositories.find_or_initialize_by(scc_id: ur['id'])
@@ -201,7 +196,7 @@ class SccAccount < ApplicationRecord
     # subscription_valid can be set to nil
     to_invalidate = invalidated_repos.select { |ir| ir.katello_root_repository_id.present? && !ir.subscription_valid }
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Invalidating #{to_invalidate.count} expired repositories"
-    invalidate_subscription_status(to_invalidate, true)
+    invalidate_subscription_status(to_invalidate, save_record: true)
 
     # delete repositories being removed upstream and that are not subscribed to
     to_delete = scc_repositories.where.not(scc_id: upstream_repo_ids)
@@ -212,7 +207,7 @@ class SccAccount < ApplicationRecord
   def update_scc_products(upstream_products)
     upstream_product_ids = []
     # initially invalidate all products and validate them during update
-    invalidated_products = invalidate_subscription_status(scc_products)
+    invalidated_products = invalidate_subscription_status(scc_products, save_record: false)
     # import products
     upstream_products.each do |up|
       cached_product = scc_products.find_or_initialize_by(scc_id: up['id'])
@@ -238,7 +233,7 @@ class SccAccount < ApplicationRecord
     # subscription_valid can be set to nil
     to_invalidate = invalidated_products.select { |ip| ip.product_id.present? && !ip.subscription_valid }
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Invalidating #{to_invalidate.count} expired products"
-    invalidate_subscription_status(to_invalidate, true)
+    invalidate_subscription_status(to_invalidate, save_record: true)
 
     # delete products being removed upstream and that are not subscribed to
     to_delete = scc_products.where.not(scc_id: upstream_product_ids).where(product_id: nil)
@@ -271,9 +266,9 @@ class SccAccount < ApplicationRecord
 
   # set all products/repos invalid
   # params: items_to_invalidate: ActiveRecord_(*)
-  #         save_record: store in database or not (default)
+  #         save_record: store in database or not
   # return: ActiveRecord elements with invalidated subscription status
-  def invalidate_subscription_status(items_to_invalidate, save_record = false)
+  def invalidate_subscription_status(items_to_invalidate, save_record:)
     if items_to_invalidate.present?
       items_to_invalidate.each do |inv|
         inv.subscription_valid = false

data/app/models/scc_repository.rb

@@ -9,11 +9,11 @@ class SccRepository < ApplicationRecord
   has_and_belongs_to_many :scc_products
 
   def full_url
-    token.blank? ? url : url + '?' + token
+    token.blank? ? url : "#{url}?#{token}"
   end
 
   def uniq_name(scc_product)
-    scc_product.scc_id.to_s + ' ' + description
+    "#{scc_product.scc_id} #{description}"
   end
 
   def pretty_name

data/config/routes.rb

@@ -23,7 +23,7 @@ Rails.application.routes.draw do
                      :defaults => { :apiv => 'v2' },
                      :apiv => /v1|v2/,
                      :constraints => ApiConstraints.new(:version => 2, :default => true) do
-      resources :scc_accounts do
+      resources :scc_accounts, except: %i[new edit] do
         collection do
           post 'test_connection'
           get 'auto_complete_search'

data/db/migrate/20210713092440_add_permissions.rb

@@ -0,0 +1,19 @@
+class AddPermissions < ActiveRecord::Migration[6.0]
+  PRODUCT_PERMISSION_NAMES = [
+    'view_scc_products',
+    'subscribe_scc_products'
+  ].freeze
+
+  def up
+    Permission.create!(:name => 'test_connection_scc_accounts', :resource_type => 'SccAccount')
+    PRODUCT_PERMISSION_NAMES.each do |p|
+      Permission.create!(:name => p, :resource_type => SccProduct)
+    end
+  end
+
+  def down
+    (PRODUCT_PERMISSION_NAMES + ['test_connection_scc_accounts']).each do |p|
+      Permission.where(:name => p).destroy_all
+    end
+  end
+end

data/db/migrate/20211022100718_add_product_class_to_scc_product.rb

@@ -0,0 +1,5 @@
+class AddProductClassToSccProduct < ActiveRecord::Migration[6.0]
+  def change
+    add_column :scc_products, :product_class, :string
+  end
+end

data/lib/foreman_scc_manager/engine.rb

@@ -22,16 +22,18 @@ module ForemanSccManager
 
     initializer 'foreman_scc_manager.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_scc_manager do
-        requires_foreman '>= 1.22'
-        requires_foreman_plugin 'katello', '>= 3.12.0'
+        requires_foreman '>= 2.1'
+        requires_foreman_plugin 'katello', '>= 3.16.0'
+
+        precompile_assets 'foreman_scc_manager/scc_accounts.js'
 
         apipie_documented_controllers ["#{ForemanSccManager::Engine.root}/app/controllers/api/v2/*.rb"]
 
         # Add permissions
         security_block :foreman_scc_manager do
           permission :view_scc_accounts,
-                     { :scc_accounts => [:show, :index],
-                       :'api/v2/scc_accounts' => [:show, :index] },
+                     { :scc_accounts => [:show, :index, :auto_complete_search],
+                       :'api/v2/scc_accounts' => [:show, :index, :auto_complete_search] },
                      :resource_type => 'SccAccount'
 
           permission :use_scc_accounts,
@@ -58,15 +60,33 @@ module ForemanSccManager
                      { :scc_accounts => [:sync],
                        :'api/v2/scc_accounts' => [:sync] },
                      :resource_type => 'SccAccount'
+
+          permission :test_connection_scc_accounts,
+                     { :scc_accounts => [:test_connection],
+                       :'api/v2/scc_accounts' => [:test_connection] },
+                     :resource_type => 'SccAccount'
+
+          permission :view_scc_products,
+                     { :scc_products => [:index, :show],
+                       :'api/v2/scc_products' => [:index, :show] },
+                     :resource_type => 'SccProduct'
+
+          permission :subscribe_scc_products,
+                     { :scc_products => [:subscribe, :unsubscribe],
+                       :'api/v2/scc_products' => [:subscribe, :unsibscribe] },
+                     :resource_type => 'SccProduct'
         end
 
         # Add a new role called 'SccManager' if it doesn't exist
         role 'SccManager',
-             %i[view_scc_accounts use_scc_accounts new_scc_accounts edit_scc_accounts delete_scc_accounts sync_scc_accounts],
+             %i[view_scc_accounts use_scc_accounts new_scc_accounts edit_scc_accounts
+                delete_scc_accounts sync_scc_accounts test_connection_scc_accounts
+                view_scc_products subscribe_scc_products],
              'Role granting permissons to manage SUSE Subscriptions'
 
         role 'SccViewer',
-             %i[view_scc_accounts use_scc_accounts sync_scc_accounts create_products view_products],
+             %i[view_scc_accounts use_scc_accounts sync_scc_accounts
+                create_products view_products subscribe_scc_products view_scc_products],
              'Role granting permissons to view and use SUSE Subscriptions'
 
         add_all_permissions_to_default_roles

data/lib/foreman_scc_manager/version.rb

@@ -1,3 +1,3 @@
 module ForemanSccManager
-  VERSION = '1.8.8'.freeze
+  VERSION = '1.8.13'.freeze
 end