foreman-tasks 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523767f29aa2c7e5485b4f18978a03120eb2369e510f5340ecb940d03372229e
-  data.tar.gz: 8db1c0c802560d5d8f910f0b8ae30be95640a4ad99c19145529aab2c6ab67ba8
+  metadata.gz: 933e58fce5919b151351e1a148a2360faea964f688a79b5db85223dd62653f51
+  data.tar.gz: 53b98db8cf8f6dc19c489a78a4eb923389413464dcb9fa4ca732888a032063ee
 SHA512:
-  metadata.gz: 284dc372bba144d11030df2ca96bfc01a716726e74e2d9797f88508984fe053d49d917f34b717b6e1806f2719df28e050750d274fe114ca0d6189b32ac5819bc
-  data.tar.gz: 4f7cdfc025e74b30177d8a437b5e01a7eb9be1159ef68eb8ab4243301850547fc9d72bbabbb629223dbcab0e77a3416ccd5a4586bf39f6f2240a09cb26b63a11
+  metadata.gz: e3a7334ab5a5efb4dd3957ead30a520836311def55777ffba66b60c272b93137ab1fbdad7a9c32ab70c23a9b5308442a6a0c1a48da00dc4d4eb8868cd9c931e9
+  data.tar.gz: df1a0dc013edb5c5baebb3e97a275b8ac9075963546cbb318743c368db9d373fc3277739a690a346b79db72397f437be86c1159cfd78cf2ae407ab7ecde8ee75

data/.rubocop.yml

@@ -1,8 +1,9 @@
-require: rubocop-rails
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rails
 
-# TODO: remove this file by either moving cops here or fixing code
-inherit_from:
-  - .rubocop_todo.yml
+inherit_from: .rubocop_todo.yml
 
 AllCops:
   Include:
@@ -55,12 +56,11 @@ Rails/FilePath:
 Rails/ReversibleMigration:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - config/routes.rb
-    - lib/foreman_tasks/engine.rb
-    - test/**/*
-    - lib/foreman_tasks/tasks/**/*
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
 
 Naming/FileName:
   Exclude:
@@ -69,7 +69,7 @@ Naming/FileName:
     - db/seeds.d/*
     - lib/foreman-tasks.rb
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Exclude:
     - '*.gemspec'
     - bin/*
@@ -101,7 +101,7 @@ Style/FormatStringToken:
 Style/RegexpLiteral:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 Metrics/ClassLength:

data/.rubocop_todo.yml

@@ -1,113 +1,49 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-04-02 18:15:37 +0200 using RuboCop version 0.54.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'foreman-tasks.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: final_newline, final_blank_line
-Layout/TrailingBlankLines:
-  Exclude:
-    - 'locale/action_names.rb'
-
 # Offense count: 1
 Lint/EmptyWhen:
   Exclude:
     - 'app/lib/actions/proxy_action.rb'
 
-# Offense count: 2
+# Offense count: 1
 Lint/UselessAssignment:
   Exclude:
     - 'lib/foreman_tasks/tasks/export_tasks.rake'
 
-# Offense count: 32
-Metrics/AbcSize:
-  Max: 41
-
-# Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 32
-
-# Offense count: 13
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 230
-
-# Offense count: 9
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-# Offense count: 482
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 211
-
-# Offense count: 54
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 29
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 167
+Minitest/AssertEmpty:
+  Enabled: false
 
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 6
+Minitest/AssertEqual:
+  Enabled: false
 
-# Offense count: 4
-Metrics/PerceivedComplexity:
-  Max: 9
+Minitest/GlobalExpectations:
+  Enabled: false
 
 # Offense count: 3
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
 Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'app/controllers/foreman_tasks/recurring_logics_controller.rb'
     - 'app/lib/actions/recurring_action.rb'
     - 'lib/foreman_tasks_core/otp_manager.rb'
 
+# Offense count: 11
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+Naming/MethodParameterName:
+  Exclude:
+    - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
+
 # Offense count: 1
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
 # NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
 # MethodDefinitionMacros: define_method, define_singleton_method
 Naming/PredicateName:
   Exclude:
     - 'spec/**/*'
     - 'app/models/foreman_tasks/task/status_explicator.rb'
 
-# Offense count: 12
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to
-Naming/UncommunicativeMethodParamName:
-  Exclude:
-    - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
-    - 'app/models/foreman_tasks/recurring_logic.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Rails/ActiveRecordAliases:
-  Exclude:
-    - 'app/models/foreman_tasks/task/dynflow_task.rb'
-    - 'test/factories/task_factory.rb'
-
 # Offense count: 6
 # Configuration parameters: Include.
 # Include: db/migrate/*.rb
@@ -119,14 +55,6 @@ Rails/CreateTableWithTimestamps:
     - 'db/migrate/20150907131503_create_task_groups.rb'
     - 'db/migrate/20151112152108_create_triggerings.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: numeric, symbolic
-Rails/HttpStatus:
-  Exclude:
-    - 'app/controllers/foreman_tasks/concerns/hosts_controller_extension.rb'
-
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
@@ -139,7 +67,14 @@ Rails/OutputSafety:
   Exclude:
     - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
 
-# Offense count: 11
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/Rakefile, **/*.rake
+Rails/RakeEnvironment:
+  Exclude:
+    - 'lib/foreman_tasks/tasks/test.rake'
+
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
@@ -163,33 +98,16 @@ Style/DoubleNegation:
     - 'app/models/foreman_tasks/lock.rb'
     - 'app/models/foreman_tasks/recurring_logic.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/Encoding:
-  Exclude:
-    - 'foreman-tasks-core.gemspec'
-    - 'foreman-tasks.gemspec'
-
-# Offense count: 6
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'foreman-tasks-core.gemspec'
-    - 'foreman-tasks.gemspec'
-    - 'lib/foreman_tasks/engine.rb'
-    - 'script/rails'
-
-# Offense count: 32
+# Offense count: 36
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'app/models/foreman_tasks/concerns/action_triggering.rb'
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
 
-Lint/SendWithMixinArgument:
+Style/HashTransformValues:
   Enabled: false

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

@@ -10,6 +10,12 @@ module ForemanTasks
         api_base_url '/foreman_tasks/api'
       end
 
+      # Foreman right now doesn't have mechanism to
+      # cause general BadRequest handling, resuing the Apipie::ParamError
+      # for now http://projects.theforeman.org/issues/3957
+      class BadRequest < Apipie::ParamError
+      end
+
       before_action :find_resource, :only => %w[show cancel update]
 
       api :GET, '/recurring_logics', N_('List recurring logics')
@@ -39,9 +45,22 @@ module ForemanTasks
         ForemanTasks::RecurringLogic
       end
 
+      api :POST, '/recurring_logics/bulk_destroy', N_('Delete recurring logics by search query')
+      param :search, String, :desc => N_('Search query'), :required => true
+      def bulk_destroy
+        if params[:search].blank?
+          raise BadRequest, _('Please provide a search parameter in the request')
+        end
+        scope = resource_scope.search_for(params[:search])
+        scope.each(&:destroy!)
+        render json: { destroyed: scope }
+      rescue ActiveRecord::RecordNotDestroyed => error
+        render json: { error: error, scope: scope }, status: :bad_request
+      end
+
       def action_permission
         case params[:action]
-        when 'cancel'
+        when 'cancel', 'bulk_destroy'
           'edit'
         else
           super

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

@@ -89,19 +89,13 @@ module ForemanTasks
       param :search, String, :desc => N_('Resume tasks matching search string')
       param :task_ids, Array, :desc => N_('Resume specific tasks by ID')
       def bulk_resume
-        scope = resource_scope
-        scope = scope.search_for(params[:search]) if params[:search]
-        scope = scope.select('DISTINCT foreman_tasks_tasks.*')
         if params[:search].nil? && params[:task_ids].nil?
-          scope = scope.where(:state => :paused)
-          scope = scope.where(:result => :error)
+          raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
         end
-        scope = scope.where(:id => params[:task_ids]) if params[:task_ids]
-
         resumed = []
         failed = []
         skipped = []
-        scope.each do |task|
+        bulk_scope.each do |task|
           if task.resumable?
             begin
               ForemanTasks.dynflow.world.execute(task.execution_plan.id)
@@ -122,6 +116,24 @@ module ForemanTasks
         }
       end
 
+      api :POST, '/tasks/bulk_cancel', N_('Cancel all cancellable tasks')
+      param :search, String, :desc => N_('Cancel tasks matching search string')
+      param :task_ids, Array, :desc => N_('Cancel specific tasks by ID')
+      def bulk_cancel
+        if params[:search].nil? && params[:task_ids].nil?
+          raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
+        end
+
+        cancelled, skipped = bulk_scope.partition(&:cancellable?)
+
+        cancelled.each(&:cancel)
+        render :json => {
+          total: cancelled.length + skipped.length,
+          cancelled: cancelled,
+          skipped: skipped
+        }
+      end
+
       api :GET, '/tasks', N_('List tasks')
       param :search, String, :desc => N_('Search string')
       param :page, :number, :desc => N_('Page number, starting at 1')
@@ -272,7 +284,7 @@ module ForemanTasks
         case params[:action]
         when 'bulk_search', 'summary', 'details', 'sub_tasks'
           :view
-        when 'bulk_resume'
+        when 'bulk_resume', 'bulk_cancel'
           :edit
         else
           super
@@ -311,6 +323,14 @@ module ForemanTasks
           results: results
         }
       end
+
+      def bulk_scope
+        scope = resource_scope
+        scope = scope.search_for(params[:search]) if params[:search]
+        scope = scope.select('DISTINCT foreman_tasks_tasks.*')
+        scope = scope.where(:id => params[:task_ids]) if params[:task_ids]
+        scope
+      end
     end
   end
 end

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

@@ -9,7 +9,7 @@ module ForemanTasks
                                        params[:certname],
                                        detected_proxy.try(:id))
 
-        render :json => { :task_id => task.id }, :status => 202
+        render :json => { :task_id => task.id }, :status => :accepted
       rescue ::Foreman::Exception => e
         render :json => { 'message' => e.to_s }, :status => :unprocessable_entity
       end

data/app/controllers/foreman_tasks/recurring_logics_controller.rb

@@ -22,6 +22,12 @@ module ForemanTasks
       redirect_to :action => :index
     end
 
+    def clear_cancelled
+      scope = resource_base.search_for('state=cancelled')
+      scope.destroy_all
+      redirect_to :action => :index
+    end
+
     def controller_name
       'foreman_tasks_recurring_logics'
     end
@@ -49,5 +55,18 @@ module ForemanTasks
       scope.search_for(params[:search])
            .paginate(:page => params[:page], :per_page => params[:per_page])
     end
+
+    def action_permission
+      case params[:action]
+      when 'clear_cancelled'
+        'edit'
+      else
+        super
+      end
+    end
+
+    def controller_permission
+      'recurring_logics'
+    end
   end
 end

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