winrm 1.7.2 → 1.7.3

data/Vagrantfile

@@ -1,9 +1,9 @@
-# encoding: UTF-8
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-VAGRANTFILE_API_VERSION = '2'
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = 'mwrock/Windows2012R2'
-end
+# encoding: UTF-8
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+VAGRANTFILE_API_VERSION = '2'
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = 'mwrock/Windows2012R2'
+end

data/appveyor.yml

@@ -1,42 +1,42 @@
-version: "master-{build}"
-
-os: Windows Server 2012 R2
-platform:
-  - x64
-
-environment:
-  winrm_user: test_user
-  winrm_pass: Pass@word1
-
-  matrix:
-    - ruby_version: "21"
-      winrm_endpoint: http://localhost:5985/wsman
-
-clone_folder: c:\projects\winrm
-clone_depth: 1
-branches:
-  only:
-    - master
-
-install:
-  - ps: net user /add $env:winrm_user $env:winrm_pass
-  - ps: net localgroup administrators $env:winrm_user /add
-  - ps: $env:winrm_cert = (New-SelfSignedCertificate -DnsName localhost -CertStoreLocation cert:\localmachine\my).Thumbprint
-  - ps: winrm create winrm/config/Listener?Address=*+Transport=HTTPS "@{Hostname=`"localhost`";CertificateThumbprint=`"$($env:winrm_cert)`"}"
-  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
-  - ps: winrm set winrm/config/service/auth '@{CbtHardeningLevel="Strict"}'
-  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
-  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
-  - ps: Write-Host $env:PATH
-  - ps: ruby --version
-  - ps: gem --version
-  - ps: gem install bundler --quiet --no-ri --no-rdoc
-  - ps: bundler --version
-
-build_script:
-  - bundle install || bundle install || bundle install
-
-test_script:
-  - SET SPEC_OPTS=--format progress
-  - bundle exec rake integration
+version: "master-{build}"
+
+os: Windows Server 2012 R2
+platform:
+  - x64
+
+environment:
+  winrm_user: test_user
+  winrm_pass: Pass@word1
+
+  matrix:
+    - ruby_version: "21"
+      winrm_endpoint: http://localhost:5985/wsman
+
+clone_folder: c:\projects\winrm
+clone_depth: 1
+branches:
+  only:
+    - master
+
+install:
+  - ps: net user /add $env:winrm_user $env:winrm_pass
+  - ps: net localgroup administrators $env:winrm_user /add
+  - ps: $env:winrm_cert = (New-SelfSignedCertificate -DnsName localhost -CertStoreLocation cert:\localmachine\my).Thumbprint
+  - ps: winrm create winrm/config/Listener?Address=*+Transport=HTTPS "@{Hostname=`"localhost`";CertificateThumbprint=`"$($env:winrm_cert)`"}"
+  - ps: winrm set winrm/config/client/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{Basic="true"}'
+  - ps: winrm set winrm/config/service/auth '@{CbtHardeningLevel="Strict"}'
+  - ps: winrm set winrm/config/service '@{AllowUnencrypted="true"}'
+  - ps: $env:PATH="C:\Ruby$env:ruby_version\bin;$env:PATH"
+  - ps: Write-Host $env:PATH
+  - ps: ruby --version
+  - ps: gem --version
+  - ps: gem install bundler --quiet --no-ri --no-rdoc
+  - ps: bundler --version
+
+build_script:
+  - bundle install || bundle install || bundle install
+
+test_script:
+  - SET SPEC_OPTS=--format progress
+  - bundle exec rake integration

data/bin/rwinrm

@@ -1,97 +1,97 @@
-#!/usr/bin/env ruby
-# encoding: UTF-8
-
-# Copyright 2014 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.
-
-# rubocop:disable all
-
-$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
-
-require 'readline'
-require 'io/console'
-require 'winrm'
-
-def help_msg
-  puts 'Usage: rwinrm user@host'
-  puts ''
-end
-
-def parse_options
-  options = {}
-  fail 'Missing required options' unless ARGV.length == 1
-
-  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
-  fail "#{ARGV[0]} is an invalid host" unless m
-  options[:user] = m[:user]
-  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
-
-  # Get the password
-  print 'Password: '
-  options[:pass] = STDIN.noecho(&:gets).chomp
-  puts
-
-  # Set some defaults required by WinRM WS
-  options[:auth_type] = :plaintext
-  options[:basic_auth_only] = true
-
-  options
-rescue StandardError => e
-  puts e.message
-  help_msg
-  exit 1
-end
-
-def repl(options)
-  client = WinRM::WinRMWebService.new(
-    options[:endpoint],
-    options[:auth_type].to_sym,
-    options)
-
-  client.set_timeout(3600)
-  shell_id = client.open_shell
-  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
-
-  read_thread = Thread.new do
-    client.get_command_output(shell_id, command_id) do |stdout, stderr|
-      STDOUT.write stdout
-      STDERR.write stderr
-    end
-  end
-  read_thread.abort_on_exception = true
-
-  while (buf = Readline.readline('', true))
-    if buf =~ /^exit/
-      read_thread.exit
-      client.cleanup_command(shell_id, command_id)
-      client.close_shell(shell_id)
-      exit 0
-    else
-      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
-    end
-  end
-rescue Interrupt
-  puts 'exiting'
-  # ctrl-c
-rescue WinRM::WinRMAuthorizationError
-  puts 'Authentication failed, bad user name or password'
-  exit 1
-rescue StandardError => e
-  puts e.message
-  exit 1
-end
-
-repl(parse_options)
-
-# rubocop:enable all
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Copyright 2014 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.
+
+# rubocop:disable all
+
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'readline'
+require 'io/console'
+require 'winrm'
+
+def help_msg
+  puts 'Usage: rwinrm user@host'
+  puts ''
+end
+
+def parse_options
+  options = {}
+  fail 'Missing required options' unless ARGV.length == 1
+
+  m = /^(?<user>[a-z0-9\.\!\$ _-]+)@{1}(?<host>[a-z0-9\.\-]+)(?<port>:[0-9]+)?/i.match(ARGV[0])
+  fail "#{ARGV[0]} is an invalid host" unless m
+  options[:user] = m[:user]
+  options[:endpoint] = "http://#{m[:host]}#{m[:port] || ':5985'}/wsman"
+
+  # Get the password
+  print 'Password: '
+  options[:pass] = STDIN.noecho(&:gets).chomp
+  puts
+
+  # Set some defaults required by WinRM WS
+  options[:auth_type] = :plaintext
+  options[:basic_auth_only] = true
+
+  options
+rescue StandardError => e
+  puts e.message
+  help_msg
+  exit 1
+end
+
+def repl(options)
+  client = WinRM::WinRMWebService.new(
+    options[:endpoint],
+    options[:auth_type].to_sym,
+    options)
+
+  client.set_timeout(3600)
+  shell_id = client.open_shell
+  command_id = client.run_command(shell_id, 'cmd', "/K prompt [#{ARGV[0]}]$P$G")
+
+  read_thread = Thread.new do
+    client.get_command_output(shell_id, command_id) do |stdout, stderr|
+      STDOUT.write stdout
+      STDERR.write stderr
+    end
+  end
+  read_thread.abort_on_exception = true
+
+  while (buf = Readline.readline('', true))
+    if buf =~ /^exit/
+      read_thread.exit
+      client.cleanup_command(shell_id, command_id)
+      client.close_shell(shell_id)
+      exit 0
+    else
+      client.write_stdin(shell_id, command_id, "#{buf}\r\n")
+    end
+  end
+rescue Interrupt
+  puts 'exiting'
+  # ctrl-c
+rescue WinRM::WinRMAuthorizationError
+  puts 'Authentication failed, bad user name or password'
+  exit 1
+rescue StandardError => e
+  puts e.message
+  exit 1
+end
+
+repl(parse_options)
+
+# rubocop:enable all

data/changelog.md

@@ -1,5 +1,8 @@
 # WinRM Gem Changelog
 
+# 1.7.3
+- Open a new shell if the current shell has been deleted
+
 # 1.7.2
 - Fix regression where BOM appears in 2008R2 output and is not stripped
 

data/lib/winrm.rb

@@ -1,42 +1,42 @@
-# encoding: UTF-8
-#
-# Copyright 2010 Dan Wanek <dan.wanek@gmail.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 'date'
-require 'logging'
-require_relative 'winrm/version'
-
-# Main WinRM module entry point
-module WinRM
-  # Enable logging if it is requested. We do this before
-  # anything else so that we can setup the output before
-  # any logging occurs.
-  if ENV['WINRM_LOG'] && ENV['WINRM_LOG'] != ''
-    begin
-      Logging.logger.root.level = ENV['WINRM_LOG']
-      Logging.logger.root.appenders = Logging.appenders.stderr
-    rescue ArgumentError
-      # This means that the logging level wasn't valid
-      $stderr.puts "Invalid WINRM_LOG level is set: #{ENV['WINRM_LOG']}"
-      $stderr.puts ''
-      $stderr.puts 'Please use one of the standard log levels: ' \
-        'debug, info, warn, or error'
-    end
-  end
-end
-
-require 'winrm/output'
-require 'winrm/helpers/iso8601_duration'
-require 'winrm/soap_provider'
+# encoding: UTF-8
+#
+# Copyright 2010 Dan Wanek <dan.wanek@gmail.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 'date'
+require 'logging'
+require_relative 'winrm/version'
+
+# Main WinRM module entry point
+module WinRM
+  # Enable logging if it is requested. We do this before
+  # anything else so that we can setup the output before
+  # any logging occurs.
+  if ENV['WINRM_LOG'] && ENV['WINRM_LOG'] != ''
+    begin
+      Logging.logger.root.level = ENV['WINRM_LOG']
+      Logging.logger.root.appenders = Logging.appenders.stderr
+    rescue ArgumentError
+      # This means that the logging level wasn't valid
+      $stderr.puts "Invalid WINRM_LOG level is set: #{ENV['WINRM_LOG']}"
+      $stderr.puts ''
+      $stderr.puts 'Please use one of the standard log levels: ' \
+        'debug, info, warn, or error'
+    end
+  end
+end
+
+require 'winrm/output'
+require 'winrm/helpers/iso8601_duration'
+require 'winrm/soap_provider'

data/lib/winrm/command_executor.rb

@@ -86,6 +86,8 @@ module WinRM
     # @return [WinRM::Output] output object with stdout, stderr, and
     #   exit code
     def run_cmd(command, arguments = [], &block)
+      tries ||= 2
+
       reset if command_count > max_commands
       ensure_open_shell!
 
@@ -95,6 +97,19 @@ module WinRM
         result = service.get_command_output(shell, command_id, &block)
       end
       result
+    rescue WinRMWSManFault => e
+      # Fault code 2150858843 may be raised if the shell id that the command is sent on
+      # has been closed. One might see this on a target windows machine that has just
+      # been provisioned and restarted the winrm service at the end of its provisioning
+      # routine. If this hapens, we should give the command one more try.
+      if e.fault_code == '2150858843' && (tries -= 1) > 0
+        service.logger.debug('[WinRM] opening new shell since the current one was deleted')
+        @shell = nil
+        open
+        retry
+      else
+        raise
+      end
     end
 
     # Run a Powershell script that resides on the local box.

data/lib/winrm/command_output_decoder.rb

@@ -1,53 +1,53 @@
-# -*- encoding: utf-8 -*-
-#
-# Copyright 2016 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 'base64'
-
-module WinRM
-  # Handles decoding a raw output response
-  class CommandOutputDecoder
-    # Decode the raw SOAP output into decoded and human consumable text,
-    # Decodes and replaces invalid unicode characters.
-    # @param raw_output [String] The raw encoded output
-    # @return [String] The decoded output
-    def decode(raw_output)
-      decoded_text = decode_raw_output(raw_output)
-      decoded_text = handle_invalid_encoding(decoded_text)
-      decoded_text = remove_bom(decoded_text)
-      decoded_text
-    end
-
-    private
-
-    def decode_raw_output(raw_output)
-      Base64.decode64(raw_output).force_encoding('utf-8')
-    end
-
-    def handle_invalid_encoding(decoded_text)
-      return decoded_text if decoded_text.valid_encoding?
-      if decoded_text.respond_to?(:scrub)
-        decoded_text.scrub
-      else
-        decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
-      end
-    end
-
-    def remove_bom(decoded_text)
-      # remove BOM which 2008R2 applies
-      decoded_text.sub("\xEF\xBB\xBF", '')
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2016 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 'base64'
+
+module WinRM
+  # Handles decoding a raw output response
+  class CommandOutputDecoder
+    # Decode the raw SOAP output into decoded and human consumable text,
+    # Decodes and replaces invalid unicode characters.
+    # @param raw_output [String] The raw encoded output
+    # @return [String] The decoded output
+    def decode(raw_output)
+      decoded_text = decode_raw_output(raw_output)
+      decoded_text = handle_invalid_encoding(decoded_text)
+      decoded_text = remove_bom(decoded_text)
+      decoded_text
+    end
+
+    private
+
+    def decode_raw_output(raw_output)
+      Base64.decode64(raw_output).force_encoding('utf-8')
+    end
+
+    def handle_invalid_encoding(decoded_text)
+      return decoded_text if decoded_text.valid_encoding?
+      if decoded_text.respond_to?(:scrub)
+        decoded_text.scrub
+      else
+        decoded_text.encode('utf-16', invalid: :replace, undef: :replace).encode('utf-8')
+      end
+    end
+
+    def remove_bom(decoded_text)
+      # remove BOM which 2008R2 applies
+      decoded_text.sub("\xEF\xBB\xBF", '')
+    end
+  end
+end