chef-winrm-fs 1.3.7 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53896e3ea3477e023ba00153d76610ac69701e467b3af19dd3c3a99051a8825b
-  data.tar.gz: b5fdc0e443bbe8c23380d9c0d8062554d521e40c97823daf9e3bed5f1f249166
+  metadata.gz: ff63f900e8d92ec0618ea948cbd905f183f3b5551e5f01ae4b981f1baf6d06c5
+  data.tar.gz: bc8a1f987323e2a59ed256939b999354600821816e8861af06aa8885ed756641
 SHA512:
-  metadata.gz: 4571a3701855390c207cba5d1ac0ce3fe5aaf8ef8a388820c051ec16b47cda74bce4aae6bb5ed49e709c2c0fd5460f5c097fd18311b49777652d438f5fb8d975
-  data.tar.gz: a90622ac3e83002808536d0353a74743c8ec11eb00077a5b15098245fcf703a098ae7c5f339a5d42e610fc548b262695a8ae0b7c431c1f6a3602f575ce3efa69
+  metadata.gz: 44a9f86a242bfdd119c7abf88a85ae5e873e7619c3f26fdc290cce9be1724eee305bdd0e834e6db503e1386f2b26a6a9c10baf3066802c444b406807588f3976
+  data.tar.gz: c1fb676b22ffce03a6392b5c0f9817b69426d1ae64eb30b90c705256f2a3c18104eeddc96f6a480b9199c4e4043726b7b883a3145e8ad97508bc5c8caa0f01aa

data/lib/chef-winrm-fs/core/file_transporter.rb

@@ -16,15 +16,21 @@
 # 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.
+$VERBOSE = true
 
-require 'benchmark' unless defined?(Benchmark)
-require 'csv' unless defined?(CSV)
-require 'digest' unless defined?(Digest)
-require 'securerandom' unless defined?(SecureRandom)
-require 'stringio' unless defined?(StringIO)
+require "benchmark" unless defined?(Benchmark)
 
-require 'chef-winrm/exceptions'
-require 'chef-winrm-fs/core/tmp_zip'
+# require "pry"
+# require "pry-byebug" if defined?(PryByebug)
+# binding.pry
+
+require "csv" unless defined?(CSV)
+require "digest" unless defined?(Digest)
+require "securerandom" unless defined?(SecureRandom)
+require "stringio" unless defined?(StringIO)
+
+require "chef-winrm/exceptions"
+require "chef-winrm-fs/core/tmp_zip"
 
 module WinRM
   module FS
@@ -38,7 +44,7 @@ module WinRM
       # Exception for the case where upload source contains more than one
       # StringIO object, or a combination of file/directory paths and StringIO object
       class UploadSourceError < StandardError
-        def initialize(msg = 'Only a single StringIO object may be uploaded.')
+        def initialize(msg = "Only a single StringIO object may be uploaded.")
           super
         end
       end
@@ -126,7 +132,7 @@ module WinRM
         # @return [String] the Array pack template for Base64 encoding a stream
         #   of data
         # @api private
-        BASE64_PACK = 'm0'.freeze
+        BASE64_PACK = "m0".freeze
 
         # @return [String] the directory where temporary upload artifacts are
         #   persisted
@@ -148,9 +154,9 @@ module WinRM
         def max_encoded_write
           @max_encoded_write ||= begin
             empty_command = WinRM::PSRP::MessageFactory.create_pipeline_message(
-              '00000000-0000-0000-0000-000000000000',
-              '00000000-0000-0000-0000-000000000000',
-              stream_command('')
+              "00000000-0000-0000-0000-000000000000",
+              "00000000-0000-0000-0000-000000000000",
+              stream_command("")
             )
             shell.max_fragment_blob_size - empty_command.bytes.length
           end
@@ -166,7 +172,7 @@ module WinRM
         # @api private
         def reconcile_destinations!(files)
           files.each do |_, data|
-            data['dst'] = File.join(data['dst'], File.basename(data['src'])) if data['target_is_folder'] == 'True'
+            data["dst"] = File.join(data["dst"], File.basename(data["src"])) if data["target_is_folder"] == "True"
           end
         end
 
@@ -185,12 +191,12 @@ module WinRM
           zip_sha1 = sha1sum(zip_io.path)
 
           hash[zip_sha1] = {
-            'src' => dir,
-            'src_zip' => zip_io.path.to_s,
-            'zip_io' => zip_io,
-            'tmpzip' => "#{TEMP_UPLOAD_DIRECTORY}\\tmpzip-#{zip_sha1}.zip",
-            'dst' => "#{remote}\\#{File.basename(dir)}",
-            'size' => File.size(zip_io.path)
+            "src" => dir,
+            "src_zip" => zip_io.path.to_s,
+            "zip_io" => zip_io,
+            "tmpzip" => "#{TEMP_UPLOAD_DIRECTORY}\\tmpzip-#{zip_sha1}.zip",
+            "dst" => "#{remote}\\#{File.basename(dir)}",
+            "size" => File.size(zip_io.path),
           }
         end
 
@@ -203,9 +209,9 @@ module WinRM
         def add_file_hash!(hash, local, remote)
           logger.debug "creating hash for file #{remote}"
           hash[sha1sum(local)] = {
-            'src' => local,
-            'dst' => remote,
-            'size' => local.is_a?(StringIO) ? local.size : File.size(local)
+            "src" => local,
+            "dst" => remote,
+            "size" => local.is_a?(StringIO) ? local.size : File.size(local),
           }
         end
 
@@ -218,9 +224,9 @@ module WinRM
         # @return [Hash] a report hash, keyed by the local SHA1 digest
         # @api private
         def check_files(files)
-          logger.debug 'Running check_files.ps1'
+          logger.debug "Running check_files.ps1"
           hash_file = check_files_ps_hash(files)
-          script = WinRM::FS::Scripts.render('check_files', hash_file: hash_file)
+          script = WinRM::FS::Scripts.render("check_files", hash_file: hash_file)
           parse_response(shell.run(script))
         end
 
@@ -235,10 +241,10 @@ module WinRM
             [
               sha1,
               {
-                'target' => data.fetch('tmpzip', data['dst']),
-                'src_basename' => data['src'].is_a?(StringIO) ? data['dst'] : File.basename(data['src']),
-                'dst' => data['dst']
-              }
+                "target" => data.fetch("tmpzip", data["dst"]),
+                "src_basename" => data["src"].is_a?(StringIO) ? data["dst"] : File.basename(data["src"]),
+                "dst" => data["dst"],
+              },
             ]
           end
           ps_hash(Hash[hash])
@@ -250,10 +256,10 @@ module WinRM
         # @param files [Hash] a files hash
         # @api private
         def cleanup(files)
-          files.select { |_, data| data.key?('zip_io') }.each do |sha1, data|
-            data.fetch('zip_io').unlink
-            files.fetch(sha1).delete('zip_io')
-            logger.debug "Cleaned up src_zip #{data['src_zip']}"
+          files.select { |_, data| data.key?("zip_io") }.each do |sha1, data|
+            data.fetch("zip_io").unlink
+            files.fetch(sha1).delete("zip_io")
+            logger.debug "Cleaned up src_zip #{data["src_zip"]}"
           end
         end
 
@@ -270,11 +276,11 @@ module WinRM
           extracted_files = extract_files_ps_hash(files)
 
           if extracted_files == ps_hash({})
-            logger.debug 'No remote files to extract, skipping'
+            logger.debug "No remote files to extract, skipping"
             {}
           else
-            logger.debug 'Running extract_files.ps1'
-            script = WinRM::FS::Scripts.render('extract_files', hash_file: extracted_files)
+            logger.debug "Running extract_files.ps1"
+            script = WinRM::FS::Scripts.render("extract_files", hash_file: extracted_files)
 
             parse_response(shell.run(script))
           end
@@ -288,11 +294,11 @@ module WinRM
         # @return [String] the inner contents of a PowerShell Hash Table
         # @api private
         def extract_files_ps_hash(files)
-          file_data = files.select { |_, data| data.key?('tmpzip') }
+          file_data = files.select { |_, data| data.key?("tmpzip") }
 
           result = file_data.map do |sha1, data|
-            val = { 'dst' => data['dst'] }
-            val['tmpzip'] = data['tmpzip'] if data['tmpzip']
+            val = { "dst" => data["dst"] }
+            val["tmpzip"] = data["tmpzip"] if data["tmpzip"]
 
             [sha1, val]
           end
@@ -308,7 +314,7 @@ module WinRM
           total = 0 if total.nil?
           minutes = (total / 60).to_i
           seconds = (total - (minutes * 60))
-          format('(%dm%.2fs)', minutes, seconds)
+          format("(%dm%.2fs)", minutes, seconds)
         end
 
         # Contructs a Hash of files or directories, keyed by the local SHA1
@@ -329,7 +335,7 @@ module WinRM
             else
               local = local.to_s
               expanded = File.expand_path(local)
-              expanded += local[-1] if local.end_with?('/', '\\')
+              expanded += local[-1] if local.end_with?("/", "\\")
               if File.file?(expanded)
                 add_file_hash!(hash, expanded, remote)
               elsif File.directory?(expanded)
@@ -387,7 +393,7 @@ module WinRM
         # @return [String] a whitespace padded string of the given length
         # @api private
         def pad(depth = 0)
-          ' ' * depth
+          " " * depth
         end
 
         # Parses response of a PowerShell script or CMD command which contains
@@ -404,17 +410,17 @@ module WinRM
           if exitcode != 0
             raise FileTransporterFailed, "[#{self.class}] Upload failed " \
               "(exitcode: #{exitcode})\n#{stderr}"
-          elsif stderr != '\r\n' && stderr != ''
+          elsif stderr != '\r\n' && stderr != ""
             raise FileTransporterFailed, "[#{self.class}] Upload failed " \
               "(exitcode: 0), but stderr present\n#{stderr}"
           end
 
-          logger.debug 'Parsing CSV Response'
+          logger.debug "Parsing CSV Response"
           logger.debug output.stdout
 
           array = CSV.parse(output.stdout, headers: true).map(&:to_hash)
-          array.each { |h| h.each { |key, value| h[key] = nil if value == '' } }
-          Hash[array.map { |entry| [entry.fetch('src_sha1'), entry] }]
+          array.each { |h| h.each { |key, value| h[key] = nil if value == "" } }
+          Hash[array.map { |entry| [entry.fetch("src_sha1"), entry] }]
         end
 
         # Converts a Ruby hash into a PowerShell hash table, represented in a
@@ -429,10 +435,10 @@ module WinRM
         def ps_hash(obj, depth = 0)
           if obj.is_a?(Hash)
             obj.map do |k, v|
-              %(#{pad(depth + 2)}#{ps_hash(k)} = #{ps_hash(v, depth + 2)})
+              %{#{pad(depth + 2)}#{ps_hash(k)} = #{ps_hash(v, depth + 2)}}
             end.join(";\n").insert(0, "@{\n").insert(-1, "\n#{pad(depth)}}")
           else
-            %("#{obj}")
+            %{"#{obj}"}
           end
         end
 
@@ -456,7 +462,7 @@ module WinRM
           chunk = 1
           bytes = 0
           # Do not freeze this string
-          buffer = ''
+          buffer = ""
           shell.run(<<-PS
             $to = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("#{dest}")
             $parent = Split-Path $to
@@ -486,7 +492,7 @@ module WinRM
             chunk += 1
             yield bytes if block_given?
           end
-          shell.run('$fileStream.Dispose()')
+          shell.run("$fileStream.Dispose()")
           buffer = nil # rubocop:disable Lint/UselessAssignment
 
           [chunk - 1, bytes]
@@ -515,7 +521,7 @@ module WinRM
             if src.is_a?(StringIO)
               chunks, bytes = stream_upload(src, dest, &block)
             else
-              File.open(src, 'rb') do |io|
+              File.open(src, "rb") do |io|
                 chunks, bytes = stream_upload(io, dest, &block)
               end
             end
@@ -539,16 +545,16 @@ module WinRM
         def stream_upload_files(files)
           response = {}
           files.each do |sha1, data|
-            src = data.fetch('src_zip', data['src'])
-            if data['chk_dirty'] == 'True'
-              response[sha1] = { 'dest' => data['tmpzip'] || data['dst'] }
-              chunks, bytes = stream_upload_file(src, data['tmpzip'] || data['dst']) do |xfered|
-                yield data['src'], xfered
+            src = data.fetch("src_zip", data["src"])
+            if data["chk_dirty"] == "True"
+              response[sha1] = { "dest" => data["tmpzip"] || data["dst"] }
+              chunks, bytes = stream_upload_file(src, data["tmpzip"] || data["dst"]) do |xfered|
+                yield data["src"], xfered
               end
-              response[sha1]['chunks'] = chunks
-              response[sha1]['xfered'] = bytes
+              response[sha1]["chunks"] = chunks
+              response[sha1]["xfered"] = bytes
             else
-              logger.debug "File #{data['dst']} is up to date, skipping"
+              logger.debug "File #{data["dst"]} is up to date, skipping"
             end
           end
           response
@@ -563,7 +569,7 @@ module WinRM
         # @api private
         def total_base64_transfer_size(files)
           size = 0
-          files.values.each { |file| size += file['size'] if file['chk_dirty'] == 'True' }
+          files.values.each { |file| size += file["size"] if file["chk_dirty"] == "True" }
           size / 3 * 4
         end
       end

data/lib/chef-winrm-fs/core/tmp_zip.rb

@@ -17,10 +17,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'delegate'
-require 'pathname' unless defined?(Pathname)
-require 'tempfile' unless defined?(Tempfile)
-require 'zip' unless defined?(Zip)
+require "delegate"
+require "pathname" unless defined?(Pathname)
+require "tempfile" unless defined?(Tempfile)
+require "zip" unless defined?(Zip)
 
 module WinRM
   module FS
@@ -70,7 +70,7 @@ module WinRM
         def initialize(dir, logger = nil)
           @logger = logger || Logging.logger[self]
           @dir = clean_dirname(dir)
-          @zip_io = Tempfile.open(['tmpzip-', '.zip'], binmode: true)
+          @zip_io = Tempfile.open(["tmpzip-", ".zip"], binmode: true)
           write_zip
           @zip_io.close
         end
@@ -113,13 +113,13 @@ module WinRM
         #   directory, excluding directories
         # @api private
         def entries
-          Pathname.glob(dir.join('**/.*')).push(*Pathname.glob(dir.join('**/*'))).delete_if(&:directory?).sort
+          Pathname.glob(dir.join("**/.*")).push(*Pathname.glob(dir.join("**/*"))).delete_if(&:directory?).sort
         end
 
         # (see Logging.log_subject)
         # @api private
         def log_subject
-          @log_subject ||= [self.class.to_s.split('::').last, path].join('::')
+          @log_subject ||= [self.class.to_s.split("::").last, path].join("::")
         end
 
         # Adds all file entries to the Zip output stream.
@@ -134,16 +134,16 @@ module WinRM
               zip_entry(entry_path),
               nil, nil, ::Zip::Entry::DEFLATED, Zlib::BEST_COMPRESSION
             )
-            entry.open('rb') { |src| IO.copy_stream(src, zos) }
+            entry.open("rb") { |src| IO.copy_stream(src, zos) }
           end
-          logger.debug '=== All files added.'
+          logger.debug "=== All files added."
         end
 
         # Writes out a temporary Zip file.
         #
         # @api private
         def write_zip
-          logger.debug 'Populating files'
+          logger.debug "Populating files"
           Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
             produce_zip_entries(zos)
           end

data/lib/chef-winrm-fs/file_manager.rb

@@ -15,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'chef-winrm' unless defined?(WinRM::Connection)
-require_relative 'scripts/scripts'
-require_relative 'core/file_transporter'
+require "chef-winrm" unless defined?(WinRM::Connection)
+require_relative "scripts/scripts"
+require_relative "core/file_transporter"
 
 module WinRM
   module FS
@@ -34,9 +34,9 @@ module WinRM
       # otherwise ''
       # @param [String] The remote file path
       # @parms [String] The digest method
-      def checksum(path, digest = 'SHA1')
+      def checksum(path, digest = "SHA1")
         @logger.debug("checksum with #{digest}: #{path}")
-        script = WinRM::FS::Scripts.render('checksum', path: path, digest: digest)
+        script = WinRM::FS::Scripts.render("checksum", path: path, digest: digest)
         ps_run(script).exitcode == 0
       end
 
@@ -45,7 +45,7 @@ module WinRM
       # @return [Boolean] True if successful, otherwise false
       def create_dir(path)
         @logger.debug("create_dir: #{path}")
-        script = WinRM::FS::Scripts.render('create_dir', path: path)
+        script = WinRM::FS::Scripts.render("create_dir", path: path)
         ps_run(script).exitcode == 0
       end
 
@@ -54,7 +54,7 @@ module WinRM
       # @return [Boolean] True if successful, otherwise False
       def delete(path)
         @logger.debug("deleting: #{path}")
-        script = WinRM::FS::Scripts.render('delete', path: path)
+        script = WinRM::FS::Scripts.render("delete", path: path)
         ps_run(script).exitcode == 0
       end
 
@@ -70,7 +70,7 @@ module WinRM
 
         return false if output.exitcode >= 1
 
-        File.open(local_path, 'wb') do |fd|
+        File.open(local_path, "wb") do |fd|
           out = _write_file(fd, output)
           index += out.length
           until out.empty?
@@ -86,12 +86,12 @@ module WinRM
       # rubocop:enable Metrics/MethodLength
 
       def _output_from_file(remote_path, chunk_size, index)
-        script = WinRM::FS::Scripts.render('download', path: remote_path, chunk_size: chunk_size, index: index)
+        script = WinRM::FS::Scripts.render("download", path: remote_path, chunk_size: chunk_size, index: index)
         ps_run(script)
       end
 
       def _write_file(tofd, output)
-        contents = output.stdout.gsub('\n\r', '')
+        contents = output.stdout.gsub('\n\r', "")
         out = Base64.decode64(contents)
         out = out[0, out.length - 1] if out.end_with? "\x00"
         return out if out.empty?
@@ -105,7 +105,7 @@ module WinRM
       # @return [Boolean] True if the file/dir exists, otherwise false.
       def exists?(path)
         @logger.debug("exists?: #{path}")
-        script = WinRM::FS::Scripts.render('exists', path: path)
+        script = WinRM::FS::Scripts.render("exists", path: path)
         ps_run(script).exitcode == 0
       end
 
@@ -114,7 +114,7 @@ module WinRM
       # @return [String] Full path to the temp directory
       def temp_dir
         @temp_dir ||= begin
-          ps_run('$env:TEMP').stdout.chomp.tr('\\', '/')
+          ps_run("$env:TEMP").stdout.chomp.tr("\\", "/")
         end
       end
 
@@ -162,7 +162,7 @@ module WinRM
         local_path = File.join(local_path, File.basename(remote_path.to_s)) if first
         FileUtils.mkdir_p(local_path) unless File.directory?(local_path)
         command = "Get-ChildItem #{remote_path} | Select-Object Name"
-        @connection.shell(:powershell) { |e| e.run(command) }.stdout.strip.split(/\n/).drop(2).each do |file|
+        @connection.shell(:powershell) { |e| e.run(command) }.stdout.strip.split("\n").drop(2).each do |file|
           download(File.join(remote_path.to_s, file.strip), File.join(local_path, file.strip), chunk_size, false)
         end
       end

data/lib/chef-winrm-fs/scripts/scripts.rb

@@ -15,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'erubi'
+require "erubi"
 
 module WinRM
   module FS

data/lib/chef-winrm-fs.rb

@@ -15,11 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'chef-winrm' unless defined?(WinRM::Connection)
-require 'logger'
-require 'pathname' unless defined?(Pathname)
-require_relative 'chef-winrm-fs/exceptions'
-require_relative 'chef-winrm-fs/file_manager'
+require "chef-winrm" unless defined?(WinRM::Connection)
+require "logger"
+require "pathname" unless defined?(Pathname)
+require_relative "chef-winrm-fs/exceptions"
+require_relative "chef-winrm-fs/file_manager"
 
 module WinRM
   # WinRM File System

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: chef-winrm-fs
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.4.0
 platform: ruby
 authors:
 - Shawn Neal
 - Matt Wrock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-winrm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.11
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.11
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +73,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -116,19 +144,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: cookstyle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: '8.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: '8.1'
 description: "    Ruby library for file system operations via Windows Remote Management\n"
 email:
 - sneal@sneal.net
@@ -160,7 +188,7 @@ homepage: http://github.com/WinRb/winrm-fs
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "-x"
 - test/
@@ -172,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -180,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: WinRM File System
 test_files: []