foreman_remote_execution 3.0.2 → 3.2.2

data/Gemfile

@@ -1,3 +1,7 @@
 source 'http://rubygems.org'
 
 gemspec :name => 'foreman_remote_execution'
+
+gem 'rubocop-minitest'
+gem 'rubocop-performance'
+gem 'rubocop-rails'

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

@@ -18,7 +18,8 @@ module Api
       api :GET, '/templates/:template_id/foreign_input_sets/:id', N_('Show foreign input set details')
       param :template_id, :identifier, :required => true
       param :id, :identifier, :required => true
-      def show; end
+      def show
+      end
 
       def_param_group :foreign_input_set do
         param :foreign_input_set, Hash, :required => true, :action_aware => true do
@@ -50,7 +51,7 @@ module Api
       param :id, :identifier, :required => true
       param_group :foreign_input_set
       def update
-        process_response @foreign_input_set.update_attributes(foreign_input_set_params)
+        process_response @foreign_input_set.update(foreign_input_set_params)
       end
 
       def resource_name(nested_resource = nil)

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

@@ -18,9 +18,13 @@ module Api
 
       api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
-      def show; end
+      def show
+        @hosts = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+        @template_invocations = @job_invocation.template_invocations
+                                               .where(host: @hosts)
+                                               .includes(:input_values)
+      end
 
-      # rubocop:disable Metrics/BlockLength
       def_param_group :job_invocation do
         param :job_invocation, Hash, :required => true, :action_aware => true do
           param :job_template_id, String, :required => false, :desc => N_('The job template to use, parameter is required unless feature was specified')
@@ -29,8 +33,8 @@ module Api
           param :inputs, Hash, :required => false, :desc => N_('Inputs to use')
           param :ssh, Hash, :desc => N_('SSH provider specific options') do
             param :effective_user, String,
-                  :required => false,
-                  :desc => N_('What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.')
+              :required => false,
+              :desc => N_('What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting.')
           end
 
           param :recurrence, Hash, :desc => N_('Create a recurring job') do
@@ -107,7 +111,7 @@ module Api
           render :json => { :cancelled => result, :id => @job_invocation.id }
         else
           render :json => { :message => _('The job could not be cancelled.') },
-                 :status => 422
+                 :status => :unprocessable_entity
         end
       end
 
@@ -122,7 +126,7 @@ module Api
           process_response @job_invocation
         else
           render :json => { :error => _('Could not rerun job %{id} because its template could not be found') % { :id => composer.reruns } },
-                 :status => 404
+                 :status => :not_found
         end
       end
 
@@ -146,7 +150,7 @@ module Api
       end
 
       def find_host
-        @host = Host.authorized(:view_hosts).find(params['host_id'])
+        @host = @nested_obj.targeting.hosts.authorized(:view_hosts, Host).find(params['host_id'])
       rescue ActiveRecord::RecordNotFound
         not_found({ :error => { :message => (_("Host with id '%{id}' was not found") % { :id => params['host_id'] }) } })
       end
@@ -159,6 +163,7 @@ module Api
 
       def job_invocation_params
         return @job_invocation_params if @job_invocation_params.present?
+
         job_invocation_params = params.fetch(:job_invocation, {}).dup
         if job_invocation_params.key?(:ssh)
           job_invocation_params.merge!(job_invocation_params.delete(:ssh).permit(:effective_user))

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

@@ -42,7 +42,8 @@ module Api
 
       api :GET, '/job_templates/:id', N_('Show job template details')
       param :id, :identifier, :required => true
-      def show; end
+      def show
+      end
 
       def_param_group :job_template do
         param :job_template, Hash, :required => true, :action_aware => true do
@@ -78,7 +79,7 @@ module Api
       param :id, :identifier, :required => true
       param_group :job_template
       def update
-        process_response @job_template.update_attributes(job_template_params)
+        process_response @job_template.update(job_template_params)
       end
 
       api :GET, '/job_templates/revision'

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

@@ -13,7 +13,8 @@ module Api
 
       api :GET, '/remote_execution_features/:id', N_('Show remote execution feature')
       param :id, :identifier, :required => true
-      def show; end
+      def show
+      end
 
       def_param_group :remote_execution_feature do
         param :remote_execution_feature, Hash, :required => true, :action_aware => true do
@@ -25,7 +26,7 @@ module Api
       param :id, :identifier, :required => true
       param_group :remote_execution_feature
       def update
-        process_response @remote_execution_feature.update_attributes(remote_execution_feature_params)
+        process_response @remote_execution_feature.update(remote_execution_feature_params)
       end
 
       private

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

@@ -7,7 +7,7 @@ module Api
       before_action :find_job_invocation, :only => %w{template_invocations}
 
       api :GET, '/job_invocations/:job_invocation_id/template_invocations',
-          N_('List template invocations belonging to job invocation')
+        N_('List template invocations belonging to job invocation')
       param_group :search_and_pagination, ::Api::V2::BaseController
       param :job_invocation_id, :identifier, :required => true
       def template_invocations
@@ -26,7 +26,10 @@ module Api
       private
 
       def resource_scope_for_template_invocations
-        @job_invocation.template_invocations.search_for(*search_options)
+        @job_invocation.template_invocations
+                       .includes(:host)
+                       .where(host: Host.authorized(:view_hosts, Host))
+                       .search_for(*search_options)
       end
 
       def find_job_invocation

data/app/controllers/cockpit_controller.rb

@@ -7,6 +7,7 @@ class CockpitController < ApplicationController
 
   def redirect
     return invalid_request unless params[:redirect_uri]
+
     redir_url = URI.parse(params[:redirect_uri])
 
     cockpit_url = SSHExecutionProvider.cockpit_url_for_host('')

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

@@ -5,7 +5,7 @@ module ::Foreman::Controller::Parameters::ForeignInputSet
     def foreign_input_set_params_filter
       Foreman::ParameterFilter.new(::ForeignInputSet).tap do |filter|
         filter.permit_by_context(:id, :_destroy, :template_id, :target_template_id, :include_all, :include, :exclude,
-                                 :nested => true)
+          :nested => true)
       end
     end
   end

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

@@ -9,16 +9,16 @@ module Foreman::Controller::Parameters::JobTemplate
     def job_template_effective_user_filter
       Foreman::ParameterFilter.new(::JobTemplateEffectiveUser).tap do |filter|
         filter.permit_by_context(:value, :current_user, :overridable,
-                                 :nested => true)
+          :nested => true)
       end
     end
 
     def job_template_params_filter
       Foreman::ParameterFilter.new(::TemplateInput).tap do |filter|
         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]
+          :effective_user_attributes => [job_template_effective_user_filter],
+          :template_inputs_attributes => [template_input_params_filter],
+          :foreign_input_sets_attributes => [foreign_input_set_params_filter]
         add_template_params_filter(filter)
         add_taxonomix_params_filter(filter)
       end

data/app/controllers/job_invocations_controller.rb

@@ -3,15 +3,15 @@ class JobInvocationsController < ApplicationController
   include ::ForemanTasks::Concerns::Parameters::Triggering
   include ::JobInvocationsChartHelper
 
-
   def new
     return @composer = prepare_composer if params[:feature].present?
+
     ui_params = {
       :host_ids => params[:host_ids],
       :targeting => {
         :targeting_type => Targeting::STATIC_TYPE,
-        :bookmark_id => params[:bookmark_id]
-      }
+        :bookmark_id => params[:bookmark_id],
+      },
     }
     # replace an empty string search with a dummy search query to match all hosts
     # but only if search query was entered (based on presence of :search parameter)
@@ -24,8 +24,8 @@ class JobInvocationsController < ApplicationController
       ui_params[:job_invocation] = {
         :job_category => template.job_category,
         :providers => {
-          template.provider_type => {:job_template_id => template.id}
-        }
+          template.provider_type => {:job_template_id => template.id},
+        },
       }
     end
 
@@ -35,6 +35,8 @@ class JobInvocationsController < ApplicationController
   def rerun
     job_invocation = resource_base.find(params[:id])
     @composer = JobInvocationComposer.from_job_invocation(job_invocation, params)
+    @job_organization = Taxonomy.find_by(id: job_invocation.task.input[:current_organization_id])
+    @job_location = Taxonomy.find_by(id: job_invocation.task.input[:current_location_id])
     render :action => 'new'
   end
 
@@ -58,6 +60,8 @@ class JobInvocationsController < ApplicationController
                                      .where(:template_invocations => { :job_invocation_id => @job_invocation.id})
     end
     @hosts = resource_base_search_and_page
+    @job_organization = Taxonomy.find_by(id: @job_invocation.task.input[:current_organization_id])
+    @job_location = Taxonomy.find_by(id: @job_invocation.task.input[:current_location_id])
   end
 
   def index
@@ -79,7 +83,7 @@ class JobInvocationsController < ApplicationController
         :success => @job_invocation.progress_report[:success],
         :cancelled => @job_invocation.progress_report[:cancelled],
         :failed => @job_invocation.progress_report[:error],
-        :pending => @job_invocation.progress_report[:pending]
+        :pending => @job_invocation.progress_report[:pending],
       },
     }
   end

data/app/controllers/job_templates_controller.rb

@@ -35,7 +35,7 @@ class JobTemplatesController < ::TemplatesController
     contents = params.fetch(:imported_template, {}).fetch(:template, nil).try(:read)
 
     @template = JobTemplate.import_raw(contents, :update => Foreman::Cast.to_bool(params[:imported_template][:overwrite]))
-    if @template && @template.save
+    if @template&.save
       flash[:notice] = _('Job template imported successfully.')
       redirect_to job_templates_path(:search => "name = \"#{@template.name}\"")
     else

data/app/controllers/remote_execution_features_controller.rb

@@ -6,10 +6,11 @@ class RemoteExecutionFeaturesController < ::ApplicationController
     @remote_execution_features = resource_base.all
   end
 
-  def show; end
+  def show
+  end
 
   def update
-    if @remote_execution_feature.update_attributes(remote_execution_feature_params)
+    if @remote_execution_feature.update(remote_execution_feature_params)
       process_success :object => @remote_execution_feature
     else
       process_error :object => @remote_execution_feature

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

@@ -1,13 +1,17 @@
 module ForemanRemoteExecution
   module HostsHelperExtensions
+    def host_overview_buttons(host)
+      [
+        { :button => link_to_if_authorized(_("Jobs"), hash_for_job_invocations_path(search: "host=#{host.name}"), :title => _("Job invocations"), :class => 'btn btn-default'), :priority => 200 },
+      ]
+    end
+
     def multiple_actions
       super + [ [_('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
+      host_features = rex_host_features(*args)
 
       if host_features.present?
         action_buttons(schedule_job_button(*args), *host_features)
@@ -16,19 +20,26 @@ module ForemanRemoteExecution
       end
     end
 
+    def rex_host_features(*args)
+      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
+    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 web_console_button(host, *args)
       return unless authorized_for(permission: 'cockpit_hosts', auth_object: host)
+
       url = SSHExecutionProvider.cockpit_url_for_host(host.name)
-      url ? link_to(_('Web Console'), url, :class => 'btn btn-default', :id => :'web-console-button') : nil
+      url ? link_to(_('Web Console'), url, :class => 'btn btn-default', :id => :'web-console-button', :target => '_new') : nil
     end
 
     def host_title_actions(*args)
       title_actions(button_group(schedule_job_multi_button(*args)),
-                    button_group(web_console_button(*args)))
+        button_group(web_console_button(*args)))
       super(*args)
     end
   end

data/app/helpers/job_invocations_chart_helper.rb

@@ -3,12 +3,13 @@
 module JobInvocationsChartHelper
   def job_invocation_chart(invocation)
     donut_chart('#status_chart',
-                job_invocation_data(invocation)[:columns],
-                job_invocation_data(invocation)[:groups])
+      job_invocation_data(invocation)[:columns],
+      job_invocation_data(invocation)[:groups])
   end
 
   def job_invocation_data(invocation)
     return @job_invocation_data if @job_invocation_data.present?
+
     progress_report = invocation.progress_report
     success = progress_report[:success]
     cancelled = progress_report[:cancelled]
@@ -36,6 +37,8 @@ module JobInvocationsChartHelper
       _('running %{percent}%%') % {:percent => percent}
     when HostStatus::ExecutionStatus::OK
       _('succeeded')
+    when HostStatus::ExecutionStatus::CANCELLED
+      _('cancelled')
     when HostStatus::ExecutionStatus::ERROR
       _('failed')
     else
@@ -45,26 +48,26 @@ module JobInvocationsChartHelper
 
   def job_invocation_success_status
     icon_text('ok',
-              @job_invocation_data[0][1],
-              :kind => 'pficon')
+      @job_invocation_data[0][1],
+      :kind => 'pficon')
   end
 
   def job_invocation_failed_status
     icon_text('error-circle-o',
-              @job_invocation_data[1][1],
-              :kind => 'pficon')
+      @job_invocation_data[1][1],
+      :kind => 'pficon')
   end
 
   def job_invocation_pending_status
     icon_text('running',
-              @job_invocation_data[2][1],
-              :kind => 'pficon')
+      @job_invocation_data[2][1],
+      :kind => 'pficon')
   end
 
   def job_invocation_cancelled_status
     icon_text('close',
-              @job_invocation_data[3][1],
-              :kind => 'pficon')
+      @job_invocation_data[3][1],
+      :kind => 'pficon')
   end
 
   def task_failed?(task)

data/app/helpers/job_invocations_helper.rb

@@ -15,7 +15,7 @@ module JobInvocationsHelper
   def job_invocations_buttons
     [
       documentation_button_rex('3.2ExecutingaJob'),
-      display_link_if_authorized(_('Run Job'), hash_for_new_job_invocation_path)
+      display_link_if_authorized(_('Run Job'), hash_for_new_job_invocation_path),
     ]
   end
 
@@ -25,11 +25,11 @@ module JobInvocationsHelper
     link_content = template_name + ' - ' + provider + ' ' +
       icon_text('edit', '', :kind => 'pficon')
     link_to_if_authorized(link_content,
-                          hash_for_edit_job_template_path(:id => template.id))
+      hash_for_edit_job_template_path(:id => template.id))
   end
 
   def preview_hosts(template_invocation)
-    hosts = template_invocation.targeting.hosts.take(20)
+    hosts = template_invocation.targeting.hosts.authorized(:view_hosts, Host).take(20)
     hosts.map do |host|
       collapsed_preview(host) +
         render(:partial => 'job_invocations/user_input',
@@ -41,10 +41,23 @@ module JobInvocationsHelper
   def collapsed_preview(target)
     title = target.try(:name) || 'N/A'
     content_tag(:h5,
-                :class => "expander collapsed out",
-                :data => { :toggle => 'collapse',
-                           :target => "#preview_#{target.id}" }) do
+      :class => "expander collapsed out",
+      :data => { :toggle => 'collapse',
+                 :target => "#preview_#{target.id}" }) do
       content_tag(:span, '', :class => 'caret') + title
     end
   end
+
+  def show_job_organization(organization)
+    organization.presence || _('Any Organization')
+  end
+
+  def show_job_location(location)
+    location.presence || _('Any Location')
+  end
+
+  def input_safe_value(input)
+    template_input = input.template_input
+    template_input.respond_to?(:hidden_value) && template_input.hidden_value ? '*' * 5 : input.value
+  end
 end

data/app/helpers/remote_execution_helper.rb

@@ -1,4 +1,3 @@
-# rubocop:disable Metrics/ModuleLength
 module RemoteExecutionHelper
   def providers_options
     RemoteExecutionProvider.providers.map { |key, provider| [ key, _(provider.humanized_name) ] }
@@ -14,9 +13,13 @@ module RemoteExecutionHelper
     end
   end
 
-  def template_invocation_status(task)
+  def template_invocation_status(task, parent_task)
     if task.nil?
-      icon_text('question', 'N/A', :kind => 'fa')
+      if parent_task.result == 'cancelled'
+        icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
+      else
+        icon_text('question', 'N/A', :kind => 'fa')
+      end
     elsif task.state == 'running'
       icon_text('running', _('running'), :kind => 'pficon')
     elsif task.state == 'planned'
@@ -46,7 +49,7 @@ module RemoteExecutionHelper
           hash_for_foreman_tasks_task_path(host_task)
           .merge(:auth_object => host_task, :permission => :view_foreman_tasks)
         )
-      end
+      end,
     ]
   end
 
@@ -57,66 +60,63 @@ module RemoteExecutionHelper
   def job_invocations_buttons
     [
       documentation_button_rex('3.2ExecutingaJob'),
-      new_link(_('Run Job'))
+      new_link(_('Run Job')),
     ]
   end
 
-  # 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 = []
     if authorized_for(hash_for_new_job_invocation_path)
       buttons << link_to(_('Rerun'), rerun_job_invocation_path(:id => job_invocation.id),
-                         :class => 'btn btn-default',
-                         :title => _('Rerun the job'))
+        :class => 'btn btn-default',
+        :title => _('Rerun the job'))
     end
     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 => job_invocation.failed_hosts.none?,
-                         :title => _('Rerun on failed hosts'))
+        :class => 'btn btn-default',
+        :disabled => job_invocation.failed_hosts.none?,
+        :title => _('Rerun on failed hosts'))
     end
     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'))
+        :class => 'btn btn-default',
+        :title => _('See the last task details'))
     end
     if authorized_for(:permission => :cancel_job_invocations, :auth_object => job_invocation)
       buttons << button_to(_('Cancel Job'), cancel_job_invocation_path(job_invocation),
-                           :class => 'btn btn-danger',
-                           :title => _('Try to cancel the job'),
-                           :disabled => !task.cancellable?,
-                           :method => :post)
+        :class => 'btn btn-danger',
+        :title => _('Try to cancel the job'),
+        :disabled => !task.cancellable?,
+        :method => :post)
       buttons << button_to(_('Abort Job'), cancel_job_invocation_path(job_invocation, :force => true),
-                           :class => 'btn btn-danger',
-                           :title => _('Try to abort the job without waiting for the results from the remote hosts'),
-                           :disabled => !task.cancellable?,
-                           :method => :post)
+        :class => 'btn btn-danger',
+        :title => _('Try to abort the job without waiting for the results from the remote hosts'),
+        :disabled => !task.cancellable?,
+        :method => :post)
     end
     return buttons
   end
 
-  # rubocop:enable Metrics/AbcSize
-
   def template_invocation_task_buttons(task, invocation)
     buttons = []
     if authorized_for(:permission => :view_foreman_tasks, :auth_object => task)
       buttons << link_to(_('Task Details'), foreman_tasks_task_path(task),
-                         :class => 'btn btn-default',
-                         :title => _('See the task details'))
+        :class => 'btn btn-default',
+        :title => _('See the task details'))
     end
     if authorized_for(:permission => :cancel_job_invocations, :auth_object => invocation)
       buttons << link_to(_('Cancel Job'), cancel_foreman_tasks_task_path(task),
-                         :class => 'btn btn-danger',
-                         :title => _('Try to cancel the job on a host'),
-                         :disabled => !task.cancellable?,
-                         :method => :post)
+        :class => 'btn btn-danger',
+        :title => _('Try to cancel the job on a host'),
+        :disabled => !task.cancellable?,
+        :method => :post)
       buttons << link_to(_('Abort Job'), abort_foreman_tasks_task_path(task),
-                         :class => 'btn btn-danger',
-                         :title => _('Try to abort the job on a host without waiting for its result'),
-                         :disabled => !task.cancellable?,
-                         :method => :post)
+        :class => 'btn btn-danger',
+        :title => _('Try to abort the job on a host without waiting for its result'),
+        :disabled => !task.cancellable?,
+        :method => :post)
     end
     buttons
   end
@@ -128,7 +128,7 @@ module RemoteExecutionHelper
     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, :authorizer => task_authorizer)
+        hash_for_foreman_tasks_task_path(invocation.task).merge(:auth_object => invocation.task, :permission => :view_foreman_tasks, :authorizer => task_authorizer)
     end
   end
 
@@ -193,7 +193,7 @@ module RemoteExecutionHelper
       _('N/A')
     else
       content_tag :span, (time > Time.now.utc ? _('in %s') : _('%s ago')) % time_ago_in_words(time),
-                  { :'data-original-title' => time.try(:in_time_zone), :rel => 'twipsy' }
+        { :'data-original-title' => time.try(:in_time_zone), :rel => 'twipsy' }
     end
   end
 
@@ -205,23 +205,23 @@ module RemoteExecutionHelper
 
   def description_checkbox_f(f, job_template, disabled)
     check_box_tag('description_format_override',
-                  job_template.generate_description_format,
-                  f.object.description_format.nil?,
-                  :class => 'description_format_override',
-                  :name => f.object_name + '[description_override]',
-                  :disabled => disabled,
-                  :onchange => 'description_override(this);') + ' ' + _('Use default description template')
+      job_template.generate_description_format,
+      f.object.description_format.nil?,
+      :class => 'description_format_override',
+      :name => f.object_name + '[description_override]',
+      :disabled => disabled,
+      :onchange => 'description_override(this);') + ' ' + _('Use default description template')
   end
 
   def description_format_textarea_f(f, job_template, disabled)
     textarea_f f, 'description_format',
-               :label => _('Description template'),
-               :value => f.object.description_format || job_template.generate_description_format,
-               :rows => 2,
-               :onchange => 'regenerate_description(this);',
-               :class => 'description_format advanced',
-               :disabled => disabled,
-               :label_help => description_format_help
+      :label => _('Description template'),
+      :value => f.object.description_format || job_template.generate_description_format,
+      :rows => 2,
+      :onchange => 'regenerate_description(this);',
+      :class => 'description_format advanced',
+      :disabled => disabled,
+      :label_help => description_format_help
   end
 
   def description_format_help
@@ -234,6 +234,7 @@ module RemoteExecutionHelper
   def load_template_from_task(template_invocation, target)
     task = template_invocation.job_invocation.sub_task_for_host(target)
     return if task.nil?
+
     task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end
 end