foreman_remote_execution 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a436dbf82dcf2ef9b040cdc5dfecf517dd25cc9e
-  data.tar.gz: 8f8d044eba9abcbb997d4299ba828700d29e71f4
+  metadata.gz: e008f8d140c9b90f475730f271f2eef1722d9ea3
+  data.tar.gz: 0a60b9e6cf46ec5d233aec53f39c2c8b60ab77b7
 SHA512:
-  metadata.gz: f27bc513effd681f1d186a264e1a1d289c3c164aabedf7fad48c90d3891eac9ce1a7f319e13196d532fe061f7b679e0d3f0da475688f72cf82d53f1c270826a1
-  data.tar.gz: b3f489e09fbad3cc4f69c8197f939bc7e3ed6a013f93b46989cf4f9f863509d73a87213715bd7f038d82a13a3a14a755da8321f096f890acaf8a99085a38bf52
+  metadata.gz: ec1c4582b54752cffd9fe0c1f944dee4449787be282ca619511a934ee36d2a30b3d0af3bbb0ed050cfbbf19533bd1afd78b96776f6efa95e99fdef4bdbc6eef5
+  data.tar.gz: cea15e552318c30f00417d3af6d57ebbd38d2fc2fb5dd54c7c8bee435b08933d203cc476b450f236537e2dc2464dcafeafd3abe9e4a8d5737cc556a656af5499

data/README.md

@@ -24,6 +24,17 @@ management functionality with remote management functionality.
 
 Check the Foreman manual [remote execution section](http://theforeman.org/plugins/foreman_remote_execution/)
 
+## Simulated runs
+There is an option to use an alternative `ScriptRunner` implementation. Instead of doing ssh connections it discards any input its given and gives back fake output.
+
+It is controlled by setting the following environment variables
+`REX_SIMULATE` - setting to 1, yes or true enables the use of the fake runner
+`REX_SIMULATE_PATH` - full path to a file which should be given back as output by the runner, currently one line per runner's refresh
+`REX_SIMULATE_FAIL_CHANCE` - number from 0 to 100, each host has a `REX_SIMULATE_FAIL_CHANCE` of exiting with `REX_SIMULATE_EXIT`, useful for simulating random failures
+`REX_SIMULATE_EXIT` - see the previous
+
+Because it doesn't really open the outgoing connections, it doesn't need hosts with valid IP addresses as targets.
+
 ## Links
 
 * [Design document](http://theforeman.github.io/foreman_remote_execution/design/)

data/app/assets/javascripts/template_invocation.js

@@ -30,22 +30,17 @@ function refresh_search_query(value){
 }
 
 function show_preview_hosts_modal() {
-  var modal_window = $('#previewHostsModal');
-
   var form = $('form#job_invocation_form');
   var data = form.serializeArray();
-
   request = $.ajax({
     data: data,
     type: 'GET',
-    url: modal_window.attr('data-url'),
-    success: function(request) {
-      modal_window.find('.modal-body').html(request);
-    },
-    complete: function() {
-      modal_window.modal({'show': true});
-      modal_window.find('a[rel="popover-modal"]').popover();
-    }
+    url: $('#previewHostsModal').attr('data-url')
+  }).then(function(result){
+    var modal_window = $('#previewHostsModal');
+    modal_window.find('.modal-body').html(result);
+    modal_window.modal({'show': true});
+    modal_window.find('a[rel="popover-modal"]').popover();
   });
 }
 

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

@@ -37,6 +37,7 @@ module Api
       api :GET, '/job_templates/:id/export', N_('Export a job template to ERB')
       param :id, :identifier, :required => true
       def export
+        Foreman::Deprecation.api_deprecation_warning('Exporting template is provided by Foreman core, please use that endpoint instead')
         send_data @job_template.to_erb, :type => 'text/plain', :disposition => 'attachment', :filename => @job_template.filename
       end
 

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

@@ -4,7 +4,7 @@ module Foreman::Controller::Parameters::RemoteExecutionFeature
   class_methods do
     def remote_execution_feature_params_filter
       ::Foreman::ParameterFilter.new(::RemoteExecutionFeature).tap do |filter|
-        filter.permit :label, :name, :provided_input_names, :description, :job_template_id
+        filter.permit :label, :name, :provided_input_names, :description, :job_template_id, :host_action_button
       end
     end
   end

data/app/controllers/job_invocations_controller.rb

@@ -39,7 +39,7 @@ class JobInvocationsController < ApplicationController
     if @composer.trigger
       redirect_to job_invocation_path(@composer.job_invocation)
     else
-      @composer.job_invocation.description_format = nil if params[:job_invocation].key?(:description_override)
+      @composer.job_invocation.description_format = nil if params.fetch(:job_invocation, {}).key?(:description_override)
       render :action => 'new'
     end
   end
@@ -86,6 +86,10 @@ class JobInvocationsController < ApplicationController
   end
 
   def prepare_composer
-    JobInvocationComposer.from_ui_params(params.merge(:triggering => triggering_params))
+    if params[:feature].present?
+      JobInvocationComposer.for_feature(params[:feature], params[:host_ids], {})
+    else
+      JobInvocationComposer.from_ui_params(params.merge(:triggering => triggering_params))
+    end
   end
 end

data/app/controllers/job_templates_controller.rb

@@ -41,11 +41,6 @@ class JobTemplatesController < ::TemplatesController
     end
   end
 
-  def export
-    find_resource unless @template.present?
-    send_data @template.to_erb, :type => 'text/plain', :disposition => 'attachment', :filename => @template.filename
-  end
-
   private
 
   def find_resource

data/app/helpers/concerns/foreman_remote_execution/hosts_helper_extensions.rb

@@ -8,11 +8,27 @@ module ForemanRemoteExecution
     end
 
     def multiple_actions_with_remote_execution
-      multiple_actions_without_remote_execution + [[_('Run Job'), new_job_invocation_path, false]]
+      multiple_actions_without_remote_execution + [ [_('Schedule Remote Job'), new_job_invocation_path, false] ]
+    end
+
+    def schedule_job_multi_button(*args)
+      host_features = RemoteExecutionFeature.with_host_action_button.order(:label).map do |feature|
+        link_to(_('%s') % feature.name, job_invocations_path(:host_ids => [args.first.id], :feature => feature.label), :method => :post)
+      end
+
+      if host_features.present?
+        action_buttons(schedule_job_button(*args), *host_features)
+      else
+        schedule_job_button(*args)
+      end
+    end
+
+    def schedule_job_button(*args)
+      link_to(_('Schedule Remote Job'), new_job_invocation_path(:host_ids => [args.first.id]), :id => :run_button, :class => 'btn btn-default')
     end
 
     def host_title_actions_with_run_button(*args)
-      title_actions(button_group(link_to(_('Run Job'), new_job_invocation_path(:host_ids => [args.first.id]), :id => :run_button, :class => 'btn btn-default')))
+      title_actions(button_group(schedule_job_multi_button(*args)))
       host_title_actions_without_run_button(*args)
     end
   end

data/app/helpers/concerns/foreman_remote_execution/job_templates_extensions.rb

@@ -10,8 +10,7 @@ module ForemanRemoteExecution
       original = permitted_actions_without_run_button(template)
 
       if template.is_a?(JobTemplate)
-        original.unshift(display_link_if_authorized(_('Export'), hash_for_export_job_template_path(:id => template.id), 'data-no-turbolink' => true))
-        original.unshift(display_link_if_authorized(_('Run'), hash_for_new_job_invocation_path(:template_id => template.id))) unless template.snippet
+        original.unshift(display_link_if_authorized(_('Run'), hash_for_new_job_invocation_path(:template_id => template.id).merge(:authorizer => authorizer))) unless template.snippet
       end
 
       original

data/app/helpers/remote_execution_helper.rb

@@ -11,31 +11,31 @@ module RemoteExecutionHelper
   def job_invocation_chart(invocation)
     options = { :class => 'statistics-pie small', :expandable => true, :border => 0, :show_title => true }
 
-    if (bulk_task = invocation.task)
-      failed_tasks = bulk_task.sub_tasks.select { |sub_task| task_failed? sub_task }
-      cancelled_tasks, failed_tasks = failed_tasks.partition { |task| task_cancelled? task }
-      success = bulk_task.output['success_count'] || 0
-      cancelled = cancelled_tasks.length
-      failed = failed_tasks.length
-      pending = (bulk_task.output['pending_count'] || bulk_task.sub_tasks.count)
-
-      flot_pie_chart('status', job_invocation_status(invocation),
-                     [{:label => _('Success'), :data => success, :color => '#5CB85C'},
-                      {:label => _('Failed'), :data => failed, :color => '#D9534F'},
-                      {:label => _('Pending'), :data => pending, :color => '#DEDEDE'},
-                      {:label => _('Cancelled'), :data => cancelled, :color => '#B7312D'}],
+    if (invocation.task)
+      # Request precise subtask counts only if the task is stopped
+      report = invocation.progress_report
+      flot_pie_chart('status', job_invocation_status(invocation, report[:progress]),
+                     [{:label => _('Success'),   :data => report[:success],   :color => '#5CB85C'},
+                      {:label => _('Failed'),    :data => report[:failed],    :color => '#D9534F'},
+                      {:label => _('Pending'),   :data => report[:pending],   :color => '#DEDEDE'},
+                      {:label => _('Cancelled'), :data => report[:cancelled], :color => '#B7312D'}],
                      options)
     else
       content_tag(:h4, job_invocation_status(invocation))
     end
   end
 
-  def job_invocation_status(invocation)
+  def job_hosts_authorizer
+    @job_hosts_authorizer ||= Authorizer.new(User.current, :collection => @hosts)
+  end
+
+  def job_invocation_status(invocation, percent = nil)
     case invocation.status
       when HostStatus::ExecutionStatus::QUEUED
         _('queued')
       when HostStatus::ExecutionStatus::RUNNING
-        _('running %{percent}%%') % {:percent => invocation.progress}
+        percent ||= invocation.progress_report[:progress]
+        _('running %{percent}%%') % {:percent => percent}
       when HostStatus::ExecutionStatus::OK
         _('succeeded')
       when HostStatus::ExecutionStatus::ERROR
@@ -45,14 +45,6 @@ module RemoteExecutionHelper
     end
   end
 
-  def task_failed?(task)
-    %w(warning error).include? task.result
-  end
-
-  def task_cancelled?(task)
-    task.execution_plan.errors.map(&:exception).any? { |exception| exception.class == ::ForemanTasks::Task::TaskCancelledException }
-  end
-
   def host_counter(label, count)
     content_tag(:div, :class => 'host_counter') do
       content_tag(:div, label, :class => 'header') + content_tag(:div, count.to_s, :class => 'count')
@@ -69,11 +61,9 @@ module RemoteExecutionHelper
     else
       case task.result
         when 'warning', 'error'
-          if task_cancelled?(task)
-            icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
-          else
-            icon_text('error-circle-o', _('failed'), :kind => 'pficon')
-          end
+          icon_text('error-circle-o', _('failed'), :kind => 'pficon')
+        when 'cancelled'
+          icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
         when 'success'
           icon_text('ok', _('success'), :kind => 'pficon')
         else
@@ -84,8 +74,8 @@ module RemoteExecutionHelper
 
   def template_invocation_actions(task, host, job_invocation, template_invocation)
     [
-      display_link_if_authorized(_('Host detail'), hash_for_host_path(host).merge(:auth_object => host, :permission => :view_hosts)),
-      display_link_if_authorized(_('Rerun on %s') % host.name, hash_for_rerun_job_invocation_path(:id => job_invocation, :host_ids => [ host.id ])),
+      display_link_if_authorized(_('Host detail'), hash_for_host_path(host).merge(:auth_object => host, :permission => :view_hosts, :authorizer => job_hosts_authorizer)),
+      display_link_if_authorized(_('Rerun on %s') % host.name, hash_for_rerun_job_invocation_path(:id => job_invocation, :host_ids => [ host.id ], :authorizer => job_hosts_authorizer)),
     ]
   end
 
@@ -103,6 +93,7 @@ module RemoteExecutionHelper
   # rubocop:disable Metrics/AbcSize
   def job_invocation_task_buttons(task)
     job_invocation = task.task_groups.find { |group| group.class == JobInvocationTaskGroup }.job_invocation
+    task_authorizer = Authorizer.new(User.current, :collection => [task])
     buttons = []
     buttons << link_to(_('Refresh'), {}, :class => 'btn btn-default', :title => _('Refresh this page'))
     if authorized_for(hash_for_new_job_invocation_path)
@@ -113,15 +104,15 @@ module RemoteExecutionHelper
     if authorized_for(hash_for_new_job_invocation_path)
       buttons << link_to(_('Rerun failed'), rerun_job_invocation_path(:id => job_invocation.id, :failed_only => 1),
                          :class => 'btn btn-default',
-                         :disabled => !task.sub_tasks.any? { |sub_task| task_failed?(sub_task) },
+                         :disabled => task.sub_tasks.where(:result => %w(error warning)).count.zero?,
                          :title => _('Rerun on failed hosts'))
     end
-    if authorized_for(:permission => :view_foreman_tasks, :auth_object => task)
+    if authorized_for(:permission => :view_foreman_tasks, :auth_object => task, :authorizer => task_authorizer)
       buttons << link_to(_('Job Task'), foreman_tasks_task_path(task),
                          :class => 'btn btn-default',
                          :title => _('See the last task details'))
     end
-    if authorized_for(:permission => :edit_foreman_tasks, :auth_object => task)
+    if authorized_for(:permission => :edit_foreman_tasks, :auth_object => task, :authorizer => task_authorizer)
       buttons << link_to(_('Cancel Job'), cancel_foreman_tasks_task_path(task),
                          :class => 'btn btn-danger',
                          :title => _('Try to cancel the job'),
@@ -153,8 +144,9 @@ module RemoteExecutionHelper
     if invocation.queued?
       job_invocation_status(invocation)
     else
+      task_authorizer = Authorizer.new(User.current, :collection => [invocation.task])
       link_to_if_authorized job_invocation_status(invocation),
-                            hash_for_foreman_tasks_task_path(invocation.task).merge(:auth_object => invocation.task, :permission => :view_foreman_tasks)
+                            hash_for_foreman_tasks_task_path(invocation.task).merge(:auth_object => invocation.task, :permission => :view_foreman_tasks, :authorizer => task_authorizer)
     end
   end
 
@@ -184,8 +176,14 @@ module RemoteExecutionHelper
     if (preview = renderer.preview)
       content_tag :pre, preview
     else
-      alert :class => 'alert-block alert-danger base in fade has-error',
-            :text => renderer.error_message.html_safe
+      if target.nil?
+        alert :text => _('Could not render the preview because no host matches the search query.'),
+              :class => 'alert alert-block alert-warning base',
+              :close => false
+      else
+        alert :class => 'alert-block alert-danger base in fade has-error',
+              :text => renderer.error_message.html_safe
+      end
     end
   end
 
@@ -240,11 +238,14 @@ module RemoteExecutionHelper
                :onchange => 'regenerate_description(this);',
                :class => 'description_format advanced',
                :disabled => disabled,
-               :help_inline => popover(_('Explanation'),
-                                       _('This template is used to generate the description ' +
-                                         'Input values can be used using the syntax %{package}. ' +
-                                         'You may also include the job category and template ' +
-                                         'name using %{job_category} and %{template_name}.'))
+               :label_help => description_format_help
+  end
+
+  def description_format_help
+    _('This template is used to generate the description.<br/>' +
+        'Input values can be used using the syntax %{package}.<br/>' +
+        'You may also include the job category and template<br/>' +
+        'name using %{job_category} and %{template_name}.').html_safe
   end
 
   def advanced_switch_f(default_text, switch_text)

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

@@ -21,7 +21,6 @@ module Actions
         link!(template_invocation)
 
         verify_permissions(host, template_invocation)
-        hostname = find_ip_or_hostname(host)
 
         raise _('Could not use any template used in the job invocation') if template_invocation.blank?
 
@@ -47,6 +46,7 @@ module Actions
         raise _('Failed rendering template: %s') % renderer.error_message unless script
 
         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)
         plan_delegated_action(proxy, ForemanRemoteExecutionCore::Actions::RunScript, action_options)
         plan_self
@@ -78,7 +78,7 @@ module Actions
 
       def finalize
         if exit_status.to_s != '0'
-          error! _('Playbook execution failed')
+          error! _('Job execution failed')
         end
       end
 
@@ -113,19 +113,6 @@ module Actions
         delegated_output[:exit_status]
       end
 
-      def find_ip_or_hostname(host)
-        %w(execution primary provision).each do |flag|
-          interface = host.send(flag + '_interface')
-          return interface.ip if interface && interface.ip.present?
-        end
-
-        host.interfaces.each do |interface|
-          return interface.ip unless interface.ip.blank?
-        end
-
-        return host.fqdn
-      end
-
       private
 
       def delegated_output

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

@@ -2,6 +2,8 @@ module Actions
   module RemoteExecution
     class RunHostsJob < Actions::ActionWithSubPlans
 
+      include Dynflow::Action::WithBulkSubPlans
+
       middleware.use Actions::Middleware::BindJobInvocation
       middleware.use Actions::Middleware::RecurringLogic
 
@@ -25,15 +27,27 @@ module Actions
         job_invocation = JobInvocation.find(input[:job_invocation_id])
         proxy_selector = RemoteExecutionProxySelector.new
 
-        # composer creates just "pattern" for template_invocations because target is evaluated
-        # during actual run (here) so we build template invocations from these patterns
-        job_invocation.targeting.hosts.map do |host|
+        current_batch.map do |host|
+          # composer creates just "pattern" for template_invocations because target is evaluated
+          # during actual run (here) so we build template invocations from these patterns
           template_invocation = job_invocation.pattern_template_invocation_for_host(host).deep_clone
           template_invocation.host_id = host.id
           trigger(RunHostJob, job_invocation, host, template_invocation, proxy_selector)
         end
       end
 
+      def batch(from, size)
+        hosts.offset(from).limit(size)
+      end
+
+      def total_count
+        hosts.count
+      end
+
+      def hosts
+        JobInvocation.find(input[:job_invocation_id]).targeting.hosts.order(:name, :id)
+      end
+
       def set_up_concurrency_control(invocation)
         limit_concurrency_level invocation.concurrency_level unless invocation.concurrency_level.nil?
         distribute_over_time invocation.time_span unless invocation.time_span.nil?

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

@@ -6,7 +6,7 @@ module ForemanRemoteExecution
       alias_method_chain :build_required_interfaces, :remote_execution
       alias_method_chain :reload, :remote_execution
       alias_method_chain :becomes, :remote_execution
-      alias_method_chain :params, :remote_execution
+      alias_method_chain :host_params, :remote_execution
 
       has_many :targeting_hosts, :dependent => :destroy, :foreign_key => 'host_id'
       has_many :template_invocations, :dependent => :destroy, :foreign_key => 'host_id'
@@ -24,11 +24,12 @@ module ForemanRemoteExecution
       @execution_status_label ||= get_status(HostStatus::ExecutionStatus).to_label(options)
     end
 
-    def params_with_remote_execution
-      params = params_without_remote_execution
+    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?
-      [:remote_execution_ssh_user, :remote_execution_effective_user_method].each do |key|
+      [: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)
       end
       params
@@ -44,10 +45,10 @@ module ForemanRemoteExecution
       proxies[:fallback] = smart_proxies.with_features(provider) if Setting[:remote_execution_fallback_proxy]
 
       if Setting[:remote_execution_global_proxy]
-        proxy_scope = if Taxonomy.enabled_taxonomies.any?
+        proxy_scope = if Taxonomy.enabled_taxonomies.any? && User.current.present?
                         ::SmartProxy.with_taxonomy_scope_override(location, organization)
                       else
-                        proxy_scope = ::SmartProxy
+                        proxy_scope = ::SmartProxy.unscoped
                       end
 
         proxy_scope = proxy_scope.authorized if authorized

data/app/models/input_template_renderer.rb

@@ -58,7 +58,7 @@ class InputTemplateRenderer
   def render_template(template_name, input_values = {}, options = {})
     options.assert_valid_keys(:with_foreign_input_set)
     with_foreign_input_set = options.fetch(:with_foreign_input_set, true)
-    template = JobTemplate.authorized(:view_job_templates).find_by(:name => template_name)
+    template = @template.class.authorized("view_#{@template.class.to_s.underscore}").find_by(:name => template_name)
     unless template
       self.error_message = _('included template \'%s\' not found') % template_name
       raise error_message

data/app/models/job_invocation.rb

@@ -48,7 +48,7 @@ class JobInvocation < ActiveRecord::Base
 
   scope :with_task, -> { references(:task) }
 
-  scoped_search :in => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id', :auto_complete => true
+  scoped_search :in => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id'
 
   scoped_search :in => :recurring_logic, :on => 'id', :rename => 'recurring',
                 :ext_method => :search_by_recurring_logic, :only_explicit => true,
@@ -86,8 +86,14 @@ class JobInvocation < ActiveRecord::Base
   end
 
   # returns progress in percents
-  def progress
-    queued? ? 0 : (task.progress * 100).to_i
+  def progress(total = nil, done = nil)
+    if queued? || !targeting.resolved? || done == 0
+      0
+    else
+      total ||= targeting.hosts.count
+      done  ||= sub_tasks.where(:result => %w(success warning error)).count
+      ((done.to_f / total) * 100).round
+    end
   end
 
   def queued?
@@ -160,9 +166,8 @@ class JobInvocation < ActiveRecord::Base
   def generate_description
     key_re = /%\{([^\}]+)\}/
     template_invocation = pattern_template_invocations.first
-    input_names = template_invocation.template.template_inputs_with_foreign(&:name)
     hash_base = Hash.new { |hash, key| hash[key] = "%{#{key}}" }
-    input_hash = hash_base.merge Hash[input_names.zip(template_invocation.input_values.map(&:value))]
+    input_hash = template_invocation.input_values.reduce(hash_base) { |h, v| h.update(v.template_input.name => v.value) }
     input_hash.update(:job_category => job_category)
     input_hash.update(:template_name => template_invocation.template.name)
     description_format.scan(key_re) { |key| input_hash[key.first] }
@@ -173,6 +178,19 @@ class JobInvocation < ActiveRecord::Base
     self.description = self.description[0..(JobInvocation.columns_hash['description'].limit - 1)]
   end
 
+  def progress_report
+    if queued? || !targeting.resolved?
+      %w(success total cancelled failed error warning pending progress).map(&:to_sym).reduce({}) do |acc, key|
+        acc.merge(key => 0)
+      end
+    else
+      counts  = task.sub_tasks_counts
+      done    = counts.values_at(:cancelled, :error, :success, :warning).reduce(:+)
+      percent = progress(counts[:total], done)
+      counts.merge(:progress => percent, :failed => counts[:error] + counts[:warning])
+    end
+  end
+
   private
 
   def failed_template_invocations