foreman_remote_execution_core 1.3.0 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ae26d6b169ea807ed8b6eea817a6797dde93a11fff3ee5a29cf6794b5ea378
-  data.tar.gz: ccb07c483e5a2973c11641cb1bc6e6385fc2b33088a4fadbeb41fff60ef2fdff
+  metadata.gz: d8a10b6004e15a426a2cc6890ecc2f295497582e3e86b7086582c5a14514ca81
+  data.tar.gz: 9e9a14d930f04fe54bda984486184b84af2b2f55c17173e884db81ab20a8e8bd
 SHA512:
-  metadata.gz: 9f9b4d32165279cc36b5c59a7fa901a239c7a67643d4542b6713d1569624107f5e79091d16916a2a9695e20d78b405d1255c6f363e6130b6e0b73903e55deae3
-  data.tar.gz: 651c3382363f5684cb2c8f62ce16582cfe8b51dbb9479addb3cd8282c2d90d2e658c2e831a563ffce1cf3f67d5ac2884e2bb1c2eca0f836b2fce1ffe85edd1f3
+  metadata.gz: c2193c056505e25e362bcf7a76414bf066faaca554acce21fb768e53e118b14dc7978391650032fe113152ea482de56db1ac538fff8448c760f44ebc136a9f5b
+  data.tar.gz: 4b6c0e548b10fb1b29dae637b01308fea528ff84b4a7caf8fba7986bc69db30fe34dcf5c1da6fecb4defea66e05dc82a5ab3bc43c42a1bcef904ccdf2eb8815d

data/lib/foreman_remote_execution_core.rb

@@ -3,16 +3,16 @@ require 'foreman_tasks_core'
 module ForemanRemoteExecutionCore
   extend ForemanTasksCore::SettingsLoader
   register_settings([:remote_execution_ssh, :smart_proxy_remote_execution_ssh_core],
-                    :ssh_identity_key_file   => '~/.ssh/id_rsa_foreman_proxy',
-                    :ssh_user                => 'root',
-                    :remote_working_dir      => '/var/tmp',
-                    :local_working_dir       => '/var/tmp',
-                    :kerberos_auth           => false,
-                    :async_ssh               => false,
-                    # When set to nil, makes REX use the runner's default interval
-                    :runner_refresh_interval => nil,
-                    :ssh_log_level           => :fatal,
-                    :cleanup_working_dirs    => true)
+    :ssh_identity_key_file   => '~/.ssh/id_rsa_foreman_proxy',
+    :ssh_user                => 'root',
+    :remote_working_dir      => '/var/tmp',
+    :local_working_dir       => '/var/tmp',
+    :kerberos_auth           => false,
+    :async_ssh               => false,
+    # When set to nil, makes REX use the runner's default interval
+    :runner_refresh_interval => nil,
+    :ssh_log_level           => :fatal,
+    :cleanup_working_dirs    => true)
 
   SSH_LOG_LEVELS = %w(debug info warn error fatal).freeze
 
@@ -32,7 +32,9 @@ module ForemanRemoteExecutionCore
       raise "Wrong value '#{@settings[:ssh_log_level]}' for ssh_log_level, must be one of #{SSH_LOG_LEVELS.join(', ')}"
     end
 
-    current = if defined?(SmartProxyDynflowCore)
+    current = if defined?(::Proxy::SETTINGS)
+                ::Proxy::SETTINGS.log_level.to_s.downcase
+              elsif defined?(SmartProxyDynflowCore::SETTINGS)
                 SmartProxyDynflowCore::SETTINGS.log_level.to_s.downcase
               else
                 Rails.configuration.log_level.to_s
@@ -71,6 +73,13 @@ module ForemanRemoteExecutionCore
     require 'foreman_remote_execution_core/dispatcher'
     require 'foreman_remote_execution_core/actions'
 
+    # rubocop:disable Lint/SuppressedException
+    begin
+      require 'smart_proxy_dynflow_core/task_launcher_registry'
+    rescue LoadError
+    end
+    # rubocop:enable Lint/SuppressedException
+
     if defined?(::SmartProxyDynflowCore)
       SmartProxyDynflowCore::TaskLauncherRegistry.register('ssh', ForemanTasksCore::TaskLauncher::Batch)
     end

data/lib/foreman_remote_execution_core/actions.rb

@@ -6,10 +6,10 @@ module ForemanRemoteExecutionCore
       def initiate_runner
         additional_options = {
           :step_id => run_step_id,
-          :uuid => execution_plan_id
+          :uuid => execution_plan_id,
         }
         ForemanRemoteExecutionCore.runner_class.build(input.merge(additional_options),
-                                                      suspended_action: suspended_action)
+          suspended_action: suspended_action)
       end
 
       def runner_dispatcher

data/lib/foreman_remote_execution_core/log_filter.rb

@@ -4,10 +4,11 @@ module ForemanRemoteExecutionCore
       @base_logger = base_logger
     end
 
-    def add(severity, *args)
+    def add(severity, *args, &block)
       severity ||= ::Logger::UNKNOWN
       return true if @base_logger.nil? || severity < @level
-      @base_logger.add(severity, *args)
+
+      @base_logger.add(severity, *args, &block)
     end
   end
 end

data/lib/foreman_remote_execution_core/polling_script_runner.rb

@@ -58,6 +58,7 @@ module ForemanRemoteExecutionCore
         @logger.info("Error while connecting to the remote host on refresh: #{e.message}")
       end
       return if output.nil? || output.empty?
+
       lines = output.lines
       result = lines.shift.match(/^DONE (\d+)?/)
       publish_data(lines.join, 'stdout') unless lines.empty?
@@ -90,6 +91,7 @@ module ForemanRemoteExecutionCore
 
     def upload_control_scripts
       return if @control_scripts_uploaded
+
       cp_script_to_remote(env_script, 'env.sh')
       @control_script_path = cp_script_to_remote(CONTROL_SCRIPT, 'control.sh')
       @retrieval_script = cp_script_to_remote(RETRIEVE_SCRIPT, 'retrieve.sh')

data/lib/foreman_remote_execution_core/script_runner.rb

@@ -1,16 +1,14 @@
 require 'net/ssh'
 require 'fileutils'
 
-# rubocop:disable Lint/HandleExceptions
+# rubocop:disable Lint/SuppressedException
 begin
   require 'net/ssh/krb'
 rescue LoadError; end
-# rubocop:enable Lint/HandleExceptions:
+# rubocop:enable Lint/SuppressedException:
 
 module ForemanRemoteExecutionCore
-  class SudoUserMethod
-    LOGIN_PROMPT = 'rex login: '.freeze
-
+  class EffectiveUserMethod
     attr_reader :effective_user, :ssh_user, :effective_user_password, :password_sent
 
     def initialize(effective_user, ssh_user, effective_user_password)
@@ -27,66 +25,64 @@ module ForemanRemoteExecutionCore
       end
     end
 
-    def login_prompt
-      LOGIN_PROMPT
-    end
-
     def filter_password?(received_data)
-      !@effective_user_password.empty? && @password_sent && received_data.match(@effective_user_password)
+      !@effective_user_password.empty? && @password_sent && received_data.match(Regexp.escape(@effective_user_password))
     end
 
     def sent_all_data?
       effective_user_password.empty? || password_sent
     end
 
+    def reset
+      @password_sent = false
+    end
+
     def cli_command_prefix
-      "sudo -p '#{LOGIN_PROMPT}' -u #{effective_user} "
     end
 
-    def reset
-      @password_sent = false
+    def login_prompt
     end
   end
 
-  class DzdoUserMethod < SudoUserMethod
-    LOGIN_PROMPT = /password/i.freeze
+  class SudoUserMethod < EffectiveUserMethod
+    LOGIN_PROMPT = 'rex login: '.freeze
 
     def login_prompt
       LOGIN_PROMPT
     end
 
     def cli_command_prefix
-      "dzdo -u #{effective_user} "
+      "sudo -p '#{LOGIN_PROMPT}' -u #{effective_user} "
     end
   end
 
-  class SuUserMethod
-    attr_accessor :effective_user, :ssh_user
+  class DzdoUserMethod < EffectiveUserMethod
+    LOGIN_PROMPT = /password/i.freeze
 
-    def initialize(effective_user, ssh_user)
-      @effective_user = effective_user
-      @ssh_user = ssh_user
+    def login_prompt
+      LOGIN_PROMPT
     end
 
-    def on_data(_, _); end
-
-    def filter_password?(received_data)
-      false
+    def cli_command_prefix
+      "dzdo -u #{effective_user} "
     end
+  end
 
-    def sent_all_data?
-      true
+  class SuUserMethod < EffectiveUserMethod
+    LOGIN_PROMPT = /Password: /i.freeze
+
+    def login_prompt
+      LOGIN_PROMPT
     end
 
     def cli_command_prefix
       "su - #{effective_user} -c "
     end
-
-    def reset; end
   end
 
   class NoopUserMethod
-    def on_data(_, _); end
+    def on_data(_, _)
+    end
 
     def filter_password?(received_data)
       false
@@ -96,9 +92,11 @@ module ForemanRemoteExecutionCore
       true
     end
 
-    def cli_command_prefix; end
+    def cli_command_prefix
+    end
 
-    def reset; end
+    def reset
+    end
   end
 
   class ScriptRunner < ForemanTasksCore::Runner::Base
@@ -136,12 +134,13 @@ module ForemanRemoteExecutionCore
                       NoopUserMethod.new
                     elsif effective_user_method == 'sudo'
                       SudoUserMethod.new(effective_user, ssh_user,
-                                         options.fetch(:secrets, {}).fetch(:sudo_password, nil))
+                        options.fetch(:secrets, {}).fetch(:effective_user_password, nil))
                     elsif effective_user_method == 'dzdo'
                       DzdoUserMethod.new(effective_user, ssh_user,
-                                         options.fetch(:secrets, {}).fetch(:sudo_password, nil))
+                        options.fetch(:secrets, {}).fetch(:effective_user_password, nil))
                     elsif effective_user_method == 'su'
-                      SuUserMethod.new(effective_user, ssh_user)
+                      SuUserMethod.new(effective_user, ssh_user,
+                        options.fetch(:secrets, {}).fetch(:effective_user_password, nil))
                     else
                       raise "effective_user_method '#{effective_user_method}' not supported"
                     end
@@ -171,17 +170,17 @@ module ForemanRemoteExecutionCore
 
     # the script that initiates the execution
     def initialization_script
+      su_method = @user_method.instance_of?(ForemanRemoteExecutionCore::SuUserMethod)
       # pipe the output to tee while capturing the exit code in a file
       <<-SCRIPT.gsub(/^\s+\| /, '')
-      | sh <<WRAPPER
-      | (#{@user_method.cli_command_prefix}#{@remote_script} < /dev/null; echo \\$?>#{@exit_code_path}) | /usr/bin/tee #{@output_path}
-      | exit \\$(cat #{@exit_code_path})
-      | WRAPPER
+      | sh -c "(#{@user_method.cli_command_prefix}#{su_method ? "'#{@remote_script} < /dev/null '" : "#{@remote_script} < /dev/null"}; echo \\$?>#{@exit_code_path}) | /usr/bin/tee #{@output_path}
+      | exit \\$(cat #{@exit_code_path})"
       SCRIPT
     end
 
     def refresh
       return if @session.nil?
+
       with_retries do
         with_disconnect_handling do
           @session.process(0)
@@ -295,6 +294,7 @@ module ForemanRemoteExecutionCore
     # part of calling the `refresh` method.
     def run_async(command)
       raise 'Async command already in progress' if @started
+
       @started = false
       @user_method.reset
 
@@ -350,6 +350,7 @@ module ForemanRemoteExecutionCore
         end
         ch.exec command do |_, success|
           raise 'could not execute command' unless success
+
           started = true
         end
       end
@@ -413,6 +414,7 @@ module ForemanRemoteExecutionCore
       if status != 0
         raise "Unable to upload file to #{path} on remote system: exit code: #{status}"
       end
+
       path
     end
 
@@ -446,6 +448,7 @@ module ForemanRemoteExecutionCore
     def check_expecting_disconnect
       last_output = @continuous_output.raw_outputs.find { |d| d['output_type'] == 'stdout' }
       return unless last_output
+
       if EXPECTED_POWER_ACTION_MESSAGES.any? { |message| last_output['output'] =~ /^#{message}/ }
         @expecting_disconnect = true
       end

data/lib/foreman_remote_execution_core/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecutionCore
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.3'.freeze
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution_core
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.3
 platform: ruby
 authors:
 - Ivan Nečas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
   requirement: !ruby/object:Gem::Requirement
@@ -60,7 +88,7 @@ homepage: https://github.com/theforeman/foreman_remote_execution
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Foreman remote execution - core bits
 test_files: []