foreman-tasks 6.0.0 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a31c8423a352c5eeb6ff93b23ce8ed3d868ee4bdb16d456233f2c3df475342cd
-  data.tar.gz: c181fdc4c13d8c3cfb7e8d8469c9188a8972b97ca223e68cb50d9a901e23d552
+  metadata.gz: a5c1faf969670adf42567f2dd46b7b78dc2199561bb96b483516fe4169b7558d
+  data.tar.gz: 9aad850fd8decb284e1ccfc1869e5220da554e53286d31ccb3abb6da492a3ca3
 SHA512:
-  metadata.gz: c7f2b880bb70b4fc2781ab9c5bff2c7bcd0434bc067669fae601f1815f6720e7dd771a170cdde8a4922565f1bd87c61d5b3dc1c0b10192bd895508d123aa84da
-  data.tar.gz: a4652958efa52fec83b6c0a8093914b1d22ad574bc4763cb66c3bc41e82bd67e5b1448be0fd79ae3ce64225cb44d6c25faeb324cd10a846dfbe77abee5d55b02
+  metadata.gz: 9f76c37ad5faccedfee63f80b35b9bb1a3b65974fbef664c49baac53f6991846ed215c76cef6452bd966ea9da219d1adbae82edba3b3e783c7619ce832d51e96
+  data.tar.gz: d32b7d573c6809bba7bc28a4568513544752657461a9877c4f3824e8f5b0eca0b674fa9161f97cd8c72204b6edcc52f3e86480e19636538c53c8a4f473304e4f

data/.github/workflows/ruby_tests.yml

@@ -4,6 +4,7 @@ env:
   RAILS_ENV: test
   DATABASE_URL: postgresql://postgres:@localhost/test
   DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: true
+  BUNDLE_WITHOUT: "journald:development:console:mysql2:sqlite:libvirt"
 jobs:
   rubocop:
     runs-on: ubuntu-latest
@@ -13,10 +14,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
-      - name: Setup
-        run: |
-          gem install bundler
-          bundle install --jobs=3 --retry=3
+          bundler-cache: true
       - name: Run rubocop
         run: bundle exec rubocop
   test_ruby:
@@ -43,30 +41,21 @@ jobs:
       - uses: actions/checkout@v2
         with:
           path: foreman-tasks
+      - name: Setup Plugin in Foreman
+        run: |
+          echo "gem 'foreman-tasks', path: './foreman-tasks'" > bundler.d/foreman-tasks.local.rb
+          echo "gem 'sqlite3'" >> bundler.d/foreman-tasks.local.rb
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
       - name: Setup Node
         uses: actions/setup-node@v1
         with:
           node-version:  ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-${{ hashFiles('Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-
-      - name: Setup Bundler
-        run: |
-          echo "gem 'foreman-tasks', path: './foreman-tasks'" > bundler.d/foreman-tasks.local.rb
-          echo "gem 'sqlite3'" >> bundler.d/foreman-tasks.local.rb
-          gem install bundler
-          bundle config set without journald development console libvirt
-          bundle config set path vendor/bundle
       - name: Prepare test env
         run: |
-          bundle install --jobs=3 --retry=3
           bundle exec rake db:create
           bundle exec rake db:migrate
       - name: Run plugin tests

data/.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
   Exclude:
     - 'node_modules/**/*'
     - 'locale/*'
+    - 'vendor/**/*'
   TargetRubyVersion: 2.5
 
 Lint/ShadowingOuterLocalVariable:

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/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

@@ -40,8 +40,12 @@ module Actions
         output[:planned_count] += group.size
       end
     rescue => e
-      action_logger.warn "Could not trigger task on the smart proxy: #{e.message}"
-      batch.each { |remote_task| remote_task.update_from_batch_trigger({}) }
+      action_logger.warn "Could not trigger task on the smart proxy"
+      action_logger.warn e
+      # 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/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 do |remote_task|
+        results = group.first.proxy.launch_tasks(operation, input_hash)
+        group.each do |remote_task|
           remote_task.update_from_batch_trigger results.fetch(remote_task.execution_plan_id, {}),
                                                 results.fetch('parent', {})
         end
@@ -48,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/lib/foreman_tasks/engine.rb

@@ -42,17 +42,17 @@ module ForemanTasks
         security_block :foreman_tasks do |_map|
           permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :summary_sub_tasks, :show],
                                             :'foreman_tasks/react' => [:index],
-                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => ForemanTasks::Task.name
+                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :summary_sub_tasks, :details, :sub_tasks] }, :resource_type => 'ForemanTasks::Task'
           permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
-                                            :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => ForemanTasks::Task.name
+                                            :'foreman_tasks/api/tasks' => [:bulk_resume, :bulk_cancel, :bulk_stop] }, :resource_type => 'ForemanTasks::Task'
 
-          permission :create_recurring_logics, {}, :resource_type => ForemanTasks::RecurringLogic.name
+          permission :create_recurring_logics, {}, :resource_type => 'ForemanTasks::RecurringLogic'
 
           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
+                                               :'foreman_tasks/api/recurring_logics' => [:index, :show] }, :resource_type => 'ForemanTasks::RecurringLogic'
 
           permission :edit_recurring_logics, { :'foreman_tasks/recurring_logics' => [:cancel, :enable, :disable, :clear_cancelled],
-                                               :'foreman_tasks/api/recurring_logics' => [:cancel, :update, :bulk_destroy] }, :resource_type => ForemanTasks::RecurringLogic.name
+                                               :'foreman_tasks/api/recurring_logics' => [:cancel, :update, :bulk_destroy] }, :resource_type => 'ForemanTasks::RecurringLogic'
         end
 
         add_all_permissions_to_default_roles
@@ -116,7 +116,7 @@ module ForemanTasks
         register_graphql_query_field :recurring_logic, '::Types::RecurringLogic', :record_field
         register_graphql_query_field :recurring_logics, '::Types::RecurringLogic', :collection_field
 
-        register_graphql_mutation_field :cancel_recurring_logic, ::Mutations::RecurringLogics::Cancel
+        register_graphql_mutation_field :cancel_recurring_logic, '::Mutations::RecurringLogics::Cancel'
 
         logger :dynflow, :enabled => true
         logger :action, :enabled => true

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
@@ -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 = '6.0.0'.freeze
+  VERSION = '6.0.3'.freeze
 end

data/locale/action_names.rb

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

data/locale/en/foreman_tasks.po

@@ -56,6 +56,9 @@ msgstr ""
 msgid "A paused task represents a process that has not finished properly. Any task in paused state can lead to potential inconsistency and needs to be resolved."
 msgstr ""
 
+msgid "A special label for tracking a recurring job. There can be only one active job with a given purpose at a time."
+msgstr ""
+
 msgid "Action"
 msgstr ""
 
@@ -68,6 +71,9 @@ msgstr ""
 msgid "Active Filters:"
 msgstr ""
 
+msgid "Active or disabled recurring logic with purpose %s already exists"
+msgstr ""
+
 msgid "All %s tasks are selected. "
 msgstr ""
 
@@ -276,6 +282,9 @@ msgstr ""
 msgid "Fri"
 msgstr ""
 
+msgid "I understand that this may cause harm and have working database backups of all backend services."
+msgstr ""
+
 msgid "ID"
 msgstr ""
 
@@ -427,9 +436,6 @@ 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 ""
 
@@ -442,6 +448,9 @@ msgstr ""
 msgid "Proxy tasks batch size"
 msgstr ""
 
+msgid "Purpose"
+msgstr ""
+
 msgid "Raw"
 msgstr ""
 
@@ -487,6 +496,9 @@ msgstr ""
 msgid "Resource search_params requires resource_type and resource_id to be specified"
 msgstr ""
 
+msgid "Resources for %s task(s) will be unlocked and will not prevent other tasks from being run. As the task(s) might be still running, it should be avoided to use this unless you are really sure the task(s) got stuck."
+msgstr ""
+
 msgid "Result"
 msgstr ""
 
@@ -663,6 +675,12 @@ msgstr[1] ""
 msgid "This action will delete all cancelled recurring logics. Please note that this action can't be reversed."
 msgstr ""
 
+msgid "This will %(action)s %(number)s task(s), putting them in the %(state)s state. Are you sure?"
+msgstr ""
+
+msgid "This will unlock the resources that the task is running against. Please note that this might lead to inconsistent state and should be used with caution, after making sure that the task can't be resumed."
+msgstr ""
+
 msgid "Thu"
 msgstr ""
 
@@ -717,6 +735,9 @@ msgstr ""
 msgid "Yes"
 msgstr ""
 
+msgid "You can find resource locks on this page. Exclusive lock marked with locked icon means that no other task can use locked resource while this task is running. Non-exclusive lock marked with unlocked icon means other tasks can access the resource freely, it is only used to indicate the relation of this task with the resource"
+msgstr ""
+
 msgid "You do not have permission"
 msgstr ""
 
@@ -758,6 +779,9 @@ msgstr ""
 msgid "is month (range: 1-12)"
 msgstr ""
 
+msgid "is not a valid format"
+msgstr ""
+
 msgid "last"
 msgstr ""