kitchen-transport-express 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b89707a72ba0d8afb26ec6cea9b18ea49cb22aee40c0291a1ceb01a1d2ea4fd
-  data.tar.gz: 14d5a4f4d22221053960bd9351c96bbc9d95231af2bb0590c517b559746f120f
+  metadata.gz: 0a21e10d9f04926c86f5594321e1beef3d71c314ed61649ff1476cf4d632a4ee
+  data.tar.gz: 2c0d14e4ae4cc96111e2fea95fde8affc3f89686867910c459007bb06c110bd2
 SHA512:
-  metadata.gz: ef0f2ba583d76b6c4bf2997f4e039374b7b79801eba8b5b678104d7a6e40db08a4433bc97c3b1845ee0b33b9bdab59232cdf593dc1c3e5767ee5be1016782858
-  data.tar.gz: 75b55d9dc967c84e981eb3b1bf1a6c92a88b304812909f32bf66a70d75aa6e28f528b22e839efc15a412dd355a71eb84860dabb89225f6e5a87dc6c4645ce040
+  metadata.gz: f9aa3d0be0cb45cf030333df24ca40431e1c387c7a3d0a086dacb03c5fa2c64f7e15bd02f98e1a5b70374950d986be90dd6757b0faeb460baa614992cca477af
+  data.tar.gz: 95e16299ded0673a3c7fd85db9e04defe7c0d04db6c51459024cd75badd8b3a1672485f8d7f0e40af7e21c6aaa9964e153676a390173d6e7e3a068939905df4d

data/.github/workflows/ruby.yml

@@ -9,7 +9,7 @@ name: Ruby
 
 on:
   pull_request:
-    branches: [ "master" ]
+    branches: [ "main" ]
 
 permissions:
   contents: read
@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.3', '2.5', '2.7', '3.0', '3.1']
+        ruby-version: ['2.5', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v4

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# kitchen-transport-express CHANGELOG
+
+## 1.1.0
+* feat: ⚡️ threaded execution of the upload and extract phase
+* fix: 🩹 add binary mode to archiver when reading a file
+* chore: ➕ add chefstyle and pry to development deps
+* chore: 📌 set minimum ruby version
+
+## 1.0.2
+* fix: 🐛 ensure finalize_config gets called
+
+## 1.0.1
+* chore: 📝 add github_url to gemspec
+
+## 1.0.0
+* feat: 🎉 initial release

data/README.md

@@ -1,5 +1,7 @@
 # Kitchen::Transport::Express
 
+[![Gem Version](https://badge.fury.io/rb/kitchen-transport-express.svg)](https://badge.fury.io/rb/kitchen-transport-express)
+
 `kitchen-transport-express` is a plugin for `Kitchen::Transport` that is designed to dramatically improve the time to converge  nodes over SSH. This gem was inspired by projects 
 like [kitchen-transport-speedy](https://github.com/criteo/kitchen-transport-speedy) and [kitchen-sync](https://github.com/coderanger/kitchen-sync).
 

data/kitchen-transport-express.gemspec

@@ -30,9 +30,13 @@ Gem::Specification.new do |spec|
   spec.metadata["github_repo"] = "https://github.com/justintsteele/kitchen-transport-express"
   spec.license       = "Apache-2.0"
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.4"
   spec.add_dependency "test-kitchen"
   spec.add_dependency "ffi-libarchive"
+  spec.add_dependency "concurrent-ruby"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "chefstyle"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/kitchen/transport/express/archiver.rb

@@ -30,10 +30,17 @@ module Kitchen
           archive_full_name
         end
 
-        def extract(archive_basename, remote)
-          logger.debug("[#{LOG_PREFIX}] Unpacking archive #{archive_basename} in #{remote}")
-          execute("tar -xzf #{::File.join(remote, archive_basename)} -C #{remote}")
-          execute("rm -f #{::File.join(remote, archive_basename)}")
+        def extract(session, local, remote)
+          return unless local.match(/.*\.tgz/)
+
+          archive_basename = File.basename(local)
+          logger.debug("[#{LOG_PREFIX}] Extracting #{::File.join(remote, archive_basename)}")
+          session.open_channel do |channel|
+            channel.request_pty
+            channel.exec("tar -xzf #{::File.join(remote, archive_basename)} -C #{remote}")
+            channel.exec("rm -f #{File.join(remote, archive_basename)}")
+          end
+          session.loop
         end
 
         private
@@ -78,7 +85,7 @@ module Kitchen
         end
 
         def content(file)
-          File.read file unless File.directory? file
+          File.read(file, mode: "rb") unless File.directory? file
         end
 
         def size(file)

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

@@ -17,7 +17,7 @@
 module Kitchen
   module Transport
     class Express
-      VERSION = "1.0.1"
+      VERSION = "1.1.0"
     end
   end
 end

data/lib/kitchen/transport/express_ssh.rb

@@ -15,6 +15,7 @@
 #   limitations under the License.
 
 require "kitchen/transport/ssh"
+require "concurrent-ruby"
 require_relative "express/version"
 require_relative "express/archiver"
 
@@ -41,11 +42,11 @@ module Kitchen
       end
 
       def finalize_config!(instance)
-        return unless verifier_defined?(instance)
-
         super.tap do
-          instance.verifier.send(:define_singleton_method, :runner_options_for_expressssh) do |config_data|
-            runner_options_for_ssh(config_data)
+          if verifier_defined?(instance)
+            instance.verifier.send(:define_singleton_method, :runner_options_for_expressssh) do |config_data|
+              runner_options_for_ssh(config_data)
+            end
           end
         end
       end
@@ -56,15 +57,14 @@ module Kitchen
         def upload(locals, remote)
           return super unless valid_remote_requirements?
 
-          Array(locals).each do |local|
-            if ::File.directory?(local)
-              archive = archive(local)
-              ensure_remote_dir_exists(remote)
-            end
-            logger.debug("[#{LOG_PREFIX}] Uploading #{File.basename(archive || local)} to #{remote}")
-            super(archive || local, remote)
-            extract(File.basename(archive), remote) if archive
+          execute("mkdir -p #{remote}")
+          processed_locals = process_locals(locals)
+          pool = Concurrent::FixedThreadPool.new([processed_locals.length, 10].min)
+          processed_locals.each do |local|
+            pool.post { transfer(local, remote, session.options) }
           end
+          pool.shutdown
+          pool.wait_for_termination
         end
 
         def valid_remote_requirements?
@@ -76,8 +76,28 @@ module Kitchen
           false
         end
 
-        def ensure_remote_dir_exists(remote)
-          execute("mkdir -p #{remote}")
+        private
+
+        def process_locals(locals)
+          processed_locals = []
+          Array(locals).each do |local|
+            if ::File.directory?(local)
+              archive_name = archive(local)
+              processed_locals.push archive_name
+            else
+              processed_locals.push local
+            end
+          end
+          processed_locals
+        end
+
+        def transfer(local, remote, opts = {})
+          logger.debug("[#{LOG_PREFIX}] Transferring #{local} to #{remote}")
+
+          Net::SSH.start(session.host, opts[:user], **opts) do |ssh|
+            ssh.scp.upload!(local, remote, opts)
+            extract(ssh, local, remote)
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-transport-express
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Steele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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
@@ -52,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chefstyle
+  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: pry
+  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
@@ -91,6 +133,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -112,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="