foreman-tasks 4.1.0 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99321b6a250c3166881128f05a88feb20cf24cc14e6ccbf813e5cc1853f4447a
-  data.tar.gz: 99ce5e8f81c1dbbdf41a6980b0ff4cb98529928dfd0769676821e6c71f8e2302
+  metadata.gz: 3152af7ac771946d9090d5a1b867c6843ff6657ab2434c4daba986c60c83579e
+  data.tar.gz: 4d3cd7b0d58af7f59a5d7745e1b75444dc43066089c60854344c49dc1d58ed43
 SHA512:
-  metadata.gz: 7284f7dd3ff25480f57f697ebe57cbff5f6b865afd1e6792c710ea880bc23f0a6f261333c727a7917be9a30c9d1de54d7e4bfeebc9bc43635244fdd1ca8f5d79
-  data.tar.gz: 6580dd94504e0d9c5cf8f2d070bb42da3782feadbdba59ee9f1275e526b5b53b1cb34106163807f99eac09b59ba8991ea2f51bb224184007f7aee4bf30808553
+  metadata.gz: 528a33eb7ef2128cdc476411c705762b3b63ba22d8a3ff3ca70755a42247c5a538494b1b248eee547a2a7ffa49821612f05f0f53e42ef026a70e107e064246f1
+  data.tar.gz: 85033e3dd3c84eb6aa8dd99e837ad024acd42639c1351f518883ef431b9b95c9ddb833f11e6708bda488113c1a33faf7959ac4a11bbeb4ea16e29a32c955e670

data/app/controllers/concerns/foreman_tasks/find_tasks_common.rb

@@ -0,0 +1,14 @@
+module ForemanTasks
+  module FindTasksCommon
+    def search_query
+      [current_taxonomy_search, params[:search]].select(&:present?).join(' AND ')
+    end
+
+    def current_taxonomy_search
+      conditions = []
+      conditions << "organization_id = #{Organization.current.id}" if Organization.current
+      conditions << "location_id = #{Location.current.id}" if Location.current
+      conditions.empty? ? '' : "(#{conditions.join(' AND ')})"
+    end
+  end
+end

data/app/controllers/foreman_tasks/api/tasks_controller.rb

@@ -1,6 +1,7 @@
 module ForemanTasks
   module Api
     class TasksController < ::Api::V2::BaseController
+      include ForemanTasks::FindTasksCommon
       include ::Foreman::Controller::SmartProxyAuth
       add_smart_proxy_filters :callback, :features => 'Dynflow'
 
@@ -51,7 +52,7 @@ module ForemanTasks
           In case :type = 'resource', what resource id we're searching the tasks for
         DESC
         param :action_types, [String], :desc => <<-DESC
-          Return just tasks of given action type, e.g. ["Actions::Katello::Repository::Synchronize"]
+          Return just tasks of given action type, e.g. `["Actions::Katello::Repository::Synchronize"]`
         DESC
         param :active_only, :bool
         param :page, String
@@ -191,11 +192,11 @@ module ForemanTasks
           params[:order] = "#{ordering_params[:sort_by]} #{ordering_params[:sort_order]}"
         end
         params[:order] ||= 'started_at DESC'
-        @tasks = DashboardTableFilter.new(resource_scope_for_index, params).scope.order(params[:order].to_s)
+        @tasks = resource_scope_for_index.order(params[:order].to_s)
       end
 
       def search_options
-        [params[:search], {}]
+        [search_query, {}]
       end
 
       def_param_group :callback_target do

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -2,6 +2,7 @@ module ForemanTasks
   class TasksController < ::ApplicationController
     include Foreman::Controller::AutoCompleteSearch
     include Foreman::Controller::CsvResponder
+    include ForemanTasks::FindTasksCommon
 
     def show
       @task = resource_base.find(params[:id])
@@ -128,17 +129,9 @@ module ForemanTasks
     def filter(scope, paginate: true)
       search = current_taxonomy_search
       search = [search, params[:search]].select(&:present?).join(' AND ')
-      scope = DashboardTableFilter.new(scope, params).scope
-      scope = scope.search_for(search, :order => params[:order])
-      scope = scope.paginate(:page => params[:page], :per_page => params[:per_page]) if paginate
+      scope = scope.search_for(search, order: params[:order])
+      scope = scope.paginate(page: params[:page], per_page: params[:per_page]) if paginate
       scope.distinct
     end
-
-    def current_taxonomy_search
-      conditions = []
-      conditions << "organization_id = #{Organization.current.id}" if Organization.current
-      conditions << "location_id = #{Location.current.id}" if Location.current
-      conditions.empty? ? '' : "(#{conditions.join(' AND ')})"
-    end
   end
 end

data/app/lib/actions/middleware/load_setting_values.rb

@@ -0,0 +1,35 @@
+module Actions
+  module Middleware
+    class LoadSettingValues < ::Dynflow::Middleware
+      # ::Actions::Middleware::LoadSettingValues
+      #
+      # A middleware to ensure we load current setting values
+
+      def delay(*args)
+        reload_setting_values
+        pass(*args)
+      end
+
+      def plan(*args)
+        reload_setting_values
+        pass(*args)
+      end
+
+      def run(*args)
+        reload_setting_values
+        pass(*args)
+      end
+
+      def finalize(*args)
+        reload_setting_values
+        pass(*args)
+      end
+
+      private
+
+      def reload_setting_values
+        ::Foreman.settings.load_values
+      end
+    end
+  end
+end

data/app/lib/actions/middleware/watch_delegated_proxy_sub_tasks.rb

@@ -20,9 +20,7 @@ module Actions
       private
 
       def set_clock
-        action.world.clock.ping action.send(:suspended_action),
-                                POLL_INTERVAL,
-                                CheckOnProxyActions
+        action.plan_event(CheckOnProxyActions, POLL_INTERVAL, optional: true)
       end
 
       def check_triggered
@@ -44,9 +42,7 @@ module Actions
 
       def notify(event, tasks)
         tasks.each do |task|
-          action.world.event task.execution_plan_id,
-                             task.step_id,
-                             event
+          action.plan_event(event, execution_plan_id: task.execution_plan_id, step_id: task.step_id)
         end
       end
 

data/app/lib/actions/proxy_action.rb

@@ -219,7 +219,7 @@ module Actions
 
     def get_proxy_data(response)
       response['actions'].detect { |action| action.fetch('input', {})['task_id'] == task.id }
-                         .try(:fetch, 'output', {})
+                         .try(:fetch, 'output', {}) || {}
     end
 
     def proxy_version(proxy)

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

@@ -140,12 +140,17 @@ module ForemanTasks
 
     def main_action
       return @main_action if defined?(@main_action)
+
+      @main_action = execution_plan && execution_plan.root_plan_step.try(:action, execution_plan)
       if active_job?
         job_data = active_job_data
-        @main_action = active_job_action(job_data['job_class'], job_data['arguments'])
-      else
-        @main_action = execution_plan && execution_plan.root_plan_step.try(:action, execution_plan)
+        begin
+          @main_action = active_job_action(job_data['job_class'], job_data['arguments'])
+        rescue => e
+          Foreman::Logging.exception("Failed to load ActiveJob for task #{id}", e, :logger => 'foreman-tasks')
+        end
       end
+      @main_action
     end
 
     # The class for ActiveJob jobs in Dynflow, JobWrapper is not expected to

data/lib/foreman_tasks/engine.rb

@@ -114,6 +114,7 @@ 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')
       end
 
       ::ForemanTasks.dynflow.config.on_init do |world|

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -12,7 +12,7 @@ namespace :foreman_tasks do
 
       * TASK_SEARCH     : scoped search filter (example: 'label = "Actions::Foreman::Host::ImportFacts"')
       * TASK_FILE       : file to export to
-      * TASK_FORMAT     : format to use for the export (either html or csv)
+      * TASK_FORMAT     : format to use for the export (either html, html-dir or csv)
       * TASK_DAYS       : number of days to go back
 
     If TASK_SEARCH is not defined, it defaults to all tasks in the past 7 days and
@@ -185,23 +185,27 @@ namespace :foreman_tasks do
     end
 
     class PageHelper
-      def self.pagify(template)
-        pre = <<-HTML
-       <html>
-       <head>
-       <title>Dynflow Console</title>
-       <script src="jquery.js"></script>
-       <link rel="stylesheet" type="text/css" href="bootstrap.css">
-       <link rel="stylesheet" type="text/css" href="application.css">
-       <script src="bootstrap.js"></script>
-       <script src="run_prettify.js"></script>
-       <script src="application.js"></script>
-       </head>
-       <body>
-          #{template}
-       <body>
-       </html>
+      def self.pagify(io, template = nil)
+        io.write <<~HTML
+          <html>
+            <head>
+              <title>Dynflow Console</title>
+              <script src="jquery.js"></script>
+              <link rel="stylesheet" type="text/css" href="bootstrap.css">
+              <link rel="stylesheet" type="text/css" href="application.css">
+              <script src="bootstrap.js"></script>
+              <script src="run_prettify.js"></script>
+              <script src="application.js"></script>
+            </head>
+          <body>
         HTML
+        if block_given?
+          yield io
+        else
+          io.write template
+        end
+      ensure
+        io.write '</body></html>'
       end
 
       def self.copy_assets(tmp_dir)
@@ -216,13 +220,64 @@ namespace :foreman_tasks do
         end
       end
 
-      def self.generate_index(tasks)
-        html = '<div><table class="table">'
-        tasks.order('started_at desc').all.each do |task|
-          html << "<tr><td><a href=\"#{task.id}.html\">#{task.label}</a></td><td>#{task.started_at}</td>\
-                   <td>#{task.state}</td><td>#{task.result}</td></tr>"
+      def self.generate_with_index(io)
+        io.write '<div><table class="table">'
+        yield io
+      ensure
+        io.write '</table></div>'
+      end
+
+      def self.generate_index_entry(io, task)
+        io << <<~HTML
+          <tr>
+            <td><a href=\"#{task.id}.html\">#{task.label}</a></td>
+            <td>#{task.started_at}</td>
+            <td>#{task.state}</td>
+            <td>#{task.result}</td>
+          </tr>
+        HTML
+      end
+    end
+
+    def csv_export(export_filename, tasks)
+      CSV.open(export_filename, 'wb') do |csv|
+        csv << %w[id state type label result parent_task_id started_at ended_at]
+        tasks.find_each do |task|
+          csv << [task.id, task.state, task.type, task.label, task.result,
+                  task.parent_task_id, task.started_at, task.ended_at]
         end
-        html << '</table></div>'
+      end
+    end
+
+    def html_export(workdir, tasks)
+      PageHelper.copy_assets(workdir)
+
+      renderer = TaskRender.new
+      total = tasks.count
+      index = File.open(File.join(workdir, 'index.html'), 'w')
+
+      File.open(File.join(workdir, 'index.html'), 'w') do |index|
+        PageHelper.pagify(index) do |io|
+          PageHelper.generate_with_index(io) do |index|
+            tasks.find_each.each_with_index do |task, count|
+              File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, renderer.render_task(task)) }
+              PageHelper.generate_index_entry(index, task)
+              puts "#{count + 1}/#{total}"
+            end
+          end
+        end
+      end
+    end
+
+    def generate_filename(format)
+      base = "/tmp/task-export-#{Time.now.to_i}"
+      case format
+      when 'html'
+        base + '.tar.gz'
+      when 'csv'
+        base + '.csv'
+      when 'html-dir'
+        base
       end
     end
 
@@ -239,36 +294,25 @@ namespace :foreman_tasks do
     end
 
     format = ENV['TASK_FORMAT'] || 'html'
-    export_filename = ENV['TASK_FILE'] || "/tmp/task-export-#{Time.now.to_i}.#{format == 'csv' ? 'csv' : 'tar.gz'}"
+    export_filename = ENV['TASK_FILE'] || generate_filename(format)
 
-    tasks = ForemanTasks::Task.search_for(filter)
+    tasks = ForemanTasks::Task.search_for(filter).order(:started_at => :desc)
 
     puts _("Exporting all tasks matching filter #{filter}")
     puts _("Gathering #{tasks.count} tasks.")
-    if format == 'html'
+    case format
+    when 'html'
       Dir.mktmpdir('task-export') do |tmp_dir|
-        PageHelper.copy_assets(tmp_dir)
-
-        renderer = TaskRender.new
-        total = tasks.count
-
-        tasks.find_each.with_index do |task, count|
-          File.open(File.join(tmp_dir, "#{task.id}.html"), 'w') { |file| file.write(PageHelper.pagify(renderer.render_task(task))) }
-          puts "#{count + 1}/#{total}"
-        end
-
-        File.open(File.join(tmp_dir, 'index.html'), 'w') { |file| file.write(PageHelper.pagify(PageHelper.generate_index(tasks))) }
-
+        html_export(tmp_dir, tasks)
         system("tar", "czf", export_filename, tmp_dir)
       end
-    elsif format == 'csv'
-      CSV.open(export_filename, 'wb') do |csv|
-        csv << %w[id state type label result parent_task_id started_at ended_at]
-        tasks.find_each do |task|
-          csv << [task.id, task.state, task.type, task.label, task.result,
-                  task.parent_task_id, task.started_at, task.ended_at]
-        end
-      end
+    when 'html-dir'
+      FileUtils.mkdir_p(export_filename)
+      html_export(export_filename, tasks)
+    when 'csv'
+      csv_export(export_filename, tasks)
+    else
+      raise "Unkonwn export format '#{format}'"
     end
 
     puts "Created #{export_filename}"

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.1.4'.freeze
 end

data/locale/action_names.rb

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

data/locale/en/foreman_tasks.po

@@ -74,6 +74,9 @@ msgstr ""
 msgid "All proxies with the required feature are unavailable at the moment"
 msgstr ""
 
+msgid "Allow proxy batch tasks"
+msgstr ""
+
 msgid "Allow triggering tasks on the smart proxy in batches"
 msgstr ""
 
@@ -99,15 +102,15 @@ msgstr ""
 msgid "Cancel Selected"
 msgstr ""
 
-msgid "Cancel all cancellable tasks"
-msgstr ""
-
 msgid "Cancel enforced: the task might be still running on the proxy"
 msgstr ""
 
 msgid "Cancel recurring logic"
 msgstr ""
 
+msgid "Cancel selected cancellable tasks"
+msgstr ""
+
 msgid "Cancel selected tasks"
 msgstr ""
 
@@ -156,6 +159,9 @@ msgstr ""
 msgid "Could not cancel step."
 msgstr ""
 
+msgid "Could not receive data: ${APIerror && APIerror.message}"
+msgstr ""
+
 msgid "Could not receive data: ${error && error.message}"
 msgstr ""
 
@@ -207,6 +213,9 @@ msgstr ""
 msgid "Enable"
 msgstr ""
 
+msgid "Enable dynflow console"
+msgstr ""
+
 msgid "Enable the dynflow console (/foreman_tasks/dynflow) for debugging"
 msgstr ""
 
@@ -246,9 +255,6 @@ msgstr ""
 msgid "Failed to initialize"
 msgstr ""
 
-msgid "Field to sort the results on"
-msgstr ""
-
 msgid "Finished"
 msgstr ""
 
@@ -270,12 +276,6 @@ msgstr ""
 msgid "Fri"
 msgstr ""
 
-msgid "Hash version of 'order' param"
-msgstr ""
-
-msgid "How to order the sorted results (e.g. ASC for ascending)"
-msgstr ""
-
 msgid "ID"
 msgstr ""
 
@@ -381,9 +381,6 @@ msgstr ""
 msgid "Number of attempts to start a task on the smart proxy before failing"
 msgstr ""
 
-msgid "Number of results per page to return"
-msgstr ""
-
 msgid "Number of seconds to wait for synchronous task to finish."
 msgstr ""
 
@@ -397,13 +394,16 @@ msgstr ""
 msgid "Operation"
 msgstr ""
 
-msgid "Output"
+msgid "Other includes all stopped tasks that are cancelled or pending"
 msgstr ""
 
-msgid "Output:"
+msgid "Other:"
+msgstr ""
+
+msgid "Output"
 msgstr ""
 
-msgid "Page number, starting at 1"
+msgid "Output:"
 msgstr ""
 
 msgid "Parent task"
@@ -427,9 +427,21 @@ msgstr ""
 msgid "Polling multiplier which is used to multiply the default polling intervals. This can be used to prevent polling too frequently for long running tasks."
 msgstr ""
 
+msgid "Preupgrade job"
+msgstr ""
+
+msgid "Proxy action retry count"
+msgstr ""
+
+msgid "Proxy action retry interval"
+msgstr ""
+
 msgid "Proxy task gone missing from the smart proxy"
 msgstr ""
 
+msgid "Proxy tasks batch size"
+msgstr ""
+
 msgid "Raw"
 msgstr ""
 
@@ -448,6 +460,12 @@ msgstr ""
 msgid "Recurring logics"
 msgstr ""
 
+msgid "Refresh Data"
+msgstr ""
+
+msgid "Remote action:"
+msgstr ""
+
 msgid "Repeat N times"
 msgstr ""
 
@@ -457,13 +475,13 @@ msgstr ""
 msgid "Repeats"
 msgstr ""
 
-msgid "Require user to be authenticated as user with admin rights when accessing dynflow console"
+msgid "Require auth for dynflow console"
 msgstr ""
 
-msgid "Required lock is already taken by other running tasks."
+msgid "Require user to be authenticated as user with admin rights when accessing dynflow console"
 msgstr ""
 
-msgid "Required lock: %s"
+msgid "Required lock is already taken by other running tasks."
 msgstr ""
 
 msgid "Resource search_params requires resource_type and resource_id to be specified"
@@ -514,9 +532,6 @@ msgstr ""
 msgid "Search query"
 msgstr ""
 
-msgid "Search string"
-msgstr ""
-
 msgid "See %{link} for more details on how to resolve the issue"
 msgstr ""
 
@@ -535,10 +550,10 @@ msgstr ""
 msgid "Set up recurring execution"
 msgstr ""
 
-msgid "Show recurring logic details"
+msgid "Setting is off"
 msgstr ""
 
-msgid "Sort field and order, e.g. 'name DESC'"
+msgid "Show recurring logic details"
 msgstr ""
 
 msgid "Start at"
@@ -559,7 +574,7 @@ msgstr ""
 msgid "Step Canceled"
 msgstr ""
 
-msgid "Stop all stoppable tasks"
+msgid "Stop selected stoppable tasks"
 msgstr ""
 
 msgid "Stop specific tasks by ID"
@@ -580,6 +595,9 @@ msgstr ""
 msgid "Sun"
 msgstr ""
 
+msgid "Sync task timeout"
+msgstr ""
+
 msgid "Task"
 msgstr ""
 
@@ -610,12 +628,21 @@ msgstr ""
 msgid "Tasks"
 msgstr ""
 
+msgid "Tasks troubleshooting URL"
+msgstr ""
+
 msgid "The ID of the step inside the execution plan to send the event to"
 msgstr ""
 
 msgid "The recommended approach is to investigate the error messages below and in 'errors' tab, address the primary cause of the issue and resume the task."
 msgstr ""
 
+msgid "The recurring logic was disabled."
+msgstr ""
+
+msgid "The recurring logic was enabled."
+msgstr ""
+
 msgid "The smart proxy task %s failed."
 msgstr ""
 
@@ -690,6 +717,9 @@ msgstr ""
 msgid "Yes"
 msgstr ""
 
+msgid "You do not have permission"
+msgstr ""
+
 msgid "activation key"
 msgstr ""
 
@@ -743,6 +773,9 @@ msgstr ""
 msgid "organization"
 msgstr ""
 
+msgid "other"
+msgstr ""
+
 msgid "paused"
 msgstr ""