smart_proxy_remote_execution_ssh 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a599d3732d4f6b064a850ae8baced28354980096785a340828533f953f844c4
-  data.tar.gz: 160b80ab983f0eb7b987987191b48c19db42d3b76079b0ba6639ec831dccc6f3
+  metadata.gz: f28e2eb48888626dad82eb56e7a5309da15d584e6d4c53eaf648e5ddfc6f3d1e
+  data.tar.gz: a5b604d80264dc78b461e1792100ecd6fc9a4a71791b8df5b064bd80a32f6920
 SHA512:
-  metadata.gz: 349961aa474809225d9781bda09687eb23f00db51cca9f758a57e075fa3d19fc07b729569b064887f91bb7f07190152d6ec9cb01e8ccf48df0841e9c3f85d10e
-  data.tar.gz: 8ad40859c92f7d1cd089adf0f37bb0aaa8add745cd461c2e1ed5b484d3ae6b856ac0ee53e61c62e89d564a4ba676b22bf5f01618da970986cd60e42591ff6346
+  metadata.gz: 3231a3d465b180d1b8b325fd9fc341c009b566452946ee56837f9f37e6502d7095d1a213bc5b4b13078b9d54e5bd592f5430aea502ecdee93edab15901440815
+  data.tar.gz: 62e77d3cf6d37c90b2e6e8e48ad8b2080186a50fd1d3633b38743a099e0897b9b1e4d4dafaf7b02b1855dcd51036d418333c156438c3b20e5fa42feac93ded17

data/lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb

@@ -5,6 +5,8 @@ require 'time'
 module Proxy::RemoteExecution::Ssh::Actions
   class PullScript < Proxy::Dynflow::Action::Runner
     JobDelivered = Class.new
+    PickupTimeout = Class.new
+    ResendNotification = Class.new
 
     execution_plan_hooks.use :cleanup, :on => :stopped
 
@@ -17,9 +19,20 @@ module Proxy::RemoteExecution::Ssh::Actions
       if event == JobDelivered
         output[:state] = :delivered
         suspend
+      elsif event == PickupTimeout
+        process_pickup_timeout
+      elsif event == ResendNotification
+        if input[:with_mqtt] && %w(ready_for_pickup notified).include?(output[:state])
+          schedule_mqtt_resend
+          mqtt_start(::Proxy::Dynflow::OtpManager.passwords[execution_plan_id])
+        end
+        suspend
       else
         super
       end
+    rescue => e
+      action_logger.error(e)
+      process_update(Proxy::Dynflow::Runner::Update.encode_exception('Proxy error', e))
     end
 
     def init_run
@@ -27,10 +40,15 @@ module Proxy::RemoteExecution::Ssh::Actions
                        ::Proxy::Dynflow::OtpManager.generate_otp(execution_plan_id)
                      end
 
-      input[:job_uuid] = job_storage.store_job(host_name, execution_plan_id, run_step_id, input[:script].tr("\r", ''))
+      plan_event(PickupTimeout, input[:time_to_pickup], optional: true) if input[:time_to_pickup]
+
+      input[:job_uuid] = job_storage.store_job(host_name, execution_plan_id, run_step_id, input[:script].tr("\r", ''), effective_user: input[:effective_user])
       output[:state] = :ready_for_pickup
       output[:result] = []
-      mqtt_start(otp_password) if input[:with_mqtt]
+      if input[:with_mqtt]
+        schedule_mqtt_resend
+        mqtt_start(otp_password)
+      end
       suspend
     end
 
@@ -103,6 +121,8 @@ module Proxy::RemoteExecution::Ssh::Actions
           'username': execution_plan_id,
           'password': otp_password,
           'return_url': "#{input[:proxy_url]}/ssh/jobs/#{input[:job_uuid]}/update",
+          'version': 'v1',
+          'effective_user': input[:effective_user]
         },
       )
       mqtt_notify payload
@@ -164,5 +184,17 @@ module Proxy::RemoteExecution::Ssh::Actions
         directive: 'foreman'
       }
     end
+
+    def process_pickup_timeout
+      if output[:state] != :delivered
+        raise "The job was not picked up in time"
+      else
+        suspend
+      end
+    end
+
+    def schedule_mqtt_resend
+      plan_event(ResendNotification, settings[:mqtt_resend_interval], optional: true)
+    end
   end
 end

data/lib/smart_proxy_remote_execution_ssh/api.rb

@@ -65,6 +65,7 @@ module Proxy::RemoteExecution
 
         with_authorized_job(job_uuid) do |job_record|
           notify_job(job_record, Actions::PullScript::JobDelivered)
+          response.headers['X-Foreman-Effective-User'] = job_record[:effective_user]
           job_record[:job]
         end
       end

data/lib/smart_proxy_remote_execution_ssh/command_logging.rb

@@ -14,7 +14,7 @@ module Proxy::RemoteExecution::Ssh::Runners
           logger.debug(line.chomp) if user_method.nil? || !user_method.filter_password?(line)
           user_method.on_data(data, pm.stdin) if user_method
         end
-        ''
+        data
       end
       pm.on_stdout(&callback)
       pm.on_stderr(&callback)

data/lib/smart_proxy_remote_execution_ssh/job_storage.rb

@@ -11,6 +11,7 @@ module Proxy::RemoteExecution::Ssh
         String :hostname, null: false, index: true
         String :execution_plan_uuid, fixed: true, size: 36, null: false, index: true
         Integer :run_step_id, null: false
+        String :effective_user
         String :job, text: true
       end
     end
@@ -24,13 +25,14 @@ module Proxy::RemoteExecution::Ssh
                              .select_map(:uuid)
     end
 
-    def store_job(hostname, execution_plan_uuid, run_step_id, job, uuid: SecureRandom.uuid, timestamp: Time.now.utc)
+    def store_job(hostname, execution_plan_uuid, run_step_id, job, uuid: SecureRandom.uuid, timestamp: Time.now.utc, effective_user: nil)
       jobs.insert(timestamp: timestamp,
                   uuid: uuid,
                   hostname: hostname,
                   execution_plan_uuid: execution_plan_uuid,
                   run_step_id: run_step_id,
-                  job: job)
+                  job: job,
+                  effective_user: effective_user)
       uuid
     end
 

data/lib/smart_proxy_remote_execution_ssh/multiplexed_ssh_connection.rb

@@ -32,7 +32,7 @@ module Proxy::RemoteExecution::Ssh::Runners
       return [] unless @password
 
       prompt = ['-P', @prompt] if @prompt
-      [{'SSHPASS' => SensitiveString.new(@password)}, '/usr/bin/sshpass', '-e', prompt].compact
+      [{'SSHPASS' => SensitiveString.new(@password)}, 'sshpass', '-e', prompt].compact
     end
 
     def ssh_options
@@ -93,7 +93,7 @@ module Proxy::RemoteExecution::Ssh::Runners
     def command(cmd)
       raise "Cannot build command to run over multiplexed connection without having an established connection" unless connected?
 
-      ['/usr/bin/ssh', reuse_ssh_options, cmd].flatten
+      ['ssh', reuse_ssh_options, cmd].flatten
     end
 
     private
@@ -103,7 +103,7 @@ module Proxy::RemoteExecution::Ssh::Runners
       # does not close its stderr which trips up the process manager which
       # expects all FDs to be closed
 
-      full_command = [method.ssh_command_prefix, '/usr/bin/ssh', establish_ssh_options, method.ssh_options, @host, 'true'].flatten
+      full_command = [method.ssh_command_prefix, 'ssh', establish_ssh_options, method.ssh_options, @host, 'true'].flatten
       log_command(full_command)
       pm = Proxy::Dynflow::ProcessManager.new(full_command)
       pm.start!
@@ -166,7 +166,7 @@ module Proxy::RemoteExecution::Ssh::Runners
     end
 
     def verify_key_passphrase
-      command = ['/usr/bin/ssh-keygen', '-y', '-f', File.expand_path(@client_private_key_file)]
+      command = ['ssh-keygen', '-y', '-f', File.expand_path(@client_private_key_file)]
       log_command(command, label: "Checking if private key has passphrase")
       pm = Proxy::Dynflow::ProcessManager.new(command)
       pm.start!

data/lib/smart_proxy_remote_execution_ssh/plugin.rb

@@ -25,7 +25,8 @@ module Proxy::RemoteExecution::Ssh
                      # :mqtt_broker             => nil,
                      # :mqtt_port               => nil,
                      # :mqtt_tls                => nil,
-                     :mode                    => :ssh
+                     :mode                    => :ssh,
+                     :mqtt_resend_interval    => 900
 
     capability(proc { 'cockpit' if settings.cockpit_integration })
 

data/lib/smart_proxy_remote_execution_ssh/runners/polling_script_runner.rb

@@ -133,7 +133,6 @@ module Proxy::RemoteExecution::Ssh::Runners
     def cleanup
       if @cleanup_working_dirs
         ensure_remote_command("rm -rf #{remote_command_dir}",
-                              publish: true,
                               error: "Unable to remove working directory #{remote_command_dir} on remote system, exit code: %{exit_code}")
       end
     end

data/lib/smart_proxy_remote_execution_ssh/version.rb

@@ -1,7 +1,7 @@
 module Proxy
   module RemoteExecution
     module Ssh
-      VERSION = '0.8.0'
+      VERSION = '0.9.0'
     end
   end
 end

data/settings.d/remote_execution_ssh.yml.example

@@ -32,3 +32,7 @@
 # unset, SSL gets used if smart-proxy's foreman_ssl_cert, foreman_ssl_key and
 # foreman_ssl_ca settings are set available.
 # :mqtt_tls:
+
+# The notification is sent over mqtt every $mqtt_resend_interval seconds, until
+# the job is picked up by the host or cancelled
+# :mqtt_resend_interval: 900

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_remote_execution_ssh
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Ssh remote execution provider for Foreman Smart-Proxy