foreman_remote_execution 1.5.6 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e46050a5990faad87a961e071259349d70484bd1a3a5dc591f2dc2d99a8ed5fd
-  data.tar.gz: 2024c485f96831c771299629dee1eae498fbc078cd9a97fded7db60a66c88b4f
+SHA1:
+  metadata.gz: d32b2841ada7024991eaaa445876b288bdb7e659
+  data.tar.gz: ac0e476c16619599050ed2ee18fe8a36c6676612
 SHA512:
-  metadata.gz: fc474783987a76f8fa74304887f7a54aba2d1a4a64619087d891266916cff2f9c4527e2a53fff719bf8736f10d9fbf8542da2d99cd78d87d946f1048965c24a8
-  data.tar.gz: af6e2aa4211743d8e210f2dfc823f81110ff6100ba4cb046b90ab85ca8a13048e6087eaaeebe9d856112cd525b2ae957e5d112a5734d96754fc77013b51b4cd7
+  metadata.gz: b359f35fd8d49fb8648cf9e166bde983c7559b7137b76704018ebd8998ac5d3d45600934dc459edf20b75982ccc9d7622e3872c6d75570c845f7378e149ca5d1
+  data.tar.gz: a35c2128ec33e5c54aff10a860d7515356a44bca013295e5066b916e89fc116e5384716904c4b30fd4808fde9eb67bbdefbd1e2240df8d6237625a858387f062

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

@@ -111,14 +111,9 @@ module Api
       param :failed_only, :bool
       def rerun
         composer = JobInvocationComposer.from_job_invocation(@job_invocation, params)
-        if composer.rerun_possible?
-          composer.trigger!
-          @job_invocation = composer.job_invocation
-          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
-        end
+        composer.trigger!
+        @job_invocation = composer.job_invocation
+        process_response @job_invocation
       end
 
       private

data/app/helpers/remote_execution_helper.rb

@@ -161,7 +161,7 @@ module RemoteExecutionHelper
 
   def preview_box(template_invocation, target)
     renderer = InputTemplateRenderer.new(template_invocation.template, target, template_invocation)
-    if (preview = (load_template_from_task(template_invocation, target) || renderer.preview))
+    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.'),
@@ -234,10 +234,4 @@ module RemoteExecutionHelper
       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?
-    task.execution_plan.actions[1].try(:input) { |input| input['script'] }
-  end
 end

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

@@ -49,8 +49,6 @@ module Actions
         job_invocation.password = job_invocation.key_passphrase = job_invocation.sudo_password = nil
         job_invocation.save!
 
-        Rails.logger.debug "cleaning cache for keys that begin with 'job_invocation_#{job_invocation.id}'"
-        Rails.cache.delete_matched(/\A#{JobInvocation::CACHE_PREFIX}_#{job_invocation.id}/)
         # creating the success notification should be the very last thing this tasks do
         job_invocation.build_notification.deliver!
       end

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

@@ -0,0 +1,57 @@
+module ForemanRemoteExecution
+  module Renderer
+    module Scope
+      class Input < ::Foreman::Renderer::Scope::Base
+        include Foreman::Renderer::Scope::Macros::HostTemplate
+
+        attr_reader :template, :host, :invocation, :input_values, :input_template_instance
+        delegate :input, to: :input_template_instance
+
+        def render_error(message)
+          raise ::InputTemplateRenderer::RenderError.new(message)
+        end
+
+        def preview?
+          !!@preview
+        end
+
+        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 = @template.class.authorized("view_#{@template.class.to_s.underscore.pluralize}").find_by(name: template_name)
+          unless template
+            self.error_message = _('included template \'%s\' not found') % template_name
+            raise error_message
+          end
+          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)
+          out = included_renderer.render
+          if included_renderer.error_message
+            @input_template_instance.error_message = included_renderer.error_message
+            raise error_message
+          else
+            out
+          end
+        end
+
+        def foreign_input_set_values(target_template, overrides = {})
+          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)
+          input_values = inputs_to_generate.inject(HashWithIndifferentAccess.new) do |hash, input_name|
+            hash.merge(input_name => included_renderer.input(input_name))
+          end
+          input_values.merge(overrides)
+        end
+
+        def allowed_helpers
+          super + [:input, :render_template, :preview?, :render_error]
+        end
+      end
+    end
+  end
+end

data/app/models/input_template_renderer.rb

@@ -5,9 +5,9 @@ class InputTemplateRenderer
   class RenderError < ::Foreman::Exception
   end
 
-  include UnattendedHelper
+  delegate :logger, to: Rails
 
-  attr_accessor :template, :host, :invocation, :input_values, :error_message
+  attr_accessor :template, :host, :invocation, :input_values, :error_message, :templates_stack
 
   # takes template object that should be rendered
   # host and template invocation arguments are optional
@@ -16,8 +16,8 @@ class InputTemplateRenderer
     raise Foreman::Exception, N_('Recursive rendering of templates detected') if templates_stack.include?(template)
 
     @host = host
-    @invocation = invocation
     @template = template
+    @invocation = invocation
     @input_values = input_values
     @preview = preview
     @templates_stack = templates_stack + [template]
@@ -25,82 +25,53 @@ class InputTemplateRenderer
 
   def render
     @template.validate_unique_inputs!
-    render_safe(@template.template, ::Foreman::Renderer::ALLOWED_HELPERS + [ :input, :render_template, :preview?, :render_error, :cached ], :host => @host)
+    source = Foreman::Renderer.get_source(
+      template: template,
+      host: host
+    )
+    scope = Foreman::Renderer.get_scope(
+      host: host,
+      klass: renderer_scope,
+      variables: {
+        host: host,
+        template: template,
+        preview: @preview,
+        invocation: invocation,
+        input_values: input_values,
+        templates_stack: templates_stack,
+        input_template_instance: self
+      }
+    )
+    Foreman::Renderer.render(source, scope)
   rescue => e
     self.error_message ||= _('error during rendering: %s') % e.message
-    Rails.logger.debug e.to_s + "\n" + e.backtrace.join("\n")
-    return false
-  end
-
-  def preview
-    old_preview = @preview
-    @preview = true
-    render
-  ensure
-    @preview = old_preview
-  end
-
-  def cached(key, &block)
-    return yield if preview?
-    cache_key = "#{JobInvocation::CACHE_PREFIX}_#{invocation.job_invocation_id}_#{key}"
-    Rails.logger.debug "cache hit for #{cache_key}" if Rails.cache.exist?(cache_key)
-    Rails.cache.fetch(cache_key, &block)
+    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
+    input = find_by_name(template.template_inputs_with_foreign, name) # rubocop:disable Rails/DynamicFindBy
     if input
       @preview ? input.preview(self) : input.value(self)
     else
-      self.error_message = _('input macro with name \'%s\' used, but no input with such name defined for this template') % name
+      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 render_error(message)
-    raise RenderError.new(message)
-  end
-
-  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 = @template.class.authorized("view_#{@template.class.to_s.underscore.pluralize}").find_by(:name => template_name)
-    unless template
-      self.error_message = _('included template \'%s\' not found') % template_name
-      raise error_message
-    end
-    if with_foreign_input_set
-      input_values = foreign_input_set_values(template, input_values)
-    end
-    included_renderer = self.class.new(template, host, invocation, input_values.with_indifferent_access, @preview, @templates_stack)
-    out = included_renderer.render
-    if included_renderer.error_message
-      self.error_message = included_renderer.error_message
-      raise error_message
-    else
-      out
-    end
-  end
-
-  def preview?
-    !!@preview
+  def preview
+    old_preview = @preview
+    @preview = true
+    render
+  ensure
+    @preview = old_preview
   end
 
-  def foreign_input_set_values(target_template, overrides = {})
-    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 = self.class.new(input_set.target_template, host, invocation, nil, @preview, @templates_stack)
-    input_values = inputs_to_generate.inject(HashWithIndifferentAccess.new) do |hash, input_name|
-      hash.merge(input_name => included_renderer.input(input_name))
-    end
-    input_values.merge(overrides)
-  end
+  private
 
-  def logger
-    Rails.logger
+  def renderer_scope
+    ForemanRemoteExecution::Renderer::Scope::Input
   end
 
   def find_by_name(collection, name)

data/app/models/job_invocation.rb

@@ -1,6 +1,4 @@
 class JobInvocation < ApplicationRecord
-  CACHE_PREFIX = "job_invocation".freeze
-
   audited :except => [:task_id, :targeting_id, :task_group_id, :triggering_id]
 
   include Authorizable

data/app/models/job_invocation_composer.rb

@@ -186,8 +186,7 @@ class JobInvocationComposer
         :concurrency_control => concurrency_control_params,
         :execution_timeout_interval => job_invocation.execution_timeout_interval,
         :remote_execution_feature_id => job_invocation.remote_execution_feature_id,
-        :template_invocations => template_invocations_params,
-        :reruns => job_invocation.id }.with_indifferent_access
+        :template_invocations => template_invocations_params }.with_indifferent_access
     end
 
     private
@@ -298,7 +297,6 @@ class JobInvocationComposer
   end
 
   attr_accessor :params, :job_invocation, :host_ids, :search_query
-  attr_reader :reruns
   delegate :job_category, :remote_execution_feature_id, :pattern_template_invocations, :template_invocations, :targeting, :triggering, :to => :job_invocation
 
   def initialize(params, set_defaults = false)
@@ -306,7 +304,6 @@ class JobInvocationComposer
     @set_defaults = set_defaults
     @job_invocation = JobInvocation.new
     @job_invocation.task_group = JobInvocationTaskGroup.new
-    @reruns = params[:reruns]
     compose
 
     @host_ids = validate_host_ids(params[:host_ids])
@@ -345,8 +342,6 @@ class JobInvocationComposer
     job_invocation.key_passphrase = params[:key_passphrase]
     job_invocation.sudo_password = params[:sudo_password]
 
-    job_invocation.job_category = nil unless rerun_possible?
-
     self
   end
   # rubocop:enable Metrics/AbcSize
@@ -475,10 +470,6 @@ class JobInvocationComposer
     job_invocation.pattern_template_invocations.map(&:template_id)
   end
 
-  def rerun_possible?
-    !(reruns && job_invocation.pattern_template_invocations.empty?)
-  end
-
   private
 
   # builds input values for a given templates id based on params

data/app/models/job_template.rb

@@ -136,7 +136,7 @@ class JobTemplate < ::Template
 
   def generate_description_format
     if description_format.blank?
-      generated_description = '%{template_name}'
+      generated_description = '%{job_category}'
       unless template_inputs_with_foreign.empty?
         inputs = template_inputs_with_foreign.map(&:name).map { |name| %{#{name}="%{#{name}}"} }.join(' ')
         generated_description << " with inputs #{inputs}"

data/app/models/template_input.rb

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

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

@@ -6,15 +6,7 @@
 
 <%= form_for @composer.job_invocation, :html => {'data-refresh-url' => refresh_job_invocations_path, :id => 'job_invocation_form'} do |f| %>
 
-  <% unless @composer.rerun_possible? %>
-  <%= alert :text => _('Could not rerun job %{id} because its template could not be found') % { :id => @composer.reruns },
-            :class => 'alert alert-block alert-danger has-error',
-            :close => false %>
-  <% end %>
-
-  <%= selectable_f f, :job_category, @composer.available_job_categories,
-                   { :selected => @composer.job_invocation.job_category, :include_blank => @composer.job_invocation.job_category.nil? },
-                   :label => _('Job category') %>
+  <%= selectable_f f, :job_category, @composer.available_job_categories, {}, :label => _('Job category') %>
   <%= f.hidden_field(:remote_execution_feature_id, :value => @composer.remote_execution_feature_id) %>
 
   <% selected_templates_per_provider = {} %>
@@ -124,5 +116,5 @@
 
   <%= render :partial => 'preview_hosts_modal' %>
 
-  <%= submit_or_cancel f, false, :cancel_path => job_invocations_path, :disabled => !@composer.rerun_possible? %>
+  <%= submit_or_cancel f, false, :cancel_path => job_invocations_path %>
 <% end %>

data/lib/foreman_remote_execution/engine.rb

@@ -34,7 +34,7 @@ module ForemanRemoteExecution
 
     initializer 'foreman_remote_execution.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_remote_execution do
-        requires_foreman '>= 1.18'
+        requires_foreman '>= 1.20'
 
         apipie_documented_controllers ["#{ForemanRemoteExecution::Engine.root}/app/controllers/api/v2/*.rb"]
 

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.5.6'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/test/factories/foreman_remote_execution_factories.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :job_template do
     sequence(:name) { |n| "Job template #{n}" }
-    sequence(:job_category) { |n| "Job name #{n}" }
+    sequence(:job_category) { |n| "job name #{n}" }
     template 'id'
     provider_type 'SSH'
     organizations { [Organization.find_by(name: 'Organization 1')] } if SETTINGS[:organizations_enabled]

data/test/functional/api/v2/job_invocations_controller_test.rb

@@ -6,11 +6,6 @@ module Api
       setup do
         @invocation = FactoryBot.create(:job_invocation, :with_template, :with_task)
         @template = FactoryBot.create(:job_template, :with_input)
-
-        # Without this the template in template_invocations and in pattern_template_invocations
-        # would belong to different job_categories, causing trouble when trying to rerun
-        @invocation.job_category = @invocation.pattern_template_invocations.first.template.job_category
-        @invocation.save!
       end
 
       test 'should get index' do
@@ -183,8 +178,6 @@ module Api
 
       test 'should rerun failed only' do
         @invocation = FactoryBot.create(:job_invocation, :with_template, :with_failed_task)
-        @invocation.job_category = @invocation.pattern_template_invocations.first.template.job_category
-        @invocation.save!
         JobInvocation.any_instance.expects(:generate_description)
         JobInvocationComposer.any_instance
                              .expects(:validate_job_category)
@@ -198,13 +191,6 @@ module Api
         targeting.user_id.must_equal users(:admin).id
         targeting.search_query.must_equal "name ^ (#{hostnames.join(',')})"
       end
-
-      test 'should return 404 if template is not found' do
-        @invocation.job_category = 'Missing category'
-        @invocation.save!
-        post :rerun, params: { :id => @invocation.id }
-        assert_response 404
-      end
     end
   end
 end

data/test/unit/input_template_renderer_test.rb

@@ -39,36 +39,6 @@ class InputTemplateRendererTest < ActiveSupport::TestCase
           renderer.error_message.wont_be_empty
         end
       end
-
-      describe 'caching helper' do
-        it 'caches the value under given key in real mode' do
-          renderer.stubs(:invocation => OpenStruct.new(:job_invocation_id => 1))
-
-          i = 1
-          result = renderer.cached('some_key') { i }
-          result.must_equal 1
-          i += 1
-          result = renderer.cached('some_key') { i }
-          result.must_equal 1
-          i += 1
-          result = renderer.cached('different_key') { i }
-          result.must_equal 3
-        end
-
-        it 'does not cache the value in preview mode' do
-          renderer.stubs(:invocation => OpenStruct.new(:job_invocation_id => 1), :preview? => true)
-
-          i = 1
-          result = renderer.cached('some_key') { i }
-          result.must_equal 1
-          i += 1
-          result = renderer.cached('some_key') { i }
-          result.must_equal 2
-          i += 1
-          result = renderer.cached('different_key') { i }
-          result.must_equal 3
-        end
-      end
     end
 
     context 'with matching input defined' do

data/test/unit/job_invocation_composer_test.rb

@@ -156,24 +156,6 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
         end
       end
 
-      describe '#rerun_possible?' do
-        it 'is true when not rerunning' do
-          composer.must_be :rerun_possible?
-        end
-
-        it 'is true when rerunning with pattern tempalte invocations' do
-          composer.expects(:reruns).returns(1)
-          composer.job_invocation.expects(:pattern_template_invocations).returns([1])
-          composer.must_be :rerun_possible?
-        end
-
-        it 'is false when rerunning without pattern template invocations' do
-          composer.expects(:reruns).returns(1)
-          composer.job_invocation.expects(:pattern_template_invocations).returns([])
-          composer.wont_be :rerun_possible?
-        end
-      end
-
       describe '#selected_job_templates' do
         it 'returns no template if none was selected through params' do
           composer.selected_job_templates.must_be_empty

data/test/unit/job_template_test.rb

@@ -44,14 +44,14 @@ class JobTemplateTest < ActiveSupport::TestCase
     end
 
     it 'uses the job name as description_format if not set or blank and has no inputs' do
-      minimal_template.generate_description_format.must_equal '%{template_name}'
+      minimal_template.generate_description_format.must_equal '%{job_category}'
       minimal_template.description_format = ''
-      minimal_template.generate_description_format.must_equal '%{template_name}'
+      minimal_template.generate_description_format.must_equal '%{job_category}'
     end
 
     it 'generates the description_format if not set or blank and has inputs' do
       input_name = template.template_inputs.first.name
-      expected_result = %(%{template_name} with inputs #{input_name}="%{#{input_name}}")
+      expected_result = %(%{job_category} with inputs #{input_name}="%{#{input_name}}")
       template.generate_description_format.must_equal expected_result
       template.description_format = ''
       template.generate_description_format.must_equal expected_result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.6.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -168,6 +168,7 @@ files:
 - app/lib/actions/middleware/bind_job_invocation.rb
 - app/lib/actions/remote_execution/run_host_job.rb
 - app/lib/actions/remote_execution/run_hosts_job.rb
+- app/lib/foreman_remote_execution/renderer/scope/input.rb
 - app/lib/proxy_api/remote_execution_ssh.rb
 - app/mailers/.gitkeep
 - app/models/concerns/foreman_remote_execution/bookmark_extensions.rb
@@ -417,7 +418,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config