kitchen-transport-express 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b255fcbeed01b423bd2bd8e71069501b2c0b636e3d2313ccdd48f8347106333d
-  data.tar.gz: 9696bbf314ccbda4c978cf89963e22005a18d064a359d835ccf033403d46f6b8
+  metadata.gz: e7399b24ea4426dcb6ea891466818b0a3471b24a6a67eb2163727afb8f9d7e35
+  data.tar.gz: fa22be3398901120654fe61679e913f3b714eaaa59f4c0c68bcd44bde1651410
 SHA512:
-  metadata.gz: 548f04230a39e196b59fd952a4a5247bb9ee4c754d88785f61400565d7c0bd8802a1857a3c7896bb7f1a311bb63475c7416b7746768436eee60fb9cfa0b2dcc7
-  data.tar.gz: ba37810bfcdafaa6ba2973e6410c35aac5ac57bc0f9102db149829cffadea1043a4a24c509f41801eacbc6347cec41ae66907c0b79d90d95484a8bc3ea4d3707
+  metadata.gz: 7b3e1b72d7b6f5117e286166e07092c83606965115650f6cf18949300280b1761e57ff78f43e375ce5785e317803c043b788b13167e6ea210ffec9c13294624c
+  data.tar.gz: 76f54ae47956867487ed15bea11dd1b114c5b92c6776da7efc9e44e4f2843837606c6fbf782ca3988fba4d62ffd3f2b5cf68ff74572e1ae0dbac9f8b35f2460e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # kitchen-transport-express CHANGELOG
 
+## 1.4.0
+* feat: ♻️ utilize concurrent futures for enhanced parallelism
+* feat: 🔊 enhanced logging
+
+## 1.3.1
+* fix: 🐛 ensure directories that only contain dot files get archived
+
 ## 1.3.0
 * chore: 📝 minor updates to method documentation
 * chore: 🔧 add metadata to gemspec

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

@@ -30,39 +30,64 @@ module Kitchen
         def archive(path)
           archive_basename = ::File.basename(path) + ".tgz"
           archive_full_name = ::File.join(::File.dirname(path), archive_basename)
-
-          file_count = ::Dir.glob(::File.join(path, "**/*")).size
-          logger.debug("[#{Express::LOG_PREFIX}] #{path} contains #{file_count} files.")
-          create_archive(path, archive_full_name)
+          files = all_files(path)
+          start_time = Time.now
+          create_archive(path, files, archive_full_name)
+          Express.log(logger, "create archive #{File.basename(archive_full_name)} (#{files.size} files)", start_time)
           archive_full_name
         end
 
+        # Transfers the archive to the remote host.
+        #
+        # @param session [Net::SSH::Connection::Session] the SSH session used to connect to the remote host and execute the extract and cleanup commands.
+        # @param local [String] the directory in the local sandbox that is being processed.
+        # @param remote [String] the remote directory (kitchen_root).
+        # @param opts [Hash] the ssh options that came in from the Kitchen instance.
+        def scp(session, local, remote, opts = {})
+          start_time = Time.now
+          session.scp.upload!(local, remote, opts)
+          Express.log(logger, "upload #{File.basename(local)} (Thread ID: #{Thread.current.object_id})", start_time)
+        end
+
         # Extracts the archive on the remote host.
         #
-        # @param session [Net::SSH::Connection::Session] The SSH session used to connect to the remote host and execute the extract and cleanup commands.
+        # @param session [Net::SSH::Connection::Session] the SSH session used to connect to the remote host and execute the extract and cleanup commands.
+        # @param local [String] the directory in the local sandbox that is being processed.
+        # @param remote [String] the remote directory (kitchen_root).
         def extract(session, local, remote)
           return unless local.match(/.*\.tgz/)
 
+          start_time = Time.now
           archive_basename = File.basename(local)
-          logger.debug("[#{Express::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} && rm -f #{File.join(remote, archive_basename)}")
           end
           session.loop
+          Express.log(logger, "extract #{File.basename(local)} (Thread ID: #{Thread.current.object_id})", start_time)
         end
 
         private
 
+        # Creates a list of all files that are in the directory to be archived.
+        #
+        # @param path [String] the path to the directory that will be archived.
+        # @return [Array] an array of all files to be archived.
+        # @api private
+        def all_files(path)
+          Dir.glob(File.join(path, "/**/*"), File::FNM_DOTMATCH).reject { |f| %w{. ..}.include? File.basename(f) }
+        end
+
         # Creats a archive of the directory provided.
         #
         # @param path [String] the path to the directory that will be archived.
+        # @param files [Array] the array of all files that will be archived.
         # @param archive_path [String] the fully qualified path to the archive that will be created.
         # @api private
-        def create_archive(path, archive_path)
+        def create_archive(path, files, archive_path)
           Archive.write_open_filename(archive_path, Archive::COMPRESSION_GZIP,
                                       Archive::FORMAT_TAR_PAX_RESTRICTED) do |tar|
-                                        write_content(tar, path)
+                                        write_content(tar, path, files)
                                       end
         end
 
@@ -70,10 +95,10 @@ module Kitchen
         #
         # @param tar [Archive::Writer] the instance of the archive class.
         # @param path [String] the path to the directory that will be archived.
+        # @param files [Array] the array of all files that will be archived.
         # @api private
-        def write_content(tar, path)
-          all_files = Dir.glob("#{path}/**/*")
-          all_files.each do |f|
+        def write_content(tar, path, files)
+          files.each do |f|
             if File.file? f
               tar.new_entry do |e|
                 entry(e, f, path)

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

@@ -20,7 +20,7 @@ module Kitchen
       # The version string for Kitchen Transport Express.
       #
       # @author Justin Steele <justin.steele@oracle.com>
-      VERSION = "1.3.0"
+      VERSION = "1.4.0"
     end
   end
 end

data/lib/kitchen/transport/express_ssh.rb

@@ -27,6 +27,16 @@ module Kitchen
     class Express
       # A constant that gets prepended to debugger messages.
       LOG_PREFIX = "EXPRESS"
+
+      # Logger class method to unify logging.
+      #
+      # @param logger [Kitchen::Logger] the logger that was created by the kitchen instance.
+      # @param message [String] the message to output.
+      # @param start_time [Time] the start time of the process if duration is desired to be part of the message.
+      def self.log(logger, message = nil, start_time = nil)
+        message = "#{message} (#{Time.now - start_time}s)" if start_time
+        logger.debug "[#{Express::LOG_PREFIX}] [#{Time.now.getutc.strftime("%Y-%m-%dT%H:%M:%S%:z")}] #{message}"
+      end
     end
 
     # Express SSH Transport Error class.
@@ -51,7 +61,7 @@ module Kitchen
       # @return [Ssh::Connection] an instance of Kitchen::Transport::ExpressSsh::Connection.
       def create_new_connection(options, &block)
         if @connection
-          logger.debug("[#{Express::LOG_PREFIX}] Shutting previous connection #{@connection}")
+          Express.log(logger, "shutting previous connection #{@connection}")
           @connection.close
         end
 
@@ -95,33 +105,35 @@ module Kitchen
         # @param locals [Array] the top-level list of directories and files to be transfered.
         # @param remote [String] the remote directory (kitchen_root).
         # @raise [ExpressFailed] if any of the threads raised an exception.
-        def upload(locals, remote) # rubocop: disable Metrics/MethodLength
+        def upload(locals, remote)
           return super unless valid_remote_requirements?(remote)
 
-          processed_locals = process_locals(locals)
-          pool, exceptions = thread_pool(processed_locals)
-          processed_locals.each do |local|
-            pool.post do
-              transfer(local, remote, session.options)
-            rescue => e
-              exceptions << e.cause
-            end
-          end
-          pool.shutdown
-          pool.wait_for_termination
-
-          raise ExpressFailed, exceptions.pop unless exceptions.empty?
-        end # rubocop: enable Metrics/MethodLength
+          start_time = Time.now
+          processed_local = process_locals(locals)
+          futures = create_futures(processed_local, remote)
+          all_done = Concurrent::Promise.zip(*futures).execute
+          all_done.value!
+        rescue => e
+          raise ExpressFailed, e.cause.to_s
+        ensure
+          Express.log(logger, "transport express complete", start_time)
+        end
 
         private
 
-        # Creates the thread pool and exceptions queue.
+        # Creates the concurrent futures.
         #
-        # @param processed_locals [Array] list of files and archives to be uploaded.
-        # @return [Array(Concurrent::FixedThreadPool, Queue)]
+        # @param locals [Array] list of files and archives to be uploaded.
+        # @return [Array(Concurrent::Promise)]
         # @api private
-        def thread_pool(processed_locals)
-          [Concurrent::FixedThreadPool.new([processed_locals.length, 10].min), Queue.new]
+        def create_futures(locals, remote)
+          # Start upload futures
+          executor = Concurrent::FixedThreadPool.new([locals.length, 10].min)
+          locals.map do |local|
+            Concurrent::Promise.execute(executor: executor) do
+              transfer(local, remote, session.options)
+            end
+          end
         end
 
         # Ensures the remote host has the minimum-required executables to extract the archives.
@@ -134,8 +146,7 @@ module Kitchen
           execute("mkdir -p #{remote}")
           true
         rescue => e
-          logger.debug("[#{Express::LOG_PREFIX}] Requirements not met on remote host for Express transport.")
-          logger.debug("[#{Express::LOG_PREFIX}] #{e}")
+          Express.log(logger, "Requirements not met on remote host for Express transport.\n#{e}")
           false
         end
 
@@ -166,13 +177,11 @@ module Kitchen
         # @raise [StandardError] if the files could not be uploaded successfully.
         # @api private
         def transfer(local, remote, opts = {})
-          logger.debug("[#{Express::LOG_PREFIX}] Transferring #{local} to #{remote}")
-
           Net::SSH.start(session.host, opts[:user], **opts) do |ssh|
-            ssh.scp.upload!(local, remote, opts)
+            scp(ssh, local, remote, opts)
             extract(ssh, local, remote)
           rescue Net::SCP::Error => ex
-            logger.debug("[#{Express::LOG_PREFIX}] upload failed with #{ex.message.strip}")
+            Express.log(logger, "upload failed with #{ex.message.strip}")
             raise "(#{ex.message.strip})"
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-transport-express
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Justin Steele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-14 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Skip the long lines in Kitchen Transport!