train-core 3.5.4 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c74943ab6ac7282ce80dc0ba284dde6552262b4309015e58bbe71a9864bb8a
-  data.tar.gz: 6aa5084e8141a4a47b5ced46793a163871ea3e2712882422d2e124daf7e8da3d
+  metadata.gz: 017550b023185b37f89bc36e7e1cc920079543ac11fe6d7788813b5363934ed4
+  data.tar.gz: bbd262ace02d7da95ae1ecce35e1c42514cf7a1fcd83f2ae7725b82b8fa65a3f
 SHA512:
-  metadata.gz: 39c6dc8ba54238f20aa45982a3153dc6df1dc203d2e2345b4a03246463b3d1bbd8ff332c9da1fc9c5f751373d0ccdea92a42737cf384f3bf240b7c28890180f6
-  data.tar.gz: efd9e6b920b5a800df45d907f6440829e6639eb6e2f37084a4426724708042c231e7538976be3920dff180559543aa6bb68620445b11fd9c3126470411e17e8d
+  metadata.gz: e7792c1fa21fb7207d23b1c283dbc0a4c989f0d1593747b5d1954b8e349ab9d5b209d5146f2af7442de1e79c519de152e376d7cf240cd1983440da0ed4ddea17
+  data.tar.gz: 55f506d5dbc20b38f89c5f150ffa69f4d6067a20311c891068ece4ce705ee5af01c6c740ced8fc0e52788cd9ab13c25000d47d2800ab7d023580bf18e1a147a8

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

@@ -86,9 +86,9 @@ module Train::Transports
         end
       end
 
-      def run_command_via_connection(cmd, &_data_handler)
+      def run_command_via_connection(cmd, opts, &_data_handler)
         # Use the runner if it is available
-        return @runner.run_command(cmd) if defined?(@runner)
+        return @runner.run_command(cmd, opts) if defined?(@runner)
 
         # If we don't have a runner, such as at the beginning of setting up the
         # transport and performing the first few steps of OS detection, fall
@@ -115,13 +115,18 @@ module Train::Transports
           @cmd_wrapper = Local::CommandWrapper.load(connection, options)
         end
 
-        def run_command(cmd)
+        def run_command(cmd, opts = {})
           if defined?(@cmd_wrapper) && !@cmd_wrapper.nil?
             cmd = @cmd_wrapper.run(cmd)
           end
 
           res = Mixlib::ShellOut.new(cmd)
-          res.run_command
+          res.timeout = opts[:timeout]
+          begin
+            res.run_command
+          rescue Mixlib::ShellOut::CommandTimeout
+            raise Train::CommandTimeoutReached
+          end
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
 
@@ -138,7 +143,7 @@ module Train::Transports
           @powershell_cmd = powershell_cmd
         end
 
-        def run_command(script)
+        def run_command(script, opts)
           # Prevent progress stream from leaking into stderr
           script = "$ProgressPreference='SilentlyContinue';" + script
 
@@ -149,7 +154,12 @@ module Train::Transports
           cmd = "#{@powershell_cmd} -NoProfile -EncodedCommand #{base64_script}"
 
           res = Mixlib::ShellOut.new(cmd)
-          res.run_command
+          res.timeout = opts[:timeout]
+          begin
+            res.run_command
+          rescue Mixlib::ShellOut::CommandTimeout
+            raise Train::CommandTimeoutReached
+          end
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
 
@@ -176,9 +186,10 @@ module Train::Transports
         #         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
         #         A command that fails (e.g. throws exception) before setting an exit code will have exitstatus 1
-        def run_command(cmd)
+        def run_command(cmd, _opts)
           script = "$ProgressPreference='SilentlyContinue';" + cmd
           encoded_script = Base64.strict_encode64(script)
+          # TODO: no way to safely implement timeouts here.
           @pipe.puts(encoded_script)
           @pipe.flush
           res = OpenStruct.new(JSON.parse(Base64.decode64(@pipe.readline)))

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,9 +325,12 @@ 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] || timeout
+        if @transport_options[:pty]
           channel.request_pty do |_ch, success|
             raise Train::Transports::SSHPTYFailed, "Requesting PTY failed" unless success
           end
@@ -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.5.4".freeze
+  VERSION = "3.7.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.7.2
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-05-24 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:
   - - ">="