foreman-tasks 5.2.0 → 5.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa2189368cc093a6ca613ca1b91add99bc3689b2cb22cd0c04a3718821b5f27f
-  data.tar.gz: f7e82294bbbb76fe6576b6c2de9e55c16342962f711a8e5c9070787be304a87c
+  metadata.gz: 9f1c154c83d919ac42b7d12edd03cff55e67f11a1367a67250a9a090759cd099
+  data.tar.gz: 519d85e8e975aab38b2e2314eb5761cb2bb3fe2d07b291822f3c667e6c0feab4
 SHA512:
-  metadata.gz: f20e5fba4dbc2401a4fed1f5eb68961ccc7095071fc309316ad14392b9209141e96aa2372eb7bb5db0e7f829ef08727ff2e232e53de86baa8385183ddb722252
-  data.tar.gz: 534ac74d1c8010ac25330562a6bdb713beacc413d2c681ee72f865727741cfb17e04d9dda2c0ea8ab7bde2f7f2e08f54fa4266e25686ca9d1f38c5309b24b94c
+  metadata.gz: 28a96b1b6c28bb5697607d69950167100815c667ecbebbc3f9f446f7e44899e7459e79a4f8efe8f53d798ee7ece6ebaad6d0becd610b11ab499cd32a4e2b5b53
+  data.tar.gz: 16c30b57fc2b2f82be9baf9d2dcf4c1b9f7a47df3013393d274fb6268ea04b6a066d3464bdeb1d911b998d7d5e68faa19ea9551193a25a07fb1cc12ddb45ee66

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -4,6 +4,8 @@ module ForemanTasks
     include Foreman::Controller::CsvResponder
     include ForemanTasks::FindTasksCommon
 
+    before_action :find_dynflow_task, only: [:unlock, :force_unlock, :cancel, :cancel_step, :resume]
+
     def show
       @task = resource_base.find(params[:id])
       render :layout => !request.xhr?
@@ -31,8 +33,7 @@ module ForemanTasks
     end
 
     def cancel_step
-      task = find_dynflow_task
-      result = ForemanTasks.dynflow.world.event(task.external_id, params[:step_id].to_i, ::Dynflow::Action::Cancellable::Cancel).wait
+      result = ForemanTasks.dynflow.world.event(@dynflow_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
@@ -41,8 +42,7 @@ module ForemanTasks
     end
 
     def cancel
-      task = find_dynflow_task
-      if task.cancel
+      if @dynflow_task.cancel
         render json: { statusText: 'OK' }
       else
         render json: {}, status: :bad_request
@@ -50,19 +50,17 @@ module ForemanTasks
     end
 
     def abort
-      task = find_dynflow_task
-      if task.abort
+      if @dynflow_task.abort
         flash[:info] = _('Trying to abort the task')
       else
         flash[:warning] = _('The task cannot be aborted at the moment.')
       end
-      redirect_back(:fallback_location => foreman_tasks_task_path(task))
+      redirect_back(:fallback_location => foreman_tasks_task_path(@dynflow_task))
     end
 
     def resume
-      task = find_dynflow_task
-      if task.resumable?
-        ForemanTasks.dynflow.world.execute(task.execution_plan.id)
+      if @dynflow_task.resumable?
+        ForemanTasks.dynflow.world.execute(@dynflow_task.execution_plan.id)
         render json: { statusText: 'OK' }
       else
         render json: {}, status: :bad_request
@@ -70,10 +68,8 @@ module ForemanTasks
     end
 
     def unlock
-      task = find_dynflow_task
-      if task.paused?
-        task.state = :stopped
-        task.save!
+      if @dynflow_task.paused?
+        unlock_task(@dynflow_task)
         render json: { statusText: 'OK' }
       else
         render json: {}, status: :bad_request
@@ -81,9 +77,7 @@ module ForemanTasks
     end
 
     def force_unlock
-      task       = find_dynflow_task
-      task.state = :stopped
-      task.save!
+      unlock_task(@dynflow_task)
       render json: { statusText: 'OK' }
     end
 
@@ -98,6 +92,12 @@ module ForemanTasks
 
     private
 
+    def unlock_task(task)
+      task.state = :stopped
+      task.locks.destroy_all
+      task.save!
+    end
+
     def respond_with_tasks(scope)
       @tasks = filter(scope, paginate: false).with_duration
       csv_response(@tasks, [:id, :action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :duration, :username], ['Id', 'Action', 'State', 'Result', 'Started At', 'Ended At', 'Duration', 'User'])
@@ -123,7 +123,7 @@ module ForemanTasks
     end
 
     def find_dynflow_task
-      resource_scope.where(:type => 'ForemanTasks::Task::DynflowTask').find(params[:id])
+      @dynflow_task = resource_scope.where(:type => 'ForemanTasks::Task::DynflowTask').find(params[:id])
     end
 
     def filter(scope, paginate: true)

data/app/lib/actions/trigger_proxy_batch.rb

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

data/app/models/foreman_tasks/recurring_logic.rb

@@ -90,7 +90,7 @@ module ForemanTasks
     def next_occurrence_time(time = Time.zone.now)
       @parser ||= CronParser.new(cron_line, Time.zone)
       # @parser.next(start_time) is not inclusive of the start_time hence stepping back one run to include checking start_time for the first run.
-      before_next = @parser.next(@parser.last(time))
+      before_next = @parser.next(@parser.last(time.in_time_zone))
       return before_next if before_next >= time && tasks.count == 0
       @parser.next(time)
     end

data/app/models/foreman_tasks/remote_task.rb

@@ -18,7 +18,8 @@ module ForemanTasks
       response = begin
                    proxy.launch_tasks('single', :action_class => proxy_action_name, :action_input => input)
                  rescue RestClient::Exception => e
-                   logger.warn "Could not trigger task on the smart proxy: #{e.message}"
+                   logger.warn "Could not trigger task on the smart proxy"
+                   logger.warn e
                    {}
                  end
       update_from_batch_trigger(response)
@@ -26,13 +27,13 @@ module ForemanTasks
     end
 
     def self.batch_trigger(operation, remote_tasks)
-      remote_tasks.group_by(&:proxy_url).values.map do |group|
+      remote_tasks.group_by(&:proxy_url).each_value do |group|
         input_hash = group.reduce({}) do |acc, remote_task|
           acc.merge(remote_task.execution_plan_id => { :action_input => remote_task.proxy_input,
                                                        :action_class => remote_task.proxy_action_name })
         end
-        results = remote_tasks.first.proxy.launch_tasks(operation, input_hash)
-        remote_tasks.each { |remote_task| remote_task.update_from_batch_trigger results[remote_task.execution_plan_id] }
+        results = group.first.proxy.launch_tasks(operation, input_hash)
+        group.each { |remote_task| remote_task.update_from_batch_trigger results[remote_task.execution_plan_id] }
       end
       remote_tasks
     end

data/extra/foreman-tasks-cleanup.sh

@@ -21,6 +21,21 @@ function build_rake() {
     echo
 }
 
+function incorrect_usage() {
+    echo "$1" >&2
+    echo
+    usage
+
+    exit 1
+}
+
+function validate_options!() {
+    if [ -z "$TASK_SEARCH" ]; then
+        [ -n "$AFTER" ] && incorrect_usage "Error: -a|--after cannot be used without -s|--search"
+        [ -n "$STATES" ] && incorrect_usage "Error: -S|--states cannot be used without -s|--search"
+    fi
+}
+
 function usage() {
         cat << EOF
 Usage: $PROGNAME [script_options...] [options...]
@@ -43,8 +58,8 @@ EOF
         echo Cleanup options:
         cat <<EOF | column -s\& -t
 -B|--batch-size BATCH_SIZE & process tasks in batches of BATCH_SIZE, 1000 by default
--S|--states STATES & operate on tasks in STATES, comma separated list of states, set to all to operate on tasks in any state
--a|--after AGE & operate on tasks older than AGE. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days
+-S|--states STATES & operate on tasks in STATES, comma separated list of states, set to all to operate on tasks in any state. Has to be used together with -s|--search
+-a|--after AGE & operate on tasks older than AGE. Expected format is a number followed by the time unit (s,h,m,y), such as '10d' for 10 days. Has to be used together with -s|--search
 -b|--backup & backup deleted tasks
 -n|--noop & do a dry run, print what would be done
 -s|--search QUERY & use QUERY in scoped search format to match tasks to delete
@@ -119,6 +134,8 @@ while true; do
     shift
 done
 
+validate_options!
+
 if [ "$EXECUTE" -eq 1 ]; then
     build_rake | sh
 else

data/lib/foreman_tasks/tasks/export_tasks.rake

@@ -241,35 +241,42 @@ namespace :foreman_tasks do
       end
     end
 
-    def csv_export(export_filename, tasks)
+    def csv_export(export_filename, id_scope, task_scope)
       CSV.open(export_filename, 'wb') do |csv|
         csv << %w[id state type label result parent_task_id started_at ended_at duration]
-        tasks.find_each do |task|
-          with_error_handling(task) do
-            csv << [task.id, task.state, task.type, task.label, task.result,
-                    task.parent_task_id, task.started_at, task.ended_at, task.duration]
+        id_scope.pluck(:id).each_slice(1000).each do |ids|
+          task_scope.where(id: ids).each do |task|
+            with_error_handling(task) do
+              csv << [task.id, task.state, task.type, task.label, task.result,
+                      task.parent_task_id, task.started_at, task.ended_at, task.duration]
+            end
           end
         end
       end
     end
 
-    def html_export(workdir, tasks)
+    def html_export(workdir, id_scope, task_scope)
       PageHelper.copy_assets(workdir)
 
+      ids = id_scope.pluck(:id)
       renderer = TaskRender.new
-      total = tasks.count(:all)
+      count = 0
+      total = ids.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|
-              content = with_error_handling(task) { renderer.render_task(task) }
-              if content
-                File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, content) }
-                with_error_handling(task, _('task index entry')) { PageHelper.generate_index_entry(index, task) }
+            ids.each_slice(1000).each do |ids|
+              task_scope.where(id: ids).each do |task|
+                content = with_error_handling(task) { renderer.render_task(task) }
+                if content
+                  File.open(File.join(workdir, "#{task.id}.html"), 'w') { |file| PageHelper.pagify(file, content) }
+                  with_error_handling(task, _('task index entry')) { PageHelper.generate_index_entry(index, task) }
+                end
+                count += 1
+                puts "#{count}/#{total}"
               end
-              puts "#{count + 1}/#{total}"
             end
           end
         end
@@ -300,7 +307,7 @@ namespace :foreman_tasks do
       end
     end
 
-    SKIP_ERRORS = ['true', '1', 'y', 'yes'].include? ENV['SKIP_FAILED'].downcase
+    SKIP_ERRORS = ['true', '1', 'y', 'yes'].include? (ENV['SKIP_FAILED'] || '').downcase
 
     filter = if ENV['TASK_SEARCH'].nil? && ENV['TASK_DAYS'].nil?
                "started_at > \"#{7.days.ago.to_s(:db)}\" || " \
@@ -317,21 +324,22 @@ namespace :foreman_tasks do
     format = ENV['TASK_FORMAT'] || 'html'
     export_filename = ENV['TASK_FILE'] || generate_filename(format)
 
-    tasks = ForemanTasks::Task.search_for(filter).order(:started_at => :desc).with_duration.distinct
+    task_scope = ForemanTasks::Task.search_for(filter).with_duration.order(:started_at => :desc)
+    id_scope = task_scope.group(:id, :started_at)
 
     puts _("Exporting all tasks matching filter #{filter}")
-    puts _("Gathering #{tasks.count(:all)} tasks.")
+    puts _("Gathering #{id_scope.count(:all).count} tasks.")
     case format
     when 'html'
       Dir.mktmpdir('task-export') do |tmp_dir|
-        html_export(tmp_dir, tasks)
+        html_export(tmp_dir, id_scope, task_scope)
         system("tar", "czf", export_filename, tmp_dir)
       end
     when 'html-dir'
       FileUtils.mkdir_p(export_filename)
-      html_export(export_filename, tasks)
+      html_export(export_filename, id_scope, task_scope)
     when 'csv'
-      csv_export(export_filename, tasks)
+      csv_export(export_filename, id_scope, task_scope)
     else
       raise "Unkonwn export format '#{format}'"
     end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '5.2.0'.freeze
+  VERSION = '5.2.3'.freeze
 end

data/test/unit/remote_task_test.rb

@@ -28,6 +28,32 @@ module ForemanTasks
           _(remote_task.remote_task_id).must_equal((remote_task.id + 5).to_s)
         end
       end
+
+      it 'honors the batches with multiple proxies' do
+        remote_task = remote_tasks.last
+        remote_task.proxy_url = 'something else'
+
+        results = remote_tasks.reduce({}) do |acc, cur|
+          acc.merge(cur.execution_plan_id.to_s => { 'task_id' => cur.id + 5, 'result' => 'success' })
+        end
+        other_results = { remote_task.execution_plan_id => results.delete(remote_task.execution_plan_id) }
+
+        fake_proxy = mock
+        fake_proxy.expects(:launch_tasks).returns(results)
+
+        another_fake_proxy = mock
+        another_fake_proxy.expects(:launch_tasks).returns(other_results)
+
+        remote_tasks.first.expects(:proxy).returns(fake_proxy)
+        remote_tasks.last.expects(:proxy).returns(another_fake_proxy)
+
+        RemoteTask.batch_trigger('a_operation', remote_tasks)
+        remote_tasks.each do |remote_task|
+          remote_task.reload
+          _(remote_task.state).must_equal 'triggered'
+          _(remote_task.remote_task_id).must_equal((remote_task.id + 5).to_s)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynflow
@@ -607,7 +607,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Foreman plugin for showing tasks information for resources and users