foreman_scc_manager 1.8.12 → 1.8.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f09d1fba685e2d82d20dcc19d519dfce35a1b6bd04b6c64353e2e40519b30fc9
-  data.tar.gz: afdb4e0f4c17546b8984c7b29d3bebfce35fa9043fb308a60423c8f113df2b84
+  metadata.gz: 18d3ef9cc3c2af2f26b0da68c6abbb88491361ff689ddeb66061dc574f9604b6
+  data.tar.gz: f4a1152c05a14eab317d058f551a738c2e2f676d570e1810b747e05192382c3a
 SHA512:
-  metadata.gz: 93779edde27305d62942cdcce50ba8dd548af379f0ff9b88fd7fe800b79bb3de41c58f6e873b116451ba20fbd65c89f6ab0428fbe7f8c7f25f07bc26982054f1
-  data.tar.gz: 0c58463cfd08bf269ae9c3a6ba2b0c833f1327d5985038cf32b38ff60a3a307377498759ca6cb11734de7a31122b2743bd9a8cb84a454cc8b6167682925c14a4
+  metadata.gz: a5f96e7074f6372e072b99c6a49ec300d151e9f0c9b013b254f70ed1f92011849adbe3c5fa9b2c84658f9919030784ced02116682d5f77ca38b316c17bcb8665
+  data.tar.gz: 39d1e30b2ac55968f70fe1653e2f0e32127e5cec6cb3f5072e8c5936980f0df4c53b7fde847c00f0d5f5961d72b8207e43fe2df0d56f77137a38881d47ce2bc4

data/README.md

@@ -8,7 +8,13 @@ Foreman plugin to sync SUSE Customer Center products and repositories into Katel
 
 ## Installation
 
-See [Foreman Manual](https://theforeman.org/plugins/#2.Installation) on 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
 
@@ -29,7 +35,7 @@ See [Foreman Manual](https://theforeman.org/plugins/#2.Installation) on how to i
 
 ## Documentation
 
-[Plugin documentation](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
 

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

@@ -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

@@ -10,7 +10,8 @@ module SccManager
     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

@@ -172,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'])
@@ -196,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)
@@ -207,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'])
@@ -233,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)
@@ -266,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/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/version.rb

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

data/test/actions/sync_test.rb

@@ -0,0 +1,24 @@
+require 'test_plugin_helper'
+
+class SccManagerActions < ActiveSupport::TestCase
+  include Dynflow::Testing
+
+  let(:action_class) { ::Actions::SccManager::Sync }
+
+  def setup
+    @scc_account = scc_accounts(:one)
+    # ensure we have an org label
+    get_organization
+  end
+
+  test 'plan sync action' do
+    action = create_action(action_class)
+    action.stubs(:action_subject).with(@scc_account)
+
+    assert_respond_to(action, :phase)
+    plan_action(action, @scc_account)
+
+    assert_action_planned_with(action, ::Actions::SccManager::SyncProducts, @scc_account)
+    assert_action_planned_with(action, ::Actions::SccManager::SyncRepositories, @scc_account)
+  end
+end

data/test/controllers/api/v2/scc_products_test.rb

@@ -5,7 +5,9 @@ class Api::V2::SccProductsControllerTest < ActionController::TestCase
     @scc_account = scc_accounts(:one)
     @scc_product1 = scc_products(:one)
     @scc_product2 = scc_products(:two)
-    @scc_account.scc_products = [@scc_product1, @scc_product2]
+    @scc_product3 = scc_products(:three)
+    @scc_product4 = scc_products(:four)
+    @scc_account.scc_products = [@scc_product1, @scc_product2, @scc_product3, @scc_product4]
   end
 
   test 'should get index' do
@@ -37,4 +39,22 @@ class Api::V2::SccProductsControllerTest < ActionController::TestCase
     put :subscribe, params: { :id => 'doest-not-exit', :scc_account_id => @scc_account.id }
     assert_response :not_found
   end
+
+  test 'show subscribed products only' do
+    get :index, params: { :scc_account_id => @scc_account.id, :subscribed_only => true }
+    assert_response :success
+    body = ActiveSupport::JSON.decode(@response.body)
+    assert_not_empty body
+    assert_equal 2, body['results'].count
+    assert_equal 2, body['subtotal']
+  end
+
+  test 'show all products if subscribed_only flag is set to false' do
+    get :index, params: { :scc_account_id => @scc_account.id, :subscribed_only => false }
+    assert_response :success
+    body = ActiveSupport::JSON.decode(@response.body)
+    assert_not_empty body
+    assert_equal 4, body['results'].count
+    assert_equal 4, body['subtotal']
+  end
 end

data/test/controllers/scc_accounts_controller_test2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class SccAccountsControllerTest2 < ActionDispatch::IntegrationTest

data/test/fixtures/models/katello_products.yml.bak

@@ -0,0 +1,10 @@
+p1:
+  id: 1
+  name: 'katello product 1'
+  provider_id: 1
+  created_at: Time.now
+p2:
+  id: 2
+  name: 'katello product 2'
+  provider_id: 1
+  created_at: Time.now

data/test/fixtures/models/scc_products.yml

@@ -10,6 +10,7 @@ one:
   description: "<p> lorem ipsum dolor sit amet </p>"
   product_type: base
   subscription_valid: nil
+  product_id: nil
 
 two:
   scc_account_id: test_account1
@@ -21,6 +22,7 @@ two:
   description: "<p> lorem ipsum dolor sit amet </p><p> lorem lorem lorem </p>"
   product_type: extras
   subscription_valid: true
+  product_id: nil
 
 three:
   scc_account_id: test_account1
@@ -32,18 +34,31 @@ three:
   description: lorem ipsum dolor sit amet
   product_type: base
   subscription_valid: nil
+  product_id: 1
+
+four:
+  scc_account_id: test_account1
+  scc_id: 444
+  name: four
+  version: 4
+  arch: x86_128
+  friendly_name: number four
+  description: lorem ipsum dolor sit amet
+  product_type: base
+  subscription_valid: nil
+  product_id: 2
 
 # create a couple of products as scc_extensions
 <% 1.upto(10) do |i| %>
 p_extension_<%= i %>:
   scc_account_id: test_account1
   scc_id: <%= i %>
-  name: p_ext_<%= i%> 
+  name: p_ext_<%= i%>
   version: 3
   arch: x86_128
-  friendly_name: number <%= i%> 
+  friendly_name: number <%= i%>
   description: lorem ipsum dolor sit amet
   product_type: extension
   subscription_valid: nil
+  product_id: nil
 <% end %>
-

data/test/models/katello_products.rb

@@ -0,0 +1,10 @@
+p1:
+  id: 1
+  name: 'katello product 1'
+  provider_id: 1
+
+p2:
+  id: 2
+  name: 'katello product 2'
+  provider_id: 1
+

data/test/models/scc_product_test.rb

@@ -30,7 +30,7 @@ end
 
 class SccProductSearchTest < ActiveSupport::TestCase
   test 'default ordered by name' do
-    product_names = ['one', 'two', 'three',
+    product_names = ['one', 'two', 'three', 'four',
                      'p_ext_1', 'p_ext_10', 'p_ext_2', 'p_ext_3',
                      'p_ext_4', 'p_ext_5', 'p_ext_6', 'p_ext_7',
                      'p_ext_8', 'p_ext_9']

data/test/test_controller_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 # require "#{Katello::Engine.root}/test/katello_test_helper"
@@ -10,6 +12,8 @@ module SignInHelper
   end
 end
 
-class ActionDispatch::IntegrationTest
-  include SignInHelper
+module ActionDispatch
+  class IntegrationTest
+    include SignInHelper
+  end
 end

data/test/test_plugin_helper.rb

@@ -1,6 +1,8 @@
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 
+require 'dynflow/testing'
+Dynflow::Testing.logger_adapter.level = 1
 require 'foreman_tasks/test_helpers'
 require "#{ForemanSccManager::Engine.root}/test/support/fixtures_support"
 

data/test/unit/access_permissions_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 require 'unit/shared/access_permissions_test_base'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_scc_manager
 version: !ruby/object:Gem::Version
-  version: 1.8.12
+  version: 1.8.13
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -36,28 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,7 @@ files:
 - db/migrate/20210210104407_add_root_repository_id_to_scc_repository.rb
 - db/migrate/20210224095050_connect_katello_root_repository_to_scc_repository.rb
 - db/migrate/20210713092440_add_permissions.rb
+- db/migrate/20211022100718_add_product_class_to_scc_product.rb
 - lib/foreman_scc_manager.rb
 - lib/foreman_scc_manager/engine.rb
 - lib/foreman_scc_manager/version.rb
@@ -182,6 +183,7 @@ files:
 - locale/en/foreman_scc_manager.po.time_stamp
 - locale/foreman_scc_manager.pot
 - locale/gemspec.rb
+- test/actions/sync_test.rb
 - test/controllers/api/v2/scc_accounts_test.rb
 - test/controllers/api/v2/scc_products_test.rb
 - test/controllers/scc_accounts_controller_test.rb
@@ -192,10 +194,12 @@ files:
 - test/fixtures/files/data_products_page2.json
 - test/fixtures/files/data_repositories.json
 - test/fixtures/files/data_subscriptions.json
+- test/fixtures/models/katello_products.yml.bak
 - test/fixtures/models/scc_accounts.yml
 - test/fixtures/models/scc_extendings.yml
 - test/fixtures/models/scc_products.yml
 - test/fixtures/models/scc_repositories.yml
+- test/models/katello_products.rb
 - test/models/scc_account_test.rb
 - test/models/scc_product_test.rb
 - test/support/fixtures_support.rb
@@ -232,14 +236,17 @@ test_files:
 - test/test_controller_helper.rb
 - test/features/sync_test.rb
 - test/models/scc_product_test.rb
+- test/models/katello_products.rb
 - test/models/scc_account_test.rb
 - test/factories/foreman_scc_manager_factories.rb
 - test/controllers/api/v2/scc_accounts_test.rb
 - test/controllers/api/v2/scc_products_test.rb
 - test/controllers/scc_accounts_controller_test2.rb
 - test/controllers/scc_accounts_controller_test.rb
+- test/actions/sync_test.rb
 - test/support/fixtures_support.rb
 - test/fixtures/models/scc_accounts.yml
+- test/fixtures/models/katello_products.yml.bak
 - test/fixtures/models/scc_repositories.yml
 - test/fixtures/models/scc_products.yml
 - test/fixtures/models/scc_extendings.yml