foreman-tasks 1.2.0 → 3.0.1

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -31,9 +31,12 @@ module ForemanTasks
 
     def cancel_step
       task = find_dynflow_task
-      flash[:info] = _('Trying to cancel step %s') % params[:step_id]
-      ForemanTasks.dynflow.world.event(task.external_id, params[:step_id].to_i, ::Dynflow::Action::Cancellable::Cancel).wait
-      redirect_to foreman_tasks_task_path(task)
+      result = ForemanTasks.dynflow.world.event(task.external_id, params[:step_id].to_i, ::Dynflow::Action::Cancellable::Cancel).wait
+      if result.rejected?
+        render json: { error: result.reason }, status: :bad_request
+      else
+        render json: { statusText: 'OK' }
+      end
     end
 
     def cancel

data/app/helpers/foreman_tasks/foreman_tasks_helper.rb

@@ -82,7 +82,7 @@ module ForemanTasks
             ' — ',
             content_tag(:span, nil, :class => 'time', :style => 'white-space: nowrap;') do
               fields.time_select(attr, datetime_options.merge(:ignore_date => true), html_options)
-            end
+            end,
           ].join
         end
       end
@@ -139,7 +139,7 @@ module ForemanTasks
         cronline_fieldset(f, triggering),
         monthly_fieldset(f, triggering),
         weekly_fieldset(f, triggering),
-        time_picker_fieldset(f, triggering)
+        time_picker_fieldset(f, triggering),
       ]
 
       content_tag(:fieldset, nil, :id => 'trigger_mode_recurring', :class => "trigger_mode_form #{'hidden' unless triggering.recurring?}") do
@@ -158,7 +158,7 @@ module ForemanTasks
         # TRANSLATORS: this translation is referring to an option which is a time interval
         _('is month (range: 1-12)'),
         # TRANSLATORS: this translation is referring to an option which is a time interval
-        _('is day of week (range: 0-6)')
+        _('is day of week (range: 0-6)'),
       ].map { |opt| content_tag(:li, opt) }.join
 
       help = _("Cron line format 'a b c d e', where: %s") % "<br><ol type=\"a\">#{options}</ol>".html_safe

data/app/lib/actions/proxy_action.rb

@@ -257,7 +257,7 @@ module Actions
       if failed_proxy_tasks.count < options[:retry_count]
         suspend do |suspended_action|
           @world.clock.ping suspended_action,
-                            Time.zone.now + options[:retry_interval],
+                            Time.now.getlocal + options[:retry_interval],
                             event
         end
       else

data/app/models/foreman_tasks/recurring_logic.rb

@@ -95,7 +95,7 @@ module ForemanTasks
         :start_at => next_occurrence_time(time),
         :start_before => options['start_before'],
         :recurring_logic_id => id,
-        :frozen => disabled?
+        :frozen => disabled?,
       }
     end
 

data/app/models/foreman_tasks/task.rb

@@ -70,6 +70,17 @@ module ForemanTasks
            end)
     scope :for_action_types, (->(action_types) { where('foreman_tasks_tasks.label IN (?)', Array(action_types)) })
 
+    apipie :class, "A class representing #{model_name.human} object" do
+      name 'Task'
+      refs 'Task'
+      sections only: %w[all additional]
+      property :main_action, object_of: 'Dynflow::Action', desc: 'Returns the main action of the task, e.g. Actions::RemoteExecution::RunHostJob'
+      property :label, String, desc: 'Returns the label of the task'
+      property :state, String, desc: 'Returns state of the task execution, e.g. "stopped"'
+      property :result, String, desc: 'Returns result of the task execution, e.g. "success"'
+      property :started_at, ActiveSupport::TimeWithZone, desc: 'Returns date with time the task started at'
+      property :ended_at, ActiveSupport::TimeWithZone, desc: 'Returns date with time the task ended at'
+    end
     class Jail < Safemode::Jail
       allow :started_at, :ended_at, :result, :state, :label, :main_action
     end

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

@@ -46,7 +46,8 @@ module ForemanTasks
     end
 
     def progress
-      execution_plan.try(:progress) || 0
+      progress_raw = execution_plan.try(:progress) || 0
+      progress_raw.round(2)
     end
 
     def execution_plan(silence_exception = true)
@@ -101,31 +102,28 @@ module ForemanTasks
 
     def input_output_failed_steps
       failed_steps.map do |f|
-        begin
-          f_action = f.action(execution_plan)
-          {
-            error: ({ exception_class: f.error.exception_class, message: f.error.message, backtrace: f.error.backtrace } if f.error),
-            action_class: f.action_class.name,
-            state: f.state,
-            input: f_action.input.pretty_inspect,
-            output: f_action.output.pretty_inspect
-          }
-        end
+        f_action = f.action(execution_plan)
+        {
+          error: ({ exception_class: f.error.exception_class, message: f.error.message, backtrace: f.error.backtrace } if f.error),
+          action_class: f.action_class.name,
+          state: f.state,
+          input: f_action.input.pretty_inspect,
+          output: f_action.output.pretty_inspect,
+        }
       end
     end
 
     def input_output_running_steps
       running_steps.map do |f|
-        begin
-          f_action = f.action(execution_plan)
-          {
-            action_class: f.action_class.name,
-            state: f.state,
-            input: f_action.input.pretty_inspect,
-            output: f_action.output.pretty_inspect,
-            cancellable: cancellable_action?(f_action)
-          }
-        end
+        f_action = f.action(execution_plan)
+        {
+          id: f_action.id,
+          action_class: f.action_class.name,
+          state: f.state,
+          input: f_action.input.pretty_inspect,
+          output: f_action.output.pretty_inspect,
+          cancellable: cancellable_action?(f_action),
+        }
       end
     end
 
@@ -218,19 +216,17 @@ module ForemanTasks
       fixed_count = 0
       logger = Foreman::Logging.logger('foreman-tasks')
       running.each do |task|
-        begin
-          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')
+        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
       fixed_count
     end

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

@@ -4,7 +4,7 @@ module ForemanTasks
     ERRONEOUS_STATUSES = [
       { :state => 'paused', :result => ANY },
       { :state => ANY, :result => 'error' },
-      { :state => ANY, :result => 'warning' }
+      { :state => ANY, :result => 'warning' },
     ].freeze
     def is_erroneous(task)
       remainder = ERRONEOUS_STATUSES.select do |status|

data/app/models/foreman_tasks/triggering.rb

@@ -75,7 +75,7 @@ module ForemanTasks
     def delay_options
       {
         :start_at => start_at.utc,
-        :start_before => start_before.try(:utc)
+        :start_before => start_before.try(:utc),
       }
     end
 

data/app/models/setting/foreman_tasks.rb

@@ -1,23 +1,23 @@
 class Setting::ForemanTasks < Setting
   def self.default_settings
     [
-      set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120),
-      set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true),
-      set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true),
-      set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4),
-      set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15),
-      set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true),
-      set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100),
+      set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120, N_('Sync task timeout')),
+      set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true, N_('Enable dynflow console')),
+      set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true, N_('Require auth for dynflow console')),
+      set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4, N_('Proxy action retry count')),
+      set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15, N_('Proxy action retry interval')),
+      set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true, N_('Allow proxy batch tasks')),
+      set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100, N_('Proxy tasks batch size')),
       set('foreman_tasks_troubleshooting_url',
           N_('Url pointing to the task troubleshooting documentation. '\
              'It should contain %{label} placeholder, that will be replaced with normalized task label '\
              '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
-          nil),
+          nil, N_('Tasks troubleshooting URL')),
       set('foreman_tasks_polling_multiplier',
           N_('Polling multiplier which is used to multiply the default polling intervals. '\
              'This can be used to prevent polling too frequently for long running tasks.'),
           1,
-          N_("Polling intervals multiplier"))
+          N_("Polling intervals multiplier")),
     ]
   end
 

data/app/services/foreman_tasks/dashboard_table_filter.rb

@@ -24,7 +24,11 @@ module ForemanTasks
     private
 
     def scope_by(field)
-      @new_scope = @new_scope.where(field => @params[field]) if @params[field].present?
+      if (field == :result) && (@params[field] == 'other')
+        @new_scope = @new_scope.where(:result => ['cancelled', 'pending'])
+      elsif @params[field].present?
+        @new_scope = @new_scope.where(field => @params[field])
+      end
     end
 
     def scope_by_time

data/app/views/foreman_tasks/api/tasks/index.json.rabl

@@ -0,0 +1,2 @@
+collection @tasks
+extends "foreman_tasks/api/tasks/show"

data/app/views/foreman_tasks/api/tasks/show.json.rabl

@@ -1,5 +1,7 @@
 object @task if @task
 
+extends 'api/v2/layouts/permissions'
+
 attributes :id, :label, :pending, :action
 attributes :username, :started_at, :ended_at, :state, :result, :progress
 attributes :input, :output, :humanized, :cli_example, :start_at

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

@@ -37,6 +37,7 @@
 
 <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>
@@ -50,7 +51,8 @@
   </thead>
   <% @recurring_logics.each do |recurring_logic| %>
     <tr>
-      <td><%= link_to(recurring_logic.cron_line, foreman_tasks_recurring_logic_path(recurring_logic)) %></td>
+      <td><%= link_to(recurring_logic.id, foreman_tasks_recurring_logic_path(recurring_logic)) %></td>
+      <td><%= recurring_logic.cron_line %></td>
       <td><%= link_to(recurring_logic.tasks.count, foreman_tasks_tasks_url(:search => "task_group.id = #{recurring_logic.task_group.id}")) %></td>
       <td><%= format_task_input(recurring_logic.tasks.first) %></td>
       <td><%= recurring_logic.tasks.order(:started_at).where('started_at IS NOT NULL').last.try(:started_at) || "-" %></td>

data/config/routes.rb

@@ -7,6 +7,7 @@ Foreman::Application.routes.draw do
         put :disable
       end
       collection do
+        get 'auto_complete_search'
         post :clear_cancelled
       end
     end
@@ -50,7 +51,6 @@ Foreman::Application.routes.draw do
       resources :tasks, :only => [:show, :index] do
         member do
           get :details
-          get :sub_tasks
         end
         collection do
           post :bulk_search
@@ -58,6 +58,7 @@ Foreman::Application.routes.draw do
           post :bulk_cancel
           post :bulk_stop
           get :summary
+          get '/:parent_task_id/sub_tasks', action: 'index'
           get '/summary/:id/sub_tasks/', action: 'summary_sub_tasks'
           post :callback
         end

data/db/migrate/20200517215015_rename_bookmarks_controller.rb

@@ -3,7 +3,7 @@ class RenameBookmarksController < ActiveRecord::Migration[5.2]
     original_controller = 'foreman_tasks_tasks'
     original_bookmarks = Bookmark.where(controller: original_controller)
     original_bookmarks_names = Hash[original_bookmarks.pluck(:name, :id)]
-    
+
     new_controller = 'foreman_tasks/tasks'
     new_bookmarks = Bookmark.where(controller: new_controller)
     new_bookmarks.find_each do |new_bookmark|
@@ -18,7 +18,7 @@ class RenameBookmarksController < ActiveRecord::Migration[5.2]
                         original_bookmark.public == new_bookmark.public
 
         if is_duplicated
-          original_bookmark.destroy     
+          original_bookmark.destroy
         else
           modified_name = "#{name}_#{generate_token}"
           original_bookmark.update(name: modified_name)

data/db/migrate/20200611090846_add_task_lock_index_on_resource_type_and_task_id.rb

@@ -0,0 +1,9 @@
+class AddTaskLockIndexOnResourceTypeAndTaskId < ActiveRecord::Migration[6.0]
+  def change
+    add_index :foreman_tasks_locks, [:task_id, :resource_type, :resource_id], name: 'index_tasks_locks_on_task_id_resource_type_and_resource_id'
+    # These indexes are not needed as they can be gained from partial index lookups
+    [:task_id, :name, :resource_type].each do |index|
+      remove_index :foreman_tasks_locks, index if index_exists?(:foreman_tasks_locks, index)
+    end
+  end
+end

data/db/seeds.d/30-notification_blueprints.rb

@@ -9,9 +9,9 @@ blueprints = [
         links:
           [
             href: "/foreman_tasks/tasks?search=#{CGI.escape('state=paused')}",
-            title: N_('List of tasks')
-          ]
-      }
+            title: N_('List of tasks'),
+          ],
+      },
   },
 
   {
@@ -24,9 +24,9 @@ blueprints = [
         links:
           [
             path_method: :foreman_tasks_task_path,
-            title: N_('Task Details')
-          ]
-      }
+            title: N_('Task Details'),
+          ],
+      },
   },
 
   {
@@ -48,7 +48,7 @@ blueprints = [
     name: 'tasks_bulk_stop',
     level: 'info',
     message: "DYNAMIC",
-  }
+  },
 ]
 
 blueprints.each { |blueprint| UINotifications::Seed.new(blueprint).configure }

data/db/seeds.d/61-foreman_tasks_bookmarks.rb

@@ -1,7 +1,7 @@
 Bookmark.without_auditing do
   [
     { :name => 'running', :query => 'state = running' },
-    { :name => 'failed', :query => 'state = paused or result = error or result = warning' }
+    { :name => 'failed', :query => 'state = paused or result = error or result = warning' },
 
   ].each do |item|
     next if Bookmark.where(:name => item[:name]).first

data/lib/foreman_tasks/cleaner.rb

@@ -30,12 +30,10 @@ module ForemanTasks
       actions_with_periods = {}
       if cleanup_settings[:actions]
         cleanup_settings[:actions].each do |action|
-          begin
-            action_class = action[:name].constantize
-            actions_with_periods[action_class] = action[:after]
-          rescue => e
-            Foreman::Logging.exception("Error handling #{action} cleanup settings", e)
-          end
+          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|

data/lib/foreman_tasks/dynflow/configuration.rb

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

data/lib/foreman_tasks/dynflow/persistence.rb

@@ -8,12 +8,10 @@ module ForemanTasks
       # clear connection only if not running in some active record transaction already
       clear_connections = ActiveRecord::Base.connection.open_transactions.zero?
       super.tap do
-        begin
-          on_execution_plan_save(execution_plan_id, value)
-        rescue => e
-          Foreman::Logging.exception('Error on on_execution_plan_save event', e,
-                                     :logger => 'dynflow')
-        end
+        on_execution_plan_save(execution_plan_id, value)
+      rescue => e
+        Foreman::Logging.exception('Error on on_execution_plan_save event', e,
+                                   :logger => 'dynflow')
       end
     ensure
       ::ActiveRecord::Base.clear_active_connections! if clear_connections

data/lib/foreman_tasks/engine.rb

@@ -34,7 +34,7 @@ module ForemanTasks
 
     initializer 'foreman_tasks.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :"foreman-tasks" do
-        requires_foreman '>= 2.0.0'
+        requires_foreman '>= 2.2.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 },
@@ -57,7 +57,7 @@ module ForemanTasks
 
           permission :create_recurring_logics, {}, :resource_type => ForemanTasks::RecurringLogic.name
 
-          permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:index, :show],
+          permission :view_recurring_logics, { :'foreman_tasks/recurring_logics' => [:auto_complete_search, :index, :show],
                                                :'foreman_tasks/api/recurring_logics' => [:index, :show] }, :resource_type => ForemanTasks::RecurringLogic.name
 
           permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel, :enable, :disable, :clear_cancelled],
@@ -79,11 +79,6 @@ module ForemanTasks
       end
     end
 
-    initializer 'foreman_tasks.ignore_dynflow_tables' do |_app|
-      # Ignore Dynflow tables when schema-dumping. Dynflow tables are handled automatically by Dynflow.
-      ActiveRecord::SchemaDumper.ignore_tables << /^dynflow_.*$/
-    end
-
     initializer 'foreman_tasks.apipie' do
       # this condition is here for compatibility reason to work with Foreman 1.4.x
       if Apipie.configuration.api_controllers_matcher.is_a?(Array) &&

data/lib/foreman_tasks/tasks/cleanup.rake

@@ -14,7 +14,7 @@ namespace :foreman_tasks do
       If TASK_SEARCH is set then AFTER, STATES can be set and it's used for cleanup. If TASK_SEARCH is not set then
       the cleanup respects the configuration file and setting AFTER or STATES will throw exception.
     DESC
-    task :run => 'environment' do
+    task :run => ['environment', 'dynflow:client'] do
       options = {}
 
       options[:filter] = ENV['TASK_SEARCH'] if ENV['TASK_SEARCH']
@@ -38,7 +38,7 @@ namespace :foreman_tasks do
     end
 
     desc 'Show the current configuration for auto-cleanup'
-    task :config => 'environment' do
+    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