foreman_remote_execution_core 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40dc9b4977c799a3f8ad7bccb38fc4b8cc32134b
-  data.tar.gz: 5ae9fe01a1989c2d2cfc9d68d4eae023e5cdc903
+  metadata.gz: 3216a936b41179b58d8ae81a238d2fbdaff11e56
+  data.tar.gz: aec1f9700b5a9f7daa4fbe6259dc8e2d64943b30
 SHA512:
-  metadata.gz: 6b3c4731a69062ca30bbc023abe2aed22f2e9be5d7ab7e067fc8c14133cb57c16f5fe70c4bceaf10abafe9717755139e246f470e08e28ba69f67b6aeb711be50
-  data.tar.gz: da984876ee96f01b82d2b6f53091e8346a5a87863cb6235b35d5cb7f145bde1b99a9e99765cba67fe4cd922c655082daa8db02b81f028e4b2c26e4e766ba93e4
+  metadata.gz: 2eadacdd4acfd582061150991734a46ac53909874379c0cf7f4562089aa32342511875773c84134c97f2e2910ae9bd94aeb21c6726c0a7652dc93ccdb808a282
+  data.tar.gz: 6f6666aedd9474440e52a15f2927e5e279e439e75fb475e8bb9b747b921d83cb003a978b50d80596858845c06d581c51e68d59f1fc75697264a4e062cc8a8490

data/lib/foreman_remote_execution_core.rb

@@ -8,9 +8,22 @@ module ForemanRemoteExecutionCore
                     :remote_working_dir    => '/var/tmp',
                     :local_working_dir     => '/var/tmp')
 
+  def self.simulate?
+    %w(yes true 1).include? ENV.fetch('REX_SIMULATE', '').downcase
+  end
+
+  def self.runner_class
+    @runner_class ||= simulate? ? FakeScriptRunner : ScriptRunner
+  end
+
   if ForemanTasksCore.dynflow_present?
     require 'foreman_tasks_core/runner'
-    require 'foreman_remote_execution_core/script_runner'
+    if simulate?
+      # Load the fake implementation of the script runner if debug is enabled
+      require 'foreman_remote_execution_core/fake_script_runner'
+    else
+      require 'foreman_remote_execution_core/script_runner'
+    end
     require 'foreman_remote_execution_core/actions'
   end
 

data/lib/foreman_remote_execution_core/actions.rb

@@ -4,7 +4,7 @@ module ForemanRemoteExecutionCore
   module Actions
     class RunScript < ForemanTasksCore::Runner::Action
       def initiate_runner
-        ScriptRunner.new(input)
+        ForemanRemoteExecutionCore.runner_class.new(input)
       end
     end
   end

data/lib/foreman_remote_execution_core/fake_script_runner.rb

@@ -0,0 +1,82 @@
+module ForemanRemoteExecutionCore
+  class FakeScriptRunner < ForemanTasksCore::Runner::Base
+
+    @data = []
+
+    class << self
+      attr_accessor :data
+
+      def load_data(path = nil)
+        if path.nil?
+          @data = <<-END.gsub(/^\s+\| ?/, '').lines
+            | ====== Simulated Remote Execution ======
+            |
+            | This is an output of a simulated remote
+            | execution run. It should run for about
+            | 5 seconds and finish successfully.
+          END
+        else
+          File.open(File.expand_path(path), 'r') do |f|
+            @data = f.readlines.map(&:chomp)
+          end
+        end
+        @data.freeze
+      end
+    end
+
+    def initialize(*args)
+      super
+      # Load the fake output the first time its needed
+      self.class.load_data(ENV['REX_SIMULATE_PATH']) unless self.class.data.frozen?
+      @position = 0
+    end
+
+    def start
+      refresh
+    end
+
+    # Do one step
+    def refresh
+      if done?
+        finish
+      else
+        step
+      end
+    end
+
+    def kill
+      finish
+    end
+
+    private
+
+    def finish
+      publish_exit_status exit_code
+    end
+
+    def step
+      publish_data(next_chunk, 'stdout')
+    end
+
+    def done?
+      @position == self.class.data.count
+    end
+
+    def next_chunk
+      output = self.class.data[@position]
+      @position += 1
+      output
+    end
+
+    # Decide if the execution should fail or not
+    def exit_code
+      fail_chance   = ENV.fetch('REX_SIMULATE_FAIL_CHANCE', 0).to_i
+      fail_exitcode = ENV.fetch('REX_SIMULATE_EXIT', 0)
+      if fail_exitcode == 0 || fail_chance < (Random.rand * 100).round
+        0
+      else
+        fail_exitcode
+      end
+    end
+  end
+end

data/lib/foreman_remote_execution_core/script_runner.rb

@@ -1,5 +1,4 @@
 require 'net/ssh'
-require 'net/scp'
 
 module ForemanRemoteExecutionCore
   class ScriptRunner < ForemanTasksCore::Runner::Base
@@ -28,7 +27,7 @@ module ForemanRemoteExecutionCore
 
       # pipe the output to tee while capturing the exit code in a file
       script = <<-SCRIPT
-          (#{su_prefix}#{remote_script}; echo $?>#{exit_code_path}) | /usr/bin/tee #{output_path}
+          (#{su_prefix}#{remote_script} < /dev/null; echo $?>#{exit_code_path}) | /usr/bin/tee #{output_path}
           exit $(< #{exit_code_path})
       SCRIPT
 
@@ -148,13 +147,18 @@ module ForemanRemoteExecutionCore
       return true
     end
 
-    def run_sync(command)
-      output = ""
+    def run_sync(command, stdin = nil)
+      stdout = ""
+      stderr = ""
       exit_status = nil
+      started = false
+
       channel = session.open_channel do |ch|
-        ch.on_data { |data| output.concat(data) }
-        ch.on_extended_data { |_, _, data| output.concat(data) }
+        ch.on_data { |_, data| stdout.concat(data) }
+        ch.on_extended_data { |_, _, data| stderr.concat(data) }
         ch.on_request("exit-status") { |_, data| exit_status = data.read_long }
+        # Send data to stdin if we have some
+        ch.send_data(stdin) unless stdin.nil?
         # on signal: sending the signal value (such as 'TERM')
         ch.on_request("exit-signal") do |_, data|
           exit_status = data.read_string
@@ -163,10 +167,14 @@ module ForemanRemoteExecutionCore
         end
         ch.exec command do |_, success|
           raise "could not execute command" unless success
+          started = true
         end
       end
+      session.process(0) until started
+      # Closing the channel without sending any data gives us SIGPIPE
+      channel.close unless stdin.nil?
       channel.wait
-      return exit_status, output
+      return exit_status, stdout, stderr
     end
 
     def su_prefix
@@ -215,29 +223,36 @@ module ForemanRemoteExecutionCore
     end
 
     def cp_script_to_remote
-      local_script_file = write_command_file_locally('script', sanitize_script(@script))
-      File.chmod(0555, local_script_file)
-      remote_script_file = remote_command_file('script')
-      upload_file(local_script_file, remote_script_file)
-      return remote_script_file
+      upload_data(sanitize_script(@script), remote_command_file('script'), 555)
     end
 
-    def upload_file(local_path, remote_path)
-      ensure_remote_directory(File.dirname(remote_path))
-      scp = Net::SCP.new(session)
-      upload_channel = scp.upload(local_path, remote_path)
-      upload_channel.wait
-    ensure
-      if upload_channel
-        upload_channel.close
-        upload_channel.wait
+    def upload_data(data, path, permissions = 555)
+      ensure_remote_directory File.dirname(path)
+      # We use tee here to pipe stdin coming from ssh to a file at $path, while silencing its output
+      # This is used to write to $path with elevated permissions, solutions using cat and output redirection
+      # would not work, because the redirection would happen in the non-elevated shell.
+      command = "#{su_prefix} tee '#{path}' >/dev/null && #{su_prefix} chmod '#{permissions}' '#{path}'"
+
+      @logger.debug("Sending data to #{path} on remote host:\n#{data}")
+      status, _out, err = run_sync(command, data)
+
+      @logger.warn("Output on stderr while uploading #{path}:\n#{err}") unless err.empty?
+      if status != 0
+        raise "Unable to upload file to #{path} on remote system: exit code: #{status}"
       end
+      path
+    end
+
+    def upload_file(local_path, remote_path)
+      mode = File.stat(local_path).mode.to_s(8)[-3..-1]
+      @logger.debug('Uploading local file: #{local_path} as #{remote_path} with #{mode} permissions')
+      upload_data(File.read(local_path), remote_path, mode)
     end
 
     def ensure_remote_directory(path)
-      exit_code, output = run_sync("mkdir -p #{path}")
+      exit_code, _output, err = run_sync("mkdir -p #{path}")
       if exit_code != 0
-        raise "Unable to create directory on remote system #{path}: exit code: #{exit_code}\n #{output}"
+        raise "Unable to create directory on remote system #{path}: exit code: #{exit_code}\n #{err}"
       end
     end
 

data/lib/foreman_remote_execution_core/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecutionCore
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution_core
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |2
-    Ssh remote execution provider code sharable between Foreman and Foreman-Proxy
+description: "  Ssh remote execution provider code sharable between Foreman and Foreman-Proxy\n"
 email:
 - inecas@redhat.com
 executables: []
@@ -63,6 +62,7 @@ files:
 - LICENSE
 - lib/foreman_remote_execution_core.rb
 - lib/foreman_remote_execution_core/actions.rb
+- lib/foreman_remote_execution_core/fake_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
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Foreman remote execution - core bits