train-core 3.4.7 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85ed8cc37da145f7dabcff7855b85b9c2a6bc8f216945aeaa693843c07f8b95
-  data.tar.gz: a4ac06f8b1c2ced955d933ba1a9553d9434c9d255d11ec5d8cc43e14e1cc0469
+  metadata.gz: dbe3fad014697c3f0a1d5fb5d3f4ff422f9e552362179f72019f7c2f9784f975
+  data.tar.gz: 337a74095aa5e41b4dd4f24ba2e41857190161a035c2adaf809617205525e442
 SHA512:
-  metadata.gz: 0b920c8d01dbdd94eae308fcca501cf9dc5f24619f8e023e4c5cedbdd11eebcfc4b4bcb41683435325f3ede4afa5b6a7981164e1cf8242aa472e2e801282c284
-  data.tar.gz: e3d5e835b15d0cc84f86066fe66aafc7456544f53fbe91d2a66c7341ed4db3b2f6a3d890e98aab26d0fe294af587fc246a89a10c7d56b9f4ac1cf09a99fae9d8
+  metadata.gz: a066352b95be252da1de517176e98fe67804484bfb7f9371a23762b04a5050e7a3a7ca814eb27c773c5b23e7eb85a6eb26fd251df67bfd25c500e34a1075f7dc
+  data.tar.gz: fdfa95f6c1278dd04760e5dface6b4feacac3d0dd2b77f8844215d6f9b17760967afa482181415368fd8c3ca869e697e205c5abd45913e6cbfb12dcfc93044c1

data/lib/train/file/local.rb

@@ -15,6 +15,12 @@ module Train
         nil
       end
 
+      def content=(new_content)
+        ::File.open(@path, "w", encoding: "UTF-8") { |fp| fp.write(new_content) }
+
+        @content = new_content
+      end
+
       def link_path
         return nil unless symlink?
 

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

@@ -1,3 +1,4 @@
+require "base64" unless defined?(Base64)
 require "shellwords" unless defined?(Shellwords)
 
 module Train
@@ -19,6 +20,21 @@ module Train
             end
         end
 
+        def content=(new_content)
+          execute_result = @backend.run_command("base64 --help")
+          if execute_result.exit_status != 0
+            raise TransportError, "#{self.class} found no base64 binary for file writes"
+          end
+
+          unix_cmd = format("echo '%<base64>s' | base64 --decode > %<file>s",
+                            base64: Base64.strict_encode64(new_content),
+                            file: @spath)
+
+          @backend.run_command(unix_cmd)
+
+          @content = new_content
+        end
+
         def exist?
           @exist ||= begin
             f = @follow_symlink ? "" : " || test -L #{@spath}"

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

@@ -26,6 +26,16 @@ module Train
           @content
         end
 
+        def content=(new_content)
+          win_cmd = format('[IO.File]::WriteAllBytes("%<file>s", [Convert]::FromBase64String("%<base64>s"))',
+                           base64: Base64.strict_encode64(new_content),
+                           file: @spath)
+
+          @backend.run_command(win_cmd)
+
+          @content = new_content
+        end
+
         def exist?
           return @exist if defined?(@exist)
 

data/lib/train/plugins/base_connection.rb

@@ -1,6 +1,7 @@
 require_relative "../errors"
 require_relative "../extras"
 require_relative "../file"
+require "fileutils" unless defined?(FileUtils)
 require "logger"
 
 class Train::Plugins::Transport
@@ -161,6 +162,48 @@ class Train::Plugins::Transport
       @cache[:file][path] ||= file_via_connection(path, *args)
     end
 
+    # Uploads local files or directories to remote host.
+    #
+    # @param locals [Array<String>] paths to local files or directories
+    # @param remote [String] path to remote destination
+    # @raise [TransportFailed] if the files could not all be uploaded
+    #   successfully, which may vary by implementation
+    def upload(locals, remote)
+      unless file(remote).directory?
+        raise TransportError, "#{self.class} expects remote directory as second upload parameter"
+      end
+
+      Array(locals).each do |local|
+        new_content = File.read(local)
+        remote_file = File.join(remote, File.basename(local))
+
+        logger.debug("Attempting to upload '#{local}' as file #{remote_file}")
+
+        file(remote_file).content = new_content
+      end
+    end
+
+    # Download remote files or directories to local host.
+    #
+    # @param remotes [Array<String>] paths to remote files or directories
+    # @param local [String] path to local destination. If `local` is an
+    #   existing directory, `remote` will be downloaded into the directory
+    #   using its original name
+    # @raise [TransportFailed] if the files could not all be downloaded
+    #   successfully, which may vary by implementation
+    def download(remotes, local)
+      FileUtils.mkdir_p(File.dirname(local))
+
+      Array(remotes).each do |remote|
+        new_content = file(remote).content
+        local_file = File.join(local, File.basename(remote))
+
+        logger.debug("Attempting to download '#{remote}' as file #{local_file}")
+
+        File.open(local_file, "w") { |fp| fp.write(new_content) }
+      end
+    end
+
     # Builds a LoginCommand which can be used to open an interactive
     # session on the remote host.
     #

data/lib/train/transports/cisco_ios_connection.rb

@@ -29,6 +29,14 @@ class Train::Transports::SSH
       result.stdout.split(" ")[-1]
     end
 
+    def upload(locals, remote)
+      raise NotImplementedError, "#{self.class} does not implement #upload()"
+    end
+
+    def download(remotes, local)
+      raise NotImplementedError, "#{self.class} does not implement #download()"
+    end
+
     private
 
     def establish_connection

data/lib/train/transports/local.rb

@@ -31,10 +31,26 @@ module Train::Transports
         nil # none, open your shell
       end
 
+      def close
+        @runner.close
+      end
+
       def uri
         "local://"
       end
 
+      def upload(locals, remote)
+        FileUtils.mkdir_p(remote)
+
+        Array(locals).each do |local|
+          FileUtils.cp_r(local, remote)
+        end
+      end
+
+      def download(remotes, local)
+        upload(remotes, local)
+      end
+
       private
 
       def select_runner(options)
@@ -70,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
@@ -99,15 +115,24 @@ 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
+
+        def close
+          # nothing to do at the moment
+        end
       end
 
       class WindowsShellRunner
@@ -118,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
 
@@ -129,9 +154,18 @@ 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
+
+        def close
+          # nothing to do at the moment
+        end
       end
 
       class WindowsPipeRunner
@@ -141,6 +175,7 @@ module Train::Transports
 
         def initialize(powershell_cmd = "powershell")
           @powershell_cmd = powershell_cmd
+          @server_pid = nil
           @pipe = acquire_pipe
           raise PipeError if @pipe.nil?
         end
@@ -151,21 +186,31 @@ 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)))
           Local::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
         end
 
+        def close
+          Process.kill("KILL", @server_pid) unless @server_pid.nil?
+          @server_pid = nil
+        end
+
         private
 
         def acquire_pipe
+          require "win32/process"
           pipe_name = "inspec_#{SecureRandom.hex}"
 
-          start_pipe_server(pipe_name)
+          @server_pid = start_pipe_server(pipe_name)
+
+          # Ensure process is killed when the Train process exits
+          at_exit { close rescue Errno::EIO }
 
           pipe = nil
 
@@ -227,11 +272,7 @@ module Train::Transports
           utf8_script = script.encode("UTF-16LE", "UTF-8")
           base64_script = Base64.strict_encode64(utf8_script)
           cmd = "#{@powershell_cmd} -NoProfile -ExecutionPolicy bypass -NonInteractive -EncodedCommand #{base64_script}"
-
-          server_pid = Process.create(command_line: cmd).process_id
-
-          # Ensure process is killed when the Train process exits
-          at_exit { Process.kill("KILL", server_pid) }
+          Process.create(command_line: cmd).process_id
         end
       end
     end

data/lib/train/transports/ssh_connection.rb

@@ -29,8 +29,8 @@ class Train::Transports::SSH
   #
   # @author Fletcher Nichol <fnichol@nichol.ca>
   class Connection < BaseConnection # rubocop:disable Metrics/ClassLength
-    attr_reader :hostname
-    attr_reader :transport_options
+    attr_reader   :hostname
+    attr_accessor :transport_options
 
     def initialize(options)
       # Track IOS command retries to prevent infinite loop on IOError. This must
@@ -247,6 +247,16 @@ class Train::Transports::SSH
 
       exit_status, stdout, stderr = execute_on_channel(cmd, opts, &data_handler)
 
+      # An interactive console might contain the STDERR in STDOUT
+      # concat both outputs for non-zero exit status. 
+      output = "#{stdout} #{stderr}".strip if exit_status != 0
+
+      # Abstract the su - USER authentication failure
+      # raise the Train::UserError and passes message & reason
+      if output && output.match?("su: Authentication failure")
+        raise Train::UserError.new(output, :bad_su_user_password)
+      end
+
       # Since `@session.loop` succeeded, reset the IOS command retry counter
       @ios_cmd_retries = 0
 
@@ -322,12 +332,12 @@ class Train::Transports::SSH
         channel.exec(cmd) do |_, success|
           abort "Couldn't execute command on SSH." unless success
           channel.on_data do |_, data|
-            yield(data) if block_given?
+            yield(data, channel) if block_given?
             stdout += data
           end
 
           channel.on_extended_data do |_, _type, data|
-            yield(data) if block_given?
+            yield(data, channel) if block_given?
             stderr += data
           end
 

data/lib/train/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-core
 version: !ruby/object:Gem::Version
-  version: 3.4.7
+  version: 3.5.5
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable