foreman_remote_execution 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4de9b6ef4385fb25d736b6e2a3c79ad3d6240e6
-  data.tar.gz: de38d2967d75a10fa0d759d1927eb5a637c9a73a
+  metadata.gz: ba7dfa6dd3c06e3240541005c42afc45c5d2c61f
+  data.tar.gz: b6985d294864cc4e69919ccf6ec6d7a29478e674
 SHA512:
-  metadata.gz: 91604a14604487b8d821e4e81991402c281c0cc342105de1b124bc4c4be18809414f54b9da28c92774c5bb5663c190c7775ed1d76341f5b2ce36e41388d5f7e4
-  data.tar.gz: 67cfafed4dc9d8a204d478781c227937a657a0134630739bb4670744c3c505f26b1d97e9777e9b9ed7e046729faa9ef8ce4f7f1a5e1dba3224be110876babbdf
+  metadata.gz: e3cb2b3678b4127b56ac9b37a7983e42d283a0728204f22c47c319d17878c5eff268cb327311b7d64e74cbef7a750217f2b98b7ef81ce4be1a87dd7695253b85
+  data.tar.gz: 5a8f1dc7ff728d443decf1047246e1f11bb87bed37df736b6baa3a19da3ea28797740533d8cb199ed3c93325bdcccaf6a02cd109b7c557f60234cb4654ef2e1e

data/.rubocop.yml

@@ -79,3 +79,19 @@ Style/VariableNumber:
 # a == 0 is not the same as a.zero?, when a is not a number
 Style/NumericPredicate:
   Enabled: false
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+# for compatibility with Foreman 1.15
+Rails/ApplicationRecord:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false

data/.rubocop_todo.yml

@@ -122,12 +122,6 @@ Style/IndentationWidth:
 Style/LineEndConcatenation:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MethodCallParentheses:
-  Exclude:
-    - 'test/unit/actions/run_hosts_job_test.rb'
-
 # Offense count: 6
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.

data/Rakefile

@@ -1,4 +1,3 @@
-#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/controllers/api/v2/job_invocations_controller.rb

@@ -53,6 +53,7 @@ module Api
           param :bookmark_id, Integer, :required => false
           param :search_query, Integer, :required => false
           param :description_format, String, :required => false, :desc => N_('Override the description format from the template for this invocation only')
+          param :execution_timeout_interval, Integer, :required => false, :desc => N_('Override the timeout interval from the template for this invocation only')
         end
       end
 

data/app/controllers/concerns/foreman/controller/parameters/job_template.rb

@@ -15,7 +15,7 @@ module Foreman::Controller::Parameters::JobTemplate
 
     def job_template_params_filter
       Foreman::ParameterFilter.new(::TemplateInput).tap do |filter|
-        filter.permit :job_category, :provider_type, :description_format,
+        filter.permit :job_category, :provider_type, :description_format, :execution_timeout_interval,
                       :effective_user_attributes => [job_template_effective_user_filter],
                       :template_inputs_attributes => [template_input_params_filter],
                       :foreign_input_sets_attributes => [foreign_input_set_params_filter]

data/app/controllers/job_templates_controller.rb

@@ -14,7 +14,7 @@ class JobTemplatesController < ::TemplatesController
   end
 
   def preview
-    find_resource unless @template.present?
+    find_resource if @template.blank?
     base = Host.authorized(:view_hosts, Host)
     host = params[:preview_host_id].present? ? base.find(params[:preview_host_id]) : base.first
     @template.template = params[:template]

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -48,7 +48,9 @@ module Actions
 
         provider = template_invocation.template.provider
         hostname = provider.find_ip_or_hostname(host)
-        action_options = provider.proxy_command_options(template_invocation, host).merge(:hostname => hostname, :script => script)
+        action_options = provider.proxy_command_options(template_invocation, host)
+                                 .merge(:hostname => hostname, :script => script,
+                                        :execution_timeout_interval => job_invocation.execution_timeout_interval)
         plan_delegated_action(proxy, ForemanRemoteExecutionCore::Actions::RunScript, action_options)
         plan_self
       end

data/app/models/concerns/foreman_remote_execution/foreman_tasks_cleaner_extensions.rb

@@ -0,0 +1,37 @@
+module ForemanRemoteExecution
+  module ForemanTasksCleanerExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      prepend ForemanRemoteExecution::JobInvocationCleaner
+    end
+  end
+
+  module JobInvocationCleaner
+    def delete
+      super
+      if noop
+        say '[noop] deleting orphaned job invocations'
+        say "[noop] #{orphaned_job_invocations.count} job invocations would be deleted"
+      else
+        count = orphaned_job_invocations.count
+        orphaned_job_invocations.find_each(&:destroy)
+        say "deleted #{count} orphaned job_invocations", false if verbose
+      end
+    end
+
+    def delete_tasks(chunk)
+      super(chunk)
+      delete_job_invocations(chunk)
+    end
+
+    def delete_job_invocations(chunk)
+      JobInvocation.where(:task_id => chunk.map(&:id)).find_each(&:destroy)
+    end
+
+    def orphaned_job_invocations
+      JobInvocation.joins('LEFT JOIN foreman_tasks_tasks ON task_id = foreman_tasks_tasks.id')
+                   .where('task_id IS NOT NULL and foreman_tasks_tasks.id IS NULL')
+    end
+  end
+end

data/app/models/concerns/foreman_remote_execution/foreman_tasks_task_extensions.rb

@@ -3,7 +3,7 @@ module ForemanRemoteExecution
     extend ActiveSupport::Concern
 
     included do
-      has_many :job_invocations, :dependent => :nullify, :foreign_key => 'task_id'
+      has_many :job_invocations, :dependent => :destroy, :foreign_key => 'task_id'
     end
   end
 end

data/app/models/concerns/foreman_remote_execution/host_extensions.rb

@@ -54,7 +54,7 @@ module ForemanRemoteExecution
     def host_params_with_remote_execution
       params = host_params_without_remote_execution
       keys = remote_execution_ssh_keys
-      params['remote_execution_ssh_keys'] = keys unless keys.blank?
+      params['remote_execution_ssh_keys'] = keys if keys.present?
       [:remote_execution_ssh_user, :remote_execution_effective_user_method,
        :remote_execution_connect_by_ip].each do |key|
         params[key.to_s] = Setting[key] unless params.key?(key.to_s)

data/app/models/host_status/execution_status.rb

@@ -68,7 +68,7 @@ class HostStatus::ExecutionStatus < HostStatus::Status
     def status
       if task.nil? || task.state == 'scheduled'
         QUEUED
-      elsif task.state == 'stopped' && 'success' == task.result
+      elsif task.state == 'stopped' && task.result == 'success'
         OK
       elsif task.pending?
         RUNNING

data/app/models/job_invocation_composer.rb

@@ -13,6 +13,7 @@ class JobInvocationComposer
         :host_ids => ui_params[:host_ids],
         :description_format => job_invocation_base[:description_format],
         :concurrency_control => concurrency_control_params,
+        :execution_timeout_interval => execution_timeout_interval,
         :template_invocations => template_invocations_params }.with_indifferent_access
     end
 
@@ -24,6 +25,14 @@ class JobInvocationComposer
       job_invocation_base.fetch(:providers, {})
     end
 
+    def execution_timeout_interval
+      providers_base.values.map do |provider|
+        id = provider[:job_template_id]
+        provider.fetch(:job_templates, {}).fetch(id, {})[:execution_timeout_interval]
+      end.first
+    end
+
+    # TODO: Fix this comment
     # parses params to get job templates in form of id => attributes for selected job templates, e.g.
     # {
     #   "459" => {},
@@ -80,6 +89,7 @@ class JobInvocationComposer
         :triggering => triggering_params,
         :description_format => api_params[:description_format],
         :concurrency_control => concurrency_control_params,
+        :execution_timeout_interval => api_params[:execution_timeout_interval] || template.execution_timeout_interval,
         :template_invocations => template_invocations_params }.with_indifferent_access
     end
 
@@ -161,6 +171,7 @@ class JobInvocationComposer
         :triggering => triggering_params,
         :description_format => job_invocation.description_format,
         :concurrency_control => concurrency_control_params,
+        :execution_timeout_interval => job_invocation.execution_timeout_interval,
         :template_invocations => template_invocations_params }.with_indifferent_access
     end
 
@@ -274,7 +285,7 @@ class JobInvocationComposer
     compose
 
     @host_ids = validate_host_ids(params[:host_ids])
-    @search_query = job_invocation.targeting.search_query unless job_invocation.targeting.bookmark_id.present?
+    @search_query = job_invocation.targeting.search_query if job_invocation.targeting.bookmark_id.blank?
   end
 
   def self.from_job_invocation(job_invocation, params = {})
@@ -300,8 +311,9 @@ class JobInvocationComposer
     job_invocation.triggering = build_triggering
     job_invocation.pattern_template_invocations = build_template_invocations
     job_invocation.description_format = params[:description_format]
-    job_invocation.time_span = params[:concurrency_control][:time_span].to_i unless params[:concurrency_control][:time_span].blank?
-    job_invocation.concurrency_level = params[:concurrency_control][:level].to_i unless params[:concurrency_control][:level].blank?
+    job_invocation.time_span = params[:concurrency_control][:time_span].to_i if params[:concurrency_control][:time_span].present?
+    job_invocation.concurrency_level = params[:concurrency_control][:level].to_i if params[:concurrency_control][:level].present?
+    job_invocation.execution_timeout_interval = params[:execution_timeout_interval]
 
     self
   end

data/app/models/job_template.rb

@@ -217,7 +217,7 @@ class JobTemplate < ::Template
 
   def self.parse_metadata(template)
     match = template.match(/<%\#(.+?).-?%>/m)
-    match.nil? ? {} : YAML.load(match[1])
+    match.nil? ? {} : YAML.safe_load(match[1])
   end
 
   private

data/app/models/setting/remote_execution.rb

@@ -40,7 +40,7 @@ class Setting::RemoteExecution < Setting
         self.set('remote_execution_connect_by_ip',
                  N_('Should the ip addresses on host interfaces be preferred over the fqdn? '\
                  'It is useful, when DNS not resolving the fqdns properly. You may override this per host by setting a parameter called remote_execution_connect_by_ip.'),
-                 false),
+                 false)
       ].each { |s| self.create! s.update(:category => 'Setting::RemoteExecution') }
     end
 

data/app/models/targeting.rb

@@ -38,8 +38,9 @@ class Targeting < ActiveRecord::Base
     self.search_query = bookmark.query if dynamic? && bookmark.present?
     self.resolved_at = Time.zone.now
     self.validate!
-    # avoid validation of hosts objects - tey will be loaded for no reason.
-    host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).pluck(:id) }
+    # avoid validation of hosts objects - they will be loaded for no reason.
+    #   pluck(:id) returns duplicate results for HostCollections
+    host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).pluck(:id).uniq }
     # this can be optimized even more, by introducing bulk insert
     self.targeting_hosts.build(host_ids.map { |id| { :host_id => id } })
     self.save(:validate => false)

data/app/models/template_input.rb

@@ -173,7 +173,11 @@ class TemplateInput < ActiveRecord::Base
     private
 
     def get_enc
-      @enc ||= Classification::ClassParam.new(:host => @renderer.host).enc
+      @enc ||= if SETTINGS[:version].short <= '1.15'
+                 Classification::ClassParam.new(:host => @renderer.host).enc
+               else
+                 HostInfoProviders::PuppetInfo.new(@renderer.host).puppetclass_parameters
+               end
     end
   end
 end

data/app/views/api/v2/foreign_input_sets/create.json.rabl

@@ -1,3 +1,3 @@
 object @foreign_input_set
 
-extends "api/v2/foreign_input_sets/show"
+extends 'api/v2/foreign_input_sets/show'

data/app/views/api/v2/foreign_input_sets/index.json.rabl

@@ -1,3 +1,3 @@
 collection @foreign_input_sets
 
-extends "api/v2/foreign_input_sets/main"
+extends 'api/v2/foreign_input_sets/main'

data/app/views/api/v2/foreign_input_sets/main.json.rabl

@@ -1,5 +1,5 @@
 object @foreign_input_set
 
-extends "api/v2/foreign_input_sets/base"
+extends 'api/v2/foreign_input_sets/base'
 
 attributes :template_id, :target_input_id, :target_template_name, :include_all, :include, :exclude

data/app/views/api/v2/foreign_input_sets/show.json.rabl

@@ -1,3 +1,3 @@
 object @foreign_input_set
 
-extends "api/v2/foreign_input_sets/main"
+extends 'api/v2/foreign_input_sets/main'

data/app/views/api/v2/job_invocations/create.json.rabl

@@ -1,3 +1,3 @@
 object @job_invocation
 
-extends "api/v2/job_invocations/show"
+extends 'api/v2/job_invocations/show'

data/app/views/api/v2/job_invocations/index.json.rabl

@@ -1,3 +1,3 @@
 collection @job_invocations
 
-extends "api/v2/job_invocations/base"
+extends 'api/v2/job_invocations/base'

data/app/views/api/v2/job_invocations/main.json.rabl

@@ -1,6 +1,6 @@
 object @job_invocation
 
-extends "api/v2/job_invocations/base"
+extends 'api/v2/job_invocations/base'
 
 node do |invocation|
   if invocation.triggering
@@ -19,7 +19,7 @@ child :targeting do
   attributes :bookmark_id, :search_query, :targeting_type, :user_id, :status, :status_label
 
   child :hosts do
-    extends "api/v2/hosts/base"
+    extends 'api/v2/hosts/base'
   end
 end
 

data/app/views/api/v2/job_invocations/show.json.rabl

@@ -1,3 +1,3 @@
 object @job_invocation
 
-extends "api/v2/job_invocations/main"
+extends 'api/v2/job_invocations/main'

data/app/views/api/v2/job_templates/create.json.rabl

@@ -1,3 +1,3 @@
 object @job_template
 
-extends "api/v2/job_templates/show"
+extends 'api/v2/job_templates/show'

data/app/views/api/v2/job_templates/index.json.rabl

@@ -1,3 +1,3 @@
 collection @job_templates
 
-extends "api/v2/job_templates/base"
+extends 'api/v2/job_templates/base'

data/app/views/api/v2/job_templates/main.json.rabl

@@ -1,11 +1,11 @@
 object @job_template
 
-extends "api/v2/job_templates/base"
+extends 'api/v2/job_templates/base'
 
 attributes :audit_comment, :description_format, :created_at, :updated_at, :template, :locked
 
 child :template_inputs do
-  extends "api/v2/template_inputs/base"
+  extends 'api/v2/template_inputs/base'
 end
 
 child :effective_user => :effective_user do
@@ -13,5 +13,5 @@ child :effective_user => :effective_user do
 end
 
 node do |job_template|
-  partial("api/v2/taxonomies/children_nodes", :object => job_template)
+  partial('api/v2/taxonomies/children_nodes', :object => job_template)
 end

data/app/views/api/v2/job_templates/show.json.rabl

@@ -1,3 +1,3 @@
 object @job_template
 
-extends "api/v2/job_templates/main"
+extends 'api/v2/job_templates/main'

data/app/views/api/v2/job_templates/update.json.rabl

@@ -1,3 +1,3 @@
 object @job_template
 
-extends "api/v2/job_templates/show"
+extends 'api/v2/job_templates/show'

data/app/views/api/v2/remote_execution_features/index.json.rabl

@@ -1,3 +1,3 @@
 collection @remote_execution_features
 
-extends "api/v2/remote_execution_features/main"
+extends 'api/v2/remote_execution_features/main'

data/app/views/api/v2/remote_execution_features/main.json.rabl

@@ -1,3 +1,3 @@
 object @remote_execution_feature
 
-extends "api/v2/remote_execution_features/base"
+extends 'api/v2/remote_execution_features/base'

data/app/views/api/v2/remote_execution_features/show.json.rabl

@@ -1,3 +1,3 @@
 object @remote_execution_feature
 
-extends "api/v2/remote_execution_features/main"
+extends 'api/v2/remote_execution_features/main'

data/app/views/api/v2/template_inputs/create.json.rabl

@@ -1,3 +1,3 @@
 object @template_input
 
-extends "api/v2/template_inputs/show"
+extends 'api/v2/template_inputs/show'

data/app/views/api/v2/template_inputs/index.json.rabl

@@ -1,3 +1,3 @@
 collection @template_inputs
 
-extends "api/v2/template_inputs/main"
+extends 'api/v2/template_inputs/main'

data/app/views/api/v2/template_inputs/main.json.rabl

@@ -1,9 +1,9 @@
 object @template_input
 
-extends "api/v2/template_inputs/base"
+extends 'api/v2/template_inputs/base'
 
 attributes :template_id, :fact_name, :variable_name, :puppet_parameter_name, :puppet_class_name,
-  :description, :required
+           :description, :required
 
 node :options do |input|
   input.options.split(/\r?\n/) if input.options.present?

data/app/views/api/v2/template_inputs/show.json.rabl

@@ -1,3 +1,3 @@
 object @template_input
 
-extends "api/v2/template_inputs/main"
+extends 'api/v2/template_inputs/main'

data/app/views/job_invocations/_form.html.erb

@@ -76,6 +76,10 @@
                       <% end %>
                       <%= render :partial => 'description_fields', :locals => { :f => f, :job_template => job_template, :disabled => job_template != selected_templates_per_provider[provider_type] } %>
                     </div>
+
+                    <div class="advanced hidden">
+                      <%= number_f job_template_fields, :execution_timeout_interval, :value => f.object.execution_timeout_interval || job_template.execution_timeout_interval, :label => _('Timeout to kill'), :help_inline => N_('Time in seconds from the start on the remote host after which the job should be killed.') %>
+                    </div>
                   <% end %>
                 </fieldset>
               <% end %>