foreman_remote_execution 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d32b2841ada7024991eaaa445876b288bdb7e659
-  data.tar.gz: ac0e476c16619599050ed2ee18fe8a36c6676612
+SHA256:
+  metadata.gz: 7e884723b111f87af0bb02b6eb789e3d246edd949afb503c6abda18a3e6a6106
+  data.tar.gz: 9b33580cc044c35b9a44321d9889364f6e8871cbb1d5a20a14fc03e652965dbc
 SHA512:
-  metadata.gz: b359f35fd8d49fb8648cf9e166bde983c7559b7137b76704018ebd8998ac5d3d45600934dc459edf20b75982ccc9d7622e3872c6d75570c845f7378e149ca5d1
-  data.tar.gz: a35c2128ec33e5c54aff10a860d7515356a44bca013295e5066b916e89fc116e5384716904c4b30fd4808fde9eb67bbdefbd1e2240df8d6237625a858387f062
+  metadata.gz: '096f0427feb1f59bcb7eb2759050a6bc420cf7961235b8345791e59a55890da359e78e8d4543a9bd1eab20bfb077450efbb6ad62fcad2149ddfa95b48e6761e9'
+  data.tar.gz: 2c2029fe3abe58f9763609ce6829f8c81afa6755a179cd73408dc4ff790e14166aeaa8d890c872301623218b9773ca44bc0499236134e82942fe58bc37b6ba1b

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

@@ -111,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

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/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

@@ -136,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/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.6.1'.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,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
@@ -178,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)
@@ -191,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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -418,7 +418,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