winrm-transport 1.0.0

data/lib/winrm/transport/logging.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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.
+
+module WinRM
+
+  module Transport
+
+    # Mixin to use an optionally provided logger for logging.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    module Logging
+
+      # Logs a message on the logger at the debug level, if a logger is
+      # present.
+      #
+      # @param msg [String] a message to log
+      # @yield evaluates and uses return value as message to log. If msg
+      #   parameter is set, it will take precedence over the block.
+      def debug(msg = nil, &block)
+        return if logger.nil? || !logger.debug?
+        logger.debug("[#{log_subject}] " << (msg || block.call))
+      end
+
+      # The subject for log messages.
+      #
+      # @return [String] log subject
+      def log_subject
+        @log_subject ||= self.class.to_s.split("::").last
+      end
+    end
+  end
+end

data/lib/winrm/transport/shell_closer.rb

@@ -0,0 +1,71 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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.
+
+module WinRM
+
+  module Transport
+
+    # An object that can close a remote shell session over WinRM.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class ShellCloser
+
+      # @return [String,nil] the identifier for the current open remote
+      #   shell session
+      attr_accessor :shell_id
+
+      # Constructs a new ShellCloser.
+      #
+      # @param info [String] a string representation of the connection
+      # @param debug [true,false] whether or not debug messages should be
+      #   output
+      # @param args [Array] arguments to construct a `WinRM::WinRMWebService`
+      def initialize(info, debug, args)
+        @info = info
+        @debug = debug
+        @args = args
+      end
+
+      # Closes the remote shell session.
+      def call(*)
+        debug("[CommandExecutor] closing remote shell #{@shell_id} on #{@info}")
+        ::WinRM::WinRMWebService.new(*@args).close_shell(@shell_id)
+        debug("[CommandExecutor] remote shell #{@shell_id} closed")
+      rescue => e
+        debug("Exception: #{e.inspect}")
+      end
+
+      # @param shell_id [String] a remote shell ID
+      # @return [ShellCloser] a new ShellCloser with a copy of this object's
+      #   state and the shell_id set to the given parameter value
+      def for(shell_id)
+        self.class.new(@info, @debug, @args).tap { |c| c.shell_id = shell_id }
+      end
+
+      private
+
+      # Writes a debug message, if debug mode is enabled.
+      #
+      # @param message [String] a message
+      # @api private
+      def debug(message)
+        $stdout.puts "D      #{message}" if @debug
+      end
+    end
+  end
+end

data/lib/winrm/transport/tmp_zip.rb

@@ -0,0 +1,184 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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 "delegate"
+require "pathname"
+require "tempfile"
+require "zip"
+
+require "winrm/transport/logging"
+
+module WinRM
+
+  module Transport
+
+    # A temporary Zip file for a given directory.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class TmpZip
+
+      include Logging
+
+      # Contructs a new Zip file for the given directory.
+      #
+      # There are 2 ways to interpret the directory path:
+      #
+      # * If the directory has no path separator terminator, then the
+      #   directory basename will be used as the base directory in the
+      #   resulting zip file.
+      # * If the directory has a path separator terminator (such as `/` or
+      #   `\\`), then the entries under the directory will be added to the
+      #   resulting zip file.
+      #
+      # The following emaples assume a directory tree structure of:
+      #
+      #     src
+      #     |-- alpha.txt
+      #     |-- beta.txt
+      #     \-- sub
+      #         \-- charlie.txt
+      #
+      # @example Including the base directory in the zip file
+      #
+      #   TmpZip.new("/path/to/src")
+      #   # produces a zip file with entries:
+      #   # - src/alpha.txt
+      #   # - src/beta.txt
+      #   # - src/sub/charlie.txt
+      #
+      # @example Excluding the base directory in the zip file
+      #
+      #   TmpZip.new("/path/to/src/")
+      #   # produces a zip file with entries:
+      #   # - alpha.txt
+      #   # - beta.txt
+      #   # - sub/charlie.txt
+      #
+      # @param dir [String,Pathname,#to_s] path to the directory
+      # @param logger [#debug,#debug?] an optional logger/ui object that
+      #   responds to `#debug` and `#debug?` (default `nil`)
+      def initialize(dir, logger = nil)
+        @logger = logger
+        @dir = Pathname.new(dir)
+        @method = ::Zip::Entry::DEFLATED
+        @compression = Zlib::BEST_COMPRESSION
+        @zip_io = Tempfile.open(["tmpzip-", ".zip"], :binmode => true)
+        write_zip
+        @zip_io.close
+      end
+
+      # @return [Pathname] path to zip file
+      def path
+        Pathname.new(zip_io.path) if zip_io.path
+      end
+
+      # Unlinks (deletes) the zip file from the filesystem.
+      def unlink
+        zip_io.unlink
+      end
+
+      private
+
+      # @return [Integer] the compression used for Zip entries. Possible
+      #   values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION`,
+      #   and `Zlib::NO_COMPRESSION`.
+      # @api private
+      attr_reader :compression
+
+      # @return [Pathname] the directory used to create the Zip file
+      # @api private
+      attr_reader :dir
+
+      # @return [#debug] the logger
+      # @api private
+      attr_reader :logger
+
+      # @return [Integer] compression method used for Zip entries. Possible
+      #   values are `Zip::Entry::DEFLATED` and `Zip::Entry::STORED`.
+      # @api private
+      attr_reader :method
+
+      # @return [IO] the Zip file IO
+      # @api private
+      attr_reader :zip_io
+
+      # @return [Pathname] the path segement to be stripped off Zip entries
+      # @api private
+      def dir_strip
+        @dir_strip ||= if dir.to_s.end_with?("/", "\\")
+          Pathname.new(dir.to_s.chop)
+        else
+          dir.dirname
+        end
+      end
+
+      # @return [Array<Pathname] all recursive files under the base
+      #   directory, excluding directories
+      # @api private
+      def entries
+        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("::")
+      end
+
+      # Adds all file entries to the Zip output stream.
+      #
+      # @param zos [Zip::OutputStream] zip output stream
+      # @api private
+      def produce_zip_entries(zos)
+        entries.each do |entry|
+          entry_path = entry.sub("#{dir_strip}/", "")
+          debug { "+++ Adding #{entry_path}" }
+          zos.put_next_entry(entry_path, nil, nil, method, compression)
+          entry.open("rb") { |src| IO.copy_stream(src, zos) }
+        end
+        debug { "=== All files added." }
+      end
+
+      # Writes out a temporary Zip file.
+      #
+      # @api private
+      def write_zip
+        debug { "Populating files" }
+        Zip::OutputStream.write_buffer(NoDupIO.new(zip_io)) do |zos|
+          produce_zip_entries(zos)
+        end
+      end
+
+      # Simple delegate wrapper to prevent `#dup` calls being made on IO
+      # objects. This is used to bypass an issue in the `Zip::Outputstream`
+      # constructor where an incoming IO is duplicated, leading to races
+      # on flushing the final stream to disk.
+      #
+      # @author Fletcher Nichol <fnichol@nichol.ca>
+      # @api private
+      class NoDupIO < SimpleDelegator
+
+        # @return [self] returns self and does *not* return a duplicate
+        #   object
+        def dup
+          self
+        end
+      end
+    end
+  end
+end

data/lib/winrm/transport/version.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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.
+
+module WinRM
+
+  module Transport
+
+    VERSION = "1.0.0"
+  end
+end

data/support/check_files.ps1

@@ -0,0 +1,46 @@
+Function Cleanup($o) { if (($o -ne $null) -and ($o.GetType().GetMethod("Dispose") -ne $null)) { $o.Dispose() } }
+
+Function Decode-Base64File($src, $dst) {
+  Try {
+    $in = (Get-Item $src).OpenRead()
+    $b64 = New-Object -TypeName System.Security.Cryptography.FromBase64Transform
+    $m = [System.Security.Cryptography.CryptoStreamMode]::Read
+    $d = New-Object -TypeName System.Security.Cryptography.CryptoStream $in,$b64,$m
+    Copy-Stream $d ($out = [System.IO.File]::OpenWrite($dst))
+  } Finally { Cleanup $in; Cleanup $out; Cleanup $d }
+}
+
+Function Copy-Stream($src, $dst) { $b = New-Object Byte[] 4096; while (($i = $src.Read($b, 0, $b.Length)) -ne 0) { $dst.Write($b, 0, $i) } }
+
+Function Check-Files($h) {
+  return $h.GetEnumerator() | ForEach-Object {
+    $dst = Unresolve-Path $_.Key
+    New-Object psobject -Property @{
+      chk_exists = ($exists = Test-Path $dst -PathType Leaf)
+      src_md5 = ($sMd5 = $_.Value)
+      dst_md5 = ($dMd5 = if ($exists) { Get-MD5Sum $dst } else { $null })
+      chk_dirty = ($dirty = if ($sMd5 -ne $dMd5) { $true } else { $false })
+      verifies = if ($dirty -eq $false) { $true } else { $false }
+    }
+  } | Select-Object -Property chk_exists,src_md5,dst_md5,chk_dirty,verifies
+}
+
+Function Get-MD5Sum($src) {
+  Try {
+    $c = New-Object -TypeName System.Security.Cryptography.MD5CryptoServiceProvider
+    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
+    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
+  } Finally { Cleanup $c; Cleanup $in }
+}
+
+Function Invoke-Input($in) {
+  $in = Unresolve-Path $in
+  Decode-Base64File $in ($decoded = "$($in).ps1")
+  $expr = Get-Content $decoded | Out-String
+  Remove-Item $in,$decoded -Force
+  return Invoke-Expression "$expr"
+}
+
+Function Unresolve-Path($p) { if ($p -eq $null) { return $null } else { return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($p) } }
+
+Check-Files (Invoke-Input $hash_file) | ConvertTo-Csv -NoTypeInformation

data/support/decode_files.ps1

@@ -0,0 +1,60 @@
+Function Cleanup($o) { if (($o -ne $null) -and ($o.GetType().GetMethod("Dispose") -ne $null)) { $o.Dispose() } }
+
+Function Decode-Base64File($src, $dst) {
+  Try {
+    $in = (Get-Item $src).OpenRead()
+    $b64 = New-Object -TypeName System.Security.Cryptography.FromBase64Transform
+    $m = [System.Security.Cryptography.CryptoStreamMode]::Read
+    $d = New-Object -TypeName System.Security.Cryptography.CryptoStream $in,$b64,$m
+    echo $null > $dst
+    Copy-Stream $d ($out = [System.IO.File]::OpenWrite($dst))
+  } Finally { Cleanup $in; Cleanup $out; Cleanup $d }
+}
+
+Function Copy-Stream($src, $dst) { $b = New-Object Byte[] 4096; while (($i = $src.Read($b, 0, $b.Length)) -ne 0) { $dst.Write($b, 0, $i) } }
+
+Function Decode-Files($hash) {
+  $hash.GetEnumerator() | ForEach-Object {
+    $tmp = Unresolve-Path $_.Key
+    $sMd5 = (Get-Item $tmp).BaseName.Replace("b64-", "")
+    $tzip, $dst = (Unresolve-Path $_.Value["tmpzip"]), (Unresolve-Path $_.Value["dst"])
+    $decoded = if ($tzip -ne $null) { $tzip } else { $dst }
+    Decode-Base64File $tmp $decoded
+    Remove-Item $tmp -Force
+    $dMd5 = Get-MD5Sum $decoded
+    $verifies = if ($sMd5 -eq $dMd5) { $true } else { $false }
+    if ($tzip) { Unzip-File $tzip $dst; Remove-Item $tzip -Force }
+    New-Object psobject -Property @{ dst = $dst; verifies = $verifies; src_md5 = $sMd5; dst_md5 = $dMd5; tmpfile = $tmp; tmpzip = $tzip }
+  } | Select-Object -Property dst,verifies,src_md5,dst_md5,tmpfile,tmpzip
+}
+
+Function Get-MD5Sum($src) {
+  Try {
+    $c = New-Object -TypeName System.Security.Cryptography.MD5CryptoServiceProvider
+    $bytes = $c.ComputeHash(($in = (Get-Item $src).OpenRead()))
+    return ([System.BitConverter]::ToString($bytes)).Replace("-", "").ToLower()
+  } Finally { Cleanup $c; Cleanup $in }
+}
+
+Function Invoke-Input($in) {
+  $in = Unresolve-Path $in
+  Decode-Base64File $in ($decoded = "$($in).ps1")
+  $expr = Get-Content $decoded | Out-String
+  Remove-Item $in,$decoded -Force
+  return Invoke-Expression "$expr"
+}
+
+Function Release-COM($o) { if ($o -ne $null) { [void][System.Runtime.Interopservices.Marshal]::ReleaseComObject($o) } }
+
+Function Unresolve-Path($p) { if ($p -eq $null) { return $null } else { return $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($p) } }
+
+Function Unzip-File($src, $dst) {
+  $r = "HKLM:\Software\Microsoft\NET Framework Setup\NDP\v4"
+  if (($PSVersionTable.PSVersion.Major -ge 3) -and ((gp "$r\Full").Version -like "4.5*" -or (gp "$r\Client").Version -like "4.5*")) {
+    [System.Reflection.Assembly]::LoadWithPartialName("System.IO.Compression.FileSystem") | Out-Null; [System.IO.Compression.ZipFile]::ExtractToDirectory("$src", "$dst")
+  } else {
+    Try { $s = New-Object -ComObject Shell.Application; ($dp = $s.NameSpace($dst)).CopyHere(($z = $s.NameSpace($src)).Items(), 0x610) } Finally { Release-Com $s; Release-Com $z; Release-COM $dp }
+  }
+}
+
+Decode-Files (Invoke-Input $hash_file) | ConvertTo-Csv -NoTypeInformation

data/winrm-transport.gemspec

@@ -0,0 +1,52 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "winrm/transport/version"
+require "English"
+
+Gem::Specification.new do |spec|
+  spec.name          = "winrm-transport"
+  spec.version       = WinRM::Transport::VERSION
+  spec.authors       = ["Fletcher Nichol"]
+  spec.email         = ["fnichol@nichol.ca"]
+
+  spec.summary       = "WinRM transport logic for re-using remote shells " \
+                       "and uploading files. The original code was extracted " \
+                       "from the Test Kitchen project and remains the " \
+                       "primary reference use case."
+
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/test-kitchen/winrm-transport"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").
+    reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir        = "exe"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9.1"
+
+  spec.add_dependency "winrm",                  "~> 1.3"
+  spec.add_dependency "rubyzip",                ">= 1.1.7", "~> 1.1"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler",    "~> 1.9"
+  spec.add_development_dependency "rake",       "~> 10.0"
+
+  spec.add_development_dependency "fakefs",     "~> 0.4"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha",      "~> 1.1"
+
+  spec.add_development_dependency "countloc",   "~> 0.4"
+  spec.add_development_dependency "maruku",     "~> 0.6"
+  spec.add_development_dependency "simplecov",  "~> 0.7"
+  spec.add_development_dependency "yard",       "~> 0.8"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  spec.add_development_dependency "finstyle",   "1.4.0"
+  spec.add_development_dependency "cane",       "2.6.2"
+end