foreman-tasks 6.0.3 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5c1faf969670adf42567f2dd46b7b78dc2199561bb96b483516fe4169b7558d
-  data.tar.gz: 9aad850fd8decb284e1ccfc1869e5220da554e53286d31ccb3abb6da492a3ca3
+  metadata.gz: 1c6773ac47a0c5b8e3e28da1461a348510e8595da0bd2d08feafd78092394fb2
+  data.tar.gz: 40d4c506cd3d31b72355e8c2d4255c854c703be6be49644b8d30a55032bd9b2b
 SHA512:
-  metadata.gz: 9f76c37ad5faccedfee63f80b35b9bb1a3b65974fbef664c49baac53f6991846ed215c76cef6452bd966ea9da219d1adbae82edba3b3e783c7619ce832d51e96
-  data.tar.gz: d32b7d573c6809bba7bc28a4568513544752657461a9877c4f3824e8f5b0eca0b674fa9161f97cd8c72204b6edcc52f3e86480e19636538c53c8a4f473304e4f
+  metadata.gz: 1d05cdb24aea11a647028a4b1c314cf5f0db3d95459bbcfa0c52aa8f53263b6deb3d27ee23bbb7ec2a227e1ebbead0a432c0ecf6701131b2f7921b39145085ab
+  data.tar.gz: 777127d69a84b7c94780f78ad5a8aa5754ad246e6019a9f35c518e0b246d73b8f6f31acc84029b1b0648b8ff3ba8f167efc4fad7f4116cb4eb2f3fad7b850591

data/app/lib/actions/proxy_action.rb

@@ -22,15 +22,7 @@ module Actions
       end
     end
 
-    class ProxyActionStopped < RuntimeError
-      def backtrace
-        []
-      end
-    end
-
-    ProxyActionStoppedEvent = ::Algebrick.type do
-      fields! exception: type { variants NilClass, Exception }
-    end
+    class ProxyActionStopped; end
 
     def plan(proxy, klass, options)
       options[:connection_options] ||= {}
@@ -60,8 +52,8 @@ module Actions
           on_data(event.data, event.meta)
         when ProxyActionMissing
           on_proxy_action_missing
-        when ProxyActionStoppedEvent
-          on_proxy_action_stopped(event)
+        when ProxyActionStopped
+          on_proxy_action_stopped
         else
           raise "Unexpected event #{event.inspect}"
         end
@@ -102,8 +94,6 @@ module Actions
       else
         suspend
       end
-    rescue RestClient::NotFound
-      on_proxy_action_missing
     end
 
     def cancel_proxy_task
@@ -143,12 +133,8 @@ module Actions
       error! ProxyActionMissing.new(_('Proxy task gone missing from the smart proxy'))
     end
 
-    def on_proxy_action_stopped(event)
-      if event.exception
-        error! ProxyActionStopped.new(_('Failed to trigger task on the smart proxy: ') + event.exception.message)
-      else
-        check_task_status
-      end
+    def on_proxy_action_stopped
+      check_task_status
     end
 
     # @override String name of an action to be triggered on server

data/app/lib/actions/trigger_proxy_batch.rb

@@ -42,10 +42,7 @@ module Actions
     rescue => e
       action_logger.warn "Could not trigger task on the smart proxy"
       action_logger.warn e
-      # The response contains non-serializable objects
-      # TypeError: no _dump_data is defined for class Monitor
-      e.response = nil
-      batch.each { |remote_task| remote_task.update_from_batch_trigger({ 'exception' => e }) }
+      batch.each { |remote_task| remote_task.update_from_batch_trigger({}) }
       output[:failed_count] += batch.size
     end
 

data/app/models/foreman_tasks/remote_task.rb

@@ -49,11 +49,10 @@ module ForemanTasks
         self.parent_task_id = parent['task_id']
         self.state = 'parent-triggered'
       else
-        exception = data['exception']
         # Tell the action the task on the smart proxy stopped
         ForemanTasks.dynflow.world.event execution_plan_id,
                                          step_id,
-                                         ::Actions::ProxyAction::ProxyActionStoppedEvent[exception],
+                                         ::Actions::ProxyAction::ProxyActionStopped.new,
                                          optional: true
       end
       save!

data/app/views/foreman_tasks/layouts/react.html.erb

@@ -10,4 +10,4 @@
   <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
   <%= react_component('ForemanTasks') %>
 <% end %>
-<%= render file: "layouts/base" %>
+<%= render template: "layouts/base" %>

data/config/foreman-tasks.yaml.example

@@ -27,16 +27,23 @@
 #
   :cleanup:
 #
-# the period after which to delete all the tasks (by default all tasks are not being deleted after some period)
-# will be deprecated in Foreman 1.18 and the use of rules is recommended.
-#
-#     :after: 30d
-#
 # per action settings to override the default defined in the actions (self.cleanup_after method)
 #
 #    :actions:
 #      - :name: Actions::Foreman::Host::ImportFacts
 #        :after: 10d
+#      # Actions name can also be a list of names
+#      - :name:
+#          - Actions::Katello::Host::Erratum::Install
+#          - Actions::Katello::Host::Erratum::ApplicableErrataInstall
+#        :after: 90d
+#      # Actions can also define a condition
+#      - :name:
+#          - Actions::RemoteExecution::RunHostJob
+#          - Actions::RemoteExecution::RunHostsJob
+#        :filter: remote_execution_feature.label = katello_errata_install
+#        :after: 90d
+
 #
 # Rules defined in this section by default don't operate
 # on tasks specified in the actions section. This behavior

data/lib/foreman_tasks/cleaner.rb

@@ -2,6 +2,50 @@ require 'csv'
 
 module ForemanTasks
   # Represents the cleanup mechanism for tasks
+  class ActionRule
+    attr_reader :klass, :after, :condition
+    def initialize(klass, after, condition = nil)
+      @klass = klass
+      @after = after
+      @condition = condition
+    end
+
+    def exclude_search
+      "NOT (#{include_search})"
+    end
+
+    def include_search
+      parts = if klass.is_a? Array
+                ["label ^ (#{klass.join(', ')})"]
+              else
+                ["label = \"#{klass}\""]
+              end
+      parts << "(#{@condition})" if @condition
+      '(' + parts.join(' AND ') + ')'
+    end
+
+    def self.compose_include_rules(rules)
+      rules.group_by { |rule| [rule.after, rule.condition] }
+           .map do |(after, condition), rules|
+        ActionRule.new(rules.map(&:klass), after, condition)
+      end
+    end
+  end
+
+  class CompositeActionRule
+    def initialize(*rules)
+      @rules = rules
+    end
+
+    def exclude_search
+      partial_condition = @rules.group_by(&:condition)
+                                .map do |condition, rules|
+        ActionRule.new(rules.map(&:klass), nil, condition).include_search
+      end.join(' OR ')
+      "NOT (#{partial_condition})"
+    end
+  end
+
   class Cleaner
     def self.run(options)
       if options.key?(:filter)
@@ -12,36 +56,30 @@ module ForemanTasks
             raise "The option #{invalid_option} is not valid unless the filter specified"
           end
         end
-        if cleanup_settings[:after]
-          Foreman::Deprecation.deprecation_warning('1.18', _(':after setting in tasks cleanup section is deprecated, use :after in :rules section to set the value. to cleanup rules'))
-          new(options.merge(:filter => '', :after => cleanup_settings[:after])).delete
-        end
         with_periods = actions_with_default_cleanup
-        with_periods.each do |action_class, period|
-          new(options.merge(:filter => "label = #{action_class.name}", :after => period)).delete
+        ActionRule.compose_include_rules(with_periods).each do |rule|
+          new(options.merge(:filter => rule.include_search, :after => rule.after)).delete
         end
-        actions_by_rules(with_periods).each do |hash|
+        actions_by_rules(CompositeActionRule.new(*with_periods)).each do |hash|
           new(options.merge(hash)).delete
         end
       end
     end
 
     def self.actions_with_default_cleanup
-      actions_with_periods = {}
-      if cleanup_settings[:actions]
-        cleanup_settings[:actions].each do |action|
-          action_class = action[:name].constantize
-          actions_with_periods[action_class] = action[:after]
-        rescue => e
-          Foreman::Logging.exception("Error handling #{action} cleanup settings", e)
-        end
-      end
-      (ForemanTasks.dynflow.world.action_classes - actions_with_periods.keys).each do |action_class|
-        if action_class.respond_to?(:cleanup_after)
-          actions_with_periods[action_class] = action_class.cleanup_after
+      actions = cleanup_settings.fetch(:actions, [])
+                                .flat_map do |action|
+        Array(action[:name]).map do |klass|
+          ActionRule.new(klass.safe_constantize || klass, action[:after], action[:filter])
         end
-      end
-      actions_with_periods
+                rescue => e
+                  Foreman::Logging.exception("Error handling #{action} cleanup settings", e)
+                  nil
+      end.compact
+      hardcoded = (ForemanTasks.dynflow.world.action_classes - actions.map(&:klass))
+                  .select { |klass| klass.respond_to?(:cleanup_after) || klass.respond_to?(:cleanup_rules) }
+                  .flat_map { |klass| klass.respond_to?(:cleanup_rules) ? klass.cleanup_rules : ActionRule.new(klass, klass.cleanup_after) }
+      actions + hardcoded
     end
 
     def self.cleanup_settings
@@ -49,8 +87,8 @@ module ForemanTasks
       @cleanup_settings = SETTINGS[:'foreman-tasks'] && SETTINGS[:'foreman-tasks'][:cleanup] || {}
     end
 
-    def self.actions_by_rules(actions_with_periods)
-      disable_actions_with_periods = "label !^ (#{actions_with_periods.keys.join(', ')})"
+    def self.actions_by_rules(action_rules)
+      disable_actions_with_periods = action_rules.exclude_search
       cleanup_settings.fetch(:rules, []).map do |hash|
         next if hash[:after].nil?
         conditions = []

data/lib/foreman_tasks/engine.rb

@@ -25,7 +25,7 @@ module ForemanTasks
 
     initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 3.2.0'
+        requires_foreman '>= 3.3.0'
         divider :top_menu, :parent => :monitor_menu, :last => true, :caption => N_('Foreman Tasks')
         menu :top_menu, :tasks,
              :url_hash => { :controller => 'foreman_tasks/tasks', :action => :index },

data/lib/foreman_tasks/tasks/cleanup.rake

@@ -39,23 +39,18 @@ namespace :foreman_tasks do
 
     desc 'Show the current configuration for auto-cleanup'
     task :config => ['environment', 'dynflow:client'] do
-      if ForemanTasks::Cleaner.cleanup_settings[:after]
-        puts _('The tasks will be deleted after %{after}') % { :after => ForemanTasks::Cleaner.cleanup_settings[:after] }
-      else
-        puts _('Global period for cleaning up tasks is not set')
-      end
-
       if ForemanTasks::Cleaner.actions_with_default_cleanup.empty?
         puts _('No actions are configured to be cleaned automatically')
       else
         puts _('The following actions are configured to be deleted automatically after some time:')
-        printf("%-50s %s\n", _('name'), _('delete after'))
-        ForemanTasks::Cleaner.actions_with_default_cleanup.each do |action, after|
-          printf("%-50s %s\n", action.name, after)
+        printf("%-75s %-20s %-50s\n", _('name'), _('delete after'), _('filter'))
+        ForemanTasks::Cleaner.actions_with_default_cleanup.each do |action, _after|
+          klass = action.klass
+          printf("%-75s %-20s %-50s\n", klass.try(:name) || klass, action.after, action.condition)
         end
       end
       puts
-      by_rules = ForemanTasks::Cleaner.actions_by_rules(ForemanTasks::Cleaner.actions_with_default_cleanup)
+      by_rules = ForemanTasks::Cleaner.actions_by_rules(ForemanTasks::CompositeActionRule.new(*ForemanTasks::Cleaner.actions_with_default_cleanup))
       if by_rules.empty?
         puts _('No cleanup rules are configured')
       else

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '6.0.3'.freeze
+  VERSION = '7.0.0'.freeze
 end

data/package.json

@@ -23,18 +23,18 @@
     "url": "http://projects.theforeman.org/projects/foreman-tasks/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": "^8.15.0"
+    "@theforeman/vendor": "^10.1.0"
   },
   "dependencies": {
     "c3": "^0.4.11"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": "^8.15.0",
-    "@theforeman/eslint-plugin-foreman": "^8.15.0",
-    "@theforeman/stories": "^8.15.0",
-    "@theforeman/test": "^8.15.0",
-    "@theforeman/vendor-dev": "^8.15.0",
+    "@theforeman/builder": "^10.1.0",
+    "@theforeman/eslint-plugin-foreman": "^10.1.0",
+    "@theforeman/stories": "^10.1.0",
+    "@theforeman/test": "^10.1.0",
+    "@theforeman/vendor-dev": "^10.1.0",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "jed": "^1.1.1",

data/test/controllers/api/tasks_controller_test.rb

@@ -108,7 +108,7 @@ module ForemanTasks
           get :show, params: { id: task.id }, session: set_session_user
           assert_response :success
           data = JSON.parse(response.body)
-          _(data['duration']).must_equal task.duration
+          _(data['duration']).must_equal task.duration.in_seconds.to_s
         end
       end
 
@@ -118,7 +118,7 @@ module ForemanTasks
           get :index, session: set_session_user
           assert_response :success
           data = JSON.parse(response.body)
-          _(data['results'][0]['duration']).must_equal task.duration
+          _(data['results'][0]['duration']).must_equal task.duration.in_seconds.to_s
         end
       end
 

data/test/controllers/tasks_controller_test.rb

@@ -96,7 +96,8 @@ module ForemanTasks
           task = ForemanTasks::Task.with_duration.find(FactoryBot.create(:some_task).id)
           get(:index, params: {}, session: set_session_user)
           assert_response :success
-          assert_include response.body.lines[1], task.duration
+          row = CSV.parse(response.body, headers: true).first
+          assert_include row['Duration'], task.duration.in_seconds.to_s
         end
       end
 
@@ -126,7 +127,8 @@ module ForemanTasks
           child.save!
           get(:sub_tasks, params: { id: parent.id }, session: set_session_user)
           assert_response :success
-          assert_include response.body.lines[1], child.duration
+          row = CSV.parse(response.body, headers: true).first
+          assert_include row['Duration'], child.duration.in_seconds.to_s
         end
       end
 

data/test/unit/cleaner_test.rb

@@ -133,33 +133,31 @@ class TasksTest < ActiveSupport::TestCase
     describe 'default behaviour' do
       it 'searches for the actions that have the cleanup_after defined' do
         ForemanTasks::Cleaner.stubs(:cleanup_settings => {})
-        _(ForemanTasks::Cleaner.actions_with_default_cleanup[ActionWithCleanup]).must_equal '15d'
+        actions = ForemanTasks::Cleaner.actions_with_default_cleanup
+        example = actions.find { |rule| rule.klass == ActionWithCleanup }
+        _(example.after).must_equal '15d'
       end
 
       it 'searches for the actions that have the cleanup_after defined' do
         ForemanTasks::Cleaner.stubs(:cleanup_settings =>
                                      { :actions => [{ :name => ActionWithCleanup.name, :after => '5d' }] })
-        _(ForemanTasks::Cleaner.actions_with_default_cleanup[ActionWithCleanup]).must_equal '5d'
-      end
-
-      it 'deprecates the usage of :after' do
-        Foreman::Deprecation.expects(:deprecation_warning)
-        ForemanTasks::Cleaner.any_instance.expects(:delete)
-        ForemanTasks::Cleaner.stubs(:cleanup_settings =>
-                                    { :after => '1d' })
-        ForemanTasks::Cleaner.stubs(:actions_with_default_cleanup).returns({})
-        ForemanTasks::Cleaner.run({})
+        actions = ForemanTasks::Cleaner.actions_with_default_cleanup
+        example = actions.find { |rule| rule.klass == ActionWithCleanup }
+        _(example.after).must_equal '5d'
       end
 
       it 'generates filters from rules properly' do
-        actions_with_default = { 'action1' => nil, 'action2' => nil }
+        actions_with_default = ForemanTasks::CompositeActionRule.new(
+          ForemanTasks::ActionRule.new('action1', nil),
+          ForemanTasks::ActionRule.new('action2', nil)
+        )
         rules = [{ :after => nil },
                  { :after => '10d', :filter => 'label = something', :states => %w[stopped paused] },
                  { :after => '15d', :filter => 'label = something_else',
                    :override_actions => true, :states => 'all' }]
         ForemanTasks::Cleaner.stubs(:cleanup_settings).returns(:rules => rules)
         r1, r2 = ForemanTasks::Cleaner.actions_by_rules actions_with_default
-        _(r1[:filter]).must_equal '(label !^ (action1, action2)) AND (label = something)'
+        _(r1[:filter]).must_equal '(NOT ((label ^ (action1, action2)))) AND (label = something)'
         _(r1[:states]).must_equal %w[stopped paused]
         _(r2[:filter]).must_equal '(label = something_else)'
         _(r2[:states]).must_equal []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 7.0.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -608,7 +608,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.2.26
 signing_key:
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resources and users