foreman-tasks 1.0.0 → 1.1.3

data/app/helpers/foreman_tasks/foreman_tasks_helper.rb

@@ -1,5 +1,4 @@
 module ForemanTasks
-  # rubocop:disable Metrics/ModuleLength
   module ForemanTasksHelper
     def recurring_logic_state(recurring_logic)
       icon, status = case recurring_logic.state
@@ -28,7 +27,7 @@ module ForemanTasks
     def troubleshooting_info_text
       return if @task.state != 'paused' || @task.main_action.nil?
       helper = TroubleshootingHelpGenerator.new(@task.main_action)
-      helper.generate_text
+      helper.generate_html
     end
 
     def username_link_task(owner, username)
@@ -209,5 +208,4 @@ module ForemanTasks
       tags.join.html_safe
     end
   end
-  # rubocop:enable Metrics/ModuleLength
 end

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

@@ -78,9 +78,7 @@ module Actions
           else
             head, *tail = subkeys
             if data.is_a?(Hash) && data.key?(head)
-              return fetch_data(data[head], *tail)
-            else
-              return nil
+              fetch_data(data[head], *tail)
             end
           end
         end

data/app/lib/actions/proxy_action.rb

@@ -41,12 +41,7 @@ module Actions
       with_connection_error_handling(event) do |event|
         case event
         when nil
-          if remote_task
-            on_resume
-          else
-            trigger_proxy_task
-          end
-          suspend
+          start_or_resume
         when ::Dynflow::Action::Skip
           # do nothing
         when ::Dynflow::Action::Cancellable::Cancel
@@ -77,6 +72,12 @@ module Actions
       end
     end
 
+    def trigger_remote_task
+      suspend do |_suspended_action|
+        ForemanTasks::RemoteTask.batch_trigger(remote_task.operation, [remote_task])
+      end
+    end
+
     def proxy_input(task_id = task.id)
       input.merge(:callback => { :task_id => task_id,
                                  :step_id => run_step_id })
@@ -88,7 +89,7 @@ module Actions
         if response['result'] == 'error'
           raise ::Foreman::Exception, _('The smart proxy task %s failed.') % proxy_task_id
         else
-          on_data(response['actions'].find { |block_action| block_action['class'] == proxy_action_name }['output'])
+          on_data(get_proxy_data(response))
         end
       else
         suspend
@@ -154,10 +155,8 @@ module Actions
       if output.key?(:proxy_output) || state == :error
         output.fetch(:proxy_output, {})
       elsif live && proxy_task_id
-        proxy_data = proxy.status_of_task(proxy_task_id)['actions'].detect do |action|
-          action['class'] == proxy_action_name || action.fetch('input', {})['proxy_operation_name'] == proxy_operation_name
-        end
-        proxy_data.fetch('output', {})
+        response = proxy.status_of_task(proxy_task_id)
+        get_proxy_data(response)
       else
         {}
       end
@@ -205,6 +204,26 @@ module Actions
 
     private
 
+    def start_or_resume
+      if remote_task
+        if remote_task.state == 'external'
+          trigger_remote_task
+        else
+          on_resume
+        end
+      else
+        trigger_proxy_task
+      end
+      suspend
+    end
+
+    def get_proxy_data(response)
+      proxy_data = response['actions'].detect do |action|
+        action['class'] == proxy_action_name || action.fetch('input', {})['proxy_operation_name'] == proxy_operation_name
+      end
+      proxy_data.fetch('output', {})
+    end
+
     def proxy_version(proxy)
       match = proxy.statuses[:version].version['version'].match(/(\d+)\.(\d+)\.(\d+)/)
       { :major => match[1].to_i, :minor => match[2].to_i, :patch => match[3].to_i }
@@ -247,10 +266,12 @@ module Actions
     end
 
     def prepare_remote_task
+      state = input[:use_concurrency_control] ? 'external' : 'new'
       ::ForemanTasks::RemoteTask.new(:execution_plan_id => execution_plan_id,
                                      :proxy_url => input[:proxy_url],
                                      :step_id => run_step_id,
-                                     :operation => proxy_operation_name)
+                                     :operation => proxy_operation_name,
+                                     :state => state)
     end
 
     def proxy_task_id

data/app/lib/foreman_tasks/concerns/polling_action_extensions.rb

@@ -0,0 +1,12 @@
+module ForemanTasks
+  module Concerns
+    module PollingActionExtensions
+      def poll_intervals
+        multiplier = Setting[:foreman_tasks_polling_multiplier] || 1
+
+        # Prevent the intervals from going below 0.5 seconds
+        super.map { |interval| [interval * multiplier, 0.5].max }
+      end
+    end
+  end
+end

data/app/models/foreman_tasks/concerns/action_triggering.rb

@@ -158,7 +158,7 @@ module ForemanTasks
             end
           end
         end
-        return true
+        true
       ensure
         # to not execute the same execution plan twice in a row
         @execution_plan = nil

data/app/models/foreman_tasks/recurring_logic.rb

@@ -14,6 +14,7 @@ module ForemanTasks
     scoped_search :on => :max_iteration, :complete_value => false, :rename => :iteration_limit
     scoped_search :on => :iteration, :complete_value => false
     scoped_search :on => :cron_line, :complete_value => true
+    scoped_search :on => :state, :complete_value => true
 
     before_create do
       task_group.save

data/app/models/foreman_tasks/remote_task.rb

@@ -9,6 +9,7 @@ module ForemanTasks
 
     scope :triggered, -> { where(:state => 'triggered') }
     scope :pending,   -> { where(:state => 'new') }
+    scope :external,  -> { where(:state => 'external') }
 
     delegate :proxy_action_name, :to => :action
 

data/app/models/foreman_tasks/task.rb

@@ -42,6 +42,10 @@ module ForemanTasks
     scoped_search :on => :start_at, :complete_value => false
     scoped_search :on => :ended_at, :complete_value => false
     scoped_search :on => :parent_task_id, :complete_value => true
+    scoped_search :on => :duration, :complete_value => false, :ext_method => :search_by_duration, :operators => %w[> >= = <= <], :only_explicit => true
+
+    # Note: the following searches may return duplicates, this is due to
+    #       one task maybe having multiple locks (e.g. read/write) for the same resource_id
     scoped_search :relation => :locks,  :on => :resource_id, :complete_value => false, :rename => 'location_id', :ext_method => :search_by_taxonomy, :only_explicit => true
     scoped_search :relation => :locks,  :on => :resource_id, :complete_value => false, :rename => 'organization_id', :ext_method => :search_by_taxonomy, :only_explicit => true
     scoped_search :relation => :locks,  :on => :resource_type, :complete_value => true, :rename => 'resource_type', :ext_method => :search_by_generic_resource, :only_explicit => true

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

@@ -228,7 +228,7 @@ module ForemanTasks
           # 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_attributes(:state => 'stopped', :result => 'error')
+          task.update(:state => 'stopped', :result => 'error')
           Foreman::Logging.exception("Failed at consistency check for task #{task.id}", e, :logger => 'foreman-tasks')
         end
       end

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

@@ -4,7 +4,8 @@ module ForemanTasks
       def search_by_generic_resource(key, operator, value)
         key = 'resource_type' if key.blank?
         key_name = connection.quote_column_name(key.sub(/^.*\./, ''))
-        condition = sanitize_sql_for_conditions(["foreman_tasks_locks.#{key_name} #{operator} ?", value])
+        value = value.split(',') if operator.index(/IN/i)
+        condition = sanitize_sql_for_conditions(["foreman_tasks_locks.#{key_name} #{operator} (?)", value])
 
         { :conditions => condition, :joins => :locks }
       end
@@ -22,6 +23,15 @@ module ForemanTasks
         sql = "foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id #{operator} ? OR foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id IS NULL"
         { :conditions => sanitize_sql_for_conditions([sql, value]), :joins => joins }
       end
+
+      # Expects the time in the format "\d+ (seconds|minutes|hours|days|months|years)"
+      SUPPORTED_DURATION_FORMAT = /\A\s*(\d+(\s+\b(seconds?|minutes?|hours?|days?|months?|years?)\b)?)\b\s*\z/i.freeze
+      def search_by_duration(_key, operator, value)
+        raise "Unsupported duration '#{value}' specified for searching" unless value =~ SUPPORTED_DURATION_FORMAT
+        value = value.strip
+        { :conditions => "coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) #{operator} ?::interval",
+          :parameter => [value] }
+      end
     end
   end
 end

data/app/models/setting/foreman_tasks.rb

@@ -13,7 +13,12 @@ class Setting::ForemanTasks < Setting
           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),
+      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"))
     ]
   end
 

data/app/services/foreman_tasks/troubleshooting_help_generator.rb

@@ -44,10 +44,6 @@ module ForemanTasks
       # rubocop:enable Rails/OutputSafety
     end
 
-    def generate_text
-      (description + link_descriptions_html).join("\n")
-    end
-
     def link_descriptions_html
       links.map do |link|
         link.description % { link: %(<a href="%{href}">%{title}</a>) % link.to_h }

data/app/services/ui_notifications/tasks/task_bulk_cancel.rb

@@ -0,0 +1,36 @@
+module UINotifications
+  module Tasks
+    class TaskBulkCancel < ::UINotifications::Base
+      def initialize(task, cancelled_length, skipped_length)
+        @subject = task
+        @cancelled_length = cancelled_length
+        @skipped_length = skipped_length
+      end
+
+      def create
+        Notification.create!(
+          initiator: initiator,
+          audience: audience,
+          subject: subject,
+          notification_blueprint: blueprint,
+          message: message,
+          notification_recipients: [NotificationRecipient.create({ :user => User.current })]
+        )
+      end
+
+      def audience
+        Notification::AUDIENCE_GLOBAL
+      end
+
+      def message
+        ('%{cancelled} Tasks were cancelled. %{skipped} Tasks were skipped. ' %
+          { cancelled: @cancelled_length,
+          skipped: @skipped_length })
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'tasks_bulk_cancel')
+      end
+    end
+  end
+end

data/app/services/ui_notifications/tasks/task_bulk_resume.rb

@@ -0,0 +1,38 @@
+module UINotifications
+  module Tasks
+    class TaskBulkResume < ::UINotifications::Base
+      def initialize(task, resumed_length, failed_length, skipped_length)
+        @subject = task
+        @resumed_length = resumed_length
+        @failed_length = failed_length
+        @skipped_length = skipped_length
+      end
+
+      def create
+        Notification.create!(
+          initiator: initiator,
+          audience: audience,
+          subject: subject,
+          notification_blueprint: blueprint,
+          message: message,
+          notification_recipients: [NotificationRecipient.create({ :user => User.current })]
+        )
+      end
+
+      def audience
+        Notification::AUDIENCE_USER
+      end
+
+      def message
+        ('%{resumed} Tasks were resumed. %{failed} Tasks failed to resume. %{skipped} Tasks were skipped. ' %
+          { resumed: @resumed_length,
+          failed: @failed_length,
+          skipped: @skipped_length })
+      end
+
+      def blueprint
+        @blueprint ||= NotificationBlueprint.find_by(name: 'tasks_bulk_resume')
+      end
+    end
+  end
+end

data/app/views/foreman_tasks/api/recurring_logics/base.json.rabl

@@ -1,3 +1,4 @@
 object @recurring_logic
 
-attributes :id, :cron_line, :end_time, :iteration, :task_group_id, :state
+attributes :id, :cron_line, :end_time, :iteration, :task_group_id, :state,
+           :max_iteration

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

@@ -16,3 +16,4 @@ node(:locks) do
   end
 end
 node(:username_path) { username_link_task(@task.owner, @task.username) }
+node(:dynflow_enable_console) { Setting['dynflow_enable_console'] }

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

@@ -2,5 +2,5 @@ object @task if @task
 
 attributes :id, :label, :pending, :action
 attributes :username, :started_at, :ended_at, :state, :result, :progress
-attributes :input, :output, :humanized, :cli_example
+attributes :input, :output, :humanized, :cli_example, :start_at
 node(:available_actions) { |t| { cancellable: t.execution_plan&.cancellable?, resumable: t.resumable? } }

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

@@ -5,6 +5,36 @@
 <%= alert(:class => 'alert-info', :id => 'multiple-alert', :close => false, :header => '', :text => @errors) %>
 <% end %>
 
+<% if authorized_for(:permission => :edit_recurring_logics, :auth_object => @recurring_logics) %>
+  <% title_actions link_to(_('Clear Cancelled'),
+              clear_cancelled_foreman_tasks_recurring_logics_path,
+              class:  ['btn', 'btn-sm', 'btn-danger'],                  
+              :'data-toggle' => "modal",
+              :'data-target' => "#clear_modal") 
+              %>
+
+  <div class="modal fade" id="clear_modal" tabindex="-1" role="dialog" aria-labelledby="Deploy" aria-hidden="true">
+    <div class="modal-dialog">
+      <div class="modal-content">
+        <div class="modal-header">
+          <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+          <h2 class="modal-title" id="deploy_modal_label">
+            <span class="glyphicon glyphicon-warning-sign"></span>
+            <%= _("Clear Cancelled") %>
+          </h2>
+        </div>
+        <div class="modal-body">
+          <%= _("This action will delete all cancelled recurring logics. Please note that this action can't be reversed.") %>
+        </div>
+        <div class="modal-footer">
+          <button type="button" class="btn btn-default" data-dismiss="modal"><%= _("Cancel") %></button>
+          <%= link_to(_('Clear Cancelled'), clear_cancelled_foreman_tasks_recurring_logics_path, method: :post, class: 'btn btn-danger modal-submit') %>
+        </div>
+      </div>
+    </div>
+  </div>
+<% end %>
+
 <table class="<%= table_css_classes('table-condensed table-fixed') %>">
   <thead>
     <th><%= N_("Cron line") %></th>

data/app/views/foreman_tasks/tasks/show.html.erb

@@ -5,6 +5,9 @@
 <% content_for(:stylesheets) do %>
   <%= webpacked_plugins_css_for :'foreman-tasks' %>
 <% end %>
+
+<% title _("Details of %s task") % @task.to_s %>
+
 <%= breadcrumbs(
   items: breadcrumb_items,
   name_field: 'action',

data/config/routes.rb

@@ -6,6 +6,9 @@ Foreman::Application.routes.draw do
         put :enable
         put :disable
       end
+      collection do
+        post :clear_cancelled
+      end
     end
 
     resources :tasks, :only => [:show] do
@@ -39,6 +42,9 @@ Foreman::Application.routes.draw do
         member do
           post :cancel
         end
+        collection do
+          post :bulk_destroy
+        end
       end
 
       resources :tasks, :only => [:show, :index] do
@@ -49,6 +55,7 @@ Foreman::Application.routes.draw do
         collection do
           post :bulk_search
           post :bulk_resume
+          post :bulk_cancel
           get :summary
           get '/summary/:id/sub_tasks/', action: 'summary_sub_tasks'
           post :callback

data/db/migrate/20200611090846_add_task_lock_index_on_resource_type_and_task_id.rb

@@ -0,0 +1,9 @@
+class AddTaskLockIndexOnResourceTypeAndTaskId < ActiveRecord::Migration[5.2]
+  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

@@ -27,6 +27,20 @@ blueprints = [
             title: N_('Task Details')
           ]
       }
+  },
+
+  {
+    group: N_('Tasks'),
+    name: 'tasks_bulk_resume',
+    level: 'info',
+    message: "DYNAMIC",
+  },
+
+  {
+    group: N_('Tasks'),
+    name: 'tasks_bulk_cancel',
+    level: 'info',
+    message: "DYNAMIC",
   }
 ]
 

data/foreman-tasks.gemspec

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 # Maintain your gem's version:
 require "foreman_tasks/version"
@@ -29,11 +27,12 @@ same resource. It also optionally provides Dynflow infrastructure for using it f
   s.test_files = `git ls-files test`.split("\n")
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
-  s.add_dependency "foreman-tasks-core"
   s.add_dependency "dynflow", '>= 1.2.3'
-  s.add_dependency "sinatra" # for Dynflow web console
-  s.add_dependency "parse-cron", '~> 0.1.4'
+  s.add_dependency "foreman-tasks-core"
   s.add_dependency "get_process_mem" # for memory polling
+  s.add_dependency "parse-cron", '~> 0.1.4'
+  s.add_dependency "sinatra" # for Dynflow web console
 
   s.add_development_dependency 'factory_bot_rails', '~> 4.8.0'
+  s.add_development_dependency 'sqlite3'
 end