kitchen-syncgz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8f79965af43b32cde2ac34b80758aef7ecbfe5ceb54324957a7d0e13b6c6559
+  data.tar.gz: 47aafaabb8d30a8f1fb52737c1c0767f7017ae481b373965b684978eb051bced
+SHA512:
+  metadata.gz: dc9c1f538cc5aba4d76e58df4432e1e351fd1fea8d4b40e2d741f04218b173ffe85ba69cf2cd22528d21b08dd72f162c0c5d8387146c3488d0dafe76e587872e
+  data.tar.gz: 55d9fb8b1555e55ca31a7554f7007975acefbdc7520d9cdd100af86e37e5e25ac5907df781d442dce0a560d415ffef67e54b028f93de6a910e1faaf34c9c8819

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+.idea/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.0.0
+
+Initial release!

data/Gemfile

@@ -0,0 +1,21 @@
+#
+# Author:: Igal Shprincis <igal.shprincis@gmail.com>
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,53 @@
+kitchen-syncgz
+============
+
+kitchen-syncgz provides alternate file transfer implementations for test-kitchen,
+most of which are faster than the default, thus speeding up your test runs.
+
+This project is a fork of [kitchen-sync](https://github.com/coderanger/kitchen-sync), the key enhancement of kitchen-syncgz is that it archives directories before transferring files to the target machine, which helps to overcome latency related issues when transferring a large number of small files. The archiving enhancement is based on the amazing work done by [Roy Reznik](https://github.com/coderanger/kitchen-sync/pull/31).
+
+Quick Start
+-----------
+
+Run `chef gem install kitchen-syncgz` and then set your transport to `sftpgz`:
+
+```
+transport:
+  name: sftpgz
+```
+
+Available Transfer Methods
+--------------------------
+
+### `sftpgz`
+
+The default mode uses SFTP for file transfers, as well as a helper script to
+avoid recopying files that are already present on the test host. If SFTP is
+disabled, this will automatically fall back to the SCP mode.
+
+By default this will use the Chef omnibus Ruby, you can customize the path to
+Ruby via `ruby_path`:
+
+```
+transport:
+  name: sftpgz
+  ruby_path: /usr/bin/ruby
+```
+
+
+License
+-------
+
+Copyright 2019, Igal Shprincis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+#
+# Author:: Igal Shprincis <igal.shprincis@gmail.com>
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'

data/kitchen-syncgz.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen-syncgz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-syncgz'
+  spec.version       = KitchenSyncGZ::VERSION
+  spec.authors       = ['Igal Shprincis']
+  spec.email         = ['igal.shprincis@gmail.com']
+  spec.description   = 'Improved file transfers for for test-kitchen'
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/igal-s/kitchen-syncgz'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-sftp'
+  spec.add_dependency 'test-kitchen', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/kitchen-syncgz.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+class KitchenSyncGZ
+  autoload :VERSION, 'kitchen-syncgz/version'
+end

data/lib/kitchen-syncgz/checksums.rb

@@ -0,0 +1,36 @@
+#
+# Author:: Igal Shprincis <igal.shprincis@gmail.com>
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+require 'digest/sha1'
+
+glob_path = base = ARGV.first
+glob_path = File.join(glob_path, '**', '*') if File.directory?(glob_path)
+d = Digest::SHA1.new
+STDOUT.write(
+  Dir.glob(glob_path, File::FNM_PATHNAME | File::FNM_DOTMATCH).inject({}) do |memo, path|
+    rel_path = path[base.length..-1]
+    if File.file?(path) && File.readable?(path)
+      d.reset
+      memo[rel_path] = d.file(path).hexdigest
+    elsif File.directory?(path)
+      memo[rel_path] = true
+    end
+    memo
+  end.to_json
+)

data/lib/kitchen-syncgz/core_ext.rb

@@ -0,0 +1,34 @@
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Kitchen
+  # Monkey patch to prevent the deletion of everything
+  module Provisioner
+    class ChefBase < Base
+
+      old_init_command = instance_method(:init_command)
+
+      define_method(:init_command) do
+        if defined?(Kitchen::Transport::Sftpgz) && instance.transport.is_a?(Kitchen::Transport::Sftpgz)
+           "mkdir -p #{config[:root_path]}"
+        else
+          old_init_command.bind(self).()
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen-syncgz/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+class KitchenSyncGZ
+  VERSION = '1.0.0'
+end

data/lib/kitchen/transport/sftpgz.rb

@@ -0,0 +1,303 @@
+#
+# Copyright 2019, Igal Shprincis
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'benchmark'
+require 'digest/sha1'
+require 'json'
+
+require 'kitchen/transport/ssh'
+require 'net/sftp'
+
+require 'kitchen-syncgz/core_ext'
+
+require 'rubygems'
+require 'rubygems/package'
+require 'zlib'
+require 'fileutils'
+
+module Kitchen
+  module Transport
+    class Sftpgz < Ssh
+      CHECKSUMS_PATH = File.expand_path('../../../kitchen-syncgz/checksums.rb', __FILE__)
+      CHECKSUMS_HASH = Digest::SHA1.file(CHECKSUMS_PATH)
+      CHECKSUMS_REMOTE_PATH = "/tmp/checksums-#{CHECKSUMS_HASH}.rb" # This won't work on Windows targets
+      MAX_TRANSFERS = 64
+
+      default_config :ruby_path, '/opt/chef/embedded/bin/ruby'
+
+      # Copy-pasta from Ssh#create_new_connection because I need the SFTP
+      # connection class.
+      # Tracked in https://github.com/test-kitchen/test-kitchen/pull/726
+      def create_new_connection(options, &block)
+        if @connection
+          logger.debug("[SSH] shutting previous connection #{@connection}")
+          @connection.close
+        end
+
+        @connection_options = options
+        @connection = self.class::Connection.new(config, options, &block)
+      end
+
+      class Connection < Ssh::Connection
+        def initialize(config, options, &block)
+          @config = config
+          super(options, &block)
+        end
+
+        # Wrap Ssh::Connection#close to also shut down the SFTP connection.
+        def close
+          if @sftp_session
+            logger.debug("[SFTP] closing connection to #{self}")
+            begin
+              sftp_session.close_channel
+            rescue Net::SSH::Disconnect
+              # Welp, we tried.
+            rescue IOError
+              # Can happen with net-ssh 4.x, no idea why.
+              # See https://github.com/net-ssh/net-ssh/pull/493
+            end
+          end
+        ensure
+          @sftp_session = nil
+          # Make sure we can turn down the session even if closing the channels
+          # fails in the middle because of a remote disconnect.
+          saved_session = @session
+          begin
+            super
+          rescue Net::SSH::Disconnect
+            # Boooo zlib warnings.
+            saved_session.transport.close if saved_session
+          end
+        end
+
+        def upload(locals, remote)
+          Array(locals).each do |local|
+            full_remote = File.join(remote, File.basename(local))
+            options = {
+                recursive: File.directory?(local),
+                purge: File.basename(local) != 'cache',
+            }
+            recursive = File.directory?(local)
+            time = Benchmark.realtime do
+              sftp_upload!(local, full_remote, options)
+            end
+            logger.info("[SFTP] Time taken to upload #{local} to #{self}:#{full_remote}: %.2f sec" % time)
+          end
+        end
+
+        private
+
+        def sftp_upload!(local, remote, recursive: true, purge: true)
+          # Fast path check, if the remote path doesn't exist at all we just run a direct transfer
+          unless safe_stat(remote)
+            logger.debug("[SFTP] Fast path upload from #{local} to #{remote}")
+            sftp_session.mkdir!(remote) if recursive
+            gzip_uploaded = false
+            if File.directory?(local)
+              logger.debug("[SFTP] Attempting to upload gzip of folder")
+              # tar.gz folder
+              temp_file_name = 'xfer_tmp.tar.gz'
+              gzipped_file_path = File.join(local, temp_file_name)
+              gzipped_data = gzip(tar(local), gzipped_file_path)
+              # Upload tar.gz to remote
+              remote_path = "#{remote}/#{temp_file_name}"
+              sftp_session.upload!(gzipped_file_path, remote_path, requests: MAX_TRANSFERS)
+              # Unzip tar.gz @ remote
+              exit_code = execute_with_exit_code("cd #{remote} && tar -zxvf #{temp_file_name}")
+              # Cleanup
+              sftp_session.remove(remote_path)
+              # Validate success
+              gzip_uploaded = exit_code == 0
+            end
+            if not gzip_uploaded
+              sftp_session.upload!(local, remote, requests: MAX_TRANSFERS)
+            end
+            return
+          end
+          # Get checksums for existing files on the remote side.
+          logger.debug("[SFTP] Slow path upload from #{local} to #{remote}")
+          copy_checksums_script!
+          checksum_cmd = "#{@config[:ruby_path]} #{CHECKSUMS_REMOTE_PATH} #{remote}"
+          logger.debug("[SFTP] Running #{checksum_cmd}")
+          checksums = JSON.parse(session.exec!(checksum_cmd))
+          # Sync files that have changed.
+          files_to_upload(checksums, local, recursive).each do |rel_path|
+            upload_file(checksums, local, remote, rel_path)
+          end
+          purge_files(checksums, remote) if purge
+          # Wait until all xfers are complete.
+          sftp_loop(0)
+        end
+
+        # Bug fix for session.loop never terminating if there is an SFTP conn active
+        # since as far as it is concerned there is still active stuff.
+        # This function is Copyright Fletcher Nichol
+        # Tracked in https://github.com/test-kitchen/test-kitchen/pull/724
+        def execute_with_exit_code(command)
+          exit_code = nil
+          closed = false
+          session.open_channel do |channel|
+
+            channel.request_pty
+
+            channel.exec(command) do |_ch, _success|
+
+              channel.on_data do |_ch, data|
+                logger << data
+              end
+
+              channel.on_extended_data do |_ch, _type, data|
+                logger << data
+              end
+
+              channel.on_request("exit-status") do |_ch, data|
+                exit_code = data.read_long
+              end
+
+              channel.on_close do |ch| # This block is new.
+                closed = true
+              end
+            end
+          end
+          session.loop { exit_code.nil? && !closed } # THERE IS A CHANGE ON THIS LINE, PAY ATTENTION!!!!!!
+          exit_code
+        end
+
+        # Create the SFTP session and block until it is ready.
+        #
+        # @return [Net::SFTP::Session]
+        def sftp_session
+          @sftp_session ||= session.sftp
+        end
+
+        # Return if the path exists (because net::sftp uses exceptions for that
+        # and it makes code gross) and also raise an exception if the path is a
+        # symlink.
+        #
+        # @param path [String] Remote path to check.
+        # @return [Boolean]
+        def safe_stat(path)
+          stat = sftp_session.lstat!(path)
+          raise "#{path} is a symlink, possible security threat, bailing out" if stat.symlink?
+          true
+        rescue Net::SFTP::StatusException
+          false
+        end
+
+        # Upload the checksum script if needed.
+        #
+        # @return [void]
+        def copy_checksums_script!
+          # Fast path because upload itself is called multiple times.
+          return if @checksums_copied
+          # Only try to transfer the script if it isn't present. a stat takes about
+          # 1/3rd the time of the transfer, so worst case here is still okay.
+          sftp_session.upload!(CHECKSUMS_PATH, CHECKSUMS_REMOTE_PATH) unless safe_stat(CHECKSUMS_REMOTE_PATH)
+          @checksums_copied = true
+        end
+
+        def files_to_upload(checksums, local, recursive)
+          glob_path = if recursive
+                        File.join(local, '**', '*')
+                      else
+                        local
+                      end
+          pending = []
+          Dir.glob(glob_path, File::FNM_PATHNAME | File::FNM_DOTMATCH).each do |path|
+            next unless File.file?(path)
+            rel_path = path[local.length..-1]
+            remote_hash = checksums.delete(rel_path)
+            pending << rel_path unless remote_hash && remote_hash == Digest::SHA1.file(path).hexdigest
+          end
+          pending
+        end
+
+        def upload_file(checksums, local, remote, rel_path)
+          parts = rel_path.split('/')
+          parts.pop # Drop the filename since we are only checking dirs
+          parts_to_check = []
+          until parts.empty?
+            parts_to_check << parts.shift
+            path_to_check = parts_to_check.join('/')
+            unless checksums[path_to_check]
+              logger.debug("[SFTP] Creating directory #{remote}#{path_to_check}")
+              add_xfer(sftp_session.mkdir("#{remote}#{path_to_check}"))
+              checksums[path_to_check] = true
+            end
+          end
+          logger.debug("[SFTP] Uploading #{local}#{rel_path} to #{remote}#{rel_path}")
+          add_xfer(sftp_session.upload("#{local}#{rel_path}", "#{remote}#{rel_path}"))
+        end
+
+        def purge_files(checksums, remote)
+          checksums.each do |key, value|
+            # Check if the file was uploaded in #upload_file.
+            if value != true
+              logger.debug("[SFTP] Removing #{remote}#{key}")
+              add_xfer(sftp_session.remove("#{remote}#{key}"))
+            end
+          end
+        end
+
+        def sftp_xfers
+          @sftp_xfers ||= []
+        end
+
+        def add_xfer(xfer)
+          sftp_xfers << xfer
+          sftp_loop
+        end
+
+        def sftp_loop(n_xfers=MAX_TRANSFERS)
+          sftp_session.loop do
+            sftp_xfers.delete_if {|x| !(x.is_a?(Net::SFTP::Request) ? x.pending? : x.active?) } # Purge any completed operations, which has two different APIs for some reason
+            sftp_xfers.length > n_xfers # Run until we have fewer than max
+          end
+        end
+
+        def tar(path)
+          tarfile = StringIO.new("")
+          Gem::Package::TarWriter.new(tarfile) do |tar|
+            Dir[File.join(path, "**/*")].each do |file|
+              mode = File.stat(file).mode
+              relative_file = file.sub /^#{Regexp::escape path}\/?/, ''
+
+              if File.directory?(file)
+                tar.mkdir relative_file, mode
+              else
+                tar.add_file relative_file, mode do |tf|
+                  File.open(file, "rb") { |f| tf.write f.read }
+                end
+              end
+            end
+          end
+
+          tarfile.rewind
+          tarfile
+        end
+
+        # gzips the underlying string in the given StringIO,
+        # returning a new StringIO representing the
+        # compressed file.
+        def gzip(tarfile, output_file)
+          z = Zlib::GzipWriter.open(output_file)
+          z.write tarfile.read
+          z.close
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-syncgz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igal Shprincis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Improved file transfers for for test-kitchen
+email:
+- igal.shprincis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-syncgz.gemspec
+- lib/kitchen-syncgz.rb
+- lib/kitchen-syncgz/checksums.rb
+- lib/kitchen-syncgz/core_ext.rb
+- lib/kitchen-syncgz/version.rb
+- lib/kitchen/transport/sftpgz.rb
+homepage: https://github.com/igal-s/kitchen-syncgz
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Improved file transfers for for test-kitchen
+test_files: []