foreman_scc_manager 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6322d1af0ee5027a7cdbdf56bf3b9e837dbd55e3f3a6bb1550ec3f9de9d08390
-  data.tar.gz: 1ec9da3d0aa4e905906c0640f80eebf6c7b635565264ddcf455f9f2ee8912b4d
+  metadata.gz: 3107d456ab7e1c5f822a4cbd7bd7ab1892d9f44fbcceb8bd60ec0ffb0746a685
+  data.tar.gz: 4d048099707ca69af205df6ffa0dc31b178e96fcd4a817f4ec4106e6927b255d
 SHA512:
-  metadata.gz: 3c52d141ba0f4f743fc24cf60f21a6fc2273f28025c87a571ead35981d97f525daaf6ac6c7d75baab784281ac1a44ffb0507b65d2f6c732239a945eb921cdae0
-  data.tar.gz: ffd154f4d1d7783bfb339d1048958a76f23ea077560188d9a33919b41a7f4818dd554cea643ce7e686e3d23ae6ca0e5aea0473405c973bb40f27f1acd1e2f6c6
+  metadata.gz: ba3d694f7bdf5978877b7304b6d71a2a035bf58122ac7e1969914d4cd8b6a55adabd174965b10092b32986ec31d31f9e585f0d6a6ebf8045edae20305223538c
+  data.tar.gz: 998d9f9d79624bb1f42e69c8ad546d6dd1c309c373a9a5db11cf849da266ecf0e83d54b77a1e260476b40169d1183c600cafcef1bf99fb8854fc61a3594e783d

data/app/controllers/scc_accounts_controller.rb

@@ -18,11 +18,10 @@ class SccAccountsController < ApplicationController
   # POST /scc_accounts
   def create
     @scc_account = SccAccount.new(scc_account_params)
-    if @scc_account.save
-      process_success
-    else
-      process_error
-    end
+    @scc_account.save_with_logic!
+    process_success
+  rescue ActiveRecord::RecordInvalid
+    process_error
   end
 
   # GET /scc_accounts/1/edit
@@ -43,11 +42,10 @@ class SccAccountsController < ApplicationController
 
   # PATCH/PUT /scc_accounts/1
   def update
-    if @scc_account.update(scc_account_params)
-      process_success
-    else
-      process_error
-    end
+    @scc_account.update_attributes_with_logic!(scc_account_params)
+    process_success
+  rescue ActiveRecord::RecordInvalid
+    process_error
   end
 
   # DELETE /scc_accounts/1
@@ -103,7 +101,15 @@ class SccAccountsController < ApplicationController
   # Only allow a trusted parameter "white list" through.
   def scc_account_params
     params[:scc_account].delete(:password) if params[:scc_account][:password].blank?
-    params.require(:scc_account).permit(:name, :login, :password, :base_url, :organization_id)
+    params.require(:scc_account).permit(
+      :name,
+      :login,
+      :password,
+      :base_url,
+      :interval,
+      :sync_date,
+      :organization_id
+    )
   end
 
   def scc_bulk_subscribe_params

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

@@ -3,6 +3,7 @@ module Actions
     class SubscribeProduct < Actions::EntryAction
       def plan(scc_product)
         raise _('Product already subscribed!') if scc_product.product
+
         ::Foreman::Logging.logger('foreman_scc_manager')
                           .info("Initiating subscription for SccProduct '#{scc_product.friendly_name}'.")
         sequence do

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

@@ -15,6 +15,7 @@ module Actions
       def finalize
         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_plan_account_repositories.rb

@@ -0,0 +1,38 @@
+module Actions
+  module SccManager
+    class SyncPlanAccountRepositories < Actions::EntryAction
+      include Actions::RecurringAction
+      def plan(scc_account)
+        add_missing_task_group(scc_account)
+        action_subject(scc_account)
+
+        User.as_anonymous_admin do
+          plan_action(::Actions::SccManager::SyncRepositories, scc_account)
+          plan_self(:sync_plan_name => scc_account.name)
+        end
+      end
+
+      def add_missing_task_group(sync_plan)
+        if sync_plan.task_group.nil?
+          sync_plan.task_group = ::SccAccountSyncPlanTaskGroup.create!
+          sync_plan.save!
+        end
+        task.add_missing_task_groups(sync_plan.task_group)
+      end
+
+      def rescue_strategy
+        # Dynflow::Action::Rescue::Skip
+        # REMOVEME
+        Dynflow::Action::Rescue::Fail
+      end
+
+      def humanized_name
+        if input.try(:[], :sync_plan_name)
+          _('Update SUSE repositories %s') % (input[:sync_plan_name] || _('Unknown'))
+        else
+          _('Update SUSE repositories')
+        end
+      end
+    end
+  end
+end

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

@@ -9,12 +9,13 @@ module Actions
       end
 
       def run
-        output[:status] = 'SUCCESS'
+        output[:status] = 'IN PROGRESS'
         begin
           output[:data] = ::SccManager.get_scc_data(input[:base_url],
                                                     '/connect/organizations/repositories',
                                                     input[:login],
                                                     input[:password])
+          output[:status] = 'SUCCESS'
         rescue StandardError
           output[:status] = 'FAILURE'
         end
@@ -37,7 +38,7 @@ module Actions
       end
 
       def humanized_output
-        output.dup.update(data: 'Trimmed')
+        output.dup.update(data: "Trimmed (got #{output[:data]&.length} repositories")
       end
     end
   end

data/app/lib/scc_manager.rb

@@ -21,6 +21,7 @@ module SccManager
     loop do
       response = RestClient.get url, auth_header
       raise 'Connection to SUSE costomer center failed.' unless response.code == 200
+
       links = (response.headers[:link] || '').split(', ').map do |link|
         href, rel = /<(.*?)>; rel="(\w+)"/.match(link).captures
         [rel.to_sym, href]

data/app/models/concerns/recurring_logic_extensions.rb

@@ -0,0 +1,9 @@
+module Concerns
+  module RecurringLogicExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :scc_account, :inverse_of => :foreman_tasks_recurring_logic, :class_name => 'SccAccount'
+    end
+  end
+end

data/app/models/scc_account.rb

@@ -4,12 +4,20 @@ class SccAccount < ApplicationRecord
   include ForemanTasks::Concerns::ActionSubject
   encrypts :password
 
+  NEVER = 'never'.freeze
+  DAILY = 'daily'.freeze
+  WEEKLY = 'weekly'.freeze
+  MONTHLY = 'monthly'.freeze
+  TYPES = [NEVER, DAILY, WEEKLY, MONTHLY].freeze
+
   self.include_root_in_json = false
 
   belongs_to :organization
   belongs_to :sync_task, class_name: 'ForemanTasks::Task'
   has_many :scc_products, dependent: :destroy
   has_many :scc_repositories, dependent: :destroy
+  belongs_to :foreman_tasks_recurring_logic, :inverse_of => :scc_account, :class_name => 'ForemanTasks::RecurringLogic', :dependent => :destroy
+  belongs_to :task_group, :class_name => 'SccAccountSyncPlanTaskGroup', :inverse_of => :scc_account
 
   validates_lengths_from_database
   validates :name, presence: true
@@ -17,11 +25,30 @@ class SccAccount < ApplicationRecord
   validates :login, presence: true
   validates :password, presence: true
   validates :base_url, presence: true
+  validates :interval, :inclusion => { :in => TYPES }, :allow_blank => false
+  validate :sync_date_is_valid_datetime
+
+  after_initialize :init
+  before_destroy :cancel_recurring_logic
 
   default_scope -> { order(:login) }
 
   scoped_search on: :login, complete_value: true
 
+  def init
+    # set default values
+    self.sync_date ||= Time.new if self.new_record?
+  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)
+  end
+
   def to_s
     name
   end
@@ -40,8 +67,103 @@ class SccAccount < ApplicationRecord
     end
   end
 
+  def use_recurring_logic?
+    self.interval != NEVER
+  end
+
+  def save_with_logic!
+    self.task_group ||= SccAccountSyncPlanTaskGroup.create!
+
+    associate_recurring_logic if self.valid?
+
+    self.save!
+    start_recurring_logic if self.use_recurring_logic?
+
+    true
+  end
+
+  def update_attributes_with_logic!(params)
+    transaction do
+      self.update_attributes!(params)
+      if rec_logic_changed?
+        old_rec_logic = self.foreman_tasks_recurring_logic
+        associate_recurring_logic
+        self.save!
+        old_rec_logic&.cancel
+        # Can/Should we do that???
+        old_rec_logic&.destroy
+        start_recurring_logic
+      end
+      toggle_enabled if enabled_toggle?
+    end
+    true
+  end
+
+  def add_recurring_logic(sync_date, interval)
+    sd = sync_date
+
+    raise _('Interval cannot be nil') if interval.nil?
+
+    cron = case interval.downcase
+           when DAILY   then "#{sd.min} #{sd.hour} * * *"
+           when WEEKLY  then "#{sd.min} #{sd.hour} * * #{sd.wday}"
+           when MONTHLY then "#{sd.min} #{sd.hour} #{sd.day} * *"
+           else
+             raise _('Interval not set correctly')
+           end
+
+    recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline(cron)
+
+    raise _('Cron expression is not valid!') unless recurring_logic.valid_cronline?
+
+    recurring_logic.save!
+    recurring_logic
+  end
+
+  def associate_recurring_logic
+    if self.use_recurring_logic?
+      self.foreman_tasks_recurring_logic = add_recurring_logic(self.sync_date, self.interval)
+    else
+      self.foreman_tasks_recurring_logic = nil
+    end
+  end
+
+  def toggle_enabled
+    self.foreman_tasks_recurring_logic&.enabled = self.enabled
+  end
+
+  def start_recurring_logic
+    # rubocop:disable Style/GuardClause
+    if self.use_recurring_logic?
+      User.as_anonymous_admin do
+        if self.sync_date.to_time < Time.now
+          self.foreman_tasks_recurring_logic.start(::Actions::SccManager::SyncPlanAccountRepositories, self)
+        else
+          self.foreman_tasks_recurring_logic.start_after(::Actions::SccManager::SyncPlanAccountRepositories, self.sync_date, self)
+        end
+      end
+    end
+    # rubocop:enable Style/GuardClause
+  end
+
+  def cancel_recurring_logic
+    self.foreman_tasks_recurring_logic&.cancel
+  end
+
+  def rec_logic_changed?
+    saved_change_to_attribute?(:sync_date) || saved_change_to_attribute?(:interval)
+  end
+
+  def enabled_toggle?
+    saved_change_to_attribute?(:enabled)
+  end
+
+  def get_scc_data(rel_url)
+    SccManager.get_scc_data(base_url, rel_url, login, password)
+  end
+
   def test_connection
-    SccManager.get_scc_data(base_url, '/connect/organizations/subscriptions', login, password)
+    get_scc_data('/connect/organizations/subscriptions')
     true
   rescue StandardError
     false

data/app/models/scc_account_sync_plan_task_group.rb

@@ -0,0 +1,7 @@
+class SccAccountSyncPlanTaskGroup < ::ForemanTasks::TaskGroup
+  has_one :scc_account, :foreign_key => :task_group_id, :dependent => :nullify, :inverse_of => :task_group, :class_name => 'SccAccount'
+
+  def resource_name
+    N_('SUSE Subscription')
+  end
+end

data/app/models/scc_product.rb

@@ -26,6 +26,7 @@ class SccProduct < ApplicationRecord
 
   def subscribe
     raise 'Product already subscribed!' if product
+
     new_product = Katello::Product.new
     new_product.name = uniq_name
     new_product.description = description

data/app/views/scc_account_sync_plan_task_groups/_scc_account_sync_plan_task_groups.html.erb

@@ -0,0 +1,4 @@
+<%= _("SUSE Subscription: ") %>
+
+<%= link_to(task_groups.first.scc_account.name, "/scc_accounts/#{task_groups.first.scc_account.id}/edit") %>
+

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

@@ -13,6 +13,10 @@
         <%= text_f f, :login, :help_block => _("Use your 'Organization credentials' obtained from the SUSE Customer Center.") %>
         <%= password_f f, :password %>
         <%= text_f f, :base_url, label: _('Base URL') %>
+        <%= selectable_f f, :interval, SccAccount::TYPES, label: _('Interval') %>
+        <%= field f, :sync_date, label: _('Sync Date') do
+          f.datetime_field :sync_date, placeholder: Time.now
+        end %>
         <div class='clearfix'>
           <div class='form-group'>
             <div class='col-md-2'></div>

data/config/routes.rb

@@ -2,6 +2,7 @@ Rails.application.routes.draw do
   resources :scc_accounts do
     collection do
       put 'test_connection'
+      get 'auto_complete_search'
     end
     member do
       put 'sync'

data/db/migrate/20190417202427_add_recurring_sync.foreman_scc_manager.rb

@@ -0,0 +1,26 @@
+class AddRecurringSync < ActiveRecord::Migration[5.2]
+  class FakeSccAccount < ApplicationRecord
+    self.table_name = 'scc_accounts'
+  end
+
+  def up
+    add_column :scc_accounts, :foreman_tasks_recurring_logic_id, :integer
+    add_column :scc_accounts, :interval, :string, default: 'never'
+    add_column :scc_accounts, :sync_date, :datetime
+    add_foreign_key :scc_accounts, :foreman_tasks_recurring_logics, :name => 'scc_accounts_foreman_tasks_recurring_logic_fk', :column => 'foreman_tasks_recurring_logic_id'
+    add_column :scc_accounts, :task_group_id, :integer, index: true
+    add_foreign_key :scc_accounts, :foreman_tasks_task_groups, column: :task_group_id
+    FakeSccAccount.all.each do |scca|
+      scca.task_group_id ||= SccAccountSyncPlanTaskGroup.create!.id
+      scca.save!
+    end
+  end
+
+  def down
+    remove_column :scc_accounts, :foreman_tasks_recurring_logic_id
+    remove_column :scc_accounts, :interval
+    remove_column :scc_accounts, :sync_date
+    remove_column :scc_accounts, :task_group_id
+    ForemanTasks::TaskGroup.where(:type => 'SccAccountSyncPlanTaskGroup').delete_all
+  end
+end

data/lib/foreman_scc_manager/engine.rb

@@ -9,6 +9,10 @@ module ForemanSccManager
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/overrides"]
 
+    config.to_prepare do
+      ForemanTasks::RecurringLogic.send :include, Concerns::RecurringLogicExtensions
+    end
+
     # Add any db migrations
     initializer 'foreman_scc_manager.load_app_instance_data' do |app|
       ForemanSccManager::Engine.paths['db/migrate'].existent.each do |path|

data/lib/foreman_scc_manager/version.rb

@@ -1,3 +1,3 @@
 module ForemanSccManager
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.6.2'.freeze
 end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,32 @@
+begin
+  require 'rubocop/rake_task'
+
+  test_patterns = [
+    "#{ForemanSccManager::Engine.root}/*.gemspec",
+    "#{ForemanSccManager::Engine.root}/*.rb",
+    "#{ForemanSccManager::Engine.root}/app/**/*.rb",
+    "#{ForemanSccManager::Engine.root}/config/**/*.rb",
+    "#{ForemanSccManager::Engine.root}/db/**/*.rb",
+    "#{ForemanSccManager::Engine.root}/lib/**/*.rake",
+    "#{ForemanSccManager::Engine.root}/lib/**/*.rb",
+    "#{ForemanSccManager::Engine.root}/locale/**/*.rb",
+    "#{ForemanSccManager::Engine.root}/test/**/*.rb"
+  ]
+
+  namespace :foreman_scc_manager do
+    desc 'Runs Rubocop style checker'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.patterns = test_patterns
+    end
+
+    desc 'Runs Rubocop style checker with xml output for Jenkins'
+    RuboCop::RakeTask.new('rubocop:jenkins') do |task|
+      task.patterns = test_patterns
+      task.requires = ['rubocop/formatter/checkstyle_formatter']
+      task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+      task.options = ['--no-color', '--out', 'rubocop.xml']
+    end
+  end
+rescue LoadError
+  puts 'Rubocop not loaded.'
+end

data/lib/tasks/test.rake

@@ -0,0 +1,26 @@
+require 'rake/testtask'
+
+# Tests
+namespace :test do
+  desc 'Test ForemanSccManager'
+  Rake::TestTask.new(:foreman_scc_manager) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :jenkins do
+  desc 'Test ForemanSccManager with XML output for jenkins'
+  task 'foreman_scc_manager' do
+    Rake::Task['jenkins:setup:minitest'].invoke
+    Rake::Task['rake:test:foreman_scc_manager'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_scc_manager']
+
+load 'tasks/jenkins.rake'
+Rake::Task['jenkins:unit'].enhance ['test:foreman_scc_manager', 'foreman_scc_manager:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')