foreman_scc_manager 1.8.6 → 1.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a0b1fc3df2a088cefb4344e848995955fb81a5478cf4500268c68f32ccf0bec
-  data.tar.gz: ae3c19f91491ba06228c59f6314e28d5c8525d8936e89c5a82af092a71dd4e85
+  metadata.gz: d9bb11cd54075948f57fe205b39e75e2d2bac3092cdcd3c1f15e9101bfaa0b3c
+  data.tar.gz: 61351f372d614b5de85b9ec6f490f08bea0c7b1848b06b66b89ca78fd6b4ca29
 SHA512:
-  metadata.gz: 57f473572bfc7342b44765343b168e94bb55ba479bb17d7a9236703bcb5cb7f2cad615b16d76934790a739037eb5b724e70ff637c17e7d95aaaa6dc993eb3bd2
-  data.tar.gz: 6569d327e0ccb6c251a823ae3af6a3bd1a40d44edc9878fd4b538303ec242a8f594dffd0e8fb951ae371c8b22ae13f16a0120ac78a6f9cb4a5bf2dabd33781fb
+  metadata.gz: 8eb54567950e62fef53342af59aa070cf0f45c31832c8869b181250c20953b5850024ded8792ce2abd7a2c947b6317d86ac99a5038f97ffdb61f67728a2a50b8
+  data.tar.gz: ea314767654f27ab0d26097ccc235fbf83fb426e46ef242284f0da8572cc1dcdfe44d2966b471a177c45bf8fbe99c857105b653f61883e39441b021cf9f67c48

data/README.md

@@ -13,6 +13,7 @@ for how to install Foreman plugins
 
 | 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       |
@@ -28,13 +29,16 @@ for how to install Foreman plugins
 ## Documentation
 The plugin documentation can be found at https://docs.orcharhino.com/sources/management_ui/the_content_menu/suse_subscriptions.html.
 
+A Hammer CLI extension is available for this plugin:
+https://github.com/ATIX-AG/hammer-cli-foreman-scc-manager
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!
 
 ## Copyright
 
-Copyright (c) 2017 ATIX AG - http://www.atix.de
+Copyright (c) 2021 ATIX AG - http://www.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

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

@@ -35,7 +35,7 @@ module Api
           param :base_url, String, :required => false, :desc => N_('URL of SUSE for scc_account')
           param :interval, ['never', 'daily', 'weekly', 'monthy'], :desc => N_('Interval for syncing scc_account')
           param :sync_date, String, :desc => N_('Date and time relative to which the sync interval is run')
-          param :katello_gpg_key_id, :identifier, :required => false, :desc => N_('Associated gpg key of scc_account')
+          param :katello_gpg_key_id, :identifier, :required => false, :desc => N_('Associated GPG key of scc_account')
         end
       end
 

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

data/app/lib/actions/scc_manager/subscribe_product.rb

@@ -12,24 +12,34 @@ module Actions
                                               :product_description => scc_product.pretty_description,
                                               :organization_id => scc_product.organization.id,
                                               :gpg_key => scc_product.scc_account.katello_gpg_key_id)
+          katello_repos = {}
           scc_product.scc_repositories.each do |repo|
             arch = scc_product.arch || 'noarch'
-            plan_action(CreateRepository,
-                        :product_id => product_create_action.output[:product_id],
-                        :uniq_name => repo.uniq_name(scc_product),
-                        :pretty_repo_name => repo.pretty_name,
-                        :url => repo.full_url,
-                        :arch => arch)
+            repo_create_action = plan_action(CreateRepository,
+                                             :product_id => product_create_action.output[:product_id],
+                                             :uniq_name => repo.uniq_name(scc_product),
+                                             :pretty_repo_name => repo.pretty_name,
+                                             :url => repo.full_url,
+                                             :arch => arch)
+            katello_repos[repo.id] = repo_create_action.output[:katello_root_repository_id]
           end
+          # connect action to resource (=> make parameters accessable in input)
           action_subject(scc_product, product_id: product_create_action.output[:product_id])
+          input.update(katello_repos: katello_repos)
           plan_self
         end
       end
 
       def finalize
+        # connect Scc products and Katello products
         scc_product = SccProduct.find(input[:scc_product][:id])
         product = ::Katello::Product.find(input[:product_id])
         scc_product.update!(product: product)
+        # extract Katello repo ids from input hash and store to database
+        input[:katello_repos].each do |scc_repo_id, katello_root_repository_id|
+          scc_repo = SccRepository.find(scc_repo_id)
+          scc_repo.update!(katello_root_repository_id: katello_root_repository_id)
+        end
       end
 
       def humanized_name
@@ -74,7 +84,9 @@ module Actions
         repository = product.add_repo(repo_param)
         repository.mirror_on_sync = true
         repository.verify_ssl_on_sync = true
-        trigger(::Actions::Katello::Repository::CreateRoot, repository)
+        trigger(::Actions::Katello::Repository::CreateRoot, repository).tap do
+          output[:katello_root_repository_id] = repository.id
+        end
       end
     end
   end

data/app/lib/actions/scc_manager/sync.rb

@@ -1,21 +1,21 @@
 module Actions
   module SccManager
+    # for dynflow documentation see here: https://dynflow.github.io/documentation/
     class Sync < Actions::EntryAction
       def plan(scc_account)
         ::Foreman::Logging.logger('foreman_scc_manager')
                           .info("Initiating 'sync' for SccAccount '#{scc_account.name}'.")
         action_subject(scc_account)
         sequence do
-          sync_repo_action = plan_action(::Actions::SccManager::SyncRepositories, scc_account)
-          sync_prod_action = plan_action(::Actions::SccManager::SyncProducts, scc_account)
-          plan_self(repo_status: sync_repo_action.output[:status], prod_status: sync_prod_action.output[:status])
+          plan_action(::Actions::SccManager::SyncRepositories, scc_account)
+          plan_action(::Actions::SccManager::SyncProducts, scc_account)
+          plan_self
         end
       end
 
       def finalize
+        # this is only executed if run actions of SyncRepositories and SyncProducts were successful
         scc_account = SccAccount.find(input[:scc_account][:id])
-        raise 'Updating failed' unless input[:repo_status] == 'SUCCESS' && input[:prod_status] == 'SUCCESS'
-
         scc_account.update! synced: Time.current
       end
 

data/app/lib/actions/scc_manager/sync_products.rb

@@ -13,22 +13,19 @@ module Actions
       end
 
       def run
-        output[:status] = 'SUCCESS'
-        begin
-          products = ::SccManager.get_scc_data(input.fetch(:base_url),
-                                               '/connect/organizations/products',
-                                               input.fetch(:login),
-                                               decrypt_field(input.fetch(:password)))
-          output[:data] = ::SccManager.sanitize_products(products).values
-        rescue StandardError => e
-          ::Foreman::Logging.logger('foreman_scc_manager').error "Error while syncronizing SCC-Products: #{e}"
-          output[:error] = e.to_s
-          output[:status] = 'FAILURE'
-        end
+        products = ::SccManager.get_scc_data(input.fetch(:base_url),
+                                             '/connect/organizations/products',
+                                             input.fetch(:login),
+                                             decrypt_field(input.fetch(:password)))
+        output[:data] = ::SccManager.sanitize_products(products).values
+      rescue StandardError => e
+        ::Foreman::Logging.logger('foreman_scc_manager').error "Error while syncronizing SCC-Products: #{e}"
+        error! e.to_s
       end
 
       def finalize
-        SccAccount.find(input.fetch(:id)).update_scc_products(output.fetch(:data)) if output[:status] == 'SUCCESS'
+        # this is only executed if 'run' succeeds
+        SccAccount.find(input.fetch(:id)).update_scc_products(output.fetch(:data))
       end
 
       def rescue_strategy

data/app/lib/actions/scc_manager/sync_repositories.rb

@@ -12,22 +12,18 @@ module Actions
       end
 
       def run
-        output[:status] = 'IN PROGRESS'
-        begin
-          output[:data] = ::SccManager.get_scc_data(input[:base_url],
-                                                    '/connect/organizations/repositories',
-                                                    input[:login],
-                                                    decrypt_field(input[:password]))
-          output[:status] = 'SUCCESS'
-        rescue StandardError => e
-          ::Foreman::Logging.logger('foreman_scc_manager').error "Error while syncronizing SCC-Repositories: #{e}"
-          output[:error] = e.to_s
-          output[:status] = 'FAILURE'
-        end
+        output[:data] = ::SccManager.get_scc_data(input[:base_url],
+                                                  '/connect/organizations/repositories',
+                                                  input[:login],
+                                                  decrypt_field(input[:password]))
+      rescue StandardError => e
+        ::Foreman::Logging.logger('foreman_scc_manager').error "Error while syncronizing SCC-Repositories: #{e}"
+        error! e.to_s
       end
 
       def finalize
-        SccAccount.find(input[:scc_account][:id]).update_scc_repositories(output[:data]) if output[:status] == 'SUCCESS'
+        # this is only executed if 'run' succeeds
+        SccAccount.find(input[:scc_account][:id]).update_scc_repositories(output[:data])
       end
 
       def rescue_strategy

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?
 
@@ -176,6 +171,8 @@ 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)
     # import repositories
     upstream_repositories.each do |ur|
       cached_repository = scc_repositories.find_or_initialize_by(scc_id: ur['id'])
@@ -187,11 +184,21 @@ class SccAccount < ApplicationRecord
       cached_repository.installer_updates = ur['installer_updates']
       # should be called after all attributes are set in case of dependencies (currently: description)
       cached_repository.name = cached_repository.pretty_name
+      cached_repository.subscription_valid = true
       cached_repository.save!
       upstream_repo_ids << ur['id']
+      # set invalidated record to true, if exists
+      invalidated_repos = revalidate_subscription_status(invalidated_repos, ur[id])
     end
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Found #{upstream_repo_ids.length} repositories"
-    # delete repositories beeing removed upstream
+
+    # all scc repos that are kept but not available upstream need to be marked invalid
+    # 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)
+
+    # delete repositories being removed upstream and that are not subscribed to
     to_delete = scc_repositories.where.not(scc_id: upstream_repo_ids)
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Deleting #{to_delete.count} old repositories"
     to_delete.destroy_all
@@ -199,6 +206,8 @@ 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)
     # import products
     upstream_products.each do |up|
       cached_product = scc_products.find_or_initialize_by(scc_id: up['id'])
@@ -212,12 +221,22 @@ class SccAccount < ApplicationRecord
       # name should be set after friendly_name because it depends on friendly_name
       cached_product.name = cached_product.pretty_name
       cached_product.description = cached_product.pretty_description
+      cached_product.subscription_valid = true
       cached_product.save!
       upstream_product_ids << up['id']
+      # set invalidated record to true, if exists
+      invalidated_products = revalidate_subscription_status(invalidated_products, up['id'])
     end
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Found #{upstream_product_ids.length} products"
-    # delete products beeing removed upstream
-    to_delete = scc_products.where.not(scc_id: upstream_product_ids)
+
+    # all scc products that are kept but not available upstream need to be marked invalid
+    # 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)
+
+    # 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)
     ::Foreman::Logging.logger('foreman_scc_manager').debug "Deleting #{to_delete.count} old products"
     to_delete.destroy_all
     # rewire product to product relationships
@@ -230,4 +249,32 @@ class SccAccount < ApplicationRecord
       end
     end
   end
+
+  # validate the subscription status of a product/repo
+  # no saving to database
+  # params: elements: scc repos or products, Array or ActiveRecord_(*)
+  #         scc_id: scc_id of the element that should be revalidated
+  # return: elements where for the element with scc_id subscription_valid is true
+  def revalidate_subscription_status(elements, scc_id)
+    return nil if elements.nil?
+
+    revalidate = elements.find { |e| e.scc_id == scc_id }
+    revalidate.subscription_valid = true unless revalidate.nil?
+    # return modified list
+    elements
+  end
+
+  # set all products/repos invalid
+  # params: items_to_invalidate: ActiveRecord_(*)
+  #         save_record: store in database or not (default)
+  # return: ActiveRecord elements with invalidated subscription status
+  def invalidate_subscription_status(items_to_invalidate, save_record = false)
+    if items_to_invalidate.present?
+      items_to_invalidate.each do |inv|
+        inv.subscription_valid = false
+        inv.save! if save_record
+      end
+    end
+    items_to_invalidate
+  end
 end

data/app/models/scc_repository.rb

@@ -4,6 +4,7 @@ class SccRepository < ApplicationRecord
   self.include_root_in_json = false
 
   belongs_to :scc_account
+  belongs_to :katello_root_repository, class_name: 'Katello::RootRepository'
   has_one :organization, through: :scc_account
   has_and_belongs_to_many :scc_products
 
@@ -12,7 +13,7 @@ class SccRepository < ApplicationRecord
   end
 
   def uniq_name(scc_product)
-    scc_product.uniq_name + ' ' + description
+    scc_product.scc_id.to_s + ' ' + description
   end
 
   def pretty_name
@@ -21,13 +22,10 @@ class SccRepository < ApplicationRecord
 
   def token_changed_callback
     User.current ||= User.anonymous_admin
-    scc_products.where.not(product: nil).find_each do |sp|
-      reponame = uniq_name(sp)
-      repository = sp.product.root_repositories.find_by(name: reponame)
-      unless repository.nil? || repository.url == full_url
-        ::Foreman::Logging.logger('foreman_scc_manager').info "Update URL-token for repository '#{reponame}'."
-        ForemanTasks.async_task(::Actions::Katello::Repository::Update, repository, url: full_url)
-      end
-    end
+    repo = self.katello_root_repository
+    return if repo.nil? || repo.url == full_url
+
+    ::Foreman::Logging.logger('foreman_scc_manager').info "Update URL-token for repository '#{repo.name}'."
+    ForemanTasks.async_task(::Actions::Katello::Repository::Update, repo, url: full_url)
   end
 end

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

@@ -12,6 +12,11 @@
           <%= check_box_tag("scc_account[scc_subscribe_product_ids][]", scc_product.id, false) %>
           <%= scc_product.pretty_name %>
         <% end %>
+        <% unless scc_product.subscription_valid? %>
+          <span style="color:red">
+            <%= _('(WARNING: Please check your SUSE subscription)') %>
+          </span>
+        <% end %>
       </span>
       <% if scc_product.scc_extensions.any? %>
         <ul style='padding-left: 20px;'>

data/db/migrate/20210205082733_add_subscription_valid_to_scc_products_and_repos.rb

@@ -0,0 +1,6 @@
+class AddSubscriptionValidToSccProductsAndRepos < ActiveRecord::Migration[5.2]
+  def change
+    add_column :scc_products, :subscription_valid, :boolean, null: true
+    add_column :scc_repositories, :subscription_valid, :boolean, null: true
+  end
+end

data/db/migrate/20210210104407_add_root_repository_id_to_scc_repository.rb

@@ -0,0 +1,6 @@
+class AddRootRepositoryIdToSccRepository < ActiveRecord::Migration[5.2]
+  def change
+    add_column :scc_repositories, :katello_root_repository_id, :integer, index: true, null: true
+    add_foreign_key :scc_repositories, :katello_root_repositories, column: :katello_root_repository_id, on_delete: :nullify
+  end
+end

data/db/migrate/20210224095050_connect_katello_root_repository_to_scc_repository.rb

@@ -0,0 +1,28 @@
+class ConnectKatelloRootRepositoryToSccRepository < ActiveRecord::Migration[5.2]
+  # add SccRepository class, because original one triggers the token_changed_callback
+  # which tried to update Katello root repositories
+  class SccRepository < ApplicationRecord
+    belongs_to :katello_root_repository, class_name: 'Katello::RootRepository'
+  end
+
+  class SccProduct < ApplicationRecord
+    belongs_to :product, class_name: 'Katello::Product'
+    has_and_belongs_to_many :scc_repositories
+  end
+
+  def up
+    SccProduct.where.not(product_id: nil).each do |scc_p|
+      # extract all katello root repository ids from subscribed products
+      katello_root_repositories = scc_p.product.root_repositories.map { |r| [r.label, r.id] }.to_h
+      # match scc repository and katello repository names
+      # katello repository name can be
+      # 1) equal to scc repo name
+      # 2) equal to scc product id + scc product name + scc repo name
+      scc_p.scc_repositories.each do |scc_r|
+        katello_root_repositories.each do |katello_label, katello_id|
+          scc_r.update!(katello_root_repository_id: katello_id) if katello_label.end_with?(::Katello::Util::Model.labelize(scc_r.name))
+        end
+      end
+    end
+  end
+end

data/db/migrate/20210713092440_add_permissions.rb

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

data/lib/foreman_scc_manager/engine.rb

@@ -22,8 +22,10 @@ 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"]