foreman_remote_execution 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e008f8d140c9b90f475730f271f2eef1722d9ea3
-  data.tar.gz: 0a60b9e6cf46ec5d233aec53f39c2c8b60ab77b7
+  metadata.gz: e4de9b6ef4385fb25d736b6e2a3c79ad3d6240e6
+  data.tar.gz: de38d2967d75a10fa0d759d1927eb5a637c9a73a
 SHA512:
-  metadata.gz: ec1c4582b54752cffd9fe0c1f944dee4449787be282ca619511a934ee36d2a30b3d0af3bbb0ed050cfbbf19533bd1afd78b96776f6efa95e99fdef4bdbc6eef5
-  data.tar.gz: cea15e552318c30f00417d3af6d57ebbd38d2fc2fb5dd54c7c8bee435b08933d203cc476b450f236537e2dc2464dcafeafd3abe9e4a8d5737cc556a656af5499
+  metadata.gz: 91604a14604487b8d821e4e81991402c281c0cc342105de1b124bc4c4be18809414f54b9da28c92774c5bb5663c190c7775ed1d76341f5b2ce36e41388d5f7e4
+  data.tar.gz: 67cfafed4dc9d8a204d478781c227937a657a0134630739bb4670744c3c505f26b1d97e9777e9b9ed7e046729faa9ef8ce4f7f1a5e1dba3224be110876babbdf

data/.rubocop.yml

@@ -2,13 +2,18 @@ inherit_from:
   - .rubocop_todo.yml
 
 AllCops:
-  RunRailsCops: true # always run the rails cops
   Exclude:
     - 'doc/plugins/**'
 
+Rails:
+  Enabled: true
+
 Rails/Date:
   Enabled: false
 
+Rails/HttpPositionalArguments:
+  Enabled: false
+
 # Don't enforce documentation
 Style/Documentation:
   Enabled: false
@@ -20,9 +25,12 @@ Rails/ActionFilter:
 Metrics/MethodLength:
   Max: 40
 
-Style/TrailingComma:
+Style/TrailingCommaInLiteral:
   Enabled: false
 
+#Style/TrailingCommaInArguments:
+#Enabled: false
+
 Style/AccessorMethodName:
   Enabled: false
 
@@ -31,6 +39,8 @@ Style/RedundantSelf:
 
 Metrics/ClassLength:
   Max: 500
+  Exclude:
+       - 'test/**/*'
 
 Style/FileName:
   Exclude:
@@ -51,5 +61,21 @@ Style/ClassAndModuleChildren:
 Style/EachWithObject:
   Enabled: false
 
+Style/GuardClause:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+       - 'config/routes.rb'
+       - 'lib/foreman_remote_execution/engine.rb'
+       - 'test/**/*'
+
 Metrics/ParameterLists:
   Enabled: false
+
+Style/VariableNumber:
+  Enabled: false
+
+# a == 0 is not the same as a.zero?, when a is not a number
+Style/NumericPredicate:
+  Enabled: false

data/.rubocop_todo.yml

@@ -39,13 +39,6 @@ Metrics/LineLength:
 Metrics/PerceivedComplexity:
   Max: 8
 
-# Offense count: 2
-# Configuration parameters: Include.
-Rails/DefaultScope:
-  Exclude:
-    - 'app/models/job_invocation.rb'
-    - 'app/models/job_template.rb'
-
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Rails/TimeZone:

data/Gemfile

@@ -1,3 +1,3 @@
 source 'http://rubygems.org'
 
-gemspec
+gemspec :name => 'foreman_remote_execution'

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

@@ -18,8 +18,7 @@ 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

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

@@ -20,9 +20,9 @@ module Api
 
       api :GET, '/job_invocations/:id', N_('Show job invocation')
       param :id, :identifier, :required => true
-      def show
-      end
+      def show; 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 => true, :desc => N_('The job template to use')

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

@@ -29,7 +29,7 @@ module Api
       def import
         options = params[:overwrite] ? { :update => true } : { :build_new => true }
 
-        @job_template = JobTemplate.import(params[:template], options)
+        @job_template = JobTemplate.import_raw(params[:template], options)
         @job_template ||= JobTemplate.new
         process_response @job_template.save
       end
@@ -43,8 +43,7 @@ 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

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

@@ -13,8 +13,7 @@ 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

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

@@ -19,8 +19,7 @@ module Api
       api :GET, '/templates/:template_id/template_inputs/:id', N_('Show template input details')
       param :template_id, :identifier, :required => true
       param :id, :identifier, :required => true
-      def show
-      end
+      def show; end
 
       def_param_group :template_input do
         param :template_input, Hash, :required => true, :action_aware => true do

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

@@ -16,9 +16,9 @@ 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,
-            :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/concerns/foreman/controller/parameters/template_input.rb

@@ -5,8 +5,8 @@ module Foreman::Controller::Parameters::TemplateInput
     def template_input_params_filter
       Foreman::ParameterFilter.new(::TemplateInput).tap do |filter|
         filter.permit_by_context :id, :_destroy, :name, :required, :input_type, :fact_name,
-            :variable_name, :puppet_class_name, :puppet_parameter_name, :description, :template_id,
-            :options, :advanced, :nested => true
+                                 :variable_name, :puppet_class_name, :puppet_parameter_name, :description, :template_id,
+                                 :options, :advanced, :nested => true
       end
     end
   end

data/app/controllers/job_invocations_controller.rb

@@ -11,7 +11,7 @@ class JobInvocationsController < ApplicationController
       }
     }
 
-    if (template = JobTemplate.find_by_id(params[:template_id]))
+    if (template = JobTemplate.find_by(id: params[:template_id]))
       ui_params[:job_invocation] = {
         :job_category => template.job_category,
         :providers => {
@@ -25,12 +25,7 @@ class JobInvocationsController < ApplicationController
 
   def rerun
     job_invocation = resource_base.find(params[:id])
-    @composer = JobInvocationComposer.from_job_invocation(job_invocation)
-    if params[:failed_only]
-      host_ids = job_invocation.failed_host_ids
-      @composer.search_query = Targeting.build_query_from_hosts(host_ids)
-    end
-
+    @composer = JobInvocationComposer.from_job_invocation(job_invocation, params)
     render :action => 'new'
   end
 
@@ -48,6 +43,8 @@ class JobInvocationsController < ApplicationController
     @job_invocation = resource_base.includes(:template_invocations => :run_host_job_task).find(params[:id])
     @auto_refresh = @job_invocation.task.try(:pending?)
     hosts_base = @job_invocation.targeting.hosts.authorized(:view_hosts, Host)
+                                .joins(:template_invocations)
+                                .merge(TemplateInvocation.where(:job_invocation_id => @job_invocation.id))
     @hosts = hosts_base.search_for(params[:search], :order => params[:order] || 'name ASC').paginate(:page => params[:page])
   end
 

data/app/controllers/job_templates_controller.rb

@@ -29,12 +29,12 @@ class JobTemplatesController < ::TemplatesController
   def import
     contents = params.fetch(:imported_template, {}).fetch(:template, nil).try(:read)
 
-    @template = JobTemplate.import(contents, :update => Foreman::Cast.to_bool(params[:imported_template][:overwrite]))
+    @template = JobTemplate.import_raw(contents, :update => Foreman::Cast.to_bool(params[:imported_template][:overwrite]))
     if @template && @template.save
       flash[:notice] = _('Job template imported successfully.')
       redirect_to job_templates_path(:search => "name = \"#{@template.name}\"")
     else
-      @template ||= JobTemplate.import(contents, :build_new => true)
+      @template ||= JobTemplate.import_raw(contents, :build_new => true)
       @template.valid?
       flash[:warning] = _('Unable to save template. Correct highlighted errors')
       render :action => 'new'

data/app/controllers/remote_execution_features_controller.rb

@@ -6,8 +6,7 @@ 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)

data/app/helpers/remote_execution_helper.rb

@@ -11,7 +11,7 @@ module RemoteExecutionHelper
   def job_invocation_chart(invocation)
     options = { :class => 'statistics-pie small', :expandable => true, :border => 0, :show_title => true }
 
-    if (invocation.task)
+    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]),
@@ -29,10 +29,14 @@ module RemoteExecutionHelper
     @job_hosts_authorizer ||= Authorizer.new(User.current, :collection => @hosts)
   end
 
-  def job_invocation_status(invocation, percent = nil)
+  def job_invocation_status(invocation, percent = nil, verbose = true)
     case invocation.status
       when HostStatus::ExecutionStatus::QUEUED
-        _('queued')
+        if verbose && invocation.task
+          _('queued to start executing in %{time}') % {:time => time_ago_in_words(invocation.task.start_at) }
+        else
+          _('queued')
+        end
       when HostStatus::ExecutionStatus::RUNNING
         percent ||= invocation.progress_report[:progress]
         _('running %{percent}%%') % {:percent => percent}
@@ -141,8 +145,9 @@ module RemoteExecutionHelper
   end
 
   def link_to_invocation_task_if_authorized(invocation)
+    status = job_invocation_status(invocation, nil, false)
     if invocation.queued?
-      job_invocation_status(invocation)
+      status
     else
       task_authorizer = Authorizer.new(User.current, :collection => [invocation.task])
       link_to_if_authorized job_invocation_status(invocation),
@@ -166,7 +171,7 @@ module RemoteExecutionHelper
 
   def invocation_result(invocation, key)
     unknown = '—'
-    result = invocation_count(invocation, :output_key => key, :unknown_string => unknown.html_safe)
+    result = invocation_count(invocation, :output_key => key, :unknown_string => unknown.html_safe) # rubocop:disable Rails/OutputSafety
     label = key == :failed_count ? 'danger' : 'info'
     result == unknown ? result : report_event_column(result, "label-#{label}")
   end
@@ -175,15 +180,13 @@ module RemoteExecutionHelper
     renderer = InputTemplateRenderer.new(template_invocation.template, target, template_invocation)
     if (preview = renderer.preview)
       content_tag :pre, preview
+    elsif 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
-      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
+      alert :class => 'alert-block alert-danger base in fade has-error',
+            :text => renderer.error_message.html_safe # rubocop:disable Rails/OutputSafety
     end
   end
 
@@ -215,9 +218,11 @@ module RemoteExecutionHelper
 
   def template_input_header(f, template)
     header = _('Template input')
-    header += ' ' + remove_child_link('x', f, {:rel => 'twipsy', :'data-title' => _('remove template input'), :'data-placement' => 'left',
-                                               :class => 'fr badge badge-danger'}) unless template.locked?
-    header.html_safe
+    unless template.locked?
+      header += ' ' + remove_child_link('x', f, {:rel => 'twipsy', :'data-title' => _('remove template input'), :'data-placement' => 'left',
+                                                 :class => 'fr badge badge-danger'})
+    end
+    header.html_safe # rubocop:disable Rails/OutputSafety
   end
 
   def description_checkbox_f(f, job_template, disabled)
@@ -245,7 +250,7 @@ module RemoteExecutionHelper
     _('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
+        'name using %{job_category} and %{template_name}.').html_safe # rubocop:disable Rails/OutputSafety
   end
 
   def advanced_switch_f(default_text, switch_text)

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

@@ -10,6 +10,7 @@ module Actions
         :link
       end
 
+      # rubocop:disable Metrics/AbcSize
       def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {})
         action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description)
 
@@ -57,9 +58,7 @@ module Actions
       end
 
       def check_exit_status
-        if delegated_output[:exit_status].to_s != '0'
-          error! _('Playbook execution failed')
-        end
+        error! _('Job execution failed') if exit_status.to_s != '0'
       end
 
       def live_output
@@ -76,12 +75,6 @@ module Actions
         N_('Remote action:')
       end
 
-      def finalize
-        if exit_status.to_s != '0'
-          error! _('Job execution failed')
-        end
-      end
-
       def rescue_strategy
         ::Dynflow::Action::Rescue::Fail
       end
@@ -120,7 +113,8 @@ module Actions
           super
         elsif phase?(Present)
           # for compatibility with old actions
-          if old_action = all_planned_actions.first
+          old_action = all_planned_actions.first
+          if old_action
             old_action.output.fetch('proxy_output', {})
           else
             {}

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

@@ -2,6 +2,7 @@ module ForemanRemoteExecution
   module HostExtensions
     extend ActiveSupport::Concern
 
+    # rubocop:disable Metrics/BlockLength
     included do
       alias_method_chain :build_required_interfaces, :remote_execution
       alias_method_chain :reload, :remote_execution
@@ -11,10 +12,36 @@ module ForemanRemoteExecution
       has_many :targeting_hosts, :dependent => :destroy, :foreign_key => 'host_id'
       has_many :template_invocations, :dependent => :destroy, :foreign_key => 'host_id'
       has_one :execution_status_object, :class_name => 'HostStatus::ExecutionStatus', :foreign_key => 'host_id'
+      has_many :run_host_job_tasks, :through => :template_invocations
+
+      scoped_search :relation => :run_host_job_tasks, :on => :result, :rename => 'job_invocation.result',
+                    :ext_method => :search_by_job_invocation,
+                    :only_explicit => true,
+                    :complete_value => TemplateInvocation::TaskResultMap::REVERSE_MAP
+
+      scoped_search :relation => :template_invocations, :on => :job_invocation_id,
+                    :rename => 'job_invocation.id', :only_explicit => true, :ext_method => :search_by_job_invocation
 
       scoped_search :in => :execution_status_object, :on => :status, :rename => :execution_status,
                     :complete_value => { :ok => HostStatus::ExecutionStatus::OK, :error => HostStatus::ExecutionStatus::ERROR }
+
+      def self.search_by_job_invocation(key, operator, value)
+        if key == 'job_invocation.result'
+          operator = operator == '=' ? 'IN' : 'NOT IN'
+          value = TemplateInvocation::TaskResultMap.status_to_task_result(value)
+        end
+
+        mapping = {
+          'job_invocation.id'     => %(#{TemplateInvocation.table_name}.job_invocation_id #{operator} ?),
+          'job_invocation.result' => %(#{ForemanTasks::Task.table_name}.result #{operator} (?))
+        }
+        {
+          :conditions => sanitize_sql_for_conditions([mapping[key], value_to_sql(operator, value)]),
+          :joins => { :template_invocations => [:run_host_job_task] }
+        }
+      end
     end
+    # rubocop:enable Metrics/BlockLength
 
     def execution_status(options = {})
       @execution_status ||= get_status(HostStatus::ExecutionStatus).to_status(options)
@@ -39,6 +66,7 @@ module ForemanRemoteExecution
       get_interface_by_flag(:execution)
     end
 
+    # rubocop:disable Metrics/PerceivedComplexity
     def remote_execution_proxies(provider, authorized = true)
       proxies = {}
       proxies[:subnet]   = execution_interface.subnet.remote_execution_proxies.with_features(provider) if execution_interface && execution_interface.subnet
@@ -48,7 +76,7 @@ module ForemanRemoteExecution
         proxy_scope = if Taxonomy.enabled_taxonomies.any? && User.current.present?
                         ::SmartProxy.with_taxonomy_scope_override(location, organization)
                       else
-                        proxy_scope = ::SmartProxy.unscoped
+                        ::SmartProxy.unscoped
                       end
 
         proxy_scope = proxy_scope.authorized if authorized

data/app/models/host_status/execution_status.rb

@@ -8,7 +8,7 @@ class HostStatus::ExecutionStatus < HostStatus::Status
   # execution is in progress, dynflow task was created
   RUNNING = 3
   # mapping to string representation
-  STATUS_NAMES = { OK => 'succeeded', ERROR => 'failed', QUEUED => 'queued', RUNNING => 'running' }
+  STATUS_NAMES = { OK => 'succeeded', ERROR => 'failed', QUEUED => 'queued', RUNNING => 'running' }.freeze
 
   def relevant?(*args)
     execution_tasks.present?

data/app/models/input_template_renderer.rb

@@ -42,7 +42,7 @@ class InputTemplateRenderer
 
   def input(name)
     return @input_values[name.to_s] if @input_values
-    input = find_by_name(@template.template_inputs_with_foreign, name)
+    input = find_by_name(@template.template_inputs_with_foreign, name) # rubocop:disable Rails/DynamicFindBy
     if input
       @preview ? input.preview(self) : input.value(self)
     else