foreman_remote_execution 1.5.4 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d911acff83175160207a45f2ca0ba34827beff57
-  data.tar.gz: 7ed92c4c5653b5317d17aa6c470ba361e7ee26b1
+SHA256:
+  metadata.gz: 9494abeb23995efb0f837561fd1b1bd84fbd7ef37060081ea573d2dde16bd74b
+  data.tar.gz: afbf23769a88fecbbcb7197249b2261a046b568be38699c35a12210ab6cb13e5
 SHA512:
-  metadata.gz: ba51f41db0f75a572099ab7bf4d69f926df0e942f5ded5b21f8111caa14e2ed4f2d1d7d5119089c4c888ca00d079113f15575933552d60d13a8daf8633ad8b39
-  data.tar.gz: f0bb2bdb7f28f155c2846442e7b7661e834c15beaf0f49aebe405ed39ab217d65db8c825d58fc11974394212e6362a67a17ccf272cd03054643e23f06b6b9248
+  metadata.gz: 28dd96a2c75c9e94f71a6613fac13ecbf7938d46fdfc0d5208833073149a3e60c84de6a7ee357ca22318abae29a7deb85afb77377ff462ee71aade08cf7ec0ca
+  data.tar.gz: 5d012baa162db923230e7d7c0f0dc03a315075ce79f3bc64b8cc1236c328061c2ff839f97c56849157c303fc5e758376ecab15d65137cf206aabe6159d7025cf

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

@@ -82,17 +82,15 @@ module Api
           return
         end
         task = @nested_obj.sub_task_for_host(@host)
-        refresh = task.pending?
-        since = params[:since].to_f if params[:since].present?
+        refresh = true
+        line_sets = []
 
-        line_sets = task.main_action.live_output
-        line_sets = line_sets.drop_while { |o| o['timestamp'].to_f <= since } if since
-
-        if line_sets.blank?
-          render :json => {:refresh => refresh, :output => []}
-        else
-          render :json => {:refresh => refresh, :output => line_sets }
+        if task
+          refresh = task.pending?
+          line_sets = output_lines_since task, params[:since]
         end
+
+        render :json => { :refresh => refresh, :output => line_sets || [] }
       end
 
       api :POST, '/job_invocations/:id/cancel', N_('Cancel job invocation')
@@ -113,9 +111,14 @@ module Api
       param :failed_only, :bool
       def rerun
         composer = JobInvocationComposer.from_job_invocation(@job_invocation, params)
-        composer.trigger!
-        @job_invocation = composer.job_invocation
-        process_response @job_invocation
+        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
       end
 
       private
@@ -163,6 +166,13 @@ module Api
           job_invocation_params[:inputs].to_hash
         )
       end
+
+      def output_lines_since(task, time)
+        since = time.to_f if time.present?
+        line_sets = task.main_action.live_output
+        line_sets = line_sets.drop_while { |o| o['timestamp'].to_f <= since } if since
+        line_sets
+      end
     end
   end
 end

data/app/controllers/job_templates_controller.rb

@@ -19,10 +19,15 @@ class JobTemplatesController < ::TemplatesController
     host = params[:preview_host_id].present? ? base.find(params[:preview_host_id]) : base.first
     @template.template = params[:template]
     renderer = InputTemplateRenderer.new(@template, host)
-    if (output = renderer.preview)
+    output = renderer.preview
+    if output
       render :plain => output
     else
-      render :status => 406, :text => _('Problem with previewing the template: %{error}. Note that you must save template input changes before you try to preview it.' % {:error => renderer.error_message})
+      render status: :not_acceptable,
+             plain: _(
+               'Problem with previewing the template: %{error}. Note that you must save template input changes before you try to preview it.' %
+               {:error => renderer.error_message}
+             )
     end
   end
 

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 = renderer.preview)
+    if (preview = (load_template_from_task(template_invocation, target) || renderer.preview))
       content_tag :pre, preview
     elsif target.nil?
       alert :text => _('Could not render the preview because no host matches the search query.'),
@@ -234,4 +234,10 @@ 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/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 = @template.class.authorized("view_#{@template.class.to_s.underscore}").find_by(:name => template_name)
+    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

data/app/models/job_invocation_composer.rb

@@ -186,7 +186,8 @@ 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 }.with_indifferent_access
+        :template_invocations => template_invocations_params,
+        :reruns => job_invocation.id }.with_indifferent_access
     end
 
     private
@@ -297,6 +298,7 @@ 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)
@@ -304,6 +306,7 @@ 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])
@@ -342,6 +345,8 @@ 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
@@ -470,6 +475,10 @@ 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

@@ -1,12 +1,14 @@
 class JobTemplate < ::Template
   audited
   include ::Exportable
+  include ::TemplateTax
 
   class NonUniqueInputsError < Foreman::Exception
   end
 
   attr_exportable :job_category, :description_format, :template_inputs,
-                  :foreign_input_sets, :provider_type, :kind => ->(template) { template.class.name.underscore }
+                  :foreign_input_sets, :provider_type,
+                  { :kind => ->(template) { template.class.name.underscore } }.merge(taxonomy_exportable)
 
   include Authorizable
   extend FriendlyId
@@ -134,7 +136,7 @@ class JobTemplate < ::Template
 
   def generate_description_format
     if description_format.blank?
-      generated_description = '%{job_category}'
+      generated_description = '%{template_name}'
       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/views/job_invocations/_form.html.erb

@@ -6,7 +6,15 @@
 
 <%= form_for @composer.job_invocation, :html => {'data-refresh-url' => refresh_job_invocations_path, :id => 'job_invocation_form'} do |f| %>
 
-  <%= selectable_f f, :job_category, @composer.available_job_categories, {}, :label => _('Job category') %>
+  <% 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') %>
   <%= f.hidden_field(:remote_execution_feature_id, :value => @composer.remote_execution_feature_id) %>
 
   <% selected_templates_per_provider = {} %>
@@ -116,5 +124,5 @@
 
   <%= render :partial => 'preview_hosts_modal' %>
 
-  <%= submit_or_cancel f, false, :cancel_path => job_invocations_path %>
+  <%= submit_or_cancel f, false, :cancel_path => job_invocations_path, :disabled => !@composer.rerun_possible? %>
 <% end %>

data/app/views/overrides/subnets/_rex_tab_pane.html.erb

@@ -1,5 +1,5 @@
 <div class="tab-pane" id="rex_proxies">
   <%= fields_for :subnet do |f| %>
-    <%= multiple_selects f, :remote_execution_proxies, SmartProxy.authorized.with_features(*RemoteExecutionProvider.provider_names), @subnet.remote_execution_proxy_ids, {:label => _("Proxies"), :help_inline => _("Select as many remote execution proxies as applicable for this subnet.  When multiple proxies with the same provider are added, actions will be load balanced among them.")} %>
+    <%= multiple_selects f, :remote_execution_proxies, SmartProxy.authorized.with_features(*RemoteExecutionProvider.provider_names).distinct, @subnet.remote_execution_proxy_ids, {:label => _("Proxies"), :help_inline => _("Select as many remote execution proxies as applicable for this subnet.  When multiple proxies with the same provider are added, actions will be load balanced among them.")} %>
   <% end %>
 </div>

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.5.4'.freeze
+  VERSION = '1.5.5'.freeze
 end

data/test/factories/foreman_remote_execution_factories.rb

@@ -1,14 +1,12 @@
 FactoryBot.define do
-
-  factory :job_template do |f|
-    f.sequence(:name) { |n| "Job template #{n}" }
-    sequence(:job_category) { |n| "job name #{n}" }
-    f.template 'id'
-    f.provider_type 'SSH'
+  factory :job_template do
+    sequence(:name) { |n| "Job template #{n}" }
+    sequence(:job_category) { |n| "Job name #{n}" }
+    template 'id'
+    provider_type 'SSH'
     organizations { [Organization.find_by(name: 'Organization 1')] } if SETTINGS[:organizations_enabled]
     locations { [Location.find_by(name: 'Location 1')] } if SETTINGS[:locations_enabled]
 
-
     trait :with_input do
       after(:build) do |template, evaluator|
         template.template_inputs << FactoryBot.build(:template_input)

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

@@ -6,6 +6,11 @@ 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
@@ -107,6 +112,16 @@ module Api
         assert_response :success
       end
 
+      test 'should provide empty output for host which does not have a task yet' do
+        host = @invocation.template_invocations_hosts.first
+        JobInvocation.any_instance.expects(:sub_task_for_host).returns(nil)
+        get :output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+        result = ActiveSupport::JSON.decode(@response.body)
+        assert_equal result['refresh'], true
+        assert_equal result['output'], []
+        assert_response :success
+      end
+
       test 'should cancel a job' do
         @invocation.task.expects(:cancellable?).returns(true)
         @invocation.task.expects(:cancel).returns(true)
@@ -168,6 +183,8 @@ 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)
@@ -181,6 +198,13 @@ 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/functional/api/v2/job_templates_controller_test.rb

@@ -92,6 +92,7 @@ module Api
 
       test 'should export template' do
         get :export, params: { :id => @template.to_param }
+        User.current = users(:admin)
         assert_equal @response.body, @template.to_erb
         assert_response :success
       end

data/test/functional/job_templates_controller_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class JobTemplatesControllerTest < ActionController::TestCase
+  context '#preview' do
+    let(:template) { FactoryBot.create(:job_template) }
+    let(:host) { FactoryBot.create(:host, :managed) }
+
+    test 'should render a preview version of a template' do
+      post :preview, params: { job_template: template.to_param, template: 'uptime' }, session: set_session_user
+      assert_response :success
+    end
+
+    test 'should render a preview version of a template for a specific host' do
+      post :preview, params: {
+        job_template: template.to_param,
+        template: '<%= @host.name %>',
+        preview_host_id: host.id
+      }, session: set_session_user
+      assert_response :success
+      assert_equal host.name, @response.body
+    end
+
+    test 'should render a error message when template has errors' do
+      InputTemplateRenderer.any_instance.stubs(:render).returns(false)
+      post :preview, params: { job_template: template.to_param }, session: set_session_user
+      assert_response :not_acceptable
+    end
+  end
+end

data/test/unit/job_invocation_composer_test.rb

@@ -156,6 +156,24 @@ 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 '%{job_category}'
+      minimal_template.generate_description_format.must_equal '%{template_name}'
       minimal_template.description_format = ''
-      minimal_template.generate_description_format.must_equal '%{job_category}'
+      minimal_template.generate_description_format.must_equal '%{template_name}'
     end
 
     it 'generates the description_format if not set or blank and has inputs' do
       input_name = template.template_inputs.first.name
-      expected_result = %(%{job_category} with inputs #{input_name}="%{#{input_name}}")
+      expected_result = %(%{template_name} 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
@@ -267,6 +267,11 @@ class JobTemplateTest < ActiveSupport::TestCase
       imported.name.must_equal old_name
       imported.template_inputs.first.to_export.must_equal exportable_template.template_inputs.first.to_export
     end
+
+    it 'has taxonomies in metadata' do
+      assert_equal 'Organization 1', exportable_template.to_export["organizations"].first
+      assert_equal 'Location 1', exportable_template.to_export["locations"].first
+    end
   end
 
   context 'there is existing template invocation of a job template' do
@@ -290,4 +295,20 @@ class JobTemplateTest < ActiveSupport::TestCase
       refute_valid job_template
     end
   end
+
+  context 'rendering' do
+    it 'renders nested template as a non-admin user' do
+      inner = FactoryBot.create(:job_template)
+      template_invocation = FactoryBot.create(:template_invocation)
+      template_invocation.template.template = "<wrap><%= render_template('#{inner.name}') %></wrap>"
+      template_invocation.template.save!
+
+      setup_user('view', 'job_templates')
+      renderer = InputTemplateRenderer.new template_invocation.template,
+                                           template_invocation.host,
+                                           template_invocation
+      result = renderer.render
+      result.must_equal "<wrap>#{inner.template}</wrap>"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.5
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -368,6 +368,7 @@ files:
 - test/functional/api/v2/template_inputs_controller_test.rb
 - test/functional/api/v2/template_invocations_controller_test.rb
 - test/functional/job_invocations_controller_test.rb
+- test/functional/job_templates_controller_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb
@@ -416,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config
@@ -432,6 +433,7 @@ test_files:
 - test/functional/api/v2/template_inputs_controller_test.rb
 - test/functional/api/v2/template_invocations_controller_test.rb
 - test/functional/job_invocations_controller_test.rb
+- test/functional/job_templates_controller_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb