train-core 3.3.21 → 3.3.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4bfda9949a3f24a3c7d48f8bb23384c73f064eccfa0f44029872e13913880c9
-  data.tar.gz: 6598c63e265c79e1344010ace35b40d1f5bd1919bb8039d4ae868c54f9f85dc5
+  metadata.gz: 2b4cd9dbab0f4f3706d077a9c26185998bbdc4925ef03783b90c9244e268990d
+  data.tar.gz: a13777cd6b9e682fae479da36147ef17cbf01cf09c2d70f3377bf916e021be0f
 SHA512:
-  metadata.gz: aeb75022b5ff8c0f93ce22b35a6d8af8b31c8f3906fe357e502cd6f7ab8e7cb0bf55df61c8e891579b5338f875413b6c1372535e5af30d3011d54fd8b7822968
-  data.tar.gz: 3c23b61031fe8c0e8d691929ccb9007a8272d1de9736b8c5bef1ffcfd8a3078b31f556454f6676cc9d9a2515333015852f64f8e5ce47d2313e393eb4b230f9f7
+  metadata.gz: 36d220f296af3ac7d239a38726c0ccf6764ff171ea73004ea700c637b05233132e79619ea05de4fedbc098493baef6ea1095126325fd988475cf4a0a05ccce66
+  data.tar.gz: 6f8b09680a850f138c217bbfc03ae18e44a117d08842d8ca00a7055931a39e95e3be3652a851a4904171f7a80e58776cf1ff2220affaa19833c495d28e10cbe7

data/lib/train/errors.rb

@@ -40,4 +40,7 @@ module Train
 
   # Exception for when a invalid cache type is passed.
   class UnknownCacheType < Error; end
+
+  # Exception for when a command reaches configured timeout
+  class CommandTimeoutReached < Error; end
 end

data/lib/train/extras/command_wrapper.rb

@@ -1,7 +1,7 @@
 # author: Dominik Richter
 # author: Christoph Hartmann
 
-require "base64"
+require "base64" unless defined?(Base64)
 require_relative "../errors"
 
 module Train::Extras

data/lib/train/platforms/detect/uuid.rb

@@ -1,4 +1,4 @@
-require "digest/sha1"
+require "digest/sha1" unless defined?(Digest::SHA1)
 require "securerandom" unless defined?(SecureRandom)
 require "json" unless defined?(JSON)
 

data/lib/train/plugins/base_connection.rb

@@ -130,10 +130,27 @@ class Train::Plugins::Transport
     # 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, &data_handler)
+    #
+    # @param [String] the command to run
+    # @param [Hash] optional hash of options for this command. The derived connection
+    #               class's implementation of run_command_via_connection should receive
+    #               and apply these options.
+    def run_command(cmd, opts = {}, &data_handler)
+      # Some implementations do not accept an opts argument.
+      # We cannot update all implementations to accept opts due to them being separate plugins.
+      # Therefore here we check the implementation's arity to maintain compatibility.
+      case method(:run_command_via_connection).arity.abs
+      when 1
+        return run_command_via_connection(cmd, &data_handler) unless cache_enabled?(:command)
+
+        @cache[:command][cmd] ||= run_command_via_connection(cmd, &data_handler)
+      when 2
+        return run_command_via_connection(cmd, opts, &data_handler) unless cache_enabled?(:command)
+
+        @cache[:command][cmd] ||= run_command_via_connection(cmd, opts, &data_handler)
+      else
+        raise NotImplementedError, "#{self.class} does not implement run_command_via_connection with arity #{method(:run_command_via_connection).arity}"
+      end
     end
 
     # This is the main file call for all connections. This will call the private

data/lib/train/transports/local.rb

@@ -112,7 +112,7 @@ module Train::Transports
 
       class WindowsShellRunner
         require "json" unless defined?(JSON)
-        require "base64"
+        require "base64" unless defined?(Base64)
 
         def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
@@ -136,7 +136,7 @@ module Train::Transports
 
       class WindowsPipeRunner
         require "json" unless defined?(JSON)
-        require "base64"
+        require "base64" unless defined?(Base64)
         require "securerandom" unless defined?(SecureRandom)
 
         def initialize(powershell_cmd = "powershell")

data/lib/train/transports/mock.rb

@@ -1,5 +1,5 @@
 require_relative "../plugins"
-require "digest"
+require "digest" unless defined?(Digest)
 
 module Train::Transports
   class Mock < Train.plugin(1)

data/lib/train/transports/ssh_connection.rb

@@ -235,12 +235,12 @@ class Train::Transports::SSH
       end
     end
 
-    def run_command_via_connection(cmd, &data_handler)
+    def run_command_via_connection(cmd, opts = {}, &data_handler)
       cmd.dup.force_encoding("binary") if cmd.respond_to?(:force_encoding)
 
       reset_session if session.closed?
 
-      exit_status, stdout, stderr = execute_on_channel(cmd, &data_handler)
+      exit_status, stdout, stderr = execute_on_channel(cmd, opts, &data_handler)
 
       # Since `@session.loop` succeeded, reset the IOS command retry counter
       @ios_cmd_retries = 0
@@ -297,7 +297,8 @@ class Train::Transports::SSH
     #         not received.
     #
     # @api private
-    def execute_on_channel(cmd)
+    def execute_on_channel(cmd, opts)
+      timeout = opts[:timeout]&.to_i
       stdout = ""
       stderr = ""
       exit_status = nil
@@ -307,7 +308,7 @@ class Train::Transports::SSH
 
         logger.debug("[SSH] #{self} cmd = #{cmd}")
 
-        if @transport_options[:pty]
+        if @transport_options[:pty] || timeout
           channel.request_pty do |_ch, success|
             raise Train::Transports::SSHPTYFailed, "Requesting PTY failed" unless success
           end
@@ -334,7 +335,20 @@ class Train::Transports::SSH
           end
         end
       end
-      session.loop
+
+      thr = Thread.new { session.loop }
+
+      if timeout
+        res = thr.join(timeout)
+        unless res
+          logger.info("ssh command reached requested timeout (#{timeout}s)")
+          session.channels.each_value { |c| c.eof!; c.close }
+          raise Train::CommandTimeoutReached.new "ssh command reached timeout (#{timeout}s)"
+        end
+      else
+        thr.join
+      end
+
       [exit_status, stdout, stderr]
     end
   end

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.3.21
+  version: 3.3.24
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable