foreman_scc_manager 1.8.4 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad2397229cd491566c2860224641db959be83c82254864cd06f5c37648cd60e
-  data.tar.gz: f9a8e1e8f6ab872e1e0528beab2563421d498e5aaa32a38c21b00756d4cf84b6
+  metadata.gz: f4d297d61cfdedf0fb329cba44d7925c052c1c8e80f8f0ec58b1435b90b229fe
+  data.tar.gz: 3b434307e158ce5b45ad3e719a7538895a8bcf8d01c98f449561c8d18d4ba87f
 SHA512:
-  metadata.gz: 962060eff9906bfb01a629a3700adaa460d5120d57e2823a19ce786f1aecafad65ddd903d2430a40a431f53a7ed341fd39103324382c9cf33fd07380b1cc49e4
-  data.tar.gz: 2d3fd9536db98424c81f7b730727d5c7fd6034428e9cbd64eb238ed4b4b022267b4f6c2a39b1f6d6008f28e751d05da3341476d7f9366151f481d3ec95b8c91c
+  metadata.gz: b31980bb5ef8302a4015ddc5338a7cbb217e666c271ae03781ba530d3823a8608e8afd9d686f80113280ed9033a033b9988fcf8a7a376e791ed2e4a30d7bf159
+  data.tar.gz: 8ebaf1d499fbe65e28c61177ddfbbc6efdf6d1438dc854493686b3842d41ae8a0d9f3bb6ef66bede4ecb2c5c0c82a40da50221e376d96974e0bca18a684a6eb5

data/README.md

@@ -13,6 +13,8 @@ for how to install Foreman plugins
 
 | Foreman Version | Katello Version | Plugin Version |
 | --------------- | --------------- | -------------- |
+| 2.1             | 3.16            | ~> 1.8.5       |
+| 2.0             | 3.16            | ~> 1.8.4       |
 | 1.24            | 3.14            | ~> 1.8.0       |
 | 1.22            | 3.12            | ~> 1.7.0       |
 | 1.21            | 3.10            | ~> 1.6.0       |
@@ -23,6 +25,9 @@ for how to install Foreman plugins
 | 1.16            | 3.5             | <= 1.3.0       |
 | 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.
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!

data/app/controllers/scc_accounts_controller.rb

@@ -1,4 +1,5 @@
 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]
   include Foreman::Controller::AutoCompleteSearch
@@ -7,6 +8,11 @@ class SccAccountsController < ApplicationController
   def index
     @scc_accounts = resource_base.search_for(params[:search], order: params[:order])
                                  .paginate(page: params[:page])
+
+    # overwrite the product list with filtered products that do not include products with empty repositories
+    @scc_accounts.each do |scc_account|
+      scc_account.scc_products_with_repos_count = scc_account.scc_products.only_products_with_repos.count
+    end
   end
 
   # GET /scc_accounts/new
@@ -121,9 +127,22 @@ class SccAccountsController < ApplicationController
     when 'sync', 'test_connection'
       :sync
     when 'bulk_subscribe'
-      :bulk_subscribe
+      :use
     else
       super
     end
   end
+
+  # Function filters a product list and removes all products without valid repositories
+  # The .order call is necessary to apply the ordering to repository that have already been loaded from the database.
+  # Input parameters:
+  # product_list: list of SccProduct
+  # product_type: return only base products if type is set (default), else all
+  def scc_filtered_products(product_list, product_type = 'base')
+    if product_type == 'base'
+      product_list.only_products_with_repos.where(product_type: 'base').order(:friendly_name)
+    else
+      product_list.only_products_with_repos.order(:friendly_name)
+    end
+  end
 end

data/app/models/scc_account.rb

@@ -2,6 +2,9 @@ class SccAccount < ApplicationRecord
   include Authorizable
   include Encryptable
   include ForemanTasks::Concerns::ActionSubject
+
+  attr_accessor :scc_products_with_repos_count
+
   encrypts :password
 
   NEVER = 'never'.freeze

data/app/models/scc_product.rb

@@ -2,6 +2,8 @@ class SccProduct < ApplicationRecord
   include Authorizable
   include ForemanTasks::Concerns::ActionSubject
 
+  scope :only_products_with_repos, -> { joins(:scc_repositories).distinct }
+
   self.include_root_in_json = false
 
   belongs_to :scc_account

data/app/views/scc_accounts/index.html.erb

@@ -17,15 +17,16 @@
         <td class="display-two-pane ellipsis">
           <%= link_to_if_authorized(scc_account.name, hash_for_edit_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer)) %>
         </td>
-        <td><%= scc_account.scc_products.count.to_s %></td>
+        <td><%= scc_account.scc_products_with_repos_count.to_s %></td>
         <td><%= link_to_if(scc_account.sync_task, scc_account.sync_status, scc_account.sync_task) %></td>
         <td>
           <%= action_buttons(
-            display_link_if_authorized(_("Select products"), hash_for_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer)),
+            display_link_if_authorized(_("Select products"), hash_for_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer, :permission => 'view_scc_accounts')),
             display_link_if_authorized(_("Sync"), hash_for_sync_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer),
                                        :method => :put),
-            display_delete_if_authorized(hash_for_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer),
+            display_delete_if_authorized(hash_for_scc_account_path(:id => scc_account).merge(:auth_object => scc_account, :authorizer => authorizer, :permission => 'delete_scc_accounts'),
                                          :data => { :confirm => _("Delete %s?") % scc_account.to_s })
+
           ) %>
         </td>
       </tr>

data/app/views/scc_accounts/show.html.erb

@@ -11,8 +11,8 @@
       </span>
       <%= scc_product.friendly_name %>
       <% if scc_product.scc_extensions.any? %>
-        <ul>
-          <% scc_product.scc_extensions.order(:friendly_name).each do |scc_extension| %>
+        <ul style='padding-left: 20px;'>
+          <% scc_filtered_products(scc_product.scc_extensions, 'extension').each do |scc_extension| %>
             <% render_list_node(f, scc_extension, parent_id + "_" + scc_product.id.to_s) %>
           <% end %>
         </ul>
@@ -29,7 +29,7 @@
     <div class="tab-pane active" id="primary">
       <ul>
         <% if @scc_account.synced %>
-          <% @scc_account.scc_products.where(product_type: 'base').order(:friendly_name).each do |scc_product| %>
+          <% scc_filtered_products(@scc_account.scc_products).each do |scc_product| %>
             <% render_list_node(f, scc_product) %>
           <% end %>
         <% else %>

data/db/migrate/20200520281300_fix_scc_permissions.rb

@@ -0,0 +1,22 @@
+class FixSccPermissions < ActiveRecord::Migration[5.2]
+  PERMISSION_NAMES = {
+    :view_scc => :view_scc_accounts,
+    :use_scc => :use_scc_accounts,
+    :new_scc => :new_scc_accounts,
+    :edit_scc => :edit_scc_accounts,
+    :delete_scc => :delete_scc_accounts,
+    :sync_scc => :sync_scc_accounts
+  }.freeze
+
+  def up
+    PERMISSION_NAMES.each do |old_n, new_n|
+      Permission.find_by(name: old_n)&.update(name: new_n, resource_type: 'SccAccount')
+    end
+  end
+
+  def down
+    PERMISSION_NAMES.each do |old_n, new_n|
+      Permission.find_by(name: new_n)&.update(name: old_n, resource_type: nil)
+    end
+  end
+end

data/lib/foreman_scc_manager/engine.rb

@@ -29,37 +29,48 @@ module ForemanSccManager
 
         # Add permissions
         security_block :foreman_scc_manager do
-          permission :view_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:show, :index],
-            :'api/v2/scc_accounts' => [:show, :index]
-          }
-          permission :use_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:bulk_subscribe],
-            :'api/v2/scc_accounts' => [:bulk_subscribe]
-          }
-          permission :new_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:new, :create],
-            :'api/v2/scc_accounts' => [:create]
-          }
-          permission :edit_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:edit, :update],
-            :'api/v2/scc_accounts' => [:update]
-          }
-          permission :delete_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:destroy],
-            :'api/v2/scc_accounts' => [:destroy]
-          }
-          permission :sync_scc, {
-            :'foreman_scc_manager/scc_accounts' => [:sync],
-            :'api/v2/scc_accounts' => [:sync]
-          }
+          permission :view_scc_accounts,
+                     { :scc_accounts => [:show, :index],
+                       :'api/v2/scc_accounts' => [:show, :index] },
+                     :resource_type => 'SccAccount'
+
+          permission :use_scc_accounts,
+                     { :scc_accounts => [:bulk_subscribe],
+                       :'api/v2/scc_accounts' => [:bulk_subscribe] },
+                     :resource_type => 'SccAccount'
+
+          permission :new_scc_accounts,
+                     { :scc_accounts => [:new, :create],
+                       :'api/v2/scc_accounts' => [:create] },
+                     :resource_type => 'SccAccount'
+
+          permission :edit_scc_accounts,
+                     { :scc_accounts => [:edit, :update],
+                       :'api/v2/scc_accounts' => [:update] },
+                     :resource_type => 'SccAccount'
+
+          permission :delete_scc_accounts,
+                     { :scc_accounts => [:destroy],
+                       :'api/v2/scc_accounts' => [:destroy] },
+                     :resource_type => 'SccAccount'
+
+          permission :sync_scc_accounts,
+                     { :scc_accounts => [:sync],
+                       :'api/v2/scc_accounts' => [:sync] },
+                     :resource_type => 'SccAccount'
         end
 
         # Add a new role called 'SccManager' if it doesn't exist
         role 'SccManager',
-             %i[view_scc use_scc new_scc edit_scc delete_scc sync_scc],
+             %i[view_scc_accounts use_scc_accounts new_scc_accounts edit_scc_accounts delete_scc_accounts sync_scc_accounts],
              'Role granting permissons to manage SUSE Subscriptions'
 
+        role 'SccViewer',
+             %i[view_scc_accounts use_scc_accounts sync_scc_accounts create_products view_products],
+             'Role granting permissons to view and use SUSE Subscriptions'
+
+        add_all_permissions_to_default_roles
+
         # add menu entry
         menu :top_menu, :scc_manager,
              url_hash: { controller: :scc_accounts, action: :index },

data/lib/foreman_scc_manager/version.rb

@@ -1,3 +1,3 @@
 module ForemanSccManager
-  VERSION = '1.8.4'.freeze
+  VERSION = '1.8.5'.freeze
 end

data/lib/tasks/test.rake

@@ -14,7 +14,7 @@ end
 
 namespace :jenkins do
   desc 'Test ForemanSccManager with XML output for jenkins'
-  task 'foreman_scc_manager' do
+  task 'foreman_scc_manager' => :environment do
     Rake::Task['jenkins:setup:minitest'].invoke
     Rake::Task['rake:test:foreman_scc_manager'].invoke
   end

data/test/fixtures/models/scc_products.yml

@@ -19,3 +19,27 @@ two:
   friendly_name: number two
   description: lorem ipsum dolor sit amet
   product_type: extras
+
+three:
+  scc_account_id: test_account1
+  scc_id: 333
+  name: three
+  version: 3
+  arch: x86_128
+  friendly_name: number three
+  description: lorem ipsum dolor sit amet
+  product_type: base
+
+# 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%> 
+  version: 3
+  arch: x86_128
+  friendly_name: number <%= i%> 
+  description: lorem ipsum dolor sit amet
+  product_type: extension
+<% end %>
+

data/test/fixtures/models/scc_repositories.yml

@@ -0,0 +1,15 @@
+# repositories for testing the empty repository filtering
+<% 1.upto(8) do |i| %>
+repo_<%= i %>:
+  id: <%= i %>
+  scc_account_id: 1
+  scc_id: <%= 63 + i %>
+  name: SLE10-Debuginfo-Updates_<%= i %>
+  distro_target: sles_<%= i %>
+  description: SLE10-Debuginfo-Updates for sles-10-ppc_<%= i %>
+  url: https://updates.suse.com/repo/example_<%= i %>
+  token: token_<%= i %>
+  autorefresh: true
+  installer_updates: false
+<% end %>
+

data/test/models/scc_product_test.rb

@@ -17,7 +17,11 @@ end
 
 class SccProductSearchTest < ActiveSupport::TestCase
   test 'default ordered by name' do
-    assert_equal SccProduct.all.pluck(:name), ['one', 'two'].sort
+    product_names = ['one', 'two', 'three',
+                     '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']
+    assert_equal SccProduct.all.pluck(:name), product_names.sort
   end
 
   test 'search name' do
@@ -30,3 +34,54 @@ class SccProductSearchTest < ActiveSupport::TestCase
     assert_empty empty
   end
 end
+
+# These produt extension tests are pre-tests for the class ProductEmptyRepoAvailableTests.
+# They do not test any direct functionality of the plugin.
+class SccProductExtensionsTest < ActiveSupport::TestCase
+  def setup
+    @product_with_extensions = scc_products(:one)
+    @product_with_extensions.scc_extensions = scc_products.select { |p| p.product_type == 'extension' }
+    @product_with_wrong_extensions = scc_products(:two)
+    @product_with_wrong_extensions.scc_extensions = [scc_products(:three)]
+    @product_without_extensions = scc_products(:three)
+  end
+
+  test 'check product extensions available' do
+    assert_equal @product_with_extensions.scc_extensions.count, 10
+    assert_not_empty @product_with_extensions.scc_extensions
+    assert_empty @product_without_extensions.scc_extensions
+  end
+
+  test 'product extension of correct type' do
+    assert_empty(@product_with_extensions.scc_extensions.reject { |p| p.product_type == 'extension' })
+    assert_not_empty(@product_with_wrong_extensions.scc_extensions.reject { |p| p.product_type == 'extension' })
+  end
+end
+
+class SccProductEmptyRepoAvailableTest < ActiveSupport::TestCase
+  def setup
+    @product_with_repos = scc_products(:one)
+    @product_with_repos.scc_extensions = scc_products.select { |p| p.product_type == 'extension' }
+    @product_with_repos.scc_repositories = scc_repositories[0..2]
+    @product_with_repos.scc_extensions[1].scc_repositories = scc_repositories[3..4]
+    @product_with_repos.scc_extensions[2].scc_repositories = scc_repositories[5..7]
+  end
+
+  test 'products with empty repositories' do
+    products_with_repos = SccProduct.only_products_with_repos
+    assert_equal SccProduct.all.count { |prod| !prod.scc_repositories.empty? }, 3
+    assert_equal products_with_repos.count, 3
+  end
+end
+
+class SccProductNoRepoTest < ActiveSupport::TestCase
+  def setup
+    @product_with_repos = scc_products(:one)
+    @product_with_repos.scc_extensions = scc_products.select { |p| p.product_type == 'extension' }
+  end
+
+  test 'products without any repositories' do
+    products_with_repos = SccProduct.only_products_with_repos
+    assert_empty products_with_repos
+  end
+end

data/test/support/fixtures_support.rb

@@ -1,8 +1,9 @@
 module ForemanSccManager
   module FixturesSupport
     FIXTURE_CLASSES = {
-      scc_accounts: ForemanSccManager::SccAccount,
-      scc_products: ForemanSccManager::SccProduct
+      scc_accounts: ::SccAccount,
+      scc_products: ::SccProduct,
+      scc_repositories: ::SccRepository
     }.freeze
 
     def self.set_fixture_classes(test_class)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_scc_manager
 version: !ruby/object:Gem::Version
-  version: 1.8.4
+  version: 1.8.5
 platform: ruby
 authors:
 - ATIX AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -153,6 +153,7 @@ files:
 - db/migrate/20170505063726_add_sync_status_to_scc_account.rb
 - db/migrate/20180321000000_change_sync_status_to_sync_task.rb
 - db/migrate/20190417202427_add_recurring_sync.foreman_scc_manager.rb
+- db/migrate/20200520281300_fix_scc_permissions.rb
 - lib/foreman_scc_manager.rb
 - lib/foreman_scc_manager/engine.rb
 - lib/foreman_scc_manager/version.rb
@@ -176,6 +177,7 @@ files:
 - test/fixtures/files/data_subscriptions.json
 - test/fixtures/models/scc_accounts.yml
 - test/fixtures/models/scc_products.yml
+- test/fixtures/models/scc_repositories.yml
 - test/models/scc_account_test.rb
 - test/models/scc_product_test.rb
 - test/support/fixtures_support.rb
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Suse Customer Center plugin for Foreman
@@ -210,6 +212,7 @@ test_files:
 - test/test_plugin_helper.rb
 - test/features/sync_test.rb
 - test/support/fixtures_support.rb
+- test/fixtures/models/scc_repositories.yml
 - test/fixtures/models/scc_products.yml
 - test/fixtures/models/scc_accounts.yml
 - test/fixtures/files/data_subscriptions.json