foreman_remote_execution 1.6.6 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50fc3a3d806569cd6ef1430201210365ab43135ff49037437b5ff7d5ae26e95c
-  data.tar.gz: 49444e24cc7ce4d174942869a87815c7f58ac1d824493df7cba3c5f592c0dc89
+  metadata.gz: 8984a2dd913e555a9c90380466a664e33a43b07281623ea730737919fe281419
+  data.tar.gz: 2db7e60c25e0cddcabb57f4541850be79fb2cceb65e3a721a81f5e46a06d0bda
 SHA512:
-  metadata.gz: 221de0ed7b0c41a9451b8fc5fa5d1cc2cea6ef25b969e9b28e166ac31c971da5fdbfe624cca3006832f7618cc6e63aff674264d5d6346e83847f7fdb46aa6969
-  data.tar.gz: 2aa565d2f95cb0704cbc73d49aa7806489fb497a5a73c3738cc23240b8fc582667b8427f892da6a8523baaf69970fba4d343b1751e29e125a84cbba262551ef6
+  metadata.gz: 0c63109a7327c158919bd835707556ca487c9840e901a1a2fa43bb2e9ea8d30c08f3c2d73b33c53f2d1f6dc1214b287fbbec35291e2bdc4573c8f744d29e2458
+  data.tar.gz: fc2ca8b0cd9bb7da6aa789dda541eaead960780e757d085b52fa393918bbfbf9bd4437df07e91c24af7f886178df66baad31afa31e621aa26881672c794b644f

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

@@ -4,8 +4,8 @@ module Api
       include ::Api::Version2
       include ::Foreman::Renderer
 
-      before_action :find_optional_nested_object, :only => %w{output}
-      before_action :find_host, :only => %w{output}
+      before_action :find_optional_nested_object, :only => %w{output raw_output}
+      before_action :find_host, :only => %w{output raw_output}
       before_action :find_resource, :only => %w{show update destroy clone cancel rerun}
 
       wrap_parameters JobInvocation, :include => (JobInvocation.attribute_names + [:ssh])
@@ -78,19 +78,23 @@ module Api
       param :since, String, :required => false
       def output
         if @nested_obj.task.scheduled?
-          render :json => { :refresh => true, :output => [], :delayed => true, :start_at => @nested_obj.task.start_at }
+          render :json => delayed_task_output(@nested_obj.task, :default => [])
           return
         end
-        task = @nested_obj.sub_task_for_host(@host)
-        refresh = true
-        line_sets = []
 
-        if task
-          refresh = task.pending?
-          line_sets = output_lines_since task, params[:since]
+        render :json => host_output(@nested_obj, @host, :default => [], :since => params[:since])
+      end
+
+      api :GET, '/job_invocations/:id/hosts/:host_id/raw', N_('Get raw output for a host')
+      param :id, :identifier, :required => true
+      param :host_id, :identifier, :required => true
+      def raw_output
+        if @nested_obj.task.scheduled?
+          render :json => delayed_task_output(@nested_obj.task)
+          return
         end
 
-        render :json => { :refresh => refresh, :output => line_sets || [] }
+        render :json => host_output(@nested_obj, @host, :raw => true)
       end
 
       api :POST, '/job_invocations/:id/cancel', N_('Cancel job invocation')
@@ -129,7 +133,7 @@ module Api
 
       def action_permission
         case params[:action]
-        when 'output'
+        when 'output', 'raw_output'
           :view
         when 'cancel'
           :cancel
@@ -177,6 +181,22 @@ module Api
         line_sets = line_sets.drop_while { |o| o['timestamp'].to_f <= since } if since
         line_sets
       end
+
+      def host_output(job_invocation, host, default: nil, since: nil, raw: false)
+        refresh = true
+
+        if (task = job_invocation.sub_task_for_host(host))
+          refresh = task.pending?
+          output  = output_lines_since(task, since)
+          output  = output.map { |set| set['output'] }.join if raw
+        end
+
+        { :complete => !refresh, :refresh => refresh, :output => output || default }
+      end
+
+      def delayed_task_output(task, default: nil)
+        { :complete => false, :refresh => true, :output => default, :delayed => true, :start_at => task.start_at }
+      end
     end
   end
 end

data/app/helpers/remote_execution_helper.rb

@@ -234,6 +234,6 @@ module RemoteExecutionHelper
   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'] }
+    task.execution_plan.actions[1].try(:input).try(:[], 'script')
   end
 end

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

@@ -1,4 +1,4 @@
-<% title @job_invocation.description, trunc_with_tooltip(@job_invocation.description, 120) %>
+<% title @job_invocation.description %>
 <% stylesheet 'foreman_remote_execution/job_invocations' %>
 <% javascript 'charts', 'foreman_remote_execution/template_invocation' %>
 <%= javascript_include_tag *webpack_asset_paths('foreman_remote_execution', :extension => 'js'), "data-turbolinks-track" => true, 'defer' => 'defer' %>

data/config/routes.rb

@@ -43,6 +43,7 @@ Rails.application.routes.draw do
       resources :job_invocations, :except => [:new, :edit, :update, :destroy] do
         resources :hosts, :only => :none do
           get '/', :to => 'job_invocations#output'
+          get '/raw', :to => 'job_invocations#raw_output'
         end
         member do
           post 'cancel'

data/lib/foreman_remote_execution/engine.rb

@@ -58,7 +58,7 @@ module ForemanRemoteExecution
           permission :create_job_invocations, { :job_invocations => [:new, :create, :refresh, :rerun, :preview_hosts],
                                                 'api/v2/job_invocations' => [:create, :rerun] }, :resource_type => 'JobInvocation'
           permission :view_job_invocations, { :job_invocations => [:index, :chart, :show, :auto_complete_search], :template_invocations => [:show],
-                                              'api/v2/job_invocations' => [:index, :show, :output] }, :resource_type => 'JobInvocation'
+                                              'api/v2/job_invocations' => [:index, :show, :output, :raw_output] }, :resource_type => 'JobInvocation'
           permission :view_template_invocations, { :template_invocations => [:show],
                                                    'api/v2/template_invocations' => [:template_invocations] }, :resource_type => 'TemplateInvocation'
           permission :create_template_invocations, {}, :resource_type => 'TemplateInvocation'

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.6.6'.freeze
+  VERSION = '1.6.7'.freeze
 end

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

@@ -101,34 +101,83 @@ module Api
         end
       end
 
-      test 'should provide output for delayed task' do
-        host = @invocation.template_invocations_hosts.first
-        ForemanTasks::Task.any_instance.expects(:scheduled?).returns(true)
-        get :output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
-        result = ActiveSupport::JSON.decode(@response.body)
-        assert_equal result['delayed'], true
-        assert_equal result['refresh'], true
-        assert_equal result['output'], []
-        assert_response :success
-      end
+      describe '#output' do
+        let(:host) { @invocation.template_invocations_hosts.first }
 
-      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
+        test 'should provide output for delayed task' do
+          ForemanTasks::Task.any_instance.expects(:scheduled?).returns(true)
+          get :output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['delayed'], true
+          assert_equal result['refresh'], true
+          assert_equal result['output'], []
+          assert_response :success
+        end
+
+        test 'should provide empty output for host which does not have a task yet' do
+          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 fail with 404 for non-existing job invocation' do
+          invocation_id = @invocation.id + 1
+          assert_empty JobInvocation.where(:id => invocation_id)
+          get :output, params: { :job_invocation_id => invocation_id, :host_id => 1234 }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['message'], "Job invocation not found by id '#{invocation_id}'"
+          assert_response :missing
+        end
       end
 
-      test 'should fail with 404 for non-existing job invocation' do
-        invocation_id = @invocation.id + 1
-        assert_empty JobInvocation.where(:id => invocation_id)
-        get :output, params: { :job_invocation_id => invocation_id, :host_id => 1234 }
-        result = ActiveSupport::JSON.decode(@response.body)
-        assert_equal result['message'], "Job invocation not found by id '#{invocation_id}'"
-        assert_response :missing
+      describe 'raw output' do
+        let(:fake_output) do
+          (1..5).map do |i|
+            { 'timestamp' => (Time.now - (5 - i)).to_f, 'output' => "#{i}\n" }
+          end
+        end
+        let(:fake_task) do
+          OpenStruct.new :pending? => false, :main_action => OpenStruct.new(:live_output => fake_output)
+        end
+        let(:host) { @invocation.template_invocations_hosts.first }
+
+        test 'should provide raw output for a host' do
+          JobInvocation.any_instance.expects(:task).returns(OpenStruct.new(:scheduled? => false))
+          JobInvocation.any_instance.expects(:sub_task_for_host).returns(fake_task)
+          get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['complete'], true
+          assert_equal result['output'], (1..5).map(&:to_s).join("\n") + "\n"
+          assert_response :success
+        end
+
+        test 'should provide raw output for delayed task' do
+          start_time = Time.now
+          JobInvocation.any_instance
+                       .expects(:task).twice
+                       .returns(OpenStruct.new(:scheduled? => true, :start_at => start_time))
+          JobInvocation.any_instance.expects(:sub_task_for_host).never
+          get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['complete'], false
+          assert_equal result['delayed'], true
+          assert_nil result['output']
+          Time.parse(result['start_at']).to_f.must_be_close_to start_time.to_f
+          assert_response :success
+        end
+
+        test 'should provide raw output for host without task' do
+          JobInvocation.any_instance.expects(:task).returns(OpenStruct.new(:scheduled? => false))
+          JobInvocation.any_instance.expects(:sub_task_for_host)
+          get :raw_output, params: { :job_invocation_id => @invocation.id, :host_id => host.id }
+          result = ActiveSupport::JSON.decode(@response.body)
+          assert_equal result['complete'], false
+          assert_nil result['output']
+          assert_response :success
+        end
       end
 
       test 'should cancel a job' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.6.7
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface