kitchen-sync 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26813092e05322f3fe42c5d75701c3412170ed16
+  data.tar.gz: 2e291464c73b250a3a77b9d84800fcc4399b3a23
+SHA512:
+  metadata.gz: 30e7e9f85ecc0171381358fa778e33fe77dcce36cc4eeb8b3d8a3377b292855d7d3c0d97ad1d5966394177bdb8a37cc89f90823372ec5e7b32c0061e1d045c1e
+  data.tar.gz: 0dd3f72194639e064dfeaa9f3eb06652087aeafe90b7c428e82975c87b7469230b1ad13550c4953f3ded066b11d3f250490319e009bf4f196fd9c522624421e2

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,21 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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,60 @@
+kitchen-sync
+============
+
+Do you wish your test-kitchen runs were faster? Boy do I have the gem for you!
+
+kitchen-sync provides alternate file transfer implementations for test-kitchen,
+most of which are faster than the default, thus speeding up your test runs.
+
+Quick Start
+-----------
+
+Add `gem 'kitchen-sync'` to your Gemfile and then at the top of your
+`.kitchen.yml`:
+
+```
+#<% require 'kitchen-sync' %>
+```
+
+Available Transfer Methods
+--------------------------
+
+You can select the transfer mode using the `KITCHEN_SYNC_MODE` environment
+variable. If not present, it defaults to `sftp`.
+
+### SFTP
+
+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.
+
+### SCP
+
+The SCP mode is just a copy of the implementation from test-kitchen. It is
+present as a fallback and for benchmark comparisons, and generally won't be
+used directly.
+
+### Rsync
+
+The rsync mode is based on the work done by [Mikhail Bautin](https://github.com/test-kitchen/test-kitchen/pull/359).
+This is the fastest mode, but it does have a few downsides. The biggest is that
+you must be using `ssh-agent` and have an identity loaded for it to use. It also
+requires that rsync be available on the remote side. Consider this implementation
+more experimental than the others at this time.
+
+License
+-------
+
+Copyright 2014, Noah Kantrowitz
+
+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:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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-sync.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen-sync/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitchen-sync'
+  spec.version       = KitchenSync::VERSION
+  spec.authors       = ['Noah Kantrowitz']
+  spec.email         = ['noah@coderanger.net']
+  spec.description   = %q{Improved file transfers for for test-kitchen}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/coderanger/kitchen-sync'
+  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 'test-kitchen', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/kitchen-sync.rb

@@ -0,0 +1,80 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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/ssh'
+require 'kitchen/provisioner/chef_base'
+require 'net/sftp'
+
+require 'kitchen-sync/core_ext'
+require 'kitchen-sync/rsync'
+require 'kitchen-sync/scp'
+require 'kitchen-sync/sftp'
+require 'kitchen-sync/version'
+
+
+class KitchenSync
+  IMPLEMENTATIONS = {
+    'rsync' => Rsync,
+    'scp' => SCP,
+    'sftp' => SFTP,
+  }
+
+  def initialize(logger, session, options)
+    @logger = logger
+    @session = session
+    @options = options
+    @impl = load_implementation
+  end
+
+  def load_implementation(default_mode='sftp')
+    mode = (ENV['KITCHEN_SYNC_MODE'] || default_mode).downcase
+    @logger.debug("[sync] Using transfer mode #{mode}")
+    impl_class = IMPLEMENTATIONS[mode]
+    raise "Sync implementation for #{mode} not found" unless impl_class
+    # Create the instance, any error during init means we use SCP instead
+    begin
+      impl_class.new(@logger, @session, @options)
+    rescue Exception
+      if impl_class != SCP
+        @logger.debug("[sync] Falling back to SCP")
+        impl_class = SCP
+        retry
+      else
+        raise
+      end
+    end
+  end
+
+  def upload(local, remote, options)
+    # This is set even for single files, so make it something that matters again
+    options[:recursive] = File.directory?(local)
+    time = Benchmark.realtime do
+      @impl.upload(local, remote, options[:recursive])
+    end
+    @logger.info("[sync] Time taken to upload #{local} to #{@session}:#{remote}: " +
+             "%.2f sec" % time)
+  end
+
+  def shutdown
+    @impl.shutdown
+  end
+end

data/lib/kitchen-sync/base.rb

@@ -0,0 +1,35 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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 KitchenSync
+  class Base
+    def initialize(logger, session, options)
+      @logger = logger
+      @session = session
+      @options = options
+    end
+
+    def upload(local, remote, recursive=true)
+      raise NotImplementedError
+    end
+
+    def shutdown
+      # This space left intentionally blank
+    end
+  end
+end

data/lib/kitchen-sync/checksums.rb

@@ -0,0 +1,36 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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-sync/core_ext.rb

@@ -0,0 +1,78 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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
+  class SSH
+
+    #old_upload = instance_method(:upload!)
+    define_method(:upload!) do |local, remote, options = {}, &progress|
+      @kitchen_sync ||= KitchenSync.new(logger, session, @options)
+      @kitchen_sync.upload(local, remote, options)
+    end
+
+    # Monkey patch the shutdown to tear down the SFTP connection too.
+    old_shutdown = instance_method(:shutdown)
+    define_method(:shutdown) do
+      begin
+        @kitchen_sync.shutdown if @kitchen_sync
+      ensure
+        old_shutdown.bind(self).call
+      end
+    end
+
+    private
+
+    # 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
+    def exec_with_exit(cmd)
+      exit_code = nil
+      session.open_channel do |channel|
+
+        channel.request_pty
+
+        channel.exec(cmd) 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
+        end
+      end
+      session.loop { !exit_code } # THERE IS A CHANGE ON THIS LINE, PAY ATTENTION!!!!!!
+      exit_code
+    end
+  end
+
+  # Monkey patch to prevent the deletion of everything
+  module Provisioner
+    class ChefBase < Base
+      def init_command
+        "mkdir -p #{config[:root_path]}"
+      end
+    end
+  end
+end

data/lib/kitchen-sync/rsync.rb

@@ -0,0 +1,70 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2013-2014, Fletcher Nichol
+# Copyright 2014, Noah Kantrowitz
+#
+# 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 'kitchen-sync/scp'
+
+class KitchenSync
+  class Rsync < SCP
+    def upload(local, remote, recursive=true)
+      upload_done = false
+      if !@rsync_failed && recursive && File.exists?('/usr/bin/rsync')
+        ssh_command = "ssh #{ssh_args.join(' ')}"
+        copy_identity
+        rsync_cmd = "/usr/bin/rsync -e '#{ssh_command}' -az #{local} #{@session.options[:user]}@#{@session.host}:#{remote}"
+        @logger.info("[sync:rsync] Running rsync command: #{rsync_cmd}")
+        if system(rsync_cmd)
+          upload_done = true
+        else
+          @logger.warn("[sync:rsync] rsync exited with status #{$?.exitstatus}, using Net::SCP instead")
+          @rsync_failed = true
+        end
+      end
+
+      # Fall back to SCP
+      super unless upload_done
+    end
+
+    # Copy your SSH identity, creating a new one if needed
+    def copy_identity
+      return if @copied_identity
+      key = Net::SSH::Authentication::Agent.connect.identities.first
+      enc_key = Base64.encode64(key.to_blob).gsub("\n", '')
+      identitiy = "ssh-rsa #{enc_key} #{key.comment}"
+      @session.exec! <<-EOT
+        test -e ~/.ssh || mkdir ~/.ssh
+        test -e ~/.ssh/authorized_keys || touch ~/.ssh/authorized_keys
+        if ! grep -q "#{identitiy}" ~/.ssh/authorized_keys ; then
+          chmod go-w ~ ~/.ssh ~/.ssh/authorized_keys ; \
+          echo "#{identitiy}" >> ~/.ssh/authorized_keys
+        fi
+      EOT
+      @copied_identity = true
+    end
+
+    def ssh_args
+      args = %W{ -o UserKnownHostsFile=/dev/null }
+      args += %W{ -o StrictHostKeyChecking=no }
+      args += %W{ -o IdentitiesOnly=yes } if @options[:keys]
+      args += %W{ -o LogLevel=#{@logger.debug? ? "VERBOSE" : "ERROR"} }
+      args += %W{ -o ForwardAgent=#{options[:forward_agent] ? "yes" : "no"} } if @options.key? :forward_agent
+      Array(@options[:keys]).each { |ssh_key| args += %W{ -i #{ssh_key}} }
+      args += %W{ -p #{@session.options[:port]}}
+    end
+  end
+end

data/lib/kitchen-sync/scp.rb

@@ -0,0 +1,36 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2013-2014, Fletcher Nichol
+# Copyright 2014, Noah Kantrowitz
+#
+# 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 'kitchen-sync/base'
+
+require 'net/scp'
+
+class KitchenSync
+  class SCP < Base
+    def upload(local, remote, recursive=true)
+      true_remote = File.join(remote, File.basename(local))
+      @session.exec!("rm -rf #{true_remote}")
+      @session.scp.upload!(local, remote, recursive: recursive) do |ch, name, sent, total|
+        if sent == total
+          @logger.debug("Uploaded #{name} (#{total} bytes)")
+        end
+      end
+    end
+  end
+end

data/lib/kitchen-sync/sftp.rb

@@ -0,0 +1,138 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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 'kitchen-sync/base'
+
+require 'net/sftp'
+
+class KitchenSync
+  class SFTP < Base
+    CHECKSUMS_PATH = File.expand_path('../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
+
+    def initialize(*args)
+      super
+      @sftp = @session.sftp
+      @xfers = []
+    end
+
+    def upload(local, remote, recursive=true)
+      remote = File.join(remote, File.basename(local))
+      # Fast path check, if the remote path doesn't exist at all we just run a direct transfer
+      unless safe_stat(remote)
+        @logger.debug("[sync:sftp] Fast path upload from #{local} to #{remote}")
+        @sftp.mkdir!(remote) if recursive
+        @sftp.upload!(local, remote, requests: MAX_TRANSFERS)
+        return
+      end
+      copy_checksums_script
+      # Get our checksums
+      checksum_cmd = "/opt/chef/embedded/bin/ruby #{CHECKSUMS_REMOTE_PATH} #{remote}"
+      @logger.info("[sync:sftp] Running #{checksum_cmd}")
+      checksums = JSON.parse(@session.exec!(checksum_cmd))
+      files_to_upload(checksums, local, recursive).each do |rel_path|
+        upload_file(checksums, local, remote, rel_path)
+      end
+      purge_files(checksums, remote)
+      sftp_loop(0) # Wait until all xfers are complete
+    end
+
+    def shutdown
+      @logger.debug("[sync:sftp] closing connection to #{@session}")
+      @sftp.close_channel
+      @sftp = nil
+    end
+
+    private
+
+    # 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.
+    def safe_stat(path)
+      stat = @sftp.lstat!(path)
+      raise "#{path} is a symlink, possible security threat, bailing out" if stat.symlink?
+      true
+    rescue Net::SFTP::StatusException
+      false
+    end
+
+    def copy_checksums_script
+      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.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("[sync:sftp] Creating directory #{remote}#{path_to_check}")
+          add_xfer(@sftp.mkdir("#{remote}#{path_to_check}"))
+          checksums[path_to_check] = true
+        end
+      end
+      @logger.debug("[sync:sftp] Uploading #{local}#{rel_path} to #{remote}#{rel_path}")
+      add_xfer(@sftp.upload("#{local}#{rel_path}", "#{remote}#{rel_path}"))
+    end
+
+    def purge_files(checksums, remote)
+      checksums.each do |key, value|
+        if value != true
+          @logger.debug("[sync:sftp] Removing #{remote}#{key}")
+          add_xfer(@sftp.remove("#{remote}#{key}"))
+        end
+      end
+    end
+
+    def add_xfer(xfer)
+      @xfers << xfer
+      sftp_loop
+    end
+
+    def sftp_loop(n_xfers=MAX_TRANSFERS)
+      @sftp.loop do
+        @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
+        @xfers.length > n_xfers # Run until we have fewer than max
+      end
+    end
+
+  end
+end

data/lib/kitchen-sync/version.rb

@@ -0,0 +1,21 @@
+#
+# Author:: Noah Kantrowitz <noah@coderanger.net>
+#
+# Copyright 2014, Noah Kantrowitz
+#
+# 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 KitchenSync
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-sync
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Noah Kantrowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !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:
+- noah@coderanger.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-sync.gemspec
+- lib/kitchen-sync.rb
+- lib/kitchen-sync/base.rb
+- lib/kitchen-sync/checksums.rb
+- lib/kitchen-sync/core_ext.rb
+- lib/kitchen-sync/rsync.rb
+- lib/kitchen-sync/scp.rb
+- lib/kitchen-sync/sftp.rb
+- lib/kitchen-sync/version.rb
+homepage: https://github.com/coderanger/kitchen-sync
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Improved file transfers for for test-kitchen
+test_files: []
+has_rdoc: