foreman_remote_execution 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a15d0142caa911a59ff7d9797ceab5dabb0e601f605c0fee3d547d1be168f5
-  data.tar.gz: d41aba8d661cae6ef74cfee2bd9e007a37f218c3056e9d9b8ae3a1de5f243bc6
+  metadata.gz: 9821a3370ca6a9a1fa582ab4412d5adea5bbfc125b4102c3bc2a2c92724aaf48
+  data.tar.gz: 6464d913e62d09c6e7318d887f4680a5f7a996a7f537e015a07abd366bda01c8
 SHA512:
-  metadata.gz: 20d61e7658cda93e3f24340ae6caa65c1c7868f37e699d7e6a9da524f2acaef9cccdf86cd47a7d2a1386037ad5aac0900935f3c3b2b4706926f16e60245f1b64
-  data.tar.gz: 66e0c4b3af2d1feab711fe90b2af6a5ce08d4159501a1725a98243647a022431d871081bf2d1e82d46f8490c41589a1df6f15f2ee6f13391fb10df240bd41fe4
+  metadata.gz: 66f0fe8d87d3b70fd5f23d2892abbe6f7b525e27635bc480eaf6517ae33a3510b81a1f2732373cac7b66f54333e5731f0a457a5d63bda16f233d2615a07efbb0
+  data.tar.gz: 6390c063f681c358200e91b6702bcc235ff953428052ab8b39f13821e26d14b30409ad87df431af468eaf57e6a39437438422016fd817da41ccb1dfaa607b090

data/app/helpers/job_invocations_chart_helper.rb

@@ -37,6 +37,8 @@ module JobInvocationsChartHelper
       _('running %{percent}%%') % {:percent => percent}
     when HostStatus::ExecutionStatus::OK
       _('succeeded')
+    when HostStatus::ExecutionStatus::CANCELLED
+      _('cancelled')
     when HostStatus::ExecutionStatus::ERROR
       _('failed')
     else

data/app/helpers/remote_execution_helper.rb

@@ -13,9 +13,13 @@ module RemoteExecutionHelper
     end
   end
 
-  def template_invocation_status(task)
+  def template_invocation_status(task, parent_task)
     if task.nil?
-      icon_text('question', 'N/A', :kind => 'fa')
+      if parent_task.result == 'cancelled'
+        icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
+      else
+        icon_text('question', 'N/A', :kind => 'fa')
+      end
     elsif task.state == 'running'
       icon_text('running', _('running'), :kind => 'pficon')
     elsif task.state == 'planned'

data/app/lib/proxy_api/remote_execution_ssh.rb

@@ -10,5 +10,11 @@ module ::ProxyAPI
     rescue => e
       raise ProxyException.new(url, e, N_('Unable to fetch public key'))
     end
+
+    def drop_from_known_hosts(hostname)
+      delete('known_hosts/' + hostname)
+    rescue => e
+      raise ProxyException.new(url, e, N_('Unable to remove host from known hosts'))
+    end
   end
 end

data/app/models/concerns/foreman_remote_execution/orchestration/ssh.rb

@@ -0,0 +1,58 @@
+module ForemanRemoteExecution
+  module Orchestration::SSH
+    extend ActiveSupport::Concern
+
+    included do
+      before_destroy :ssh_destroy
+      after_validation :queue_ssh_destroy
+      register_rebuild(:queue_ssh_destroy, N_("SSH_#{self.to_s.split('::').first}"))
+    end
+
+    def drop_from_known_hosts(args)
+      proxy_id, target = args
+      proxy = ::SmartProxy.find(proxy_id)
+      begin
+        proxy.drop_host_from_known_hosts(target)
+      rescue => e
+        Rails.logger.warn e.message
+        return false
+      end
+      true
+    end
+
+    def ssh_destroy
+      logger.debug "Scheduling SSH known_hosts cleanup"
+
+      host, _kind, target = host_kind_target
+      proxies = host.remote_execution_proxies('SSH').values
+      proxies.flatten.uniq.each do |proxy|
+        queue.create(id: queue_id(proxy.id), name: _("Remove SSH known hosts for %s") % self,
+          priority: 200, action: [self, :drop_from_known_hosts, [proxy.id, target]])
+      end
+    end
+
+    def queue_ssh_destroy
+      should_drop_from_known_hosts? && ssh_destroy
+    end
+
+    def should_drop_from_known_hosts?
+      host, = host_kind_target
+      host&.build && host&.changes&.key?('build')
+    end
+
+    private
+
+    def host_kind_target
+      if self.is_a?(::Host::Base)
+        [self, 'host', name]
+      else
+        [self.host, 'interface', ip]
+      end
+    end
+
+    def queue_id(proxy_id)
+      _, kind, id = host_kind_target
+      "ssh_remove_known_hosts_#{kind}_#{id}_#{proxy_id}"
+    end
+  end
+end

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

@@ -12,6 +12,10 @@ module ForemanRemoteExecution
       key
     end
 
+    def drop_host_from_known_hosts(host)
+      ::ProxyAPI::RemoteExecutionSSH.new(:url => url).drop_from_known_hosts(host)
+    end
+
     def refresh
       errors = super
       update_pubkey

data/app/models/host_status/execution_status.rb

@@ -7,8 +7,10 @@ class HostStatus::ExecutionStatus < HostStatus::Status
   QUEUED = 2
   # execution is in progress, dynflow task was created
   RUNNING = 3
+  # execution has been cancelled
+  CANCELLED = 4
   # mapping to string representation
-  STATUS_NAMES = { OK => 'succeeded', ERROR => 'failed', QUEUED => 'queued', RUNNING => 'running' }.freeze
+  STATUS_NAMES = { OK => 'succeeded', ERROR => 'failed', QUEUED => 'queued', RUNNING => 'running', CANCELLED => 'cancelled' }.freeze
 
   def relevant?(*args)
     execution_tasks.present?
@@ -38,6 +40,8 @@ class HostStatus::ExecutionStatus < HostStatus::Status
     case to_status(options)
       when OK
         execution_tasks.present? ? N_('Last execution succeeded') : N_('No execution finished yet')
+      when CANCELLED
+        N_('Last execution cancelled')
       when ERROR
         N_('Last execution failed')
       else
@@ -54,6 +58,8 @@ class HostStatus::ExecutionStatus < HostStatus::Status
       case status
         when OK
           [ "state = 'stopped' AND result = 'success'" ]
+        when CANCELLED
+          [ "state = 'stopped' AND result = 'cancelled'" ]
         when ERROR
           [ "state = 'stopped' AND (result = 'error' OR result = 'warning')" ]
         when QUEUED
@@ -74,6 +80,8 @@ class HostStatus::ExecutionStatus < HostStatus::Status
         QUEUED
       elsif task.state == 'stopped' && task.result == 'success'
         OK
+      elsif task.state == 'stopped' && task.result == 'cancelled'
+        CANCELLED
       elsif task.pending?
         RUNNING
       else

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

@@ -5,6 +5,7 @@
     </h2>
     <div class="card-pf-body">
       <div id='status_chart'>
+        <%= react_component('JobInvocationContainer', data: { url: "/job_invocations/chart?id=#{job_invocation.id}" }) %>
       </div>
     </div>
   </div>

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

@@ -1 +1 @@
-<td class="host_status" id="<%= dom_id(host) %>-status" data-refresh_required="<%= task.nil? || task.pending? ? 'true' : '' %>" data-id="<%= host.id %>"><%= template_invocation_status(task) %></td>
+<td class="host_status" id="<%= dom_id(host) %>-status" data-refresh_required="<%= task.nil? || task.pending? ? 'true' : '' %>" data-id="<%= host.id %>"><%= template_invocation_status(task, job_invocation.task) %></td>

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

@@ -1,7 +1,7 @@
 <% template_invocations = job_invocation.pattern_template_invocations %>
 <div class='row'>
   <div class="col-xs-6 col-sm-6 col-md-6">
-    <%= render :partial => 'card_results' %>
+    <%= render :partial => 'card_results', :locals => { :job_invocation => job_invocation } %>
     <%= render :partial => 'card_schedule', :locals => { :job_invocation => job_invocation } %>
   </div>
   <div class='col-xs-12 col-sm-6 col-md-6'>

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

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

data/config/routes.rb

@@ -16,7 +16,8 @@ Rails.application.routes.draw do
     end
   end
 
-  resources :job_invocations, :only => [:new, :create, :show, :index] do
+  match 'job_invocations/new', to: 'job_invocations#new', via: [:get, :post], as: 'new_job_invocation'
+  resources :job_invocations, :only => [:create, :show, :index] do
     collection do
       post 'refresh'
       get 'chart'

data/foreman_remote_execution.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = Dir['README*', 'LICENSE']
 
   s.add_dependency 'deface'
-  s.add_dependency 'dynflow', '>= 1.0.1', '< 2.0.0'
+  s.add_dependency 'dynflow', '>= 1.0.2', '< 2.0.0'
   s.add_dependency 'foreman_remote_execution_core'
   s.add_dependency 'foreman-tasks', '>= 0.15.1'
 

data/lib/foreman_remote_execution/engine.rb

@@ -166,10 +166,12 @@ module ForemanRemoteExecution
 
       Host::Managed.prepend ForemanRemoteExecution::HostExtensions
       Host::Managed.include ForemanTasks::Concerns::HostActionSubject
+      Host::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       (Nic::Base.descendants + [Nic::Base]).each do |klass|
         klass.send(:include, ForemanRemoteExecution::NicExtensions)
       end
+      Nic::Managed.include ForemanRemoteExecution::Orchestration::SSH
 
       Bookmark.include ForemanRemoteExecution::BookmarkExtensions
       HostsHelper.prepend ForemanRemoteExecution::HostsHelperExtensions

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/test/functional/job_invocations_controller_test.rb

@@ -46,4 +46,16 @@ class JobInvocationsControllerTest < ActionController::TestCase
     assert_equal(template_invocation_params,
       assigns(:composer).params['template_invocations'])
   end
+
+  test 'new via GET and POST' do
+    template = FactoryBot.create(:job_template, :with_input)
+    feature = FactoryBot.create(:remote_execution_feature, job_template: template)
+    params = { feature: feature.label, inputs: { template.template_inputs.first.name => 'foobar' } }
+
+    get :new, params: params, session: set_session_user
+    assert_response :success
+
+    post :new, params: params, session: set_session_user
+    assert_response :success
+  end
 end

data/test/models/orchestration/ssh_test.rb

@@ -0,0 +1,24 @@
+require 'test_plugin_helper'
+
+class SSHOrchestrationTest < ActiveSupport::TestCase
+  let(:host) { FactoryBot.create(:host, :managed, :with_subnet) }
+  let(:proxy) { FactoryBot.create(:smart_proxy, :ssh) }
+  let(:interface) { host.interfaces.first }
+
+  before { interface.subnet.remote_execution_proxies = [proxy] }
+
+  it 'attempts to drop IP address and hostname from smart proxies on destroy' do
+    host.stubs(:skip_orchestration?).returns false
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(interface.ip)
+    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(host.name)
+    host.destroy
+  end
+
+  it 'attempts to drop IP address and hostname from smart proxies on rebuild' do
+    host.build = true
+    host.save!
+    ids = ["ssh_remove_known_hosts_interface_#{interface.ip}_#{proxy.id}",
+           "ssh_remove_known_hosts_host_#{host.name}_#{proxy.id}"]
+    _(host.queue.task_ids).must_equal ids
+  end
+end

data/test/unit/remote_execution_provider_test.rb

@@ -149,7 +149,10 @@ class RemoteExecutionProviderTest < ActiveSupport::TestCase
         FactoryBot.create(:host) do |host|
           host.interfaces = [FactoryBot.build(:nic_managed, flags.merge(:ip => nil, :name => 'somehost.somedomain.org', :primary => true)),
                              FactoryBot.build(:nic_managed, flags.merge(:ip => '127.0.0.1'))]
-        end
+        end.reload
+        # Reassigning the interfaces triggers the on-deletion ssh key removal for the interface which is being replaced
+        # This has an undesired side effect of caching the original interface as execution one which made the tests
+        # give wrong results. Reloading the host wipes the cache
       end
 
       let(:flags) do

data/webpack/index.js

@@ -12,18 +12,3 @@ componentRegistry.register({
 });
 
 registerReducer('foremanRemoteExecutionReducers', rootReducer);
-
-if (window.location.href.match(/job_invocations/)) {
-  const jobInvocationId = parseInt(
-    new URI(window.location.href).filename(),
-    10,
-  );
-
-  const mountJobInvocationContainer = () => {
-    mount('JobInvocationContainer', '#status_chart', {
-      url: `/job_invocations/chart?id=${jobInvocationId}`,
-    });
-  };
-
-  document.addEventListener('page:change', mountJobInvocationContainer);
-}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -178,6 +178,7 @@ files:
 - app/models/concerns/foreman_remote_execution/foreman_tasks_triggering_extensions.rb
 - app/models/concerns/foreman_remote_execution/host_extensions.rb
 - app/models/concerns/foreman_remote_execution/nic_extensions.rb
+- app/models/concerns/foreman_remote_execution/orchestration/ssh.rb
 - app/models/concerns/foreman_remote_execution/smart_proxy_extensions.rb
 - app/models/concerns/foreman_remote_execution/subnet_extensions.rb
 - app/models/concerns/foreman_remote_execution/taxonomy_extensions.rb
@@ -377,6 +378,7 @@ files:
 - test/functional/job_invocations_controller_test.rb
 - test/functional/job_templates_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
+- test/models/orchestration/ssh_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb
@@ -442,6 +444,7 @@ test_files:
 - test/functional/job_invocations_controller_test.rb
 - test/functional/job_templates_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
+- test/models/orchestration/ssh_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
 - test/unit/actions/run_hosts_job_test.rb