winrm 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc4d15623138a5d39c308936ad8e6738621317c0
-  data.tar.gz: 64064ba319d3d5d856ba346a383823ccd0054f40
+  metadata.gz: aa96ea262bfb740bcf397684129464232f76321f
+  data.tar.gz: ca5894916562e3d5243c2099f8a439b10922d140
 SHA512:
-  metadata.gz: dab6833383b786a008734ef928a4f7ed2346b912f6e342fde139053053bede56296e097f17726e801b5ef7d0023ba9ee8b373ff7b5d545e78564c6ff13900f94
-  data.tar.gz: 5c7c43892944ed073c2cc66a6bf590e4164e052c6b6d596dec684408dd11594d3da8ea275f39d724d197571ce746ce65378a2e1f9a6394bae4955f4c09ed1efd
+  metadata.gz: 87d111e8d6597aeb11a24dcf2a33f569426c48bd91940c25e27f461c4ca2e4d2c939eaa518f1b479e35f163700559fa152a5346c0ffd71693f3021bedeb77dfa
+  data.tar.gz: f349d8858850cb6f3017b67cab69fc8c843f5d188eecaec95903e7f7bedb098160babfe7fa83e58d2b77999dc23c8a0d6891617d6c4d069daf8a2c1d8c7a2fe4

data/changelog.md

@@ -1,5 +1,8 @@
 # WinRM Gem Changelog
 
+# 1.6.1
+- Use codepage 437 by default on os versions older than Windows 7 and Windows Server 2008 R2
+
 # 1.6.0
 - Adding `:negotiate` transport providing NTLM/Negotiate encryption of WinRM requests and responses
 - Removed dependency on UUIDTools gem

data/lib/winrm/command_executor.rb

@@ -35,11 +35,6 @@ module WinRM
       proc { service.close_shell(shell_id) }
     end
 
-    # @return [Integer,nil] the safe maximum number of commands that can
-    #   be executed in one remote shell session, or `nil` if the
-    #   threshold has not yet been determined
-    attr_reader :max_commands
-
     # @return [WinRM::WinRMWebService] a WinRM web service object
     attr_reader :service
 
@@ -53,7 +48,6 @@ module WinRM
     #   responds to `#debug` and `#info` (default: `nil`)
     def initialize(service)
       @service = service
-      @logger = service.logger
       @command_count = 0
     end
 
@@ -74,10 +68,11 @@ module WinRM
     # @return [String] the remote shell session indentifier
     def open
       close
-      retryable(service.retry_limit, service.retry_delay) { @shell = service.open_shell }
+      retryable(service.retry_limit, service.retry_delay) do
+        @shell = service.open_shell(codepage: code_page)
+      end
       add_finalizer(shell)
       @command_count = 0
-      determine_max_commands unless max_commands
       shell
     end
 
@@ -91,7 +86,7 @@ module WinRM
     # @return [WinRM::Output] output object with stdout, stderr, and
     #   exit code
     def run_cmd(command, arguments = [], &block)
-      reset if command_count_exceeded?
+      reset if command_count > max_commands
       ensure_open_shell!
 
       @command_count += 1
@@ -120,39 +115,34 @@ module WinRM
         [
           '-encodedCommand',
           ::WinRM::PowershellScript.new(
-            safe_script(script_file.is_a?(IO) ? script_file.read : script_file)
+            script_file.is_a?(IO) ? script_file.read : script_file
           ).encoded
         ],
         &block
       )
     end
 
-    private
-
-    # @return [Integer] the default maximum number of commands which can be
-    #   executed in one remote shell session on "older" versions of Windows
-    # @api private
-    LEGACY_LIMIT = 15
+    # Code page appropriate to os version. utf-8 (65001) is buggy pre win7/2k8r2
+    # So send MS-DOS (437) for earlier versions
+    #
+    # @return [Integer] code page in use
+    def code_page
+      @code_page ||= os_version < '6.1' ? 437 : 65_001
+    end
 
-    # @return [Integer] the default maximum number of commands which can be
-    #   executed in one remote shell session on "modern" versions of Windows
-    # @api private
-    MODERN_LIMIT = 1500
+    # @return [Integer] the safe maximum number of commands that can
+    #   be executed in one remote shell session
+    def max_commands
+      @max_commands ||= (os_version < '6.2' ? 15 : 1500) - 2
+    end
 
-    # @return [String] the PowerShell command used to determine the version
-    #   of Windows
-    # @api private
-    PS1_OS_VERSION = '[environment]::OSVersion.Version.tostring()'.freeze
+    private
 
     # @return [Integer] the number of executed commands on the remote
     #   shell session
     # @api private
     attr_accessor :command_count
 
-    # @return [#debug,#info] the logger
-    # @api private
-    attr_reader :logger
-
     # Creates a finalizer for this connection which will close the open
     # remote shell session when the object is garabage collected or on
     # Ruby VM shutdown.
@@ -163,13 +153,6 @@ module WinRM
       ObjectSpace.define_finalizer(self, self.class.finalize(shell_id, service))
     end
 
-    # @return [true,false] whether or not the number of exeecuted commands
-    #   have exceeded the maxiumum threshold
-    # @api private
-    def command_count_exceeded?
-      command_count > max_commands.to_i
-    end
-
     # Ensures that there is an open remote shell session.
     #
     # @raise [WinRM::WinRMError] if there is no open shell
@@ -179,14 +162,19 @@ module WinRM
         'before any run methods are invoked' if shell.nil?
     end
 
-    # Determines the safe maximum number of commands that can be executed
-    # on a remote shell session by interrogating the remote host.
+    # Fetches the OS build bersion of the remote endpoint
     #
     # @api private
-    def determine_max_commands
-      os_version = run_powershell_script(PS1_OS_VERSION).stdout.chomp
-      @max_commands = os_version < '6.2' ? LEGACY_LIMIT : MODERN_LIMIT
-      @max_commands -= 2 # to be safe
+    def os_version
+      @os_version ||= begin
+        version = nil
+        wql = service.run_wql('select version from Win32_OperatingSystem')
+        if wql[:xml_fragment]
+          version = wql[:xml_fragment].first[:version] if wql[:xml_fragment].first[:version]
+        end
+        fail ::WinRM::WinRMError, 'Unable to determine endpoint os version' if version.nil?
+        version
+      end
     end
 
     # Removes any finalizers for this connection.
@@ -200,7 +188,7 @@ module WinRM
     #
     # @api private
     def reset
-      logger.debug("Resetting WinRM shell (Max command limit is #{max_commands})")
+      service.logger.debug("Resetting WinRM shell (Max command limit is #{max_commands})")
       open
     end
 
@@ -215,11 +203,11 @@ module WinRM
       yield
     rescue *RESCUE_EXCEPTIONS_ON_ESTABLISH.call => e
       if (retries -= 1) > 0
-        logger.info("[WinRM] connection failed. retrying in #{delay} seconds (#{e.inspect})")
+        service.logger.info("[WinRM] connection failed. retrying in #{delay} seconds: #{e.inspect}")
         sleep(delay)
         retry
       else
-        logger.warn("[WinRM] connection failed, terminating (#{e.inspect})")
+        service.logger.warn("[WinRM] connection failed, terminating (#{e.inspect})")
         raise
       end
     end
@@ -229,14 +217,8 @@ module WinRM
         Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
         Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH,
         ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
-        HTTPClient::KeepAliveDisconnected,
-        HTTPClient::ConnectTimeoutError
+        HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
       ].freeze
     end
-
-    # suppress the progress stream from leaking to stderr
-    def safe_script(script)
-      "$ProgressPreference='SilentlyContinue';" + script
-    end
   end
 end

data/lib/winrm/helpers/powershell_script.rb

@@ -30,8 +30,13 @@ module WinRM
     # --EncodedCommand argument.
     # @return [String] The UTF-16LE base64 encoded script
     def encoded
-      encoded_script = text.encode('UTF-16LE', 'UTF-8')
+      encoded_script = safe_script(text).encode('UTF-16LE', 'UTF-8')
       Base64.strict_encode64(encoded_script)
     end
+
+    # suppress the progress stream from leaking to stderr
+    def safe_script(script)
+      "$ProgressPreference='SilentlyContinue';" + script
+    end
   end
 end

data/lib/winrm/version.rb

@@ -3,5 +3,5 @@
 # WinRM module
 module WinRM
   # The version of the WinRM library
-  VERSION = '1.6.0'
+  VERSION = '1.6.1'
 end

data/spec/command_executor_spec.rb

@@ -35,21 +35,11 @@ describe WinRM::CommandExecutor, unit: true do
     )
   end
 
-  let(:version_output) do
-    o = ::WinRM::Output.new
-    o[:exitcode] = 0
-    o[:data].concat([{ stdout: '6.3.9600.0\r\n' }])
-    o
-  end
+  let(:version_output) { { xml_fragment: [{ version: '6.3.9600' }] } }
 
   before do
     allow(service).to receive(:open_shell).and_return(shell_id)
-
-    stub_powershell_script(
-      shell_id,
-      "$ProgressPreference='SilentlyContinue';[environment]::OSVersion.Version.tostring()",
-      version_output
-    )
+    allow(service).to receive(:run_wql).and_return(version_output)
   end
 
   describe '#close' do
@@ -124,35 +114,50 @@ describe WinRM::CommandExecutor, unit: true do
     end
 
     describe 'for modern windows distributions' do
-      let(:version_output) do
-        o = ::WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ stdout: '6.3.9600.0\r\n' }])
-        o
-      end
+      let(:version_output) { { xml_fragment: [{ version: '6.3.9600' }] } }
 
       it 'sets #max_commands to 1500 - 2' do
-        expect(executor.max_commands).to eq nil
-        executor.open
-
         expect(executor.max_commands).to eq(1500 - 2)
       end
+
+      it 'sets code_page to UTF-8' do
+        expect(executor.code_page).to eq 65_001
+      end
     end
 
     describe 'for older/legacy windows distributions' do
-      let(:version_output) do
-        o = ::WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ stdout: '6.1.8500.0\r\n' }])
-        o
-      end
+      let(:version_output) { { xml_fragment: [{ version: '6.1.8500' }] } }
 
       it 'sets #max_commands to 15 - 2' do
-        expect(executor.max_commands).to eq nil
-        executor.open
+        expect(executor.max_commands).to eq(15 - 2)
+      end
+
+      it 'sets code_page to UTF-8' do
+        expect(executor.code_page).to eq 65_001
+      end
+    end
 
+    describe 'for super duper older/legacy windows distributions' do
+      let(:version_output) { { xml_fragment: [{ version: '6.0.8500' }] } }
+
+      it 'sets #max_commands to 15 - 2' do
         expect(executor.max_commands).to eq(15 - 2)
       end
+
+      it 'sets code_page to MS-DOS' do
+        expect(executor.code_page).to eq 437
+      end
+    end
+
+    describe 'when unable to find os version' do
+      let(:version_output) { { xml_fragment: [{ funny_clowns: 'haha' }] } }
+
+      it 'raises WinRMError' do
+        expect { executor.code_page }.to raise_error(
+          ::WinRM::WinRMError,
+          'Unable to determine endpoint os version'
+        )
+      end
     end
   end
 
@@ -232,12 +237,7 @@ describe WinRM::CommandExecutor, unit: true do
     describe 'when called many times over time' do
       # use a 'old' version of windows with lower max_commands threshold
       # to trigger quicker shell recyles
-      let(:version_output) do
-        o = ::WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ stdout: '6.1.8500.0\r\n' }])
-        o
-      end
+      let(:version_output) { { xml_fragment: [{ version: '6.1.8500' }] } }
 
       let(:echo_output) do
         o = ::WinRM::Output.new
@@ -251,11 +251,8 @@ describe WinRM::CommandExecutor, unit: true do
         allow(service).to receive(:close_shell)
         allow(service).to receive(:run_command).and_yield('command-xxx')
         allow(service).to receive(:get_command_output).and_return(echo_output)
-        stub_powershell_script(
-          's1',
-          "$ProgressPreference='SilentlyContinue';[environment]::OSVersion.Version.tostring()",
-          version_output
-        )
+        allow(service).to receive(:run_wql).with('select version from Win32_OperatingSystem')
+          .and_return(version_output)
       end
 
       it 'resets the shell when #max_commands threshold is tripped' do
@@ -295,7 +292,7 @@ describe WinRM::CommandExecutor, unit: true do
       before do
         stub_powershell_script(
           shell_id,
-          "$ProgressPreference='SilentlyContinue';echo Hello",
+          'echo Hello',
           echo_output,
           command_id
         )
@@ -309,7 +306,7 @@ describe WinRM::CommandExecutor, unit: true do
           'powershell',
           [
             '-encodedCommand',
-            ::WinRM::PowershellScript.new("$ProgressPreference='SilentlyContinue';echo Hello")
+            ::WinRM::PowershellScript.new('echo Hello')
               .encoded
           ]
         )
@@ -353,12 +350,7 @@ describe WinRM::CommandExecutor, unit: true do
     describe 'when called many times over time' do
       # use a 'old' version of windows with lower max_commands threshold
       # to trigger quicker shell recyles
-      let(:version_output) do
-        o = ::WinRM::Output.new
-        o[:exitcode] = 0
-        o[:data].concat([{ stdout: '6.1.8500.0\r\n' }])
-        o
-      end
+      let(:version_output) { { xml_fragment: [{ version: '6.1.8500' }] } }
 
       let(:echo_output) do
         o = ::WinRM::Output.new
@@ -372,11 +364,8 @@ describe WinRM::CommandExecutor, unit: true do
         allow(service).to receive(:close_shell)
         allow(service).to receive(:run_command).and_yield('command-xxx')
         allow(service).to receive(:get_command_output).and_return(echo_output)
-        stub_powershell_script(
-          's1',
-          "$ProgressPreference='SilentlyContinue';[environment]::OSVersion.Version.tostring()",
-          version_output
-        )
+        allow(service).to receive(:wsman_identify).with('select version from Win32_OperatingSystem')
+          .and_return(version_output)
       end
 
       it 'resets the shell when #max_commands threshold is tripped' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Dan Wanek
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gssapi