winrm 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aea153848b3f833150520c7ccd2ff1ec940f0238
-  data.tar.gz: 0c4ab4320a28d135423de6ee6ea39a8e428cc069
+  metadata.gz: 46a0806843f652f3d0b8d8858eb87cf0365d8e4d
+  data.tar.gz: 76f409feeda643970222972be8c571e2905a6fb9
 SHA512:
-  metadata.gz: 97ea0581ac573fb208c5d2b43d3a71b926c2b65a05198a157e03c1538cf2169b8ff09ec0134188d0ae4703e2c4ae462a90e6409abf3eb98ee6292c48eef2bd9c
-  data.tar.gz: acb321d609e66cb79de65d900e6a7b62f1b3962d5975f10b57188dd2d2788a26667a2cd69bc06278d8972b825b54909bd2fd9fac75e19eae15c4abaf60cbccae
+  metadata.gz: cd17e956aa071c63ab65c0a9db69bada2a256b735ee4c9e2b63b32a16920357749bc814b32b15dd3ad61e777d77144fa73eea1e851c23347e0486ded69ffd47b
+  data.tar.gz: 119346b0543a18a8715f90b2c318df0bf98cbdeeae16d8afd7ffd70f73c6690b620e8c94d541e4a0798dc490c395f5e4feee7d12c8e83fddf64970560781602d

data/changelog.md

@@ -1,5 +1,8 @@
 # WinRM Gem Changelog
 
+# 2.2.3
+- Revert change made in 2.2.2 that retries network errors in Close and cleanup
+
 # 2.2.2
 - Update PSRP buffer size
 - Close and cleanup should retry on error and never raise net errors

data/lib/winrm/exceptions.rb

@@ -15,15 +15,6 @@
 # limitations under the License.
 
 module WinRM
-  NETWORK_EXCEPTIONS = lambda do
-    [
-      Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
-      Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, ::WinRM::WinRMWSManFault,
-      ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
-      HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
-    ].freeze
-  end
-
   # WinRM base class for errors
   class WinRMError < StandardError; end
 

data/lib/winrm/shells/base.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require_relative 'retryable'
-require_relative 'suppressible'
 require_relative '../http/transport'
 require_relative '../wsmv/cleanup_command'
 require_relative '../wsmv/close_shell'
@@ -32,16 +31,14 @@ module WinRM
       TOO_MANY_COMMANDS = '2150859174'.freeze
       ERROR_OPERATION_ABORTED = '995'.freeze
       SHELL_NOT_FOUND = '2150858843'.freeze
-      ERROR_READING_REGISTRY_KEY = '2147943418'.freeze
 
       FAULTS_FOR_RESET = [
-        SHELL_NOT_FOUND,
-        ERROR_READING_REGISTRY_KEY,
+        '2150858843', # Shell has been closed
+        '2147943418', # Error reading registry key
         TOO_MANY_COMMANDS, # Maximum commands per user exceeded
       ].freeze
 
       include Retryable
-      include Suppressible
 
       # Create a new Cmd shell
       # @param connection_opts [ConnectionOpts] The WinRM connection options
@@ -89,10 +86,10 @@ module WinRM
       # Closes the shell if one is open
       def close
         return unless shell_id
-        suppressible do
-          retryable(connection_opts[:retry_limit], connection_opts[:retry_delay]) do
-            self.class.close_shell(connection_opts, transport, shell_id)
-          end
+        begin
+          self.class.close_shell(connection_opts, transport, shell_id)
+        rescue WinRMWSManFault => e
+          raise unless [ERROR_OPERATION_ABORTED, SHELL_NOT_FOUND].include?(e.fault_code)
         end
         remove_finalizer
         @shell_id = nil
@@ -156,11 +153,12 @@ module WinRM
           shell_uri: shell_uri,
           shell_id: shell_id,
           command_id: command_id)
-        suppressible do
-          retryable(connection_opts[:retry_limit], connection_opts[:retry_delay]) do
-            transport.send_request(cleanup_msg.build)
-          end
-        end
+        transport.send_request(cleanup_msg.build)
+      rescue WinRMWSManFault => e
+        raise unless [ERROR_OPERATION_ABORTED, SHELL_NOT_FOUND].include?(e.fault_code)
+      rescue WinRMHTTPTransportError => t
+        # dont let the cleanup raise so we dont lose any errors from the command
+        logger.info("[WinRM] #{t.status_code} returned in cleanup with error: #{t.message}")
       end
 
       def open

data/lib/winrm/shells/retryable.rb

@@ -21,12 +21,21 @@ module WinRM
   module Shells
     # Shell mixin for retrying an operation
     module Retryable
+      RETRYABLE_EXCEPTIONS = lambda do
+        [
+          Errno::EACCES, Errno::EADDRINUSE, Errno::ECONNREFUSED, Errno::ETIMEDOUT,
+          Errno::ECONNRESET, Errno::ENETUNREACH, Errno::EHOSTUNREACH, ::WinRM::WinRMWSManFault,
+          ::WinRM::WinRMHTTPTransportError, ::WinRM::WinRMAuthorizationError,
+          HTTPClient::KeepAliveDisconnected, HTTPClient::ConnectTimeoutError
+        ].freeze
+      end
+
       # Retries the operation a specified number of times with a delay between
       # @param retries [Integer] The number of times to retry
       # @param delay [Integer] The number of seconds to wait between retry attempts
       def retryable(retries, delay)
         yield
-      rescue *WinRM::NETWORK_EXCEPTIONS.call
+      rescue *RETRYABLE_EXCEPTIONS.call
         raise unless (retries -= 1) > 0
         sleep(delay)
         retry

data/lib/winrm/version.rb

@@ -3,5 +3,5 @@
 # WinRM module
 module WinRM
   # The version of the WinRM library
-  VERSION = '2.2.2'.freeze
+  VERSION = '2.2.3'.freeze
 end

data/tests/spec/shells/base_spec.rb

@@ -213,11 +213,11 @@ describe DummyShell do
       expect(subject.shell_id).to be(nil)
     end
 
-    context 'when connection is refused' do
+    context 'when shell was not found' do
       it 'does not raise' do
         subject.run(command, arguments)
         expect(DummyShell).to receive(:close_shell)
-          .and_raise(Errno::ECONNREFUSED.new)
+          .and_raise(WinRM::WinRMWSManFault.new('oops', '2150858843'))
         expect { subject.close }.not_to raise_error
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: winrm
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Dan Wanek
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-16 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gssapi
@@ -271,7 +271,6 @@ files:
 - lib/winrm/shells/power_shell.rb
 - lib/winrm/shells/retryable.rb
 - lib/winrm/shells/shell_factory.rb
-- lib/winrm/shells/suppressible.rb
 - lib/winrm/version.rb
 - lib/winrm/wsmv/base.rb
 - lib/winrm/wsmv/cleanup_command.rb

data/lib/winrm/shells/suppressible.rb

@@ -1,31 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2017 Matt Wrock <matt@mattwrock.com>
-#
-# 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_relative '../exceptions'
-
-module WinRM
-  module Shells
-    # Shell mixin for suppressing a network exception
-    module Suppressible
-      # performs an operation and suppresses any network exceptions
-      def suppressible
-        yield
-      rescue *WinRM::NETWORK_EXCEPTIONS.call => e
-        logger.info("[WinRM] Exception suppressed: #{e.message}")
-      end
-    end
-  end
-end