foreman_remote_execution 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f8f8c5208313baaca0c289321f6cc4c07c8d27d9f8d97c83e764d58a902f152
-  data.tar.gz: cf6df45271fa254133e0c15e1084f835984e857247b1b8980b61555db9b43ae2
+  metadata.gz: 4cab4376bc924e75310a2a56b5a659a5305a0da5dc8dbbd9e850f41d1a67b95b
+  data.tar.gz: 6d9bf2cefb54c4f8360dad8026c6bf5dd825466f0a6fe74be404016c1e312ca7
 SHA512:
-  metadata.gz: 8c0ebcfd20e690e37e882e7a1d93be312989252d9b875977852e4587b7b3fe2232bc745f89f7d5d83bce1dc6c6480871ad4daae5d30b482d3f9b7fccf64089fd
-  data.tar.gz: 1fc408ceb6aebaddd2fb83fe91ceb9f7674ae3735bc2eb89c522903dc1f67175f348261557a95ae30d091dc409aa20cfc9a4133426b1f42913c2f6da165c3781
+  metadata.gz: 06540f56e6585f76429447973081fd15dabda10f8e58da00783999bb3eec0a237fa61703c98a0e667e0bfa89d4c835e949284521005d2a27a5396958e4d05c7c
+  data.tar.gz: 678fa795c597717faedc8595e5f45ee51a367aa4f0bd974af7329300b82415f636751f5fa24ae3cb37bb7b67ced63d4d58907d89fb36ccfb7c618c4cab3a781d

data/app/assets/javascripts/foreman_remote_execution/template_input.js

@@ -1,13 +1,3 @@
-$(document).on('change', 'select.input_type_selector', function () {
-  update_visibility_after_input_type_change($(this));
-});
-
-function update_visibility_after_input_type_change(select){
-  fieldset = select.closest('fieldset');
-  fieldset.find('div.custom_input_type_fields').hide();
-  fieldset.find('div.' + select.val() + '_input_type').show();
-}
-
 function update_foreign_input_set_include(include_all_checkbox) {
     fieldset = $(include_all_checkbox.closest('fieldset'));
     fieldset.find('input.foreign_input_set_include').prop('disabled', include_all_checkbox.checked);

data/app/assets/javascripts/foreman_remote_execution/template_invocation.js

@@ -70,18 +70,7 @@ function job_invocation_form_binds() {
 
   $('select#targeting_bookmark_id').on('change', refresh_search_query);
 
-  $('a.advanced_fields_switch').on('click', toggle_advanced_fields )
-}
-
-function toggle_advanced_fields() {
-  switcher = $('a.advanced_fields_switch');
-  original = switcher.html();
-  switcher.html(switcher.data('alternativeLabel'));
-  switcher.data('alternativeLabel', original);
-
-  switcher.siblings('i').toggleClass('fa-angle-right').toggleClass('fa-angle-down');
-
-  $('div.advanced').toggle()
+  tfm.advancedFields.initAdvancedFields()
 }
 
 function delayed_refresh(url, data){

data/app/assets/stylesheets/foreman_remote_execution/template_invocation.css.scss

@@ -44,6 +44,7 @@ div.terminal {
   div.line div.content {
     position: relative;
     margin-left: 50px;
+    white-space: pre;
   }
 
   a {

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

@@ -4,7 +4,7 @@ module Api
       include ::Api::Version2
       include ::Foreman::Renderer
 
-      before_action :find_optional_nested_object
+      before_action :find_optional_nested_object, :only => %w{output}
       before_action :find_host, :only => %w{output}
       before_action :find_resource, :only => %w{show update destroy clone cancel rerun}
 
@@ -123,6 +123,10 @@ module Api
 
       private
 
+      def allowed_nested_id
+        %w(job_invocation_id)
+      end
+
       def action_permission
         case params[:action]
         when 'output'

data/app/helpers/job_invocation_output_helper.rb

@@ -1,4 +1,5 @@
 module JobInvocationOutputHelper
+  COLOR_PATTERN = /\e\[.*?m/
   CONSOLE_COLOR = {
     '31' => 'red',
     '32' => 'lightgreen',
@@ -17,19 +18,19 @@ module JobInvocationOutputHelper
   }.tap { |h| h.default = 'default' }.freeze
 
   def colorize_line(line)
-    line = line.gsub(/\e\[.*?m/) do |seq|
+    line = line.gsub(COLOR_PATTERN) do |seq|
       color = seq[/(\d+)m/,1]
       "{{{format color:#{color}}}}"
     end
 
-    current_color = 'default'
+    @current_color ||= 'default'
     out = %{<span style="color: #{@current_color}">}
     parts = line.split(/({{{format.*?}}})/)
     parts.each do |console_line|
       if console_line.include?('{{{format')
         if (color_index = console_line[/color:(\d+)/, 1]).present?
-          current_color = CONSOLE_COLOR[color_index]
-          out << %{</span><span style="color: #{current_color}">}
+          @current_color = CONSOLE_COLOR[color_index]
+          out << %{</span><span style="color: #{@current_color}">}
         end
       else
         out << h(console_line)

data/app/helpers/job_invocations_helper.rb

@@ -12,35 +12,6 @@ module JobInvocationsHelper
     end
   end
 
-  def job_invocation_task_buttons(task)
-    job_invocation = task.task_groups.find { |group| group.class == JobInvocationTaskGroup }.job_invocation
-    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'))
-    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 => task.sub_tasks.none? { |sub_task| task_failed?(sub_task) },
-                         :title => _('Rerun on failed hosts'))
-    end
-    if authorized_for(:permission => :view_foreman_tasks, :auth_object => task)
-      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)
-      buttons << link_to(_('Cancel Job'), cancel_foreman_tasks_task_path(task),
-                         :class => 'btn btn-danger',
-                         :title => _('Try to cancel the job'),
-                         :disabled => !task.cancellable?,
-                         :method => :post)
-    end
-    buttons
-  end
-
   def job_invocations_buttons
     [
       documentation_button_rex('3.2ExecutingaJob'),

data/app/helpers/remote_execution_helper.rb

@@ -4,10 +4,6 @@ module RemoteExecutionHelper
     RemoteExecutionProvider.providers.map { |key, provider| [ key, _(provider.humanized_name) ] }
   end
 
-  def template_input_types_options
-    TemplateInput::TYPES.map { |key, name| [ _(name), key ] }
-  end
-
   def job_hosts_authorizer
     @job_hosts_authorizer ||= Authorizer.new(User.current, :collection => @hosts)
   end
@@ -78,7 +74,7 @@ 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.where(:result => %w(error warning)).count.zero?,
+                         :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)
@@ -188,15 +184,6 @@ module RemoteExecutionHelper
     documentation_button section, :root_url => url
   end
 
-  def template_input_header(f, template)
-    header = _('Template input')
-    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)
     check_box_tag('description_format_override',
                   job_template.generate_description_format,
@@ -225,16 +212,6 @@ module RemoteExecutionHelper
         'name using %{job_category} and %{template_name}.').html_safe # rubocop:disable Rails/OutputSafety
   end
 
-  def advanced_switch_f(default_text, switch_text)
-    content_tag :div, :class => 'form-group' do
-      content_tag(:div, '', :class => 'col-md-2 control-label') +
-      content_tag(:div, :class => 'col-md-4') do
-        content_tag(:i, '', :class => 'fa fa-angle-right') + ' ' +
-        link_to(default_text, '#', :class => 'advanced_fields_switch', :'data-alternative-label' => switch_text)
-      end
-    end
-  end
-
   def load_template_from_task(template_invocation, target)
     task = template_invocation.job_invocation.sub_task_for_host(target)
     return if task.nil?

data/app/lib/foreman_remote_execution/renderer/scope/input.rb

@@ -1,10 +1,10 @@
 module ForemanRemoteExecution
   module Renderer
     module Scope
-      class Input < ::Foreman::Renderer::Scope::Base
+      class Input < ::Foreman::Renderer::Scope::Template
         include Foreman::Renderer::Scope::Macros::HostTemplate
 
-        attr_reader :template, :host, :invocation, :input_values, :input_template_instance
+        attr_reader :template, :host, :invocation, :input_template_instance, :current_user
         delegate :input, to: :input_template_instance
 
         def render_error(message)
@@ -31,10 +31,14 @@ module ForemanRemoteExecution
             self.error_message = _('included template \'%s\' not found') % template_name
             raise error_message
           end
+
+          default_values = template.default_input_values(input_values.keys)
           if with_foreign_input_set
             input_values = foreign_input_set_values(template, input_values)
           end
-          included_renderer = InputTemplateRenderer.new(template, host, invocation, input_values.with_indifferent_access, @preview, @templates_stack)
+          input_values = default_values.merge(input_values).with_indifferent_access
+
+          included_renderer = InputTemplateRenderer.new(template, host, invocation, input_values, @preview, @templates_stack)
           out = included_renderer.render
           if included_renderer.error_message
             @input_template_instance.error_message = included_renderer.error_message
@@ -48,16 +52,32 @@ module ForemanRemoteExecution
           input_set = @template.foreign_input_sets.find_by(:target_template_id => target_template)
           return overrides if input_set.nil?
 
-          inputs_to_generate = input_set.inputs.map(&:name) - overrides.keys.map(&:to_s)
-          included_renderer = InputTemplateRenderer.new(input_set.target_template, host, invocation, nil, @preview, @templates_stack)
+          inputs_to_generate = input_set.inputs.map { |i| i.name.to_s } - overrides.keys.map(&:to_s)
           input_values = inputs_to_generate.inject(HashWithIndifferentAccess.new) do |hash, input_name|
-            hash.merge(input_name => included_renderer.input(input_name))
+            hash.merge(input_name.to_s => input(input_name))
+          end
+          input_values.merge(overrides).with_indifferent_access
+        end
+
+        def input(name)
+          return template_input_values[name.to_s] if template_input_values.key?(name.to_s)
+          input = find_by_name(template.template_inputs_with_foreign, name) # rubocop:disable Rails/DynamicFindBy
+          if input
+            @preview ? input.preview(self) : input.value(self)
+          else
+            error_message = _('input macro with name \'%s\' used, but no input with such name defined for this template') % name
+            raise UndefinedInput, "Rendering failed, no input with name #{name} for input macro found"
           end
-          input_values.merge(overrides)
         end
 
         def allowed_helpers
-          super + [:input, :render_template, :preview?, :render_error]
+          super + [:input, :render_template, :preview?, :render_error, :current_user]
+        end
+
+        private
+
+        def find_by_name(collection, name)
+          collection.detect { |i| i.name == name.to_s }
         end
       end
     end

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

@@ -4,24 +4,12 @@ module ForemanRemoteExecution
 
     included do
       # autosave => true is required so the changes of inputs are saved even if template was not changed
-      has_many :template_inputs, :dependent => :destroy, :foreign_key => 'template_id', :autosave => true
       has_many :foreign_input_sets, :dependent => :destroy, :foreign_key => 'template_id', :autosave => true
 
       def template_inputs_with_foreign(templates_stack = [])
         self.template_inputs.to_a + foreign_input_sets.map { |set| set.inputs(templates_stack) }.flatten
       end
-      accepts_nested_attributes_for :template_inputs, :allow_destroy => true
       accepts_nested_attributes_for :foreign_input_sets, :allow_destroy => true
     end
-
-    # create or overwrite instance methods...
-    # def instance_method_name
-    # end
-
-    # module ClassMethods
-    #   # create or overwrite class methods...
-    #   def class_method_name
-    #   end
-    # end
   end
 end

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

@@ -0,0 +1,9 @@
+module ForemanRemoteExecution
+  module TemplateInputExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :template_invocation_input_values, :dependent => :destroy
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module ForemanRemoteExecution
+  module TemplateOverrides
+    def inputs_unchanged_when_locked
+      inputs_changed = template_inputs.any? { |input| input.changed? || input.new_record? }
+      foreign_input_sets_changed = foreign_input_sets.any? { |input_set| input_set.changed? || input_set.new_record? }
+      if inputs_changed || foreign_input_sets_changed
+        errors.add(:base, _('This template is locked. Please clone it to a new template to customize.'))
+      end
+    end
+  end
+end

data/app/models/input_template_renderer.rb

@@ -7,7 +7,7 @@ class InputTemplateRenderer
 
   delegate :logger, to: Rails
 
-  attr_accessor :template, :host, :invocation, :input_values, :error_message, :templates_stack
+  attr_accessor :template, :host, :invocation, :template_input_values, :error_message, :templates_stack, :current_user
 
   # takes template object that should be rendered
   # host and template invocation arguments are optional
@@ -18,48 +18,40 @@ class InputTemplateRenderer
     @host = host
     @template = template
     @invocation = invocation
-    @input_values = input_values
+    @template_input_values = input_values
     @preview = preview
     @templates_stack = templates_stack + [template]
   end
 
   def render
+    @template_input_values ||= values_from_invocation
     @template.validate_unique_inputs!
     source = Foreman::Renderer.get_source(
       template: template,
       host: host
     )
-    scope = Foreman::Renderer.get_scope(
+    @scope = Foreman::Renderer.get_scope(
       host: host,
       klass: renderer_scope,
+      template_input_values: @template_input_values,
       variables: {
         host: host,
         template: template,
         preview: @preview,
         invocation: invocation,
-        input_values: input_values,
+        input_values: @template_input_values,
         templates_stack: templates_stack,
-        input_template_instance: self
+        input_template_instance: self,
+        current_user: User.current.try(:login)
       }
     )
-    Foreman::Renderer.render(source, scope)
+    Foreman::Renderer.render(source, @scope)
   rescue => e
     self.error_message ||= _('error during rendering: %s') % e.message
     Foreman::Logging.exception('Error during rendering of a job template', e)
     false
   end
 
-  def input(name)
-    return @input_values[name.to_s] if @input_values
-    input = find_by_name(template.template_inputs_with_foreign, name) # rubocop:disable Rails/DynamicFindBy
-    if input
-      @preview ? input.preview(self) : input.value(self)
-    else
-      error_message = _('input macro with name \'%s\' used, but no input with such name defined for this template') % name
-      raise UndefinedInput, "Rendering failed, no input with name #{name} for input macro found"
-    end
-  end
-
   def preview
     old_preview = @preview
     @preview = true
@@ -70,6 +62,13 @@ class InputTemplateRenderer
 
   private
 
+  def values_from_invocation
+    input_values = @invocation ? Hash[@invocation.input_values.map { |iv| [iv.template_input.name, iv.value] }] : {}
+    default_values = template.default_input_values(input_values.keys)
+    result = @preview ? input_values : default_values.merge(input_values)
+    result.with_indifferent_access
+  end
+
   def renderer_scope
     ForemanRemoteExecution::Renderer::Scope::Input
   end

data/app/models/job_invocation.rb

@@ -156,11 +156,16 @@ class JobInvocation < ApplicationRecord
   end
 
   def failed_host_ids
-    failed_template_invocations.map(&:host_id)
+    failed_hosts.pluck(:id)
   end
 
   def failed_hosts
-    failed_template_invocations.includes(:host).map(&:host)
+    base = targeting.hosts
+    if finished?
+      base.where.not(:id => not_failed_template_invocations.select(:host_id))
+    else
+      base.where(:id => failed_template_invocations.select(:host_id))
+    end
   end
 
   def total_hosts_count
@@ -240,7 +245,12 @@ class JobInvocation < ApplicationRecord
   private
 
   def failed_template_invocations
-    results = TemplateInvocation::TaskResultMap.status_to_task_result(:failed)
-    template_invocations.joins(:run_host_job_task).where("#{ForemanTasks::Task.table_name}.result" => results)
+    results = [:cancelled, :failed].map { |state| TemplateInvocation::TaskResultMap.status_to_task_result(state) }.flatten
+    template_invocations.joins(:run_host_job_task).where(ForemanTasks::Task.table_name => { :result => results })
+  end
+
+  def not_failed_template_invocations
+    results = [:cancelled, :failed].map { |state| TemplateInvocation::TaskResultMap.status_to_task_result(state) }.flatten
+    template_invocations.joins(:run_host_job_task).where.not(ForemanTasks::Task.table_name => { :result => results })
   end
 end

data/app/models/job_invocation_composer.rb

@@ -461,14 +461,10 @@ class JobInvocationComposer
     pattern_template_invocations.find { |invocation| invocation.template == job_template }
   end
 
-  def template_invocation_input_value_for(job_template, input)
+  def input_value_for(input)
     invocations = pattern_template_invocations
     default = TemplateInvocationInputValue.new
-    if (invocation = invocations.detect { |i| i.template_id == job_template.id })
-      invocation.input_values.detect { |iv| iv.template_input_id == input.id } || default
-    else
-      default
-    end
+    invocations.map(&:input_values).flatten.detect { |iv| iv.template_input_id == input.id } || default
   end
 
   def job_template_ids