foreman-tasks 2.0.3 → 3.0.0

data/app/models/foreman_tasks/recurring_logic.rb

@@ -31,12 +31,12 @@ module ForemanTasks
         if value
           task.update!(:start_at => next_occurrence_time) if task.start_at < Time.zone.now
           update(:state => 'active')
+        else
+          update(:state => 'disabled')
         end
-      elsif value
+      else
         raise RecurringLogicCancelledException
       end
-
-      update(:state => 'disabled') unless value
     end
 
     def enabled?
@@ -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

@@ -102,32 +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)
-          {
-            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
+        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
 
@@ -220,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

@@ -17,7 +17,7 @@ class Setting::ForemanTasks < Setting
           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/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/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/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.1.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],

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '2.0.3'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/package.json

@@ -28,7 +28,6 @@
   "dependencies": {
     "c3": "^0.4.11",
     "humanize-duration": "^3.20.1",
-    "react-html-parser": "^2.0.2",
     "react-intl": "^2.8.0"
   },
   "devDependencies": {

data/test/controllers/api/recurring_logics_controller_test.rb

@@ -44,7 +44,7 @@ module ForemanRecurringLogic
           post :cancel, params: { :id => @recurring_logic.id }
           assert_response :success
           @recurring_logic.reload
-          assert @recurring_logic.state == 'cancelled'
+          assert_equal @recurring_logic.state, 'cancelled'
         end
       end
     end

data/test/controllers/api/tasks_controller_test.rb

@@ -115,7 +115,7 @@ module ForemanTasks
             assert_response :success
             response = JSON.parse(@response.body)
             assert_kind_of Array, response
-            assert response.empty?
+            assert_empty response
           end
         end
       end
@@ -135,18 +135,18 @@ module ForemanTasks
           wait_for { ForemanTasks::Task.find_by(external_id: triggered.id).state == 'running' }
 
           task = ForemanTasks::Task.where(:external_id => triggered.id).first
-          task.state.must_equal 'running'
-          task.result.must_equal 'pending'
+          _(task.state).must_equal 'running'
+          _(task.result).must_equal 'pending'
 
           callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1][:callback]
           post :callback, params: { 'callback' => callback, 'data' => { 'result' => 'success' } }
           triggered.finished.wait(5)
 
           task.reload
-          task.state.must_equal 'stopped'
-          task.result.must_equal 'success'
-          task.main_action.output['proxy_task_id'].must_equal Support::DummyProxyAction.proxy.uuid
-          task.main_action.output['proxy_output'].must_equal('result' => 'success')
+          _(task.state).must_equal 'stopped'
+          _(task.result).must_equal 'success'
+          _(task.main_action.output['proxy_task_id']).must_equal Support::DummyProxyAction.proxy.uuid
+          _(task.main_action.output['proxy_output']).must_equal('result' => 'success')
         end
       end
     end

data/test/controllers/tasks_controller_test.rb

@@ -120,30 +120,30 @@ module ForemanTasks
           @controller.stubs(:params).returns(:search => "id = #{task.id}")
           in_taxonomy_scope(organizations.first) do |_o, _l|
             results = @controller.send(:filter, ForemanTasks::Task)
-            results.map(&:id).sort.must_equal [task.id]
+            _(results.map(&:id).sort).must_equal [task.id]
           end
         end
 
         it 'does not scope by taxonomy if unset' do
           organizations
           tasks
-          @controller.send(:current_taxonomy_search).must_equal ''
+          _(@controller.send(:current_taxonomy_search)).must_equal ''
           results = @controller.send(:filter, ForemanTasks::Task)
-          results.map(&:id).sort.must_equal tasks.map(&:id).sort
+          _(results.map(&:id).sort).must_equal tasks.map(&:id).sort
         end
 
         it 'scopes by organization if set' do
           scoped, _, unscoped = tasks
           in_taxonomy_scope(organizations.first) do |o, _l|
-            @controller.send(:current_taxonomy_search).must_equal "(organization_id = #{o.id})"
+            _(@controller.send(:current_taxonomy_search)).must_equal "(organization_id = #{o.id})"
             results = @controller.send(:filter, ForemanTasks::Task)
-            results.map(&:id).sort.must_equal [scoped, unscoped].map(&:id).sort
+            _(results.map(&:id).sort).must_equal [scoped, unscoped].map(&:id).sort
           end
         end
 
         it 'scopes by org and location if set' do
           in_taxonomy_scope(organizations.first, FactoryBot.create(:location)) do |o, l|
-            @controller.send(:current_taxonomy_search).must_equal "(organization_id = #{o.id} AND location_id = #{l.id})"
+            _(@controller.send(:current_taxonomy_search)).must_equal "(organization_id = #{o.id} AND location_id = #{l.id})"
           end
         end
       end

data/test/core/unit/runner_test.rb

@@ -14,7 +14,7 @@ module ForemanTasksCore
 
         describe '#generate_updates' do
           it 'returns empty hash when there are no outputs' do
-            runner.generate_updates.must_be :empty?
+            _(runner.generate_updates).must_be :empty?
           end
 
           it 'returns a hash with outputs' do
@@ -22,10 +22,10 @@ module ForemanTasksCore
             type = 'stdout'
             runner.publish_data(message, type)
             updates = runner.generate_updates
-            updates.keys.must_equal [suspended_action]
+            _(updates.keys).must_equal [suspended_action]
             update = updates.values.first
-            update.exit_status.must_be :nil?
-            update.continuous_output.raw_outputs.count.must_equal 1
+            _(update.exit_status).must_be :nil?
+            _(update.continuous_output.raw_outputs.count).must_equal 1
           end
 
           it 'works in compatibility mode' do
@@ -34,10 +34,10 @@ module ForemanTasksCore
             type = 'stdout'
             runner.publish_data(message, type)
             updates = runner.generate_updates
-            updates.keys.must_equal [nil]
+            _(updates.keys).must_equal [nil]
             update = updates.values.first
-            update.exit_status.must_be :nil?
-            update.continuous_output.raw_outputs.count.must_equal 1
+            _(update.exit_status).must_be :nil?
+            _(update.continuous_output.raw_outputs.count).must_equal 1
           end
         end
       end
@@ -53,38 +53,38 @@ module ForemanTasksCore
         describe '#initialize_continuous_outputs' do
           it 'initializes outputs for targets and parent' do
             outputs = runner.initialize_continuous_outputs
-            outputs.keys.count.must_equal 3
-            outputs.values.each { |output| output.must_be_instance_of ContinuousOutput }
+            _(outputs.keys.count).must_equal 3
+            outputs.values.each { |output| _(output).must_be_instance_of ContinuousOutput }
           end
         end
 
         describe '#generate_updates' do
           it 'returns only updates for hosts with pending outputs' do
-            runner.generate_updates.must_equal({})
+            _(runner.generate_updates).must_equal({})
             runner.publish_data_for('foo', 'something', 'something')
             updates = runner.generate_updates
-            updates.keys.count.must_equal 1
+            _(updates.keys.count).must_equal 1
           end
 
           it 'works in compatibility mode' do
             runner = Parent.new targets
-            runner.generate_updates.must_equal({})
+            _(runner.generate_updates).must_equal({})
             runner.broadcast_data('something', 'stdout')
             updates = runner.generate_updates
-            updates.keys.count.must_equal 3
+            _(updates.keys.count).must_equal 3
             # One of the keys is nil in compatibility mode
-            updates.keys.compact.count.must_equal 2
+            _(updates.keys.compact.count).must_equal 2
             updates.keys.compact.each do |key|
-              key.must_be_instance_of ::Dynflow::Action::Suspended
+              _(key).must_be_instance_of ::Dynflow::Action::Suspended
             end
           end
 
           it 'works without compatibility mode' do
             runner.broadcast_data('something', 'stdout')
             updates = runner.generate_updates
-            updates.keys.count.must_equal 3
+            _(updates.keys.count).must_equal 3
             updates.keys.each do |key|
-              key.must_be_instance_of ::Dynflow::Action::Suspended
+              _(key).must_be_instance_of ::Dynflow::Action::Suspended
             end
           end
         end
@@ -92,14 +92,14 @@ module ForemanTasksCore
         describe '#publish_data_for' do
           it 'publishes data for a single host' do
             runner.publish_data_for('foo', 'message', 'stdout')
-            runner.generate_updates.keys.count.must_equal 1
+            _(runner.generate_updates.keys.count).must_equal 1
           end
         end
 
         describe '#broadcast_data' do
           it 'publishes data for all hosts' do
             runner.broadcast_data('message', 'stdout')
-            runner.generate_updates.keys.count.must_equal 3
+            _(runner.generate_updates.keys.count).must_equal 3
           end
         end
 
@@ -115,7 +115,7 @@ module ForemanTasksCore
           it 'broadcasts the exception to all targets' do
             runner.expects(:publish_exit_status).never
             runner.publish_exception('general failure', exception, false)
-            runner.generate_updates.keys.count.must_equal 3
+            _(runner.generate_updates.keys.count).must_equal 3
           end
 
           it 'publishes exit status if fatal' do