smart_proxy_remote_execution_ssh 0.3.2 → 0.5.1

data/lib/smart_proxy_remote_execution_ssh.rb

@@ -1,7 +1,7 @@
-require 'smart_proxy_remote_execution_ssh/version'
 require 'smart_proxy_dynflow'
-require 'smart_proxy_remote_execution_ssh/webrick_ext'
+require 'smart_proxy_remote_execution_ssh/version'
 require 'smart_proxy_remote_execution_ssh/plugin'
+require 'smart_proxy_remote_execution_ssh/webrick_ext'
 
 module Proxy::RemoteExecution
   module Ssh
@@ -19,6 +19,10 @@ module Proxy::RemoteExecution
         unless File.exist?(public_key_file)
           raise "Ssh public key file #{public_key_file} doesn't exist"
         end
+
+        validate_mode!
+        validate_ssh_log_level!
+        validate_mqtt_settings!
       end
 
       def private_key_file
@@ -28,6 +32,60 @@ module Proxy::RemoteExecution
       def public_key_file
         File.expand_path("#{private_key_file}.pub")
       end
+
+      def validate_mode!
+        Plugin.settings.mode = Plugin.settings.mode.to_sym
+
+        unless Plugin::MODES.include? Plugin.settings.mode
+          raise "Mode has to be one of #{Plugin::MODES.join(', ')}, given #{Plugin.settings.mode}"
+        end
+
+        if Plugin.settings.async_ssh
+          Plugin.logger.warn('Option async_ssh is deprecated, use ssh-async mode instead.')
+
+          case Plugin.settings.mode
+          when :ssh
+            Plugin.logger.warn('Deprecated option async_ssh used together with ssh mode, switching mode to ssh-async.')
+            Plugin.settings.mode = :'ssh-async'
+          when :'async-ssh'
+            # This is a noop
+          else
+            Plugin.logger.warn('Deprecated option async_ssh used together with incompatible mode, ignoring.')
+          end
+        end
+      end
+
+      def validate_mqtt_settings!
+        return unless Plugin.settings.mode == :'pull-mqtt'
+
+        raise 'mqtt_broker has to be set when pull-mqtt mode is used' if Plugin.settings.mqtt_broker.nil?
+        raise 'mqtt_port has to be set when pull-mqtt mode is used' if Plugin.settings.mqtt_port.nil?
+      end
+
+      def validate_ssh_log_level!
+        wanted_level = Plugin.settings.ssh_log_level.to_s
+        levels = Plugin::SSH_LOG_LEVELS
+        unless levels.include? wanted_level
+          raise "Wrong value '#{Plugin.settings.ssh_log_level}' for ssh_log_level, must be one of #{levels.join(', ')}"
+        end
+
+        current = ::Proxy::SETTINGS.log_level.to_s.downcase
+
+        # regular log levels correspond to upcased ssh logger levels
+        ssh, regular = [wanted_level, current].map do |wanted|
+          levels.each_with_index.find { |value, _index| value == wanted }.last
+        end
+
+        if ssh < regular
+          raise 'ssh_log_level cannot be more verbose than regular log level'
+        end
+
+        Plugin.settings.ssh_log_level = Plugin.settings.ssh_log_level.to_sym
+      end
+
+      def job_storage
+        @job_storage ||= Proxy::RemoteExecution::Ssh::JobStorage.new
+      end
     end
   end
 end

data/settings.d/remote_execution_ssh.yml.example

@@ -4,14 +4,23 @@
 :local_working_dir: '/var/tmp'
 :remote_working_dir: '/var/tmp'
 # :kerberos_auth: false
-# :async_ssh: false
+
+# Mode of operation, one of ssh, ssh-async, pull, pull-mqtt
+:mode: ssh
 
 # Defines how often (in seconds) should the runner check
 # for new data leave empty to use the runner's default
 # (1 second for regular, 60 seconds with async_ssh enabled)
 # :runner_refresh_interval:
 
-# Defines the verbosity of logging coming from Net::SSH
-# one of :debug, :info, :warn, :error, :fatal
+# Defines the verbosity of logging coming from ssh command
+# one of :debug, :info, :error, :fatal
 # must be lower than general log level
 # :ssh_log_level: fatal
+
+# Remove working directories on job completion
+# :cleanup_working_dirs: true
+
+# MQTT configuration, need to be set if mode is set to pull-mqtt
+# :mqtt_broker: localhost
+# :mqtt_port: 1883

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_remote_execution_ssh
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,16 +114,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: mqtt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -147,12 +161,26 @@ extra_rdoc_files:
 files:
 - LICENSE
 - README.md
-- bundler.plugins.d/remote_execution_ssh.rb
+- bundler.d/remote_execution_ssh.rb
 - lib/smart_proxy_remote_execution_ssh.rb
+- lib/smart_proxy_remote_execution_ssh/actions.rb
+- lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb
+- lib/smart_proxy_remote_execution_ssh/actions/run_script.rb
 - lib/smart_proxy_remote_execution_ssh/api.rb
+- lib/smart_proxy_remote_execution_ssh/async_scripts/control.sh
+- lib/smart_proxy_remote_execution_ssh/async_scripts/retrieve.sh
 - lib/smart_proxy_remote_execution_ssh/cockpit.rb
+- lib/smart_proxy_remote_execution_ssh/dispatcher.rb
 - lib/smart_proxy_remote_execution_ssh/http_config.ru
+- lib/smart_proxy_remote_execution_ssh/job_storage.rb
+- lib/smart_proxy_remote_execution_ssh/log_filter.rb
+- lib/smart_proxy_remote_execution_ssh/net_ssh_compat.rb
 - lib/smart_proxy_remote_execution_ssh/plugin.rb
+- lib/smart_proxy_remote_execution_ssh/runners.rb
+- lib/smart_proxy_remote_execution_ssh/runners/fake_script_runner.rb
+- lib/smart_proxy_remote_execution_ssh/runners/polling_script_runner.rb
+- lib/smart_proxy_remote_execution_ssh/runners/script_runner.rb
+- lib/smart_proxy_remote_execution_ssh/utils.rb
 - lib/smart_proxy_remote_execution_ssh/version.rb
 - lib/smart_proxy_remote_execution_ssh/webrick_ext.rb
 - settings.d/remote_execution_ssh.yml.example