kitchen-transport-speedy 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTI2NDc5MTEyMjJjMmM2ODdhOTMyOWRkMjM5ODE2ODNlNjA5Zjk0Nw==
+  data.tar.gz: !binary |-
+    YjE1YzYwNGRhOGE5OGE4OTUzNzdmNTgyZGYxZDg2MTgwNmQ0ODljZQ==
+SHA512:
+  metadata.gz: !binary |-
+    NmEwMTBjMzMwZjVkYzZlNzU0MTVkZGNjZDkwMjBjM2RjYmI3ZTA0ZTAzNGZm
+    NWJkYjVlOWZjOWZiZDRjZDk5MGJmOGI2OTliYmE5NTAzNmFjM2YwOTBjMTFk
+    ZmZjMDlkZmEzMDFhMmRhMjA2ZGY2ZmVkMjBiMzU2ZTdhODQwYjE=
+  data.tar.gz: !binary |-
+    Y2U5YzE1MzRiMTRkNTNkNjczYTY2NTE4YTllMjQzMzE2ZWEzMTQ4ZWYzNzI1
+    NGFkNGI5NTlhNGZhODRlMDhlODE3Y2Q5ODZmMmVhN2RiNTQ3MzAyY2EwMTFk
+    ZWE5ODBhMzI4YjQ1NTVlMjJjOTIwMGVlNDZmNDkzNTQzYmUxODg=

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.lock
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.3.0
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: OsWBNLndrR49ZwQmRNbJIqFiyEjZG5mosZF2d8aFpKwGpfu0EplQjmPeXokPSvQIzuBUVTh5a+pCZaESyiNlwHOs4b3olu8ifhPsJfs9FaZHkUV8enkHhOcuziqpVpp7LLqvjaBR42RTaOAAipKCe2BJP7ZQxJCf0heDBdOJDE7R/LLdFS02wi1i9FOjYUS+/DZNpoySAN2y+uiQ36Rhq6ZcsmiEoO24jWtOhTK7uGM41pfAAgeFGNAJxU+bC3G703cuUtllqaz+VHLMbiB6nAr8LzHZLFsiM2dcIFnu1M4jTVyc6dfYvSNAYTWqwgsVM4XYAcA83Qo/5479YBQoiMfhi0Ujo3fE6fZ2zRNOYMv/sbge4wc3mQtZickm5ofIzX+78Ch7if+Vu+lNFl7sKUoFvsl15IgyQdCJvss/zGlTchs2WpcMftFJs3vKfA+c8x5q3OWvmQNG2dssjz28eTf/fk1L6RzPowhob270xDbmDuQ6TXbovMEjleq62N41w8EL/uVwtKzTLjTVUyKtWU+sipCZuwTFvFNCmWGo8qszT6Jck75MPoxcneVdbz1oMPfadRxyMTnR+cWKO5mYHUDQJS4uF6Vlpn5+dF/plGngKh+tF5XFMVfpgFzhI1UXqLnPfxKHJK6MCTKJied5xYFQ9X1IdQtZQ/57M87yZpw=
+  gem: kitchen-transport-speedy
+  on:
+    tags: true
+    repo: criteo/kitchen-transport-speedy

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kitchen-transport-speedy.gemspec
+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,45 @@
+# Kitchen::Transport::Speedy
+
+This gem is transport plugin for kitchen. It signicantly improves file synchronization between workstation and boxes using archive transfer instead of individual transfers.
+
+The transport only works where ssh works and requires `tar` to be present both on the workstation and in the box.
+
+## Timing
+
+On my workstation, on a already created linux box, from "kitchen converge" to the beginning of chef-client converges:
+- with speedy\_ssh transport: 10 secs
+- without speedy transport: 180 secs
+
+Please note that cookbooks + roles + environments + databags represent around 5.5k files to transfer.
+
+Tested with test-kitchen 1.8
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kitchen-transport-speedy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kitchen-transport-speedy
+
+## Usage
+
+Modify your `.kitchen.yml` to include:
+
+```
+transport:
+  name: speedy_ssh
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/criteo/kitchen-transport-speedy.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/kitchen-transport-speedy.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitchen/transport/speedy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kitchen-transport-speedy"
+  spec.version       = Kitchen::Transport::SpeedyModule::VERSION
+  spec.authors       = ["Grégoire Seux"]
+  spec.email         = ["g.seux@criteo.com"]
+
+  spec.summary       = %q{Fast transport for test-kitchen using archiving}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'test-kitchen'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kitchen/transport/speedy.rb

@@ -0,0 +1,67 @@
+require "kitchen/transport/speedy/version"
+require 'kitchen'
+
+require 'mixlib/shellout'
+
+module Kitchen
+  module Transport
+
+    module SpeedyBase
+      # require :log_prefix
+      # copy paste from ssh transport
+      # see https://github.com/test-kitchen/test-kitchen/pull/726
+      def create_new_connection(options, &block)
+        if @connection
+          logger.debug("[#{log_prefix}] shutting previous connection #{@connection}")
+          @connection.close
+        end
+
+        @connection_options = options
+        @connection = self.class::Connection.new(options, &block)
+      end
+    end
+
+    module SpeedyConnectionBase
+
+      def valid_local_requirements?
+        raise NotImplementedError
+      end
+
+      def valid_remote_requirements?
+        raise NotImplementedError
+      end
+
+      def archive_locally(path, archive_path)
+        raise NotImplementedError
+      end
+
+      def  dearchive_remotely(archive_basename, remote)
+        raise NotImplementedError
+      end
+
+      def upload(locals, remote)
+        unless valid_local_requirements? && valid_remote_requirements?
+          logger.debug("Calling back default implementation since requirements cannot be validate locally and in the box")
+          return super
+        end
+
+        Array(locals).each do |local|
+          if ::File.directory?(local)
+            file_count = ::Dir.glob(::File.join(local, '**/*')).size
+            logger.debug("#{local} contains #{file_count}")
+            archive_basename = ::File.basename(local) + '.tar'
+            archive = ::File.join(::File.dirname(local), archive_basename)
+            Mixlib::ShellOut.new(archive_locally(local, archive)).run_command.error!
+
+            logger.debug("Calling regular upload for #{archive} to #{remote}")
+            super(archive, remote)
+            execute(dearchive_remotely(archive_basename, remote))
+          else
+            logger.debug("Calling regular upload for #{local} since it is a simple file")
+            super(local, remote)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/transport/speedy/version.rb

@@ -0,0 +1,7 @@
+module Kitchen
+  module Transport
+    class SpeedyModule
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/kitchen/transport/speedy_ssh.rb

@@ -0,0 +1,44 @@
+require_relative 'speedy'
+require 'kitchen/transport/ssh'
+
+module Kitchen
+  module Transport
+    class SpeedySsh < Ssh
+
+      kitchen_transport_api_version 1
+      plugin_version SpeedyModule::VERSION
+
+      def log_prefix
+        "SSH"
+      end
+
+      include SpeedyBase
+
+      class Connection < Ssh::Connection
+        include SpeedyConnectionBase
+
+        def valid_local_requirements?
+          !Mixlib::ShellOut.new("which tar > /dev/null").run_command.error?
+        end
+
+        def valid_remote_requirements?
+          begin
+            execute("which tar > /dev/null")
+            true
+          rescue => e
+            logger.debug(e)
+          end
+        end
+
+        def archive_locally(path, archive_path)
+          "tar -cf #{archive_path} -C #{::File.dirname(path)} #{::File.basename(path)}"
+        end
+
+        def dearchive_remotely(archive_basename, remote)
+          "tar -xf #{::File.join(remote, archive_basename)} -C #{remote}"
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-transport-speedy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grégoire Seux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- g.seux@criteo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kitchen-transport-speedy.gemspec
+- lib/kitchen/transport/speedy.rb
+- lib/kitchen/transport/speedy/version.rb
+- lib/kitchen/transport/speedy_ssh.rb
+homepage: 
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fast transport for test-kitchen using archiving
+test_files: []