smart_proxy_remote_execution_ssh 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048f8694430967060fae6bd7790fe56930b5c2bac37f3bc26e7b13db69081da6'
-  data.tar.gz: 5a3b1e344a47aa4c97dcce97f43dc9e424d398f79c67a6f1e066d670758c99f0
+  metadata.gz: debc9989aade4d23bda1b90e9fa8e85c99948f5b9ca37d6cecca7573bb994e5e
+  data.tar.gz: 38a2731c7f28643daaa33ddd29f93172b7467877f36b12c750b82f86e921c04d
 SHA512:
-  metadata.gz: a4bc90b3dda6d190c8f94aeb6731a3a6679788ea4f950e1bb4196c1d5da4630b170fe152e9c96a5e4cb7dcd25ba1d6371292e52b4059773759c1fbe8461bd347
-  data.tar.gz: f4849b32f7529cbb29d127ae1c4c9fd9642b0700c834b1e3eebf59b5d9cfca282fca674188a734a37b36d45ff3e423096aa3512ceae118aef7ff831cb1600a38
+  metadata.gz: a3f5776ce0f6ad361f2c344d0ff5d5cef9b6b032e23dc42ae0e877298abd9e95c0156c77334b106036f376e62c60c01ab13344d6bda53baa52c93c7caba79b71
+  data.tar.gz: d1de077038e5fce86df1871e4702e2abb4c7de4937f66aa8730803bb4542aa8f26c1c848d24bb74db1ce5594514d3a552b92b7ad315d346ead5e7586cb20da20

data/lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb

@@ -4,9 +4,20 @@ require 'time'
 
 module Proxy::RemoteExecution::Ssh::Actions
   class PullScript < Proxy::Dynflow::Action::Runner
+    include ::Dynflow::Action::Timeouts
+
     JobDelivered = Class.new
     PickupTimeout = Class.new
 
+    # The proxy has the job stored in its job storage
+    READY_FOR_PICKUP = 'ready_for_pickup'
+    # The host was notified over MQTT at least once
+    NOTIFIED = 'notified'
+    # The host has picked up the job
+    DELIVERED = 'delivered'
+    # We received at least one output from the host
+    RUNNING = 'running'
+
     execution_plan_hooks.use :cleanup, :on => :stopped
 
     def plan(action_input, mqtt: false)
@@ -16,14 +27,22 @@ module Proxy::RemoteExecution::Ssh::Actions
 
     def run(event = nil)
       if event == JobDelivered
-        output[:state] = :delivered
+        output[:state] = DELIVERED
         suspend
       elsif event == PickupTimeout
         process_pickup_timeout
+      elsif event == ::Dynflow::Action::Timeouts::Timeout
+        process_timeout
+      elsif event.nil?
+        if (timeout = input['execution_timeout_interval'])
+          schedule_timeout(timeout, optional: true)
+        end
+        super
       else
         super
       end
     rescue => e
+      cleanup
       action_logger.error(e)
       process_update(Proxy::Dynflow::Runner::Update.encode_exception('Proxy error', e))
     end
@@ -36,7 +55,7 @@ module Proxy::RemoteExecution::Ssh::Actions
       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[:state] = READY_FOR_PICKUP
       output[:result] = []
 
       mqtt_start(otp_password) if input[:with_mqtt]
@@ -50,7 +69,7 @@ module Proxy::RemoteExecution::Ssh::Actions
     end
 
     def process_external_event(event)
-      output[:state] = :running
+      output[:state] = RUNNING
       data = event.data
       case data['version']
       when nil
@@ -89,19 +108,34 @@ module Proxy::RemoteExecution::Ssh::Actions
       process_update(Proxy::Dynflow::Runner::Update.new(continuous_output, exit_code))
     end
 
-    def kill_run
+    def process_timeout
+      kill_run "Execution timeout exceeded"
+    end
+
+    def kill_run(fail_msg = 'The job was cancelled by the user')
+      continuous_output = Proxy::Dynflow::ContinuousOutput.new
+      exit_code = nil
+
       case output[:state]
-      when :ready_for_pickup
+      when READY_FOR_PICKUP, NOTIFIED
         # If the job is not running yet on the client, wipe it from storage
         cleanup
-        # TODO: Stop the action
-      when :notified, :running
+        exit_code = 'EXCEPTION'
+      when DELIVERED, RUNNING
         # Client was notified or is already running, dealing with this situation
         # is only supported if mqtt is available
         # Otherwise we have to wait it out
-        mqtt_cancel if input[:with_mqtt]
+        if input[:with_mqtt]
+          mqtt_cancel 
+          fail_msg += ', notifying the host over MQTT'
+        else
+          fail_msg += ', however the job was triggered without MQTT and cannot be stopped'
+        end
       end
-      suspend
+      continuous_output.add_output(fail_msg + "\n")
+      process_update(Proxy::Dynflow::Runner::Update.new(continuous_output, exit_code))
+
+      suspend unless exit_code
     end
 
     def mqtt_start(otp_password)
@@ -118,12 +152,12 @@ module Proxy::RemoteExecution::Ssh::Actions
         },
       )
       Proxy::RemoteExecution::Ssh::MQTT::Dispatcher.instance.new(input[:job_uuid], mqtt_topic, payload)
-      output[:state] = :notified
+      output[:state] = NOTIFIED
     end
 
     def mqtt_cancel
-      cleanup
       payload = mqtt_payload_base.merge(
+        content: "#{input[:proxy_url]}/ssh/jobs/#{input[:job_uuid]}/cancel",
         metadata: {
           'event': 'cancel',
           'job_uuid': input[:job_uuid]
@@ -163,11 +197,9 @@ module Proxy::RemoteExecution::Ssh::Actions
     end
 
     def process_pickup_timeout
-      if output[:state] != :delivered
-        raise "The job was not picked up in time"
-      else
-        suspend
-      end
+      suspend unless [READY_FOR_PICKUP, NOTIFIED].include? output[:state]
+
+      kill_run 'The job was not picked up in time'
     end
   end
 end

data/lib/smart_proxy_remote_execution_ssh/api.rb

@@ -71,6 +71,14 @@ module Proxy::RemoteExecution
         end
       end
 
+      get "/jobs/:job_uuid/cancel" do |job_uuid|
+        do_authorize_with_ssl_client
+
+        with_authorized_job(job_uuid) do |job_record|
+          {}
+        end
+      end
+
       private
 
       def notify_job(job_record, event)

data/lib/smart_proxy_remote_execution_ssh/multiplexed_ssh_connection.rb

@@ -154,6 +154,8 @@ module Proxy::RemoteExecution::Ssh::Runners
       ssh_options << "-o ControlPath=#{socket_file}"
       ssh_options << "-o ControlPersist=yes"
       ssh_options << "-o ProxyCommand=none"
+      ssh_options << "-o ServerAliveInterval=15"
+      ssh_options << "-o ServerAliveCountMax=3" # This is the default, but let's be explicit
       @establish_ssh_options = ssh_options
     end
 

data/lib/smart_proxy_remote_execution_ssh/version.rb

@@ -1,7 +1,7 @@
 module Proxy
   module RemoteExecution
     module Ssh
-      VERSION = '0.10.0'
+      VERSION = '0.10.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_remote_execution_ssh
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler