train 3.2.0 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8dd3de7c1923ee9b164a40fe8b3fb6bfdfe318c3b9cb3b322397551e8a17a5f
-  data.tar.gz: 7b3b63a44c454963d8b47b1c3e7772b17db8f73b20a6519da955a475823d6b3f
+  metadata.gz: 190dd867daf0d960422c03d54854a6da292346e9728e0c54c56ba733dcfd9746
+  data.tar.gz: 41822552cb18b121b2e75f16a34bf51c568c6eb9b5dff9a7bc75d4e365c9552f
 SHA512:
-  metadata.gz: 13928685d3aa1d35942241ce81be9cda15cbdfdfadf2e9c04fdb63da9d0573eba79bfb5431fb907ca57b0732c2a9a6be94abc60dd43261d950297ae764bd2d1e
-  data.tar.gz: 0eb217f2809ff17bc7a0715b9c49566a45d16db343131c208a6dabc9765771095020dc8618af13a3003e5e7c0c72d9804ae649bef56246fd3a77ee690e0e6d15
+  metadata.gz: 1b8eeb403d7ed720b53603b34ea6aff2f807c3de2c3145062da88669212dcc56ce54666436b39ce7b2b3ffdf8f983d04ae0a4a5743d01f78760689bc6790d165
+  data.tar.gz: 9477cfde739dffb54cee8c17c1540a8a903b6418b302b4f958251aa2498049c16ec698be72dcc0467a5e6e31fe0aa867cb0bcfebd3be82701af74948284891d7

data/lib/train/extras/command_wrapper.rb

@@ -28,32 +28,53 @@ module Train::Extras
   class LinuxCommand < CommandWrapperBase
     Train::Options.attach(self)
 
-    option :shell, default: false
+    option :shell,         default: false
     option :shell_options, default: nil
     option :shell_command, default: nil
-    option :sudo, default: false
-    option :sudo_options, default: nil
+    option :sudo,          default: false
+    option :sudo_options,  default: nil
     option :sudo_password, default: nil
-    option :sudo_command, default: nil
+    option :sudo_command,  default: nil
     option :user
 
+    attr_reader :backend
+
     def initialize(backend, options)
       @backend = backend
       validate_options(options)
 
-      @shell = options[:shell]
+      @shell         = options[:shell]
       @shell_options = options[:shell_options] # e.g. '--login'
       @shell_command = options[:shell_command] # e.g. '/bin/sh'
-      @sudo = options[:sudo]
-      @sudo_options = options[:sudo_options]
+      @sudo          = options[:sudo]
+      @sudo_options  = options[:sudo_options]
       @sudo_password = options[:sudo_password]
-      @sudo_command = options[:sudo_command]
-      @user = options[:user]
+      @sudo_command  = options[:sudo_command]
+      @user          = options[:user]
+    end
+
+    def with_sudo_pty
+      old_pty = backend.transport_options[:pty]
+      backend.transport_options[:pty] = true if @sudo
+
+      yield
+    ensure
+      backend.transport_options[:pty] = old_pty
     end
 
     # (see CommandWrapperBase::verify)
     def verify
-      res = @backend.run_command(run("echo"))
+      cmd = if @sudo
+              # Wrap it up. It needs /dev/null on the outside to disable stdin
+              "bash -c '(#{run("-v")}) < /dev/null'"
+            else
+              run("echo")
+            end
+
+      # rubocop:disable Style/BlockDelimiters
+      res = with_sudo_pty {
+        @backend.run_command(cmd)
+      }
       return nil if res.exit_status == 0
 
       rawerr = res.stdout + " " + res.stderr
@@ -96,9 +117,12 @@ module Train::Extras
 
       res = (@sudo_command || "sudo") + " "
 
-      res = "#{safe_string(@sudo_password + "\n")} | #{res}-S " unless @sudo_password.nil?
+      if @sudo_password
+        str = safe_string(@sudo_password + "\n")
+        res = "#{str} | #{res}-S "
+      end
 
-      res << @sudo_options.to_s + " " unless @sudo_options.nil?
+      res << "#{@sudo_options} " if @sudo_options
 
       res + cmd
     end
@@ -109,7 +133,7 @@ module Train::Extras
       return cmd unless @shell
 
       shell = @shell_command || "$SHELL"
-      options = " " + @shell_options.to_s unless @shell_options.nil?
+      options = " #{@shell_options}" if @shell_options
 
       "#{safe_string(cmd)} | #{shell}#{options}"
     end

data/lib/train/transports/local.rb

@@ -146,6 +146,12 @@ module Train::Transports
           raise PipeError if @pipe.nil?
         end
 
+        # @param  cmd The command to execute
+        # @return Local::ComandResult with stdout, stderr and exitstatus
+        #         Note that exitstatus ($?) in PowerShell is boolean, but we use a numeric exit code.
+        #         A command that succeeds without setting an exit code will have exitstatus 0
+        #         A command that exits with an exit code will have that value as exitstatus
+        #         A command that fails (e.g. throws exception) before setting an exit code will have exitstatus 1
         def run_command(cmd)
           script = "$ProgressPreference='SilentlyContinue';" + cmd
           encoded_script = Base64.strict_encode64(script)
@@ -199,10 +205,16 @@ module Train::Transports
               $scriptBlock = $ExecutionContext.InvokeCommand.NewScriptBlock($command)
               try {
                 $stdout = & $scriptBlock | Out-String
-                $result = @{ 'stdout' = $stdout ; 'stderr' = ''; 'exitstatus' = 0 }
+                $exit_code = $LastExitCode
+                if ($exit_code -eq $null)
+                {
+                  $exit_code = 0
+                }
+                $result = @{ 'stdout' = $stdout ; 'stderr' = ''; 'exitstatus' = $exit_code }
               } catch {
                 $stderr = $_ | Out-String
-                $result = @{ 'stdout' = ''; 'stderr' = $stderr; 'exitstatus' = 1 }
+                $exit_code = $LastExitCode
+                $result = @{ 'stdout' = ''; 'stderr' = $stderr; 'exitstatus' = $exit_code }
               }
               $resultJSON = $result | ConvertTo-JSON
 

data/lib/train/transports/ssh_connection.rb

@@ -31,11 +31,16 @@ class Train::Transports::SSH
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
     attr_reader :hostname
+    attr_reader :transport_options
+
     def initialize(options)
       # Track IOS command retries to prevent infinite loop on IOError. This must
       # be done before `super()` because the parent runs detection commands.
       @ios_cmd_retries = 0
+
       super(options)
+
+      @session                = nil
       @username               = @options.delete(:username)
       @hostname               = @options.delete(:hostname)
       @port                   = @options[:port] # don't delete from options
@@ -43,13 +48,12 @@ class Train::Transports::SSH
       @connection_retry_sleep = @options.delete(:connection_retry_sleep)
       @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
       @max_ssh_sessions       = @options.delete(:max_ssh_connections) { 9 }
-      @session                = nil
       @transport_options      = @options.delete(:transport_options)
-      @cmd_wrapper            = nil
       @proxy_command          = @options.delete(:proxy_command)
       @bastion_host           = @options.delete(:bastion_host)
       @bastion_user           = @options.delete(:bastion_user)
       @bastion_port           = @options.delete(:bastion_port)
+
       @cmd_wrapper            = CommandWrapper.load(self, @transport_options)
     end
 
@@ -69,8 +73,8 @@ class Train::Transports::SSH
 
       args  = %w{ -o UserKnownHostsFile=/dev/null }
       args += %w{ -o StrictHostKeyChecking=no }
-      args += %w{ -o IdentitiesOnly=yes } if options[:keys]
-      args += %w{ -o BatchMode=yes } if options[:non_interactive]
+      args += %w{ -o IdentitiesOnly=yes }        if options[:keys]
+      args += %w{ -o BatchMode=yes }             if options[:non_interactive]
       args += %W{ -o LogLevel=#{level} }
       args += %W{ -o ForwardAgent=#{fwd_agent} } if options.key?(:forward_agent)
       Array(options[:keys]).each do |ssh_key|
@@ -154,6 +158,12 @@ class Train::Transports::SSH
       @session.forward.remote(port, host, remote_port, remote_host)
     end
 
+    def obscured_options
+      options_to_print = @options.clone
+      options_to_print[:password] = "<hidden>" if options_to_print.key?(:password)
+      options_to_print
+    end
+
     private
 
     PING_COMMAND = "echo '[SSH] Established'".freeze
@@ -178,6 +188,7 @@ class Train::Transports::SSH
     # @api private
     def establish_connection(opts)
       logger.debug("[SSH] opening connection to #{self}")
+      logger.debug("[SSH] using options %p" % [obscured_options])
       if check_proxy
         require "net/ssh/proxy/command"
         @options[:proxy] = Net::SSH::Proxy::Command.new(generate_proxy_command)
@@ -218,9 +229,9 @@ class Train::Transports::SSH
 
     def run_command_via_connection(cmd, &data_handler)
       cmd.dup.force_encoding("binary") if cmd.respond_to?(:force_encoding)
-      logger.debug("[SSH] #{self} (#{cmd})")
 
       reset_session if session.closed?
+
       exit_status, stdout, stderr = execute_on_channel(cmd, &data_handler)
 
       # Since `@session.loop` succeeded, reset the IOS command retry counter
@@ -266,9 +277,7 @@ class Train::Transports::SSH
     #
     # @api private
     def to_s
-      options_to_print = @options.clone
-      options_to_print[:password] = "<hidden>" if options_to_print.key?(:password)
-      "#{@username}@#{@hostname}<#{options_to_print.inspect}>"
+      "#{@username}@#{@hostname}"
     end
 
     # Given a channel and a command string, it will execute the command on the channel
@@ -280,27 +289,31 @@ class Train::Transports::SSH
     #         not received.
     #
     # @api private
-    def execute_on_channel(cmd, &data_handler)
-      stdout = stderr = ""
+    def execute_on_channel(cmd)
+      stdout = ""
+      stderr = ""
       exit_status = nil
       session.open_channel do |channel|
         # wrap commands if that is configured
         cmd = @cmd_wrapper.run(cmd) if @cmd_wrapper
 
+        logger.debug("[SSH] #{self} cmd = #{cmd}")
+
         if @transport_options[:pty]
           channel.request_pty do |_ch, success|
             raise Train::Transports::SSHPTYFailed, "Requesting PTY failed" unless success
           end
         end
+
         channel.exec(cmd) do |_, success|
           abort "Couldn't execute command on SSH." unless success
           channel.on_data do |_, data|
-            yield(data) unless data_handler.nil?
+            yield(data) if block_given?
             stdout += data
           end
 
           channel.on_extended_data do |_, _type, data|
-            yield(data) unless data_handler.nil?
+            yield(data) if block_given?
             stderr += data
           end
 

data/lib/train/version.rb

@@ -3,5 +3,5 @@
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = "3.2.0".freeze
+  VERSION = "3.2.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.3
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json