foreman_remote_execution_core 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a81b2a41e08c662ce352dd037d625bd42cb9d53a
-  data.tar.gz: a5294079e9132731210ebe670f2f7c1810639cdb
+  metadata.gz: 3da26d7438bb0f37e70f72eff0be70fa47601eaa
+  data.tar.gz: b23e6453a1df9b201e33653c1af7309421b06755
 SHA512:
-  metadata.gz: 04e246d897664d62109be19680cb4c973dac71868385b228f1257de2d923a8523fc12d9cdbbb2c167de092f8703fcea26459d0363ac8f005344d40a1afe8b484
-  data.tar.gz: 8ab7a7eb9c9accc486c975896aaf70f3671e95ca1ab2f9509d56832c6985185e45a74c0b5a4fe7fef11aa4c9f30e97ffca62d995889e16b8d03967c157a871d5
+  metadata.gz: 4c7cdca98c404df5cd8e45aaf944044a611161b7de2d75373846bf0968cb1cfcf33b9af3185288b5e4cc70ad92e7bd68ce5a652cd981700e85c2dbef399f6489
+  data.tar.gz: 5acc08e7302f5f58b27129980fcc39f4e98ec7c7dfc82877c1fa466a1039124d42f1dede0835319f12c8b5c34419b3e01ba8b17581d14a4ec2743c5527845b78

data/lib/foreman_remote_execution_core.rb

@@ -3,18 +3,27 @@ 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)
+                    :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)
 
   def self.simulate?
     %w(yes true 1).include? ENV.fetch('REX_SIMULATE', '').downcase
   end
 
   def self.runner_class
-    @runner_class ||= simulate? ? FakeScriptRunner : ScriptRunner
+    @runner_class ||= if simulate?
+                        FakeScriptRunner
+                      elsif settings[:async_ssh]
+                        PollingScriptRunner
+                      else
+                        ScriptRunner
+                      end
   end
 
   if ForemanTasksCore.dynflow_present?
@@ -24,7 +33,9 @@ module ForemanRemoteExecutionCore
       require 'foreman_remote_execution_core/fake_script_runner'
     else
       require 'foreman_remote_execution_core/script_runner'
+      require 'foreman_remote_execution_core/polling_script_runner'
     end
+    require 'foreman_remote_execution_core/dispatcher'
     require 'foreman_remote_execution_core/actions'
   end
 

data/lib/foreman_remote_execution_core/actions.rb

@@ -4,7 +4,15 @@ module ForemanRemoteExecutionCore
   module Actions
     class RunScript < ForemanTasksCore::Runner::Action
       def initiate_runner
-        ForemanRemoteExecutionCore.runner_class.new(input)
+        additional_options = {
+          :step_id => run_step_id,
+          :uuid => execution_plan_id
+        }
+        ForemanRemoteExecutionCore.runner_class.new(input.merge(additional_options))
+      end
+
+      def runner_dispatcher
+        ForemanRemoteExecutionCore::Dispatcher.instance
       end
     end
   end

data/lib/foreman_remote_execution_core/dispatcher.rb

@@ -0,0 +1,12 @@
+require 'foreman_tasks_core/runner/dispatcher'
+
+module ForemanRemoteExecutionCore
+  class Dispatcher < ::ForemanTasksCore::Runner::Dispatcher
+
+    def refresh_interval
+      @refresh_interval ||= ForemanRemoteExecutionCore.settings[:runner_refresh_interval] ||
+                              ForemanRemoteExecutionCore.runner_class::DEFAULT_REFRESH_INTERVAL
+    end
+
+  end
+end

data/lib/foreman_remote_execution_core/polling_script_runner.rb

@@ -0,0 +1,125 @@
+module ForemanRemoteExecutionCore
+  class PollingScriptRunner < ScriptRunner
+
+    DEFAULT_REFRESH_INTERVAL = 60
+
+    def initialize(options = {})
+      super(options)
+      @callback_host = options[:callback_host]
+      @task_id = options[:uuid]
+      @step_id = options[:step_id]
+      @otp = ForemanTasksCore::OtpManager.generate_otp(@task_id)
+    end
+
+    def prepare_start
+      super
+      basedir         = File.dirname @remote_script
+      @pid_path       = File.join(basedir, 'pid')
+      @retrieval_script ||= File.join(basedir, 'retrieve')
+      prepare_retrieval unless @prepared
+    end
+
+    def control_script
+      close_stdin = '</dev/null'
+      close_fds = close_stdin + ' >/dev/null 2>/dev/null'
+      # pipe the output to tee while capturing the exit code in a file, don't wait for it to finish, output PID of the main command
+      <<-SCRIPT.gsub(/^\s+\| /, '')
+      | sh -c '(#{su_prefix}#{@remote_script} #{close_stdin}; echo $?>#{@exit_code_path}) | /usr/bin/tee #{@output_path} >/dev/null; #{callback_scriptlet}' #{close_fds} &
+      | echo $! > '#{@pid_path}'
+      SCRIPT
+    end
+
+    def trigger(*args)
+      run_sync(*args)
+    end
+
+    def refresh
+      err = output = nil
+      with_retries do
+        _, output, err = run_sync("#{su_prefix} #{@retrieval_script}")
+      end
+      lines = output.lines
+      result = lines.shift.match(/^DONE (\d+)?/)
+      publish_data(lines.join, 'stdout') unless lines.empty?
+      publish_data(err, 'stderr') unless err.empty?
+      if result
+        exitcode = result[1] || 0
+        publish_exit_status(exitcode.to_i)
+      end
+      destroy_session
+    end
+
+    def close
+      super
+      ForemanTasksCore::OtpManager.drop_otp(@task_id, @otp) if @otp
+    end
+
+    def prepare_retrieval
+      # The script always outputs at least one line
+      # First line of the output either has to begin with
+      # "RUNNING" or "DONE $EXITCODE"
+      # The following lines are treated as regular output
+      base = File.dirname(@output_path)
+      posfile = File.join(base, 'position')
+      tmpfile = File.join(base, 'tmp')
+      script = <<-SCRIPT.gsub(/^ +\| /, '')
+      | #!/bin/sh
+      | pid=$(cat "#{@pid_path}")
+      | if ! pgrep --help 2>/dev/null >/dev/null; then
+      |   echo DONE 1
+      |   echo "pgrep is required" >&2
+      |   exit 1
+      | fi
+      | if pgrep -P "$pid" >/dev/null 2>/dev/null; then
+      |   echo RUNNING
+      | else
+      |   echo "DONE $(cat "#{@exit_code_path}" 2>/dev/null)"
+      | fi
+      | [ -f "#{@output_path}" ] || exit 0
+      | [ -f "#{posfile}" ] || echo 1 > "#{posfile}"
+      | position=$(cat "#{posfile}")
+      | tail --bytes "+${position}" "#{@output_path}" > "#{tmpfile}"
+      | bytes=$(cat "#{tmpfile}" | wc --bytes)
+      | expr "${position}" + "${bytes}" > "#{posfile}"
+      | cat "#{tmpfile}"
+      SCRIPT
+      @logger.debug("copying script:\n#{script.lines.map { |line| "    | #{line}" }.join}")
+      cp_script_to_remote(script, 'retrieve')
+      @prepared = true
+    end
+
+    def callback_scriptlet(callback_script_path = nil)
+      if @otp
+        callback_script_path = cp_script_to_remote(callback_script, 'callback') if callback_script_path.nil?
+        "#{su_prefix}#{callback_script_path}"
+      else
+        ':' # Shell synonym for "do nothing"
+      end
+    end
+
+    def callback_script
+      <<-SCRIPT.gsub(/^ +\| /, '')
+      | #!/bin/sh
+      | exit_code=$(cat "#{@exit_code_path}")
+      | url="#{@callback_host}/dynflow/tasks/#{@task_id}/done"
+      | json="{ \\\"step_id\\\": #{@step_id} }"
+      | if which curl >/dev/null; then
+      |   curl -X POST -d "$json" -u "#{@task_id}:#{@otp}" "$url"
+      | else
+      |   echo 'curl is required' >&2
+      |   exit 1
+      | fi
+      SCRIPT
+    end
+
+    private
+
+    def destroy_session
+      if @session
+        @logger.debug("Closing session with #{@ssh_user}@#{@host}")
+        @session.close
+        @session = nil
+      end
+    end
+  end
+end

data/lib/foreman_remote_execution_core/script_runner.rb

@@ -11,6 +11,7 @@ module ForemanRemoteExecutionCore
     attr_reader :execution_timeout_interval
 
     EXPECTED_POWER_ACTION_MESSAGES = ['restart host', 'shutdown host'].freeze
+    DEFAULT_REFRESH_INTERVAL = 1
 
     def initialize(options)
       super()
@@ -30,23 +31,33 @@ module ForemanRemoteExecutionCore
     end
 
     def start
-      remote_script = cp_script_to_remote
-      output_path = File.join(File.dirname(remote_script), 'output')
-      exit_code_path = File.join(File.dirname(remote_script), 'exit_code')
+      prepare_start
+      script = control_script
+      logger.debug("executing script:\n#{script.lines.map { |line| "  | #{line}" }.join}")
+      trigger(script)
+    rescue => e
+      logger.error("error while initalizing command #{e.class} #{e.message}:\n #{e.backtrace.join("\n")}")
+      publish_exception('Error initializing command', e)
+    end
+
+    def trigger(*args)
+      run_async(*args)
+    end
 
+    def prepare_start
+      @remote_script = cp_script_to_remote
+      @output_path = File.join(File.dirname(@remote_script), 'output')
+      @exit_code_path = File.join(File.dirname(@remote_script), 'exit_code')
+    end
+
+    def control_script
       # pipe the output to tee while capturing the exit code in a file
-      script = <<-SCRIPT.gsub(/^\s+\| /, '')
+      <<-SCRIPT.gsub(/^\s+\| /, '')
       | sh <<WRAPPER
-      | (#{su_prefix}#{remote_script} < /dev/null; echo \\$?>#{exit_code_path}) | /usr/bin/tee #{output_path}
-      | exit \\$(cat #{exit_code_path})
+      | (#{su_prefix}#{@remote_script} < /dev/null; echo \\$?>#{@exit_code_path}) | /usr/bin/tee #{@output_path}
+      | exit \\$(cat #{@exit_code_path})
       | WRAPPER
       SCRIPT
-
-      logger.debug("executing script:\n#{script.lines.map { |line| "  | #{line}" }.join}")
-      run_async(script)
-    rescue => e
-      logger.error("error while initalizing command #{e.class} #{e.message}:\n #{e.backtrace.join("\n")}")
-      publish_exception('Error initializing command', e)
     end
 
     def refresh
@@ -246,8 +257,8 @@ module ForemanRemoteExecutionCore
       return path
     end
 
-    def cp_script_to_remote
-      upload_data(sanitize_script(@script), remote_command_file('script'), 555)
+    def cp_script_to_remote(script = @script, name = 'script')
+      upload_data(sanitize_script(script), remote_command_file(name), 555)
     end
 
     def upload_data(data, path, permissions = 555)

data/lib/foreman_remote_execution_core/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecutionCore
-  VERSION = '1.0.5'.freeze
+  VERSION = '1.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution_core
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -49,7 +49,9 @@ files:
 - LICENSE
 - lib/foreman_remote_execution_core.rb
 - lib/foreman_remote_execution_core/actions.rb
+- lib/foreman_remote_execution_core/dispatcher.rb
 - lib/foreman_remote_execution_core/fake_script_runner.rb
+- lib/foreman_remote_execution_core/polling_script_runner.rb
 - lib/foreman_remote_execution_core/script_runner.rb
 - lib/foreman_remote_execution_core/version.rb
 homepage: https://github.com/theforeman/foreman_remote_execution
@@ -72,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Foreman remote execution - core bits