train-core 3.6.2 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc67d13ca7a06113a56b506c659ad2a8b7cb0ce9468a632aad6d9716d2bfbbb3
-  data.tar.gz: 8f77e2c0ed1e8e18f55b8d96f2a74c43cb135818a3d945c9740c26f37bed3475
+  metadata.gz: acaccd8e644f55898c93991140f7e5b2d80bc097f35a0abd0daffcae9c183d22
+  data.tar.gz: bc1fe10109c88984eaeecb33a8674bac49ccef138c198ffd0fad48f3cf82d3f1
 SHA512:
-  metadata.gz: 32b328597cccde06aa86d32fc84d3255c66310c2b8544f4fe1aebf4bfd42b93e422a04e69a85b281954956f6e2ff8c035c672ac64c18fd89107edf94cd666049
-  data.tar.gz: 2eb61ddb2225dfa731fb32f1895b35703b152d80a23a46f0e2550b829bbbac955f753c028d50bb7bce020f692416934b908d35379ccefeaa6b4a17efbc58dd97
+  metadata.gz: 1b4531fa4c4422fa17bafd72591d1215a116c7ba2e0884d5f55f1064f436f1e7c28044983614e7d03a8ef034c7c986357300de77b9303dd50589aefd1ce84588
+  data.tar.gz: f5ef700b4ab4aa297e62cf3f104e9f29fab45d75582d670ae8a9d18bccef602e0aba502b9c2e7f6dc004e13ff240bbc88a0b7f34ae96390c07ef74713e590d6e

data/lib/train/extras/command_wrapper.rb

@@ -81,6 +81,9 @@ module Train::Extras
       when /sudo: sorry, you must have a tty to run sudo/
         ["Sudo requires a TTY. Please see the README on how to configure "\
           "sudo to allow for non-interactive usage.", :sudo_no_tty]
+      when /sudo: a terminal is required to read the password; either use/
+        ["Sudo cannot prompt for password because there is no terminal. "\
+            "Please provide the sudo password directly", :sudo_missing_terminal]
       else
         [rawerr, nil]
       end

data/lib/train/extras/stat.rb

@@ -34,7 +34,7 @@ module Train::Extras
 
     def self.linux_stat(shell_escaped_path, backend, follow_symlink)
       lstat = follow_symlink ? " -L" : ""
-      format = (backend.os.esx? || backend.os[:name] == "alpine" || backend.os[:name] == "yocto") ? "-c" : "--printf"
+      format = (backend.os.esx? || %w{alpine yocto ubios}.include?(backend.os[:name])) ? "-c" : "--printf"
       res = backend.run_command("stat#{lstat} #{shell_escaped_path} 2>/dev/null #{format} '%s\n%f\n%U\n%u\n%G\n%g\n%X\n%Y\n%C'")
       # ignore the exit_code: it is != 0 if selinux labels are not supported
       # on the system.

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

@@ -12,7 +12,7 @@ module Train
           @spath = path.gsub(/[<>"|?*]/, "")
         end
 
-        def basename(suffix = nil, sep = '\\')
+        def basename(suffix = nil, sep = "\\")
           super(suffix, sep)
         end
 

data/lib/train/options.rb

@@ -59,6 +59,9 @@ module Train
           default = hm[:default]
           if default.is_a? Proc
             res[field] = default.call(res)
+          elsif hm.key?(:coerce)
+            field_value = hm[:coerce].call(res)
+            res[field] = field_value.nil? ? default : field_value
           else
             res[field] = default
           end

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

@@ -74,6 +74,14 @@ module Train::Platforms::Detect::Specifications
         end
       end
 
+      declare_instance("ubios", "Ubiquiti UbiOS", "ubios") do
+        l_o_r = linux_os_release
+        if l_o_r && l_o_r["ID"] == "ubios"
+          @platform[:release] = l_o_r["VERSION_ID"]
+          true
+        end
+      end
+
       declare_instance("debian", "Debian Linux", "debian") do
         # if we get this far we have to be some type of debian
         @platform[:release] = unix_file_contents("/etc/debian_version").chomp

data/lib/train/transports/local.rb

@@ -190,8 +190,23 @@ module Train::Transports
           script = "$ProgressPreference='SilentlyContinue';" + cmd
           encoded_script = Base64.strict_encode64(script)
           # TODO: no way to safely implement timeouts here.
-          @pipe.puts(encoded_script)
-          @pipe.flush
+          begin
+            @pipe.puts(encoded_script)
+            @pipe.flush
+          rescue Errno::EPIPE
+            # Retry once if the pipe went away
+            begin
+              # Maybe the pipe went away, but the server didn't? Reset it, to get a clean start.
+              close
+            rescue Errno::EIO
+              # Ignore - server already went away
+            end
+            @pipe = acquire_pipe
+            raise PipeError if @pipe.nil?
+
+            @pipe.puts(encoded_script)
+            @pipe.flush
+          end
           res = OpenStruct.new(JSON.parse(Base64.decode64(@pipe.readline)))
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
@@ -216,12 +231,10 @@ module Train::Transports
 
           # PowerShell needs time to create pipe.
           100.times do
-            begin
-              pipe = open("//./pipe/#{pipe_name}", "r+")
-              break
-            rescue
-              sleep 0.1
-            end
+            pipe = open("//./pipe/#{pipe_name}", "r+")
+            break
+          rescue
+            sleep 0.1
           end
 
           pipe

data/lib/train/transports/ssh.rb

@@ -43,8 +43,8 @@ module Train::Transports
 
     # common target configuration
     option :host,      required: true
-    option :port,      default: 22, required: true
-    option :user,      default: "root", required: true
+    option :port,      default: 22, coerce: proc { |u| read_options_from_ssh_config(u, :port) }, required: true
+    option :user,      default: "root", coerce: proc { |u| read_options_from_ssh_config(u, :user) }, required: true
     option :key_files, default: nil
     option :password,  default: nil
 
@@ -86,6 +86,14 @@ module Train::Transports
       end
     end
 
+    # Returns the ssh config option like user, port from config files
+    # Params options [Hash], option_type [String]
+    # Return String
+    def self.read_options_from_ssh_config(options, option_type)
+      config_options = Net::SSH.configuration_for(options[:host], true)
+      config_options[option_type]
+    end
+
     private
 
     def reusable_connection?(conn_opts)
@@ -278,5 +286,6 @@ module Train::Transports
       yield @connection if block_given?
       @connection
     end
+
   end
 end

data/lib/train/transports/ssh_connection.rb

@@ -32,6 +32,10 @@ class Train::Transports::SSH
     attr_reader   :hostname
     attr_accessor :transport_options
 
+    # If we use the GNU timeout utility to timout a command server-side, it will
+    # exit with this status code if the command timed out.
+    GNU_TIMEOUT_EXIT_STATUS = 124
+
     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.
@@ -321,6 +325,9 @@ class Train::Transports::SSH
         # wrap commands if that is configured
         cmd = @cmd_wrapper.run(cmd) if @cmd_wrapper
 
+        # Timeout the command if requested and able
+        cmd = "timeout #{timeout}s #{cmd}" if timeout && timeoutable?(cmd)
+
         logger.debug("[SSH] #{self} cmd = #{cmd}")
 
         if @transport_options[:pty]
@@ -350,21 +357,30 @@ class Train::Transports::SSH
           end
         end
       end
+      session.loop
 
-      thr = Thread.new { session.loop }
-
-      if timeout
-        res = thr.join(timeout)
-        unless res
-          logger.debug("train ssh command '#{cmd}' 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
+      if timeout && timeoutable?(cmd) && exit_status == GNU_TIMEOUT_EXIT_STATUS
+        logger.debug("train ssh command '#{cmd}' 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
 
       [exit_status, stdout, stderr]
     end
+
+    # Returns true if we think we can attempt to timeout the command
+    def timeoutable?(cmd)
+      have_timeout_cli? && !cmd.include?("|") # Don't try to timeout a command that has pipes
+    end
+
+    # Returns true if the GNU timeout command is available
+    def have_timeout_cli?
+      return @have_timeout_cli unless @have_timeout_cli.nil?
+
+      res = session.exec!("timeout --version")
+      @have_timeout_cli = res.exitstatus == 0
+      logger.debug("train ssh have_timeout_cli status is '#{@have_timeout_cli}'")
+      @have_timeout_cli
+    end
   end
 end

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.8.1
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -181,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="