train-core 3.3.6 → 3.3.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6481551d7379b4a6cdee61568a1252e7feae2dc2d83def688417945eced8776
-  data.tar.gz: 3bec9acaea41dba70ed5c55cb7d6460d40e1c900002a172356419c80da222f7e
+  metadata.gz: 73c36e29da576607716f40e56d269c20dc0f340eb6db173401920d31780b0795
+  data.tar.gz: 7dc1d05255dfe2ee94ce9c485a17542128c23981f806a2f232ec7c4e748055d0
 SHA512:
-  metadata.gz: '09b0f40e16fc0533bb474a460d3526fd767cacd2e2c18e35a6f9aa825e953adc7de241116d12a832c179c6e7383afbb7357ecf31bdeb75347854083fee328caa'
-  data.tar.gz: c1bcbb41f3c7e3e832f1adf70b5f02634906e6f40d8ed989ff7aafb56b2e5008ba4cab5ce483dc39badaf8142e8e685a7f262c1f154d28c078ce0d899d9561fc
+  metadata.gz: 0c93f29190920583a17b6a03f07fdd082802ce6e4a3f1d991a2e20a31a186527c487e168cb99aab77a973f648603456eb4932d02a21bdf08ab915bfc2e0f5af6
+  data.tar.gz: 3037542a3872731085cd7b859d79a400038ba1f5091c0433ee40fd3d3c4298b5db9d9682b4c5b60bf3c9ed94bcadeeff0a5d9e441e7dba13f7856a622cee9a33

data/lib/train.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
@@ -7,7 +6,7 @@ require_relative "train/options"
 require_relative "train/plugins"
 require_relative "train/errors"
 require_relative "train/platforms"
-require "addressable/uri"
+require "addressable/uri" unless defined?(Addressable::URI)
 
 module Train
   # Create a new transport instance, with the plugin indicated by the

data/lib/train/errors.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
@@ -41,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.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 

data/lib/train/extras/command_wrapper.rb

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

data/lib/train/extras/stat.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # author: Dominik Richter
 # author: Christoph Hartmann
 module Train::Extras

data/lib/train/file.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # author: Christoph Hartmann
 # author: Dominik Richter

data/lib/train/file/local.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train
   class File
     class Local < Train::File

data/lib/train/file/local/unix.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require "shellwords"
+require "shellwords" unless defined?(Shellwords)
 require_relative "../../extras/stat"
 
 module Train

data/lib/train/file/local/windows.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train
   class File
     class Local

data/lib/train/file/remote.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train
   class File
     class Remote < Train::File

data/lib/train/file/remote/aix.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative "unix"
 
 module Train

data/lib/train/file/remote/linux.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative "unix"
 
 module Train

data/lib/train/file/remote/qnx.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # author: Christoph Hartmann
 # author: Dominik Richter

data/lib/train/file/remote/unix.rb

@@ -1,4 +1,4 @@
-require "shellwords"
+require "shellwords" unless defined?(Shellwords)
 
 module Train
   class File

data/lib/train/file/remote/windows.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train
   class File
     class Remote

data/lib/train/options.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)

data/lib/train/platforms.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative "platforms/common"
 require_relative "platforms/detect"
 require_relative "platforms/detect/scanner"

data/lib/train/platforms/common.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms
   module Common
     # Add a family connection. This will create a family

data/lib/train/platforms/detect.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms
   module Detect
     # Main detect method to scan all platforms for a match

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

@@ -1,6 +1,6 @@
 require_relative "os_linux"
 require_relative "os_windows"
-require "rbconfig"
+require "rbconfig" unless defined?(RbConfig)
 
 module Train::Platforms::Detect::Helpers
   module OSCommon
@@ -37,8 +37,8 @@ module Train::Platforms::Detect::Helpers
       res = @backend.run_command(cmd)
       stdout = res.stdout
       stderr = res.stderr
-      # When you try to execute command using ssh connction as root user and you have provided ssh user identity file
-      # it gives standard output to login as authorised user other than root. To show this standard ouput as an error
+      # When you try to execute command using ssh connection as root user and you have provided ssh user identity file
+      # it gives standard output to login as authorized user other than root. To show this standard output as an error
       # to user we are matching the string of stdout and raising the error here so that user gets exact information.
       if @backend.class.to_s == "Train::Transports::SSH::Connection"
         if stdout =~ /Please login as the user/
@@ -165,7 +165,7 @@ module Train::Platforms::Detect::Helpers
     def json_cmd(cmd)
       cmd = @backend.run_command(cmd)
       if cmd.exit_status == 0 && !cmd.stdout.empty?
-        require "json"
+        require "json" unless defined?(JSON)
         eos_ver = JSON.parse(cmd.stdout)
         @platform[:release] = eos_ver["version"]
         @platform[:arch] = eos_ver["architecture"]

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms::Detect::Helpers
   module Linux
     def redhatish_platform(conf)

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

@@ -33,15 +33,20 @@ module Train::Platforms::Detect::Helpers
       command = @backend.run_command(
         "Get-WmiObject Win32_OperatingSystem | Select Caption,Version | ConvertTo-Json"
       )
-      return false if (command.exit_status != 0) || command.stdout.empty?
-
-      payload = JSON.parse(command.stdout)
-      @platform[:family] = "windows"
-      @platform[:release] = payload["Version"]
-      @platform[:name] = payload["Caption"]
-
-      read_wmic
-      true
+      # some targets (e.g. Cisco) may return 0 and print an error to stdout
+      return false if (command.exit_status != 0) || command.stdout.downcase !~ /window/
+
+      begin
+        payload = JSON.parse(command.stdout)
+        @platform[:family] = "windows"
+        @platform[:release] = payload["Version"]
+        @platform[:name] = payload["Caption"]
+
+        read_wmic
+        true
+      rescue
+        false
+      end
     end
 
     def local_windows?
@@ -126,7 +131,7 @@ module Train::Platforms::Detect::Helpers
       return if !file.exist? || file.size == 0
 
       json = JSON.parse(file.content)
-      json["node_uuid"] if json["node_uuid"]
+      json["node_uuid"]
     end
 
     def windows_uuid_from_wmic

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative "helpers/os_common"
 
 module Train::Platforms::Detect

data/lib/train/platforms/detect/specifications/api.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms::Detect::Specifications
   class Api
     def self.load

data/lib/train/platforms/detect/specifications/os.rb

@@ -128,7 +128,7 @@ module Train::Platforms::Detect::Specifications
 
       declare_lsb("scientific", "Scientific Linux", "redhat", /scientific/i)
 
-      declare_lsb("xenserver", "Xenserer Linux", "redhat", /xenserver/i)
+      declare_lsb("xenserver", "Xenserver Linux", "redhat", /xenserver/i)
 
       declare_instance("parallels-release", "Parallels Linux", "redhat") do
         if (raw = unix_file_contents("/etc/parallels-release"))

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

@@ -1,6 +1,6 @@
-require "digest/sha1"
-require "securerandom"
-require "json"
+require "digest/sha1" unless defined?(Digest::SHA1)
+require "securerandom" unless defined?(SecureRandom)
+require "json" unless defined?(JSON)
 
 module Train::Platforms::Detect
   class UUID

data/lib/train/platforms/family.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms
   class Family
     include Train::Platforms::Common

data/lib/train/platforms/platform.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Train::Platforms
   class Platform
     include Train::Platforms::Common
@@ -47,7 +45,7 @@ module Train::Platforms
       @uuid ||= Train::Platforms::Detect::UUID.new(self).find_or_create_uuid.downcase
     end
 
-    # This is for backwords compatability with
+    # This is for backwards compatibility with
     # the current inspec os resource.
     def[](name)
       if respond_to?(name)

data/lib/train/plugin_test_helper.rb

@@ -13,13 +13,13 @@ require "minitest/spec"
 require "minitest/autorun"
 
 # Data formats commonly used in testing
-require "json"
-require "ostruct"
+require "json" unless defined?(JSON)
+require "ostruct" unless defined?(OpenStruct)
 
 # Utilities often needed
-require "fileutils"
-require "tmpdir"
-require "pathname"
+require "fileutils" unless defined?(FileUtils)
+require "tmpdir" unless defined?(Dir.mktmpdir)
+require "pathname" unless defined?(Pathname)
 
 # You might want to put some debugging tools here.  We run tests to find bugs,
 # after all.

data/lib/train/plugins.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)
@@ -24,7 +23,7 @@ module Train
   # Create a versioned plugin by providing the transport layer plugin version
   # to this method. It will then select the correct class to inherit from.
   #
-  # The plugin version determins what methods will be available to your plugin.
+  # The plugin version determines what methods will be available to your plugin.
   #
   # @param [Int] version = 1 the plugin version to use
   # @return [Transport] the versioned transport base class

data/lib/train/plugins/base_connection.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require_relative "../errors"
 require_relative "../extras"
 require_relative "../file"
@@ -132,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
@@ -160,7 +175,7 @@ class Train::Plugins::Transport
     # service is preferred to simply waiting on a socket to become
     # available.
     def wait_until_ready
-      # this method may be left unimplemented if that is applicablelog
+      # this method may be left unimplemented if that is applicable log
     end
 
     private

data/lib/train/plugins/transport.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 # Author:: Christoph Hartmann (<chris@lollyrock.com>)

data/lib/train/transports/cisco_ios_connection.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Train::Transports::SSH
   class CiscoIOSConnection < BaseConnection
     class BadEnablePassword < Train::TransportError; end

data/lib/train/transports/local.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 #
 # author: Dominik Richter
 # author: Christoph Hartmann
 
 require_relative "../plugins"
 require_relative "../errors"
-require "mixlib/shellout"
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
 
 module Train::Transports
   class Local < Train.plugin(1)
@@ -112,8 +111,8 @@ module Train::Transports
       end
 
       class WindowsShellRunner
-        require "json"
-        require "base64"
+        require "json" unless defined?(JSON)
+        require "base64" unless defined?(Base64)
 
         def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
@@ -136,9 +135,9 @@ module Train::Transports
       end
 
       class WindowsPipeRunner
-        require "json"
-        require "base64"
-        require "securerandom"
+        require "json" unless defined?(JSON)
+        require "base64" unless defined?(Base64)
+        require "securerandom" unless defined?(SecureRandom)
 
         def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
@@ -147,7 +146,7 @@ module Train::Transports
         end
 
         # @param  cmd The command to execute
-        # @return Local::ComandResult with stdout, stderr and exitstatus
+        # @return Local::CommandResult 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

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.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
@@ -18,7 +17,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "net/ssh"
+require "net/ssh" unless defined?(Net::SSH)
 require "net/scp"
 require_relative "../errors"
 
@@ -238,7 +237,7 @@ module Train::Transports
     # Creates a new SSH Connection instance and save it for potential future
     # reuse.
     #
-    # @param options [Hash] conneciton options
+    # @param options [Hash] connection options
     # @return [Ssh::Connection] an SSH Connection instance
     # @api private
     def create_new_connection(options, &block)

data/lib/train/transports/ssh_connection.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
@@ -18,9 +17,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "net/ssh"
+require "net/ssh" unless defined?(Net::SSH)
 require "net/scp"
-require "timeout"
+require "timeout" unless defined?(Timeout)
 
 class Train::Transports::SSH
   # A Connection instance can be generated and re-generated, given new
@@ -236,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
@@ -298,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
@@ -308,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
@@ -335,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

@@ -1,7 +1,6 @@
-# encoding: utf-8
 #
 # Author:: Dominik Richter (<dominik.richter@gmail.com>)
 
 module Train
-  VERSION = "3.3.6".freeze
+  VERSION = "3.3.27".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.3.6
+  version: 3.3.27
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable