chef-winrm-fs 1.4.2 → 1.4.4

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

@@ -1,171 +1,193 @@
-# frozen_string_literal: true
-
-#
-# Copyright 2015 Shawn Neal <sneal@sneal.net>
-#
-# 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 "chef-winrm" unless defined?(WinRM::Connection)
-require_relative "scripts/scripts"
-require_relative "core/file_transporter"
-
-module WinRM
-  module FS
-    # Perform file transfer operations between a local machine and winrm endpoint
-    class FileManager
-      # Creates a new FileManager instance
-      # @param [WinRM::Connection] WinRM web connection client
-      def initialize(connection)
-        @connection = connection
-        @logger = connection.logger
-      end
-
-      # Gets the SHA1 checksum of the specified file if it exists,
-      # otherwise ''
-      # @param [String] The remote file path
-      # @parms [String] The digest method
-      def checksum(path, digest = "SHA1")
-        @logger.debug("checksum with #{digest}: #{path}")
-        script = WinRM::FS::Scripts.render("checksum", path: path, digest: digest)
-        ps_run(script).exitcode == 0
-      end
-
-      # Create the specifed directory recursively
-      # @param [String] The remote dir to create
-      # @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)
-        ps_run(script).exitcode == 0
-      end
-
-      # Deletes the file or directory at the specified path
-      # @param [String] The path to remove
-      # @return [Boolean] True if successful, otherwise False
-      def delete(path)
-        @logger.debug("deleting: #{path}")
-        script = WinRM::FS::Scripts.render("delete", path: path)
-        ps_run(script).exitcode == 0
-      end
-
-      # Downloads the specified remote file to the specified local path
-      # @param [String] The full path on the remote machine
-      # @param [String] The full path to write the file to locally
-      # rubocop:disable Metrics/MethodLength
-      def download(remote_path, local_path, chunk_size = 1024 * 1024, first = true)
-        @logger.debug("downloading: #{remote_path} -> #{local_path} #{chunk_size}")
-        index = 0
-        output = _output_from_file(remote_path, chunk_size, index)
-        return download_dir(remote_path, local_path, chunk_size, first) if output.exitcode == 2
-
-        return false if output.exitcode >= 1
-
-        File.open(local_path, "wb") do |fd|
-          out = _write_file(fd, output)
-          index += out.length
-          until out.empty?
-            output = _output_from_file(remote_path, chunk_size, index)
-            return false if output.exitcode >= 1
-
-            out = _write_file(fd, output)
-            index += out.length
-          end
-        end
-        true
-      end
-      # 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)
-        ps_run(script)
-      end
-
-      def _write_file(tofd, output)
-        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?
-
-        tofd.write(out)
-        out
-      end
-
-      # Checks to see if the given path exists on the target file system.
-      # @param [String] The full path to the directory or file
-      # @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)
-        ps_run(script).exitcode == 0
-      end
-
-      # Gets the current user's TEMP directory on the remote system, for example
-      # 'C:/Windows/Temp'
-      # @return [String] Full path to the temp directory
-      def temp_dir
-        @temp_dir ||= begin
-          ps_run("$env:TEMP").stdout.chomp.tr("\\", "/")
-        end
-      end
-
-      # Upload one or more local files and directories to a remote directory
-      # @example copy a single file to a winrm endpoint
-      #
-      #   file_manager.upload('/Users/sneal/myfile.txt', 'c:/foo/myfile.txt')
-      #
-      # @example copy a single directory to a winrm endpoint
-      #
-      #   file_manager.upload('c:/dev/my_dir', '$env:AppData')
-      #
-      # @param [String] A path to a local directory or file that will be copied
-      #   to the remote Windows box.
-      # @param [String] The target directory or file
-      #   This path may contain powershell style environment variables
-      # @yieldparam [Fixnum] Number of bytes copied in current payload sent to the winrm endpoint
-      # @yieldparam [Fixnum] The total number of bytes to be copied
-      # @yieldparam [String] Path of file being copied
-      # @yieldparam [String] Target path on the winrm endpoint
-      # @return [Fixnum] The total number of bytes copied
-      def upload(local_path, remote_path, &block)
-        @connection.shell(:powershell) do |shell|
-          file_transporter ||= WinRM::FS::Core::FileTransporter.new(shell)
-          begin
-            file_transporter.upload(local_path, remote_path, &block)[0]
-          ensure
-            file_transporter.close
-          end
-        end
-      end
-
-      private
-
-      def ps_run(cmd)
-        shell = @connection.shell(:powershell)
-        begin
-          shell.run(cmd)
-        ensure
-          shell.close
-        end
-      end
-
-      def download_dir(remote_path, local_path, chunk_size, first)
-        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|
-          download(File.join(remote_path.to_s, file.strip), File.join(local_path, file.strip), chunk_size, false)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+# Copyright 2015 Shawn Neal <sneal@sneal.net>
+#
+# 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 "chef-winrm" unless defined?(WinRM::Connection)
+require_relative "scripts/scripts"
+require_relative "core/file_transporter"
+
+module WinRM
+  module FS
+    # Perform file transfer operations between a local machine and winrm endpoint
+    class FileManager
+      # Creates a new FileManager instance
+      # @param [WinRM::Connection] WinRM web connection client
+      def initialize(connection)
+        @connection = connection
+        @logger = connection.logger
+      end
+
+      # Gets the SHA1 checksum of the specified file if it exists,
+      # otherwise ''
+      # @param [String] The remote file path
+      # @parms [String] The digest method
+      def checksum(path, digest = "SHA1")
+        @logger.debug("checksum with #{digest}: #{path}")
+        script = WinRM::FS::Scripts.render("checksum", path: path, digest: digest)
+        ps_run(script).exitcode == 0
+      end
+
+      # Create the specifed directory recursively
+      # @param [String] The remote dir to create
+      # @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)
+        ps_run(script).exitcode == 0
+      end
+
+      # Deletes the file or directory at the specified path
+      # @param [String] The path to remove
+      # @return [Boolean] True if successful, otherwise False
+      def delete(path)
+        @logger.debug("deleting: #{path}")
+        script = WinRM::FS::Scripts.render("delete", path: path)
+        ps_run(script).exitcode == 0
+      end
+
+      # Downloads the specified remote file to the specified local path
+      # @param [String] The full path on the remote machine
+      # @param [String] The full path to write the file to locally
+      # rubocop:disable Metrics/MethodLength
+      def download(remote_path, local_path, chunk_size = 1024 * 1024, first = true)
+        @logger.debug("downloading: #{remote_path} -> #{local_path} #{chunk_size}")
+        with_shell do
+          index = 0
+          output = _output_from_file(remote_path, chunk_size, index)
+          return download_dir(remote_path, local_path, chunk_size, first) if output.exitcode == 2
+
+          return false if output.exitcode >= 1
+
+          File.open(local_path, "wb") do |fd|
+            out = _write_file(fd, output)
+            index += out.length
+            until out.empty?
+              output = _output_from_file(remote_path, chunk_size, index)
+              return false if output.exitcode >= 1
+
+              out = _write_file(fd, output)
+              index += out.length
+            end
+          end
+        end
+        true
+      end
+      # 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)
+        ps_run(script)
+      end
+
+      def _write_file(tofd, output)
+        # Base64 decoding already discards any bytes outside the Base64
+        # alphabet, so the payload needs no scrubbing pass of its own.
+        out = output.stdout.unpack1("m")
+        # download.ps1.erb reads $chunk[0..$bytesRead], one byte past the data.
+        out.delete_suffix!("\x00")
+        return out if out.empty?
+
+        tofd.write(out)
+        out
+      end
+
+      # Checks to see if the given path exists on the target file system.
+      # @param [String] The full path to the directory or file
+      # @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)
+        ps_run(script).exitcode == 0
+      end
+
+      # Gets the current user's TEMP directory on the remote system, for example
+      # 'C:/Windows/Temp'
+      # @return [String] Full path to the temp directory
+      def temp_dir
+        @temp_dir ||= begin
+          ps_run("$env:TEMP").stdout.chomp.tr("\\", "/")
+        end
+      end
+
+      # Upload one or more local files and directories to a remote directory
+      # @example copy a single file to a winrm endpoint
+      #
+      #   file_manager.upload('/Users/sneal/myfile.txt', 'c:/foo/myfile.txt')
+      #
+      # @example copy a single directory to a winrm endpoint
+      #
+      #   file_manager.upload('c:/dev/my_dir', '$env:AppData')
+      #
+      # @param [String] A path to a local directory or file that will be copied
+      #   to the remote Windows box.
+      # @param [String] The target directory or file
+      #   This path may contain powershell style environment variables
+      # @yieldparam [Fixnum] Number of bytes copied in current payload sent to the winrm endpoint
+      # @yieldparam [Fixnum] The total number of bytes to be copied
+      # @yieldparam [String] Path of file being copied
+      # @yieldparam [String] Target path on the winrm endpoint
+      # @return [Fixnum] The total number of bytes copied
+      def upload(local_path, remote_path, &block)
+        @connection.shell(:powershell) do |shell|
+          file_transporter ||= WinRM::FS::Core::FileTransporter.new(shell)
+          begin
+            file_transporter.upload(local_path, remote_path, &block)[0]
+          ensure
+            file_transporter.close
+          end
+        end
+      end
+
+      private
+
+      def ps_run(cmd)
+        return @shell.run(cmd) if @shell
+
+        shell = @connection.shell(:powershell)
+        begin
+          shell.run(cmd)
+        ensure
+          shell.close
+        end
+      end
+
+      # Holds a single PowerShell shell open for the duration of the block, so
+      # that a transfer spanning many chunks pays to open and close a remote
+      # runspace once rather than once per chunk. Re-entrant: a nested call
+      # reuses the shell that is already open.
+      def with_shell
+        return yield if @shell
+
+        @shell = @connection.shell(:powershell)
+        begin
+          yield
+        ensure
+          @shell.close
+          @shell = nil
+        end
+      end
+
+      def download_dir(remote_path, local_path, chunk_size, first)
+        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"
+        ps_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
+    end
+  end
+end

data/lib/chef-winrm-fs/scripts/check_files.ps1.erb

@@ -1,49 +1,49 @@
-$hash_file = <%= hash_file %>
-
-Function Cleanup($disposable) {
-  if (($disposable -ne $null) -and ($disposable.GetType().GetMethod("Dispose") -ne $null)) {
-    $disposable.Dispose()
-  }
-}
-
-Function Check-Files($h) {
-  return $h.GetEnumerator() | ForEach-Object {
-    $dst = Unresolve-Path $_.Value.target
-    $dst_changed = $false
-    if(Test-Path $dst -PathType Container) {
-      $dst_changed = $true
-      $dst = Join-Path $dst $_.Value.src_basename
-    }
-    New-Object psobject -Property @{
-      chk_exists = ($exists = Test-Path $dst -PathType Leaf)
-      src_sha1 = ($sMd5 = $_.Key)
-      dst_sha1 = ($dMd5 = if ($exists) { Get-SHA1Sum $dst } else { $null })
-      chk_dirty = ($dirty = if ($sMd5 -ne $dMd5) { $true } else { $false })
-      verifies = if ($dirty -eq $false) { $true } else { $false }
-      target_is_folder = $dst_changed
-    }
-  } | Select-Object -Property chk_exists,src_sha1,dst_sha1,chk_dirty,verifies,target_is_folder
-}
-
-Function Get-SHA1Sum($src) {
-  Try {
-    $c = [System.Security.Cryptography.SHA1]::Create()
-    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
-    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
-  } 
-  Finally {
-    Cleanup $c
-    Cleanup $in
-  }
-}
-
-Function Unresolve-Path($path) {
-  if ($path -eq $null) {
-    return $null
-  }
-  else {
-    return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($path)
-  }
-}
-
-Check-Files $hash_file | ConvertTo-Csv -NoTypeInformation
+$hash_file = <%= hash_file %>
+
+Function Cleanup($disposable) {
+  if (($disposable -ne $null) -and ($disposable.GetType().GetMethod("Dispose") -ne $null)) {
+    $disposable.Dispose()
+  }
+}
+
+Function Check-Files($h) {
+  return $h.GetEnumerator() | ForEach-Object {
+    $dst = Unresolve-Path $_.Value.target
+    $dst_changed = $false
+    if(Test-Path $dst -PathType Container) {
+      $dst_changed = $true
+      $dst = Join-Path $dst $_.Value.src_basename
+    }
+    New-Object psobject -Property @{
+      chk_exists = ($exists = Test-Path $dst -PathType Leaf)
+      src_sha1 = ($sMd5 = $_.Key)
+      dst_sha1 = ($dMd5 = if ($exists) { Get-SHA1Sum $dst } else { $null })
+      chk_dirty = ($dirty = if ($sMd5 -ne $dMd5) { $true } else { $false })
+      verifies = if ($dirty -eq $false) { $true } else { $false }
+      target_is_folder = $dst_changed
+    }
+  } | Select-Object -Property chk_exists,src_sha1,dst_sha1,chk_dirty,verifies,target_is_folder
+}
+
+Function Get-SHA1Sum($src) {
+  Try {
+    $c = [System.Security.Cryptography.SHA1]::Create()
+    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
+    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
+  } 
+  Finally {
+    Cleanup $c
+    Cleanup $in
+  }
+}
+
+Function Unresolve-Path($path) {
+  if ($path -eq $null) {
+    return $null
+  }
+  else {
+    return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($path)
+  }
+}
+
+Check-Files $hash_file | ConvertTo-Csv -NoTypeInformation

data/lib/chef-winrm-fs/scripts/checksum.ps1.erb

@@ -1,13 +1,13 @@
-$p = $ExecutionContext.SessionState.Path
-$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-
-if (Test-Path $path -PathType Leaf) {
-  $cryptoProv = [System.Security.Cryptography.<%= digest %>]::Create()
-  $file = [System.IO.File]::Open($path,
-      [System.IO.Filemode]::Open, [System.IO.FileAccess]::Read)
-  $digest = ([System.BitConverter]::ToString($cryptoProv.ComputeHash($file)))
-  $digest = $digest.Replace("-","").ToLower()
-  $file.Close()
-
-  Write-Output $digest
-}
+$p = $ExecutionContext.SessionState.Path
+$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
+
+if (Test-Path $path -PathType Leaf) {
+  $cryptoProv = [System.Security.Cryptography.<%= digest %>]::Create()
+  $file = [System.IO.File]::Open($path,
+      [System.IO.Filemode]::Open, [System.IO.FileAccess]::Read)
+  $digest = ([System.BitConverter]::ToString($cryptoProv.ComputeHash($file)))
+  $digest = $digest.Replace("-","").ToLower()
+  $file.Close()
+
+  Write-Output $digest
+}

data/lib/chef-winrm-fs/scripts/create_dir.ps1.erb

@@ -1,6 +1,6 @@
-$p = $ExecutionContext.SessionState.Path
-$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-if (!(Test-Path $path)) {
-  New-Item -ItemType Directory -Force -Path $path | Out-Null
-}
-exit 0
+$p = $ExecutionContext.SessionState.Path
+$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
+if (!(Test-Path $path)) {
+  New-Item -ItemType Directory -Force -Path $path | Out-Null
+}
+exit 0

data/lib/chef-winrm-fs/scripts/delete.ps1.erb

@@ -1,6 +1,6 @@
-$p = $ExecutionContext.SessionState.Path
-$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-if (Test-Path $path) {
-  Remove-Item $path -Force -Recurse
-}
-exit 0
+$p = $ExecutionContext.SessionState.Path
+$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
+if (Test-Path $path) {
+  Remove-Item $path -Force -Recurse
+}
+exit 0

data/lib/chef-winrm-fs/scripts/download.ps1.erb

@@ -1,17 +1,17 @@
-$p = $ExecutionContext.SessionState.Path
-$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-$index = <%= index %>
-$chunkSize = <%= chunk_size %>
-if (Test-Path $path -PathType Leaf) {
-  $file = [System.IO.File]::OpenRead($path)
-  $seekedTo = $file.Seek($index, [System.IO.SeekOrigin]::Begin)
-  $chunk = New-Object byte[] $chunkSize
-  $bytesRead = $file.Read($chunk, 0, $chunkSize)
-  $bytes = [System.convert]::ToBase64String($chunk[0..$bytesRead])
-  Write-Host $bytes
-  exit 0
-}
-ElseIf (Test-Path $path -PathType Container) {
-  exit 2
-}
-exit 1
+$p = $ExecutionContext.SessionState.Path
+$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
+$index = <%= index %>
+$chunkSize = <%= chunk_size %>
+if (Test-Path $path -PathType Leaf) {
+  $file = [System.IO.File]::OpenRead($path)
+  $seekedTo = $file.Seek($index, [System.IO.SeekOrigin]::Begin)
+  $chunk = New-Object byte[] $chunkSize
+  $bytesRead = $file.Read($chunk, 0, $chunkSize)
+  $bytes = [System.convert]::ToBase64String($chunk[0..$bytesRead])
+  Write-Host $bytes
+  exit 0
+}
+ElseIf (Test-Path $path -PathType Container) {
+  exit 2
+}
+exit 1

data/lib/chef-winrm-fs/scripts/exists.ps1.erb

@@ -1,10 +1,10 @@
-$p = $ExecutionContext.SessionState.Path
-$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
-if (Test-Path $path) {
-  $true
-  exit 0
-}
-else {
-  $false
-  exit 1
-}
+$p = $ExecutionContext.SessionState.Path
+$path = $p.GetUnresolvedProviderPathFromPSPath("<%= path %>")
+if (Test-Path $path) {
+  $true
+  exit 0
+}
+else {
+  $false
+  exit 1
+}