train 2.0.2 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4765459fcc15937793cf65643f2d95ffb9deb6a4902364adc38ee8c9194b609
-  data.tar.gz: 9149263a29d8760dafa83824c4f25a1aa252553dbc58b9e74e31edab7db8ffad
+  metadata.gz: fc5c0aaf06370bfbf2ee1308c13dfd87a0da5a736536c4bf3024dd3400a62861
+  data.tar.gz: 04e7e0b56d0acd587ce5a567e8c81b2a2b701fd87c0165271048158340958d05
 SHA512:
-  metadata.gz: f0da823f4a6e406654b38a6c0cca183d8b4720425e2d2b9eac7772eaa41d1f4fdd105b8d0fc70d1748ac9dfc8a7d48cee52b256696b4c244327ccbcfbccb0bad
-  data.tar.gz: f5d33756dd4e9f0ab66f762aeeb1800ec69cdd8732afcebd8ce7580336c967f439accd4891db600a9d281d52f2f23752ab31f5bfcec081c4fa46c53e81c65f84
+  metadata.gz: 68a9846a2638f11c3d5d34f340f20cd42748206307f10b930c4967745d6c6db7e803109322c36f9ee15c5b4c7e15c4c05bcbbc58acad15878ca058b2c05e1f34
+  data.tar.gz: 343a8c70c0e73ff1c3169e28696ad073c5611afa8bcd8425b27b25ff6bd0220084c02139ef96a95c074737df29e8418b03bb91790646c1675b552010b1514f19

data/lib/train/platforms/detect/helpers/os_common.rb

@@ -14,8 +14,7 @@ module Train::Platforms::Detect::Helpers
     end
 
     def winrm?
-      Object.const_defined?('Train::Transports::WinRM::Connection') &&
-        @backend.class == Train::Transports::WinRM::Connection
+      @backend.class.to_s == 'Train::Transports::WinRM::Connection'
     end
 
     def unix_file_contents(path)

data/lib/train/platforms/detect/helpers/os_linux.rb

@@ -37,6 +37,7 @@ module Train::Platforms::Detect::Helpers
 
       raw.lines.each_with_object({}) do |line, memo|
         line.strip!
+        next if line.start_with?('#')
         next if line.empty?
         key, value = line.split('=', 2)
         memo[key] = value.gsub(/\A"|"\Z/, '') unless value.empty?

data/lib/train/plugins/base_connection.rb

@@ -114,10 +114,14 @@ class Train::Plugins::Transport
 
     # This is the main command call for all connections. This will call the private
     # run_command_via_connection on the connection with optional caching
-    def run_command(cmd)
-      return run_command_via_connection(cmd) unless cache_enabled?(:command)
+    #
+    # This command accepts an optional data handler block. When provided,
+    # inbound data will be published vi `data_handler.call(data)`. This can allow
+    # callers to receive and render updates from remote command execution.
+    def run_command(cmd, &data_handler)
+      return run_command_via_connection(cmd, &data_handler) unless cache_enabled?(:command)
 
-      @cache[:command][cmd] ||= run_command_via_connection(cmd)
+      @cache[:command][cmd] ||= run_command_via_connection(cmd, &data_handler)
     end
 
     # This is the main file call for all connections. This will call the private
@@ -150,8 +154,13 @@ class Train::Plugins::Transport
     # Execute a command using this connection.
     #
     # @param command [String] command string to execute
+    # @param &data_handler(data) [Proc] proc that is called when data arrives from
+    # the connection.  This block is optional. Individual transports will need
+    # to explicitly invoke the block in their implementation of run_command_via_connection;
+    # if they do not, the block is ignored and will not be used to report data back to the caller.
+    #
     # @return [CommandResult] contains the result of running the command
-    def run_command_via_connection(_command)
+    def run_command_via_connection(_command, &_data_handler)
       fail NotImplementedError, "#{self.class} does not implement #run_command_via_connection()"
     end
 

data/lib/train/transports/cisco_ios_connection.rb

@@ -56,7 +56,7 @@ class Train::Transports::SSH
       @session
     end
 
-    def run_command_via_connection(cmd)
+    def run_command_via_connection(cmd, &_data_handler)
       # Ensure buffer is empty before sending data
       @buf = ''
 

data/lib/train/transports/docker.rb

@@ -89,7 +89,7 @@ class Train::Transports::Docker
       end
     end
 
-    def run_command_via_connection(cmd)
+    def run_command_via_connection(cmd, &_data_handler)
       cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
       stdout, stderr, exit_status = @container.exec(
         [

data/lib/train/transports/local.rb

@@ -71,7 +71,7 @@ module Train::Transports
         end
       end
 
-      def run_command_via_connection(cmd)
+      def run_command_via_connection(cmd, &_data_handler)
         # Use the runner if it is available
         return @runner.run_command(cmd) if defined?(@runner)
 

data/lib/train/transports/mock.rb

@@ -124,7 +124,7 @@ class Train::Transports::Mock
 
     private
 
-    def run_command_via_connection(cmd)
+    def run_command_via_connection(cmd, &_data_handler)
       @cache[:command][Digest::SHA256.hexdigest cmd.to_s] ||
         command_not_found(cmd)
     end

data/lib/train/transports/ssh.rb

@@ -63,6 +63,7 @@ module Train::Transports
     option :bastion_user, default: 'root'
     option :bastion_port, default: 22
     option :non_interactive, default: false
+    option :verify_host_key, default: false
 
     option :compression_level do |opts|
       # on nil or false: set compression level to 0
@@ -168,7 +169,7 @@ module Train::Transports
       }
       # disable host key verification. The hash key to use
       # depends on the version of net-ssh in use.
-      connection_options[verify_host_key_option] = false
+      connection_options[verify_host_key_option] = opts[:verify_host_key] || false
 
       connection_options
     end

data/lib/train/transports/ssh_connection.rb

@@ -207,44 +207,12 @@ class Train::Transports::SSH
       end
     end
 
-    def run_command_via_connection(cmd) # rubocop:disable AbcSize
-      stdout = stderr = ''
-      exit_status = nil
+    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?
-      session.open_channel do |channel|
-        # wrap commands if that is configured
-        cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
-
-        if @transport_options[:pty]
-          channel.request_pty do |_ch, success|
-            fail 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|
-            stdout += data
-          end
-
-          channel.on_extended_data do |_, _type, data|
-            stderr += data
-          end
-
-          channel.on_request('exit-status') do |_, data|
-            exit_status = data.read_long
-          end
-
-          channel.on_request('exit-signal') do |_, data|
-            exit_status = data.read_long
-          end
-        end
-      end
-      @session.loop
+      exit_status, stdout, stderr = execute_on_channel(cmd, &data_handler)
 
       # Since `@session.loop` succeeded, reset the IOS command retry counter
       @ios_cmd_retries = 0
@@ -293,5 +261,51 @@ class Train::Transports::SSH
       options_to_print[:password] = '<hidden>' if options_to_print.key?(:password)
       "#{@username}@#{@hostname}<#{options_to_print.inspect}>"
     end
+
+    # Given a channel and a command string, it will execute the command on the channel
+    # and accumulate results in  @stdout/@stderr.
+    #
+    # @param channel [Net::SSH::Connection::Channel] an open ssh channel
+    # @param cmd [String] the command to execute
+    # @return [Integer] exit status or nil if exit-status/exit-signal requests
+    #         not received.
+    #
+    # @api private
+    def execute_on_channel(cmd, &data_handler)
+      stdout = stderr = ''
+      exit_status = nil
+      session.open_channel do |channel|
+        # wrap commands if that is configured
+        cmd = @cmd_wrapper.run(cmd) unless @cmd_wrapper.nil?
+
+        if @transport_options[:pty]
+          channel.request_pty do |_ch, success|
+            fail 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?
+            stdout += data
+          end
+
+          channel.on_extended_data do |_, _type, data|
+            yield(data) unless data_handler.nil?
+            stderr += data
+          end
+
+          channel.on_request('exit-status') do |_, data|
+            exit_status = data.read_long
+          end
+
+          channel.on_request('exit-signal') do |_, data|
+            exit_status = data.read_long
+          end
+        end
+      end
+      session.loop
+      [exit_status, stdout, stderr]
+    end
   end
 end

data/lib/train/transports/vmware.rb

@@ -73,7 +73,7 @@ module Train::Transports
         force_platform!('vmware', @platform_details)
       end
 
-      def run_command_via_connection(cmd)
+      def run_command_via_connection(cmd, &_data_handler)
         if @powershell_binary == :pwsh
           result = parse_pwsh_output(cmd)
 

data/lib/train/transports/winrm.rb

@@ -64,6 +64,10 @@ module Train::Transports
     option :kerberos_realm, default: nil
     option :kerberos_service, default: nil
     option :ca_trust_file, default: nil
+    # The amount of time in SECONDS for which each operation must get an ack
+    # from the winrm endpoint. Does not mean that the command has
+    # completed in this time, only that the server has ack'd the request.
+    option :operation_timeout, default: nil
 
     def initialize(opts)
       super(opts)

data/lib/train/transports/winrm_connection.rb

@@ -36,6 +36,7 @@ class Train::Transports::WinRM
       @connection_retries     = @options.delete(:connection_retries)
       @connection_retry_sleep = @options.delete(:connection_retry_sleep)
       @max_wait_until_ready   = @options.delete(:max_wait_until_ready)
+      @operation_timeout      = @options.delete(:operation_timeout)
     end
 
     # (see Base::Connection#close)
@@ -95,12 +96,13 @@ class Train::Transports::WinRM
       Train::File::Remote::Windows.new(self, path)
     end
 
-    def run_command_via_connection(command)
+    def run_command_via_connection(command, &data_handler)
       return if command.nil?
       logger.debug("[WinRM] #{self} (#{command})")
       out = ''
 
       response = session.run(command) do |stdout, _|
+        yield(stdout) if data_handler && stdout
         out << stdout if stdout
       end
 
@@ -178,6 +180,7 @@ class Train::Transports::WinRM
           retry_delay: @connection_retry_sleep.to_i,
         }.merge(retry_options)
 
+        opts[:operation_timeout] = @operation_timeout unless @operation_timeout.nil?
         @service = ::WinRM::Connection.new(options.merge(opts))
         @service.logger = logger
         @service.shell(:powershell)

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.5
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -308,7 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Transport interface to talk to different backends.