foreman_remote_execution 4.5.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 113fb04d80f92308f55da87e148b2c30de510b5a97dda5c400bdac598d3a407f
-  data.tar.gz: 42a44014bbb85af6ccef059d4d716a9e840865be30735cea61fb65cd94a63d2f
+  metadata.gz: e6f79124fa44d1ce9756c7c680a43ea7c9c1d309836641e4f1d91fe713a75fdb
+  data.tar.gz: 1db640940ff3ba7a44b183c017ee0c1c3262e5263553365e930695b5f1686b8e
 SHA512:
-  metadata.gz: 6321f8795de48743746748a71b3a64d4c75de23f55bfe0e79bfd660a54ecd2b5522f10554fa96c16d11350a6800457b47ae0a82fec7f905142f9d062103b3ce6
-  data.tar.gz: 41962649438f42c27845b6e7b6694cff343c4f44e8b7771534a25127458ed2b9a15b404e319e00958f36f81a0d139733820873dd5a2771cb5efeaaebbbfa7223
+  metadata.gz: 9c105b218161cc5e509c5da55ca76d339d37d217e318aff139609361ece08ff0fa36c0b70fbb41e0c2bfac2633c86218fd4539e762e1c4f0e1ed49dc778ec728
+  data.tar.gz: 9d148bc9b8af5f27c6b5bb91d8e28ea27bbff870ce1239a2e87413d5cf49b5740ccad18f713f22a1d348ff5fe185bdef015dd2bbd1b85f2efe802547e88fe193

data/app/controllers/job_invocations_controller.rb

@@ -67,7 +67,7 @@ class JobInvocationsController < ApplicationController
   end
 
   def index
-    @job_invocations = resource_base_search_and_page.with_task.order('job_invocations.id DESC')
+    @job_invocations = resource_base_search_and_page.preload(:task, :targeting).order('job_invocations.id DESC')
   end
 
   # refreshes the form

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

@@ -47,12 +47,16 @@ module Actions
         script = renderer.render
         raise _('Failed rendering template: %s') % renderer.error_message unless script
 
+        first_execution = host.executed_through_proxies.where(:id => proxy.id).none?
+        host.executed_through_proxies << proxy if first_execution
+
         additional_options = { :hostname => provider.find_ip_or_hostname(host),
                                :script => script,
                                :execution_timeout_interval => job_invocation.execution_timeout_interval,
                                :secrets => secrets(host, job_invocation, provider),
                                :use_batch_triggering => true,
-                               :use_concurrency_control => options[:use_concurrency_control]}
+                               :use_concurrency_control => options[:use_concurrency_control],
+                               :first_execution => first_execution }
         action_options = provider.proxy_command_options(template_invocation, host)
                                  .merge(additional_options)
 

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

@@ -6,6 +6,8 @@ module ForemanRemoteExecution
         has_many :template_invocations, :dependent => :destroy, :foreign_key => 'host_id'
         has_one :execution_status_object, :class_name => 'HostStatus::ExecutionStatus', :foreign_key => 'host_id', :dependent => :destroy
         has_many :run_host_job_tasks, :through => :template_invocations
+        has_many :host_proxy_invocations, :foreign_key => 'host_id', :dependent => :destroy
+        has_many :executed_through_proxies, :through => :host_proxy_invocations, :source => 'smart_proxy'
 
         scoped_search :relation => :run_host_job_tasks, :on => :result, :rename => 'job_invocation.result',
           :ext_method => :search_by_job_invocation,

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

@@ -1,5 +1,11 @@
 module ForemanRemoteExecution
   module SmartProxyExtensions
+    def self.prepended(base)
+      base.instance_eval do
+        has_many :host_proxy_invocations, :dependent => :destroy
+      end
+    end
+
     def pubkey
       self[:pubkey] || update_pubkey
     end

data/app/models/host_proxy_invocation.rb

@@ -0,0 +1,4 @@
+class HostProxyInvocation < ApplicationRecord
+  belongs_to :host, :class_name => 'Host::Managed', :inverse_of => :host_proxy_invocations
+  belongs_to :smart_proxy
+end

data/app/models/host_status/execution_status.rb

@@ -64,11 +64,11 @@ class HostStatus::ExecutionStatus < HostStatus::Status
 
       case status
         when OK
-          [ "foreman_tasks_tasks.state = 'stopped' AND result = 'success'" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND foreman_tasks_tasks.result = 'success'" ]
         when CANCELLED
-          [ "foreman_tasks_tasks.state = 'stopped' AND result = 'cancelled'" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND foreman_tasks_tasks.result = 'cancelled'" ]
         when ERROR
-          [ "foreman_tasks_tasks.state = 'stopped' AND (result = 'error' OR result = 'warning')" ]
+          [ "foreman_tasks_tasks.state = 'stopped' AND (foreman_tasks_tasks.result = 'error' OR foreman_tasks_tasks.result = 'warning')" ]
         when QUEUED
           [ "foreman_tasks_tasks.state = 'scheduled' OR foreman_tasks_tasks.state IS NULL" ]
         when RUNNING

data/app/models/job_invocation.rb

@@ -65,8 +65,6 @@ class JobInvocation < ApplicationRecord
   scoped_search :on => 'pattern_template_name', :rename => 'pattern_template_name', :operators => ['= '],
     :complete_value => false, :only_explicit => true, :ext_method => :search_by_pattern_template
 
-  scope :with_task, -> { references(:task) }
-
   scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring_logic.id'
 
   scoped_search :relation => :recurring_logic, :on => 'id', :rename => 'recurring',
@@ -99,7 +97,7 @@ class JobInvocation < ApplicationRecord
   def self.search_by_status(key, operator, value)
     conditions = HostStatus::ExecutionStatus::ExecutionTaskStatusMapper.sql_conditions_for(value)
     conditions[0] = "NOT (#{conditions[0]})" if operator == '<>'
-    { :conditions => sanitize_sql_for_conditions(conditions), :include => :task }
+    { :conditions => sanitize_sql_for_conditions(conditions), :joins => :task }
   end
 
   def self.search_by_recurring_logic(key, operator, value)
@@ -193,11 +191,16 @@ class JobInvocation < ApplicationRecord
   end
 
   def total_hosts_count
+    count = _('N/A')
+
     if targeting.resolved?
-      task&.main_action&.total_count || targeting.hosts.count
-    else
-      _('N/A')
+      count = if task&.main_action.respond_to?(:total_count)
+                task.main_action.total_count
+              else
+                targeting.hosts.count
+              end
     end
+    count
   end
 
   def pattern_template_invocation_for_host(host)

data/app/models/job_invocation_composer.rb

@@ -174,7 +174,7 @@ class JobInvocationComposer
         input = template.template_inputs_with_foreign.find { |i| i.name == name }
         unless input
           raise ::Foreman::Exception, _('Unknown input %{input_name} for template %{template_name}') %
-              { :input_name => name, :template_name => template.name }
+            { :input_name => name, :template_name => template.name }
         end
         { :template_input_id => input.id, :value => value }
       end
@@ -405,7 +405,7 @@ class JobInvocationComposer
     job_invocation.effective_user_password = params[:effective_user_password]
 
     if @reruns && job_invocation.targeting.static?
-      job_invocation.targeting.host_ids = JobInvocation.find(@reruns).targeting.host_ids
+      job_invocation.targeting.assign_host_ids(JobInvocation.find(@reruns).targeting.host_ids)
       job_invocation.targeting.mark_resolved!
     end
 

data/app/models/remote_execution_provider.rb

@@ -50,7 +50,7 @@ class RemoteExecutionProvider
       method = host_setting(host, :remote_execution_effective_user_method)
       unless EFFECTIVE_USER_METHODS.include?(method)
         raise _('Effective user method "%{current_value}" is not one of %{valid_methods}') %
-                  { :current_value => method, :valid_methods => EFFECTIVE_USER_METHODS}
+          { :current_value => method, :valid_methods => EFFECTIVE_USER_METHODS}
       end
       method
     end

data/app/models/setting/remote_execution.rb

@@ -70,13 +70,13 @@ class Setting::RemoteExecution < Setting
       self.set('remote_execution_form_job_template',
         N_('Choose a job template that is pre-selected in job invocation form'),
         'Run Command - SSH Default',
-        _('Form Job Template'),
+        N_('Form Job Template'),
         nil,
         { :collection => proc { Hash[JobTemplate.unscoped.map { |template| [template.name, template.name] }] } }),
       self.set('remote_execution_job_invocation_report_template',
         N_('Select a report template used for generating a report for a particular remote execution job'),
         'Jobs - Invocation report template',
-        _('Job Invocation Report Template'),
+        N_('Job Invocation Report Template'),
         nil,
         { :collection => proc { self.job_invocation_report_templates_select } }),
     ]

data/app/models/targeting.rb

@@ -46,9 +46,13 @@ class Targeting < ApplicationRecord
     #   pluck(:id) returns duplicate results for HostCollections
     host_ids = User.as(user.login) { Host.authorized(RESOLVE_PERMISSION, Host).search_for(search_query).order(:name, :id).pluck(:id).uniq }
     host_ids.shuffle!(random: Random.new) if randomized_ordering
+    self.assign_host_ids(host_ids)
+    self.save(:validate => false)
+  end
+
+  def assign_host_ids(host_ids)
     # this can be optimized even more, by introducing bulk insert
     self.targeting_hosts.build(host_ids.map { |id| { :host_id => id } })
-    self.save(:validate => false)
   end
 
   def dynamic?

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

@@ -21,7 +21,7 @@
     <% @job_invocations.each do |invocation| %>
       <tr>
         <td class="text_warp"><%= link_to_if_authorized invocation_description(invocation), hash_for_job_invocation_path(invocation).merge(:auth_object => invocation, :permission => :view_job_invocations, :authorizer => authorizer) %></td>
-        <td><%= trunc_with_tooltip(invocation&.targeting&.search_query, 15) %></td>
+        <td><%= trunc_with_tooltip(invocation.targeting.search_query, 15) %></td>
         <td><%= link_to_invocation_task_if_authorized(invocation) %></td>
         <td><%= invocation_result(invocation, :success_count) %></td>
         <td><%= invocation_result(invocation, :failed_count) %></td>

data/db/migrate/2021051713291621250977_add_host_proxy_invocations.rb

@@ -0,0 +1,12 @@
+class AddHostProxyInvocations < ActiveRecord::Migration[6.0]
+  def change
+    # rubocop:disable Rails/CreateTableWithTimestamps
+    create_table :host_proxy_invocations do |t|
+      t.references :host, :null => false
+      t.references :smart_proxy, :null => false
+    end
+    # rubocop:enable Rails/CreateTableWithTimestamps
+
+    add_index :host_proxy_invocations, [:host_id, :smart_proxy_id], unique: true
+  end
+end

data/lib/foreman_remote_execution/engine.rb

@@ -201,12 +201,10 @@ 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 = '4.5.0'.freeze
+  VERSION = '4.5.1'.freeze
 end

data/test/unit/job_invocation_composer_test.rb

@@ -864,7 +864,9 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
     it 'marks targeting as resolved if static' do
       created = JobInvocationComposer.from_job_invocation(job_invocation).job_invocation
       assert created.targeting.resolved?
-      assert_equal job_invocation.template_invocations_host_ids, created.targeting.host_ids
+      created.targeting.save
+      created.targeting.reload
+      assert_equal job_invocation.template_invocations_host_ids, created.targeting.targeting_hosts.pluck(:host_id)
     end
 
     it 'takes randomized_ordering from the original job invocation when rerunning failed' do
@@ -874,6 +876,17 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
       composer = JobInvocationComposer.from_job_invocation(job_invocation, :host_ids => host_ids)
       assert composer.job_invocation.targeting.randomized_ordering
     end
+
+    it 'works with invalid hosts' do
+      host = job_invocation.targeting.hosts.first
+      ::Host::Managed.any_instance.stubs(:valid?).returns(false)
+      composer = JobInvocationComposer.from_job_invocation(job_invocation, {})
+      targeting = composer.compose.job_invocation.targeting
+      targeting.save!
+      targeting.reload
+      assert targeting.valid?
+      assert_equal targeting.hosts.pluck(:id), [host.id]
+    end
   end
 
   describe '.for_feature' do

data/test/unit/job_invocation_test.rb

@@ -10,7 +10,7 @@ class JobInvocationTest < ActiveSupport::TestCase
     end
 
     it 'is able to perform search through job invocations' do
-      found_jobs = JobInvocation.search_for(%{job_category = "#{job_invocation.job_category}"}).paginate(:page => 1).with_task.order('job_invocations.id DESC')
+      found_jobs = JobInvocation.search_for(%{job_category = "#{job_invocation.job_category}"}).paginate(:page => 1).order('job_invocations.id DESC')
       _(found_jobs).must_equal [job_invocation]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.1
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -171,7 +171,6 @@ 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
@@ -180,6 +179,7 @@ files:
 - app/models/concerns/foreman_remote_execution/template_overrides.rb
 - app/models/concerns/foreman_remote_execution/user_extensions.rb
 - app/models/foreign_input_set.rb
+- app/models/host_proxy_invocation.rb
 - app/models/host_status/execution_status.rb
 - app/models/input_template_renderer.rb
 - app/models/invocation_provider_input_value.rb
@@ -324,6 +324,7 @@ files:
 - db/migrate/20200623073022_rename_sudo_password_to_effective_user_password.rb
 - db/migrate/20200820122057_add_proxy_selector_override_to_remote_execution_feature.rb
 - db/migrate/20210312074713_add_provider_inputs.rb
+- db/migrate/2021051713291621250977_add_host_proxy_invocations.rb
 - db/seeds.d/100-assign_features_with_templates.rb
 - db/seeds.d/20-permissions.rb
 - db/seeds.d/50-notification_blueprints.rb
@@ -380,7 +381,6 @@ files:
 - test/functional/job_templates_controller_test.rb
 - test/functional/ui_job_wizard_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
-- test/models/orchestration/ssh_test.rb
 - test/support/remote_execution_helper.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb
@@ -518,7 +518,6 @@ test_files:
 - test/functional/job_templates_controller_test.rb
 - test/functional/ui_job_wizard_controller_test.rb
 - test/helpers/remote_execution_helper_test.rb
-- test/models/orchestration/ssh_test.rb
 - test/support/remote_execution_helper.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_host_job_test.rb

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

@@ -1,70 +0,0 @@
-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(proxy_id)
-      _, _, target = host_kind_target
-      return true if target.nil?
-
-      proxy = ::SmartProxy.find(proxy_id)
-      begin
-        proxy.drop_host_from_known_hosts(target)
-      rescue ::ProxyAPI::ProxyException => e
-        if e.wrapped_exception.is_a?(RestClient::NotFound)
-          # ignore 404 when known_hosts entry is missing or the module was not enabled
-          Foreman::Logging.exception "Proxy failed to delete SSH known_hosts for #{name}, #{ip}", e, :level => :error
-        else
-          raise e
-        end
-      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
-      # #remote_execution_proxies may not be defined on the host object in some case
-      # for example Host::Discovered does not have it defined, even though these hosts
-      # have Nic::Managed interfaces associated with them
-      proxies = (host.try(: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])
-      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 && !host.new_record? && 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/test/models/orchestration/ssh_test.rb

@@ -1,56 +0,0 @@
-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.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.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
-    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
-  end
-
-  it 'does not fail on 404 from the smart proxy' do
-    host.stubs(:skip_orchestration?).returns false
-    ::ProxyAPI::RemoteExecutionSSH.any_instance.expects(:delete).raises(RestClient::ResourceNotFound).twice
-    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
-    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
-  end
-
-  it 'does not trigger the removal when creating a new host' do
-    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).never
-    host = Host::Managed.new(:name => 'test', :ip => '127.0.0.1')
-    host.stubs(:skip_orchestration?).returns false
-    _(host.queue.task_ids).must_equal []
-  end
-
-  it 'does not call to the proxy when target is nil' do
-    host.stubs(:skip_orchestration?).returns false
-    SmartProxy.any_instance.expects(:drop_host_from_known_hosts).with(host.name)
-    host.interfaces.first.stubs(:ip)
-    host.destroy
-    _(host.queue.items.map(&:status)).must_equal %w(completed completed)
-  end
-end