train-core 3.7.0 → 3.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0529be878892640599f401af47c6c012a8d060fea3113895872b0af7e24127
-  data.tar.gz: 4b387bc5129fbf652b37713a63d74173d8d04f3ea5dbdf9993cadf0d276f3add
+  metadata.gz: 4f18f7c68501c5b726aa917009507d012e8c31022bedb829a2b4c90636137cb9
+  data.tar.gz: 939cc8932cf9b94c88785e5d3efd0c3e8b3ef0b47948e2f80fe5c7baa434d40d
 SHA512:
-  metadata.gz: 7fdf259b32a3dc0f033681b2f98e164f2ef76c8b4e7f51fb5bc1fe2412a1501039cdddfc06ef409f7b235dbcefef693f97c7fff21c02d7011618fdfc5ad09a9d
-  data.tar.gz: 2f90638d94542daf5e70488f6fd5e592986d3a76ac6b10f188414a109b53fffc8000202ce0a853f68bc1a8c1dfee9178107da5fee2b51728a01b1863b3976baf
+  metadata.gz: 00176b461c853b0d1167451fa43aea79159b696a3e0be0a0cd8a10934ee426d60b6fc463e0cd62643a7c53a6ead8100ec423ab8c1f18c3f48a3085601abf93fc
+  data.tar.gz: ccacf527642f27d7a84782050f0c05f2f0e617ea82b3bac2f5be258a17a2572cdbc0b7212e1eafba48003204012cb616e29daf88649e9349d7b726f59576df41

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/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

@@ -42,12 +42,12 @@ module Train::Transports
     include_options Train::Extras::CommandWrapper
 
     # common target configuration
-    option :host,      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 :host, required: true
+    option :ssh_config_file, default: false
+    option :port, default: 22, coerce: proc { |v| read_options_from_ssh_config(v, :port) }, required: true
+    option :user, default: "root", coerce: proc { |v| read_options_from_ssh_config(v, :user) }, required: true
     option :key_files, default: nil
     option :password,  default: nil
-
     # additional ssh options
     option :keepalive, default: true
     option :keepalive_interval, default: 60
@@ -75,6 +75,7 @@ module Train::Transports
 
     # (see Base#connection)
     def connection(state = {}, &block)
+      apply_ssh_config_file(options[:host])
       opts = merge_options(options, state || {})
       validate_options(opts)
       conn_opts = connection_options(opts)
@@ -86,16 +87,39 @@ 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]
+      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
+        files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+        config_options = Net::SSH::Config.for(options[:host], files)
+        config_options[option_type]
+      end
+    end
+
+    def apply_ssh_config_file(host)
+      if options[:ssh_config_file] != false && !options[:ssh_config_file].nil?
+        files = options[:ssh_config_file] == true ? Net::SSH::Config.default_files : options[:ssh_config_file]
+        host_cfg = ssh_config_file_for_host(host, files)
+        host_cfg.each do |key, value|
+          # setting the key_files option to the private keys set in ssh config file
+          if key == :keys && options[:key_files].nil? && !host_cfg[:keys].nil? && options[:password].nil?
+            options[:key_files] = host_cfg[key]
+          elsif options[key].nil?
+            # Give precedence to config file when ssh_config_file options is set to true or to the path of the config file.
+            # This is required as there are default values set for some of the opitons and we unable to
+            # identify whether the values are set from the cli option or those are default so either we should give
+            # precedence to config file or otherwise we need to check each options default values and then set the value for that option.
+            options[key] = host_cfg[key]
+          end
+        end
+      end
     end
 
     private
 
+    def ssh_config_file_for_host(host, files)
+      Net::SSH::Config.for(host, files)
+    end
+
     def reusable_connection?(conn_opts)
       return false unless @connection_options
 
@@ -131,6 +155,8 @@ module Train::Transports
         end
       end
 
+      options[:auth_methods] = options[:auth_methods].uniq
+
       if options[:pty]
         logger.warn("[SSH] PTY requested: stderr will be merged into stdout")
       end
@@ -186,6 +212,7 @@ module Train::Transports
         bastion_port: opts[:bastion_port],
         non_interactive: opts[:non_interactive],
         append_all_supported_algorithms: opts[:append_all_supported_algorithms],
+        config: options[:ssh_config_file],
         transport_options: opts,
       }
       # disable host key verification. The hash key and value to use

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.5
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-11-30 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:
   - - ">="