foreman-tasks 7.0.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6773ac47a0c5b8e3e28da1461a348510e8595da0bd2d08feafd78092394fb2
-  data.tar.gz: 40d4c506cd3d31b72355e8c2d4255c854c703be6be49644b8d30a55032bd9b2b
+  metadata.gz: c5d611523d1262879b33177bf9c1f4c394142fee8433c2fda798cb4063b60f99
+  data.tar.gz: 1e7974c6fde725d0fe46dcffd6793c7f4b078c3c6e2e3429dce42180e61e4044
 SHA512:
-  metadata.gz: 1d05cdb24aea11a647028a4b1c314cf5f0db3d95459bbcfa0c52aa8f53263b6deb3d27ee23bbb7ec2a227e1ebbead0a432c0ecf6701131b2f7921b39145085ab
-  data.tar.gz: 777127d69a84b7c94780f78ad5a8aa5754ad246e6019a9f35c518e0b246d73b8f6f31acc84029b1b0648b8ff3ba8f167efc4fad7f4116cb4eb2f3fad7b850591
+  metadata.gz: 6f358b767cf2c8f2f6d31a43aa6c1fca27a6db053311d4540cea15d11c7c76758db192d5b39ecef17fcfc9d89e9e99a233c6b3d14fadd41efcca709aea37704b
+  data.tar.gz: 9c08bf19e2f8bdc05add76a9b8e9b783407b03ba99f0c47325454468a4654e44296f8dafd87e40a5d58ed771edb58900c0ac41738202efce5043193b5580a50c

data/.github/workflows/js_tests.yml

@@ -12,7 +12,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10, 12]
+        node-version:
+          - 12
+          - 14
     steps:
       - uses: actions/checkout@v2
       - name: Setup Node

data/.github/workflows/ruby_tests.yml

@@ -29,7 +29,7 @@ jobs:
       fail-fast: false
       matrix:
         foreman-core-branch: [develop]
-        ruby-version: [2.5, 2.6, 2.7]
+        ruby-version: [2.7]
         node-version: [12]
     steps:
       - run: sudo apt-get update

data/app/lib/actions/foreman/host/import_facts.rb

@@ -8,12 +8,7 @@ module Actions
 
         def plan(_host_type, host_name, facts, certname, proxy_id)
           facts['domain'].try(:downcase!)
-          host = if SETTINGS[:version].short > '1.16'
-                   ::Host::Managed.import_host(host_name, certname)
-                 else
-                   # backwards compatibility
-                   ::Host::Managed.import_host(host_name, facts['_type'], certname, proxy_id)
-                 end
+          host = ::Host::Managed.import_host(host_name, certname)
           host.save(:validate => false) if host.new_record?
           action_subject(host, :facts => facts.to_unsafe_h, :proxy_id => proxy_id)
           if host.build?

data/app/lib/actions/helpers/with_delegated_action.rb

@@ -3,7 +3,7 @@ module Actions
     module WithDelegatedAction
       include ::Actions::Helpers::WithContinuousOutput
 
-      def plan_delegated_action(proxy, klass, options)
+      def plan_delegated_action(proxy, klass, options, proxy_action_class: ::Actions::ProxyAction)
         case proxy
         when :not_defined
           if klass.is_a?(String)
@@ -14,7 +14,7 @@ module Actions
         when :not_available
           raise Foreman::Exception, _('All proxies with the required feature are unavailable at the moment')
         when ::SmartProxy
-          delegated_action = plan_action(::Actions::ProxyAction, proxy, klass, options)
+          delegated_action = plan_action(proxy_action_class, proxy, klass, options)
         end
 
         input[:delegated_action_id] = delegated_action.id

data/app/lib/actions/proxy_action.rb

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

data/app/lib/actions/trigger_proxy_batch.rb

@@ -42,7 +42,10 @@ module Actions
     rescue => e
       action_logger.warn "Could not trigger task on the smart proxy"
       action_logger.warn e
-      batch.each { |remote_task| remote_task.update_from_batch_trigger({}) }
+      # 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 }) }
       output[:failed_count] += batch.size
     end
 

data/app/models/foreman_tasks/remote_task.rb

@@ -7,7 +7,7 @@ module ForemanTasks
                       :foreign_key => :execution_plan_id,
                       :inverse_of  => :remote_tasks
 
-    scope :triggered, -> { where(:state => 'triggered') }
+    scope :triggered, -> { where(:state => ['triggered', 'parent-triggered']) }
     scope :pending,   -> { where(:state => 'new') }
     scope :external,  -> { where(:state => 'external') }
 
@@ -49,10 +49,11 @@ 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::ProxyActionStopped.new,
+                                         ::Actions::ProxyAction::ProxyActionStoppedEvent[exception],
                                          optional: true
       end
       save!

data/app/models/foreman_tasks/task/dynflow_task.rb

@@ -219,19 +219,24 @@ module ForemanTasks
     def self.consistency_check
       fixed_count = 0
       logger = Foreman::Logging.logger('foreman-tasks')
-      running.each do |task|
-        changes = task.update_from_dynflow(task.execution_plan)
+
+      # Dynflow execution plans which are not stopped at this point should
+      # eventually get moving and their tasks should eventually get back in sync
+      # as the execution plans run
+      joins('LEFT JOIN dynflow_execution_plans ON foreman_tasks_tasks.external_id = dynflow_execution_plans.uuid::varchar')
+        .where('foreman_tasks_tasks.state_updated_at < dynflow_execution_plans.ended_at')
+        .find_each do |task|
+        changes = task.update_from_dynflow(task.execution_plan.to_hash)
         unless changes.empty?
           fixed_count += 1
           logger.warn('Task %s updated at consistency check: %s' % [task.id, changes.inspect])
         end
       rescue => e
-        # if we fail updating the data from dynflow, it usually means there is something
-        # odd with the data consistency and at this point it is not possible to resume, switching
-        # the task to stopped/error
         task.update(:state => 'stopped', :result => 'error')
         Foreman::Logging.exception("Failed at consistency check for task #{task.id}", e, :logger => 'foreman-tasks')
       end
+      # Wipe tasks left behind by now stopped tasks
+      ForemanTasks::Lock.left_joins(:task).merge(where(:state => 'stopped')).destroy_all
       fixed_count
     end
 

data/app/views/foreman_tasks/recurring_logics/index.html.erb

@@ -1,5 +1,5 @@
 <% title _("Recurring logics") %>
-<% title_actions SETTINGS[:version].short <= '1.13' ? help_path : help_button %>
+<% title_actions help_button %>
 
 <% if @errors %>
 <%= alert(:class => 'alert-info', :id => 'multiple-alert', :close => false, :header => '', :text => @errors) %>
@@ -38,16 +38,16 @@
 <table class="<%= table_css_classes('table-condensed table-fixed') %>">
   <thead>
     <th class="col-md-1"><%= N_("ID") %></th>
-    <th><%= N_("Cron line") %></th>
-    <th><%= N_("Task count") %></th>
-    <th><%= N_("Action") %></th>
-    <th><%= N_("Last occurrence") %></th>
-    <th><%= N_("Next occurrence") %></th>
-    <th><%= N_("Current iteration") %></th>
-    <th><%= N_("Iteration limit") %></th>
-    <th><%= N_("Repeat until") %></th>
-    <th><%= N_("State") %></th>
-    <th><%= N_("Purpose") %></th>
+    <th><%= _("Cron line") %></th>
+    <th><%= _("Task count") %></th>
+    <th><%= _("Action") %></th>
+    <th><%= _("Last occurrence") %></th>
+    <th><%= _("Next occurrence") %></th>
+    <th><%= _("Current iteration") %></th>
+    <th><%= _("Iteration limit") %></th>
+    <th><%= _("Repeat until") %></th>
+    <th><%= _("State") %></th>
+    <th><%= _("Purpose") %></th>
     <th/>
   </thead>
   <% @recurring_logics.each do |recurring_logic| %>

data/app/views/foreman_tasks/task_groups/_common.html.erb

@@ -1,11 +1,11 @@
 <div>
   <table class='<%= table_css_classes('table-condensed') %>'>
     <tr>
-      <th><%= N_('ID') %></th>
+      <th><%= _('ID') %></th>
       <td><%= link_to(task_group.id, foreman_tasks_task_group_url(task_group)) %></td>
     </tr>
     <tr>
-      <th><%= N_('Task count') %></th>
+      <th><%= _('Task count') %></th>
       <td><%= link_to(task_group.tasks.count, foreman_tasks_tasks_url(:search => "task_group.id = #{task_group.id}")) %></td>
     </tr>
   </table>

data/app/views/foreman_tasks/task_groups/recurring_logic_task_groups/_recurring_logic_task_group.html.erb

@@ -1,47 +1,47 @@
 <% recurring_logic = task_group.recurring_logic -%>
 <table class='<%= table_css_classes('table-condensed') %>'>
   <tr>
-    <th>ID</th>
+    <th><%= _('ID') %></th>
     <td><%= link_to(recurring_logic.id, recurring_logic) %></td>
   </tr>
   <tr>
-    <th><%= N_("Cron line") %></th>
+    <th><%= _("Cron line") %></th>
     <td><%= recurring_logic.cron_line %></td>
   </tr>
   <tr>
-    <th><%= N_("Action") %></th>
+    <th><%= _("Action") %></th>
     <td><%= format_task_input(recurring_logic.tasks.last) %></td>
   </tr>
   <tr>
-    <th><%= N_("Last occurrence") %></th>
+    <th><%= _("Last occurrence") %></th>
     <td><%= recurring_logic.tasks.order(:started_at).where('started_at IS NOT NULL').last.try(:started_at) || '-' %></td>
   </tr>
   <tr>
-    <th><%= N_("Next occurrence") %></th>
+    <th><%= _("Next occurrence") %></th>
     <td><%= recurring_logic_next_occurrence recurring_logic %></td>
   </tr>
   <tr>
-    <th><%= N_("Current iteration") %></th>
+    <th><%= _("Current iteration") %></th>
     <td><%= recurring_logic.iteration %></td>
   </tr>
   <tr>
-    <th><%= N_("Iteration limit") %></th>
+    <th><%= _("Iteration limit") %></th>
     <td><%= format_recurring_logic_limit recurring_logic.max_iteration %></td>
   </tr>
   <tr>
-    <th><%= N_("Repeat until") %></th>
+    <th><%= _("Repeat until") %></th>
     <td><%= format_recurring_logic_limit recurring_logic.end_time.try(:in_time_zone) %></td>
   </tr>
   <tr>
-    <th><%= N_("State") %></th>
+    <th><%= _("State") %></th>
     <td><%= recurring_logic_state(recurring_logic) %></td>
   </tr>
   <tr>
-    <th><%= N_("Purpose") %></th>
+    <th><%= _("Purpose") %></th>
     <td><%= recurring_logic.purpose %></td>
   </tr>
   <tr>
-    <th><%= N_("Task count") %></th>
+    <th><%= _("Task count") %></th>
     <td><%= link_to(task_group.tasks.count, foreman_tasks_tasks_url(:search => "task_group.id = #{task_group.id}")) %></td>
   </tr>
 </table>

data/lib/foreman_tasks/cleaner.rb

@@ -84,7 +84,7 @@ module ForemanTasks
 
     def self.cleanup_settings
       return @cleanup_settings if @cleanup_settings
-      @cleanup_settings = SETTINGS[:'foreman-tasks'] && SETTINGS[:'foreman-tasks'][:cleanup] || {}
+      @cleanup_settings = SETTINGS.dig(:'foreman-tasks', :cleanup) || {}
     end
 
     def self.actions_by_rules(action_rules)

data/lib/foreman_tasks/dynflow/configuration.rb

@@ -16,7 +16,7 @@ module ForemanTasks
         :backup_deleted_plans => true,
         :backup_dir => default_backup_dir,
       }
-      settings = SETTINGS[:'foreman-tasks'] && SETTINGS[:'foreman-tasks'][:backup]
+      settings = SETTINGS.dig(:'foreman-tasks', :backup)
       backup_options.merge!(settings) if settings
       @backup_settings = with_environment_override backup_options
     end

data/lib/foreman_tasks/engine.rb

@@ -166,7 +166,10 @@ module ForemanTasks
         world.middleware.use Actions::Middleware::KeepCurrentUser, :before => ::Dynflow::Middleware::Common::Transaction
         world.middleware.use Actions::Middleware::KeepCurrentTimezone
         world.middleware.use Actions::Middleware::KeepCurrentRequestID
-        world.middleware.use ::Actions::Middleware::LoadSettingValues if Gem::Version.new(::SETTINGS[:version]) >= Gem::Version.new('2.5')
+        world.middleware.use ::Actions::Middleware::LoadSettingValues
+      end
+      ::ForemanTasks.dynflow.config.on_init(true) do
+        ::ForemanTasks::Task::DynflowTask.consistency_check
       end
     end
 

data/lib/foreman_tasks/version.rb

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

data/lib/tasks/gettext.rake

@@ -16,6 +16,7 @@ if gettext_find_task
                  .all_action_names
                  .uniq
                  .map { |n| %[_("#{n}")] }
+                 .sort
                  .join("\n")
     end
   end

data/locale/action_names.rb

@@ -1,5 +1,4 @@
 # Autogenerated!
-_("Import Puppet classes")
-_("Import facts")
 _("Action with sub plans")
-_("Remote action:")
+_("Import Puppet classes")
+_("Import facts")