winrm 1.7.1 → 1.7.2

data/spec/command_output_decoder_spec.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+require 'winrm/command_output_decoder'
+
+describe WinRM::CommandOutputDecoder, unit: true do
+  let(:raw_output_with_bom) do
+    '77u/' \
+    'ICAgQ29ubmVjdGlvbi1zcGVjaWZpYyBETlMgU3VmZml4ICAuIDogDQogICBMaW5rLWxvY2FsIElQdjYgQWRkcmVzcyA' \
+    'uIC4gLiAuIC4gOiBmZTgwOjo5MTFkOjE2OTQ6NTcwNDo1YjI5JTEyDQogICBJUHY0IEFkZHJlc3MuIC4gLiAuIC4gLi' \
+    'AuIC4gLiAuIC4gOiAxMC4wLjIuMTUNCiAgIFN1Ym5ldCBNYXNrIC4gLiAuIC4gLiAuIC4gLiAuIC4gLiA6IDI1NS4yN' \
+    'TUuMjU1LjANCiAgIERlZmF1bHQgR2F0ZXdheSAuIC4gLiAuIC4gLiAuIC4gLiA6IDEwLjAuMi4yDQoNClR1bm5lbCBh' \
+    'ZGFwdGVyIGlzYXRhcC57RjBENTY2RDgtNzlCMS00QUYwLUJENUQtMkM5RkVEOEI3MTE3fToNCg0KICAgTWVkaWEgU3R' \
+    'hdGUgLiAuIC4gLiAuIC4gLiAuIC4gLiAuIDogTWVkaWEgZGlzY29ubmVjdGVkDQogICBDb25uZWN0aW9uLXNwZWNpZm' \
+    'ljIEROUyBTdWZmaXggIC4gOiANCg0KVHVubmVsIGFkYXB0ZXIgVGVyZWRvIFR1bm5lbGluZyBQc2V1ZG8tSW50ZXJmY' \
+    'WNlOg0KDQogICBDb25uZWN0aW9uLXNwZWNpZmljIEROUyBTdWZmaXggIC4gOiANCiAgIElQdjYgQWRkcmVzcy4gLiAu' \
+    'IC4gLiAuIC4gLiAuIC4gLiA6IDIwMDE6MDo5ZDM4OjZhYmQ6NGJiOjI4YjU6ZjVmZjpmZGYwDQogICBMaW5rLWxvY2F' \
+    'sIElQdjYgQWRkcmVzcyAuIC4gLiAuIC4gOiBmZTgwOjo0YmI6MjhiNTpmNWZmOmZkZjAlMTQNCiAgIERlZmF1bHQgR2' \
+    'F0ZXdheSAuIC4gLiAuIC4gLiAuIC4gLiA6IDo6DQo='
+  end
+  let(:expected) do
+    "   Connection-specific DNS Suffix  . : \r\n   Link-local IPv6 Address . . . . . : fe80::911" \
+    "d:1694:5704:5b29%12\r\n   IPv4 Address. . . . . . . . . . . : 10.0.2.15\r\n   Subnet Mask ." \
+    " . . . . . . . . . . : 255.255.255.0\r\n   Default Gateway . . . . . . . . . : 10.0.2.2\r\n" \
+    "\r\nTunnel adapter isatap.{F0D566D8-79B1-4AF0-BD5D-2C9FED8B7117}:\r\n\r\n   Media State . ." \
+    " . . . . . . . . . : Media disconnected\r\n   Connection-specific DNS Suffix  . : \r\n\r\nT" \
+    "unnel adapter Teredo Tunneling Pseudo-Interface:\r\n\r\n   Connection-specific DNS Suffix  " \
+    ". : \r\n   IPv6 Address. . . . . . . . . . . : 2001:0:9d38:6abd:4bb:28b5:f5ff:fdf0\r\n   Li" \
+    "nk-local IPv6 Address . . . . . : fe80::4bb:28b5:f5ff:fdf0%14\r\n   Default Gateway . . . ." \
+    " . . . . . : ::\r\n"
+  end
+  subject { described_class.new }
+  context 'valid UTF-8 raw output' do
+    it 'decodes' do
+      expect(subject.decode(raw_output_with_bom)).to eq(expected)
+    end
+  end
+end

data/spec/config-example.yml

@@ -1,19 +1,19 @@
-# Copy this file to config.yml and edit the settings below.
-# This should work out of the box for vagrant provisioned boxes.
-
-## Kerberos
-#auth_type: kerberos
-#endpoint: "http://<yourserver>:5985/wsman"
-#options:
-#  realm: "your.realm"
-
-## Plain Text
-auth_type: plaintext
-# If you are running this in a vagrant provisioned box using NAT,
-# this will be the forwarded WinRM HTTP port to your VM.
-# If you are running this on the VM, the default HTTP port is 5985.
-# See README.md#Troubleshooting.
-endpoint: "http://localhost:55985/wsman"
-options:
-  user: vagrant
-  pass: vagrant
+# Copy this file to config.yml and edit the settings below.
+# This should work out of the box for vagrant provisioned boxes.
+
+## Kerberos
+#auth_type: kerberos
+#endpoint: "http://<yourserver>:5985/wsman"
+#options:
+#  realm: "your.realm"
+
+## Plain Text
+auth_type: plaintext
+# If you are running this in a vagrant provisioned box using NAT,
+# this will be the forwarded WinRM HTTP port to your VM.
+# If you are running this on the VM, the default HTTP port is 5985.
+# See README.md#Troubleshooting.
+endpoint: "http://localhost:55985/wsman"
+options:
+  user: vagrant
+  pass: vagrant

data/spec/exception_spec.rb

@@ -1,50 +1,50 @@
-# encoding: UTF-8
-describe 'Exceptions', unit: true do
-  describe WinRM::WinRMAuthorizationError do
-    let(:error) { WinRM::WinRMHTTPTransportError.new('Foo happened', 500) }
-
-    it 'adds the response code to the message' do
-      expect(error.message).to eq('Foo happened (500).')
-    end
-
-    it 'exposes the response code as an attribute' do
-      expect(error.status_code).to eq 500
-    end
-
-    it 'is a winrm error' do
-      expect(error).to be_kind_of(WinRM::WinRMError)
-    end
-  end
-
-  describe WinRM::WinRMWSManFault do
-    let(:error) { WinRM::WinRMWSManFault.new('fault text', 42) }
-
-    it 'exposes the fault text as an attribute' do
-      expect(error.fault_description).to eq('fault text')
-    end
-
-    it 'exposes the fault code as an attribute' do
-      expect(error.fault_code).to eq 42
-    end
-
-    it 'is a winrm error' do
-      expect(error).to be_kind_of(WinRM::WinRMError)
-    end
-  end
-
-  describe WinRM::WinRMWMIError do
-    let(:error) { WinRM::WinRMWMIError.new('message text', 77_777) }
-
-    it 'exposes the error text as an attribute' do
-      expect(error.error).to eq('message text')
-    end
-
-    it 'exposes the error code as an attribute' do
-      expect(error.error_code).to eq 77_777
-    end
-
-    it 'is a winrm error' do
-      expect(error).to be_kind_of(WinRM::WinRMError)
-    end
-  end
-end
+# encoding: UTF-8
+describe 'Exceptions', unit: true do
+  describe WinRM::WinRMAuthorizationError do
+    let(:error) { WinRM::WinRMHTTPTransportError.new('Foo happened', 500) }
+
+    it 'adds the response code to the message' do
+      expect(error.message).to eq('Foo happened (500).')
+    end
+
+    it 'exposes the response code as an attribute' do
+      expect(error.status_code).to eq 500
+    end
+
+    it 'is a winrm error' do
+      expect(error).to be_kind_of(WinRM::WinRMError)
+    end
+  end
+
+  describe WinRM::WinRMWSManFault do
+    let(:error) { WinRM::WinRMWSManFault.new('fault text', 42) }
+
+    it 'exposes the fault text as an attribute' do
+      expect(error.fault_description).to eq('fault text')
+    end
+
+    it 'exposes the fault code as an attribute' do
+      expect(error.fault_code).to eq 42
+    end
+
+    it 'is a winrm error' do
+      expect(error).to be_kind_of(WinRM::WinRMError)
+    end
+  end
+
+  describe WinRM::WinRMWMIError do
+    let(:error) { WinRM::WinRMWMIError.new('message text', 77_777) }
+
+    it 'exposes the error text as an attribute' do
+      expect(error.error).to eq('message text')
+    end
+
+    it 'exposes the error code as an attribute' do
+      expect(error.error_code).to eq 77_777
+    end
+
+    it 'is a winrm error' do
+      expect(error).to be_kind_of(WinRM::WinRMError)
+    end
+  end
+end

data/spec/issue_184_spec.rb

@@ -1,67 +1,67 @@
-# encoding: UTF-8
-require 'winrm/winrm_service'
-require 'rexml/document'
-require 'erb'
-require 'base64'
-
-describe 'issue 184', unit: true do
-  let(:shell_id)    { 'shell-123' }
-  let(:command_id)  { 123 }
-  let(:test_data_xml_template) do
-    ERB.new(File.read('spec/stubs/responses/get_command_output_response.xml.erb'))
-  end
-  let(:service) do
-    WinRM::WinRMWebService.new(
-      'http://dummy/wsman',
-      :plaintext,
-      user: 'dummy',
-      pass: 'dummy')
-  end
-
-  describe 'response doc stdout with invalid UTF-8 characters' do
-    let(:test_data_stdout) { 'ffff' } # Base64-decodes to '}\xF7\xDF', an invalid sequence
-    let(:test_data_stderr) { '' }
-    let(:test_data_xml)    { test_data_xml_template.result(binding) }
-
-    before do
-      allow(service).to receive(:send_get_output_message).and_return(
-        REXML::Document.new(test_data_xml)
-      )
-    end
-
-    it 'does not raise an ArgumentError: invalid byte sequence in UTF-8' do
-      begin
-        expect(
-          service.get_command_output(shell_id, command_id)
-        ).not_to raise_error
-      rescue RSpec::Expectations::ExpectationNotMetError => e
-        expect(e.message).not_to include 'ArgumentError'
-      end
-    end
-
-    it 'does not have an empty stdout' do
-      expect(
-        service.get_command_output(shell_id, command_id)[:data][0][:stdout]
-      ).not_to be_empty
-    end
-  end
-
-  describe 'response doc stdout with valid UTF-8' do
-    let(:test_data_raw)    { '✓1234-äöü' }
-    let(:test_data_stdout) { Base64.encode64(test_data_raw) }
-    let(:test_data_stderr) { '' }
-    let(:test_data_xml)    { test_data_xml_template.result(binding) }
-
-    before do
-      allow(service).to receive(:send_get_output_message).and_return(
-        REXML::Document.new(test_data_xml)
-      )
-    end
-
-    it 'decodes to match input data' do
-      expect(
-        service.get_command_output(shell_id, command_id)[:data][0][:stdout]
-      ).to eq(test_data_raw)
-    end
-  end
-end
+# encoding: UTF-8
+require 'winrm/winrm_service'
+require 'rexml/document'
+require 'erb'
+require 'base64'
+
+describe 'issue 184', unit: true do
+  let(:shell_id)    { 'shell-123' }
+  let(:command_id)  { 123 }
+  let(:test_data_xml_template) do
+    ERB.new(File.read('spec/stubs/responses/get_command_output_response.xml.erb'))
+  end
+  let(:service) do
+    WinRM::WinRMWebService.new(
+      'http://dummy/wsman',
+      :plaintext,
+      user: 'dummy',
+      pass: 'dummy')
+  end
+
+  describe 'response doc stdout with invalid UTF-8 characters' do
+    let(:test_data_stdout) { 'ffff' } # Base64-decodes to '}\xF7\xDF', an invalid sequence
+    let(:test_data_stderr) { '' }
+    let(:test_data_xml)    { test_data_xml_template.result(binding) }
+
+    before do
+      allow(service).to receive(:send_get_output_message).and_return(
+        REXML::Document.new(test_data_xml)
+      )
+    end
+
+    it 'does not raise an ArgumentError: invalid byte sequence in UTF-8' do
+      begin
+        expect(
+          service.get_command_output(shell_id, command_id)
+        ).not_to raise_error
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        expect(e.message).not_to include 'ArgumentError'
+      end
+    end
+
+    it 'does not have an empty stdout' do
+      expect(
+        service.get_command_output(shell_id, command_id)[:data][0][:stdout]
+      ).not_to be_empty
+    end
+  end
+
+  describe 'response doc stdout with valid UTF-8' do
+    let(:test_data_raw)    { '✓1234-äöü' }
+    let(:test_data_stdout) { Base64.encode64(test_data_raw) }
+    let(:test_data_stderr) { '' }
+    let(:test_data_xml)    { test_data_xml_template.result(binding) }
+
+    before do
+      allow(service).to receive(:send_get_output_message).and_return(
+        REXML::Document.new(test_data_xml)
+      )
+    end
+
+    it 'decodes to match input data' do
+      expect(
+        service.get_command_output(shell_id, command_id)[:data][0][:stdout]
+      ).to eq(test_data_raw)
+    end
+  end
+end

data/spec/issue_59_spec.rb

@@ -1,23 +1,23 @@
-# encoding: UTF-8
-describe 'issue 59', integration: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  describe 'long running script without output' do
-    let(:logged_output) { StringIO.new }
-    let(:logger)        { Logging.logger(logged_output) }
-
-    it 'should not error' do
-      @winrm.set_timeout(1)
-      @winrm.logger = logger
-
-      out = @winrm.powershell('$ProgressPreference="SilentlyContinue";sleep 3; Write-Host "Hello"')
-
-      expect(out).to have_exit_code 0
-      expect(out).to have_stdout_match(/Hello/)
-      expect(out).to have_no_stderr
-      expect(logged_output.string).to match(/retrying receive request/)
-    end
-  end
-end
+# encoding: UTF-8
+describe 'issue 59', integration: true do
+  before(:all) do
+    @winrm = winrm_connection
+  end
+
+  describe 'long running script without output' do
+    let(:logged_output) { StringIO.new }
+    let(:logger)        { Logging.logger(logged_output) }
+
+    it 'should not error' do
+      @winrm.set_timeout(1)
+      @winrm.logger = logger
+
+      out = @winrm.powershell('$ProgressPreference="SilentlyContinue";sleep 3; Write-Host "Hello"')
+
+      expect(out).to have_exit_code 0
+      expect(out).to have_stdout_match(/Hello/)
+      expect(out).to have_no_stderr
+      expect(logged_output.string).to match(/retrying receive request/)
+    end
+  end
+end

data/spec/matchers.rb

@@ -1,74 +1,74 @@
-# encoding: UTF-8
-require 'rspec/expectations'
-
-# rspec matchers
-module WinRMSpecs
-  def self.stdout(output)
-    output[:data].collect do |i|
-      i[:stdout]
-    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
-  end
-
-  def self.stderr(output)
-    output[:data].collect do |i|
-      i[:stderr]
-    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
-  end
-end
-
-RSpec::Matchers.define :have_stdout_match do |expected_stdout|
-  match do |actual_output|
-    !expected_stdout.match(WinRMSpecs.stdout(actual_output)).nil?
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stdout(actual_output)}' would match #{expected_stdout}"
-  end
-end
-
-RSpec::Matchers.define :have_stderr_match do |expected_stderr|
-  match do |actual_output|
-    !expected_stderr.match(WinRMSpecs.stderr(actual_output)).nil?
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stderr(actual_output)}' would match #{expected_stderr}"
-  end
-end
-
-RSpec::Matchers.define :have_no_stdout do
-  match do |actual_output|
-    stdout = WinRMSpecs.stdout(actual_output)
-    stdout == '\r\n' || stdout == ''
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stdout(actual_output)}' would have no stdout"
-  end
-end
-
-RSpec::Matchers.define :have_no_stderr do
-  match do |actual_output|
-    stderr = WinRMSpecs.stderr(actual_output)
-    stderr == '\r\n' || stderr == ''
-  end
-  failure_message do |actual_output|
-    "expected that '#{WinRMSpecs.stderr(actual_output)}' would have no stderr"
-  end
-end
-
-RSpec::Matchers.define :have_exit_code do |expected_exit_code|
-  match do |actual_output|
-    expected_exit_code == actual_output[:exitcode]
-  end
-  failure_message do |actual_output|
-    "expected exit code #{expected_exit_code}, but got #{actual_output[:exitcode]}"
-  end
-end
-
-RSpec::Matchers.define :be_a_uid do
-  match do |actual|
-    # WinRM1.1 returns uuid's prefixed with 'uuid:' where as later versions do not
-    actual && actual.to_s.match(/^(uuid:)*\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$/)
-  end
-  failure_message do |actual|
-    "expected a uid, but got '#{actual}'"
-  end
-end
+# encoding: UTF-8
+require 'rspec/expectations'
+
+# rspec matchers
+module WinRMSpecs
+  def self.stdout(output)
+    output[:data].collect do |i|
+      i[:stdout]
+    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
+  end
+
+  def self.stderr(output)
+    output[:data].collect do |i|
+      i[:stderr]
+    end.join('\r\n').gsub(/(\\r\\n)+$/, '')
+  end
+end
+
+RSpec::Matchers.define :have_stdout_match do |expected_stdout|
+  match do |actual_output|
+    !expected_stdout.match(WinRMSpecs.stdout(actual_output)).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{WinRMSpecs.stdout(actual_output)}' would match #{expected_stdout}"
+  end
+end
+
+RSpec::Matchers.define :have_stderr_match do |expected_stderr|
+  match do |actual_output|
+    !expected_stderr.match(WinRMSpecs.stderr(actual_output)).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{WinRMSpecs.stderr(actual_output)}' would match #{expected_stderr}"
+  end
+end
+
+RSpec::Matchers.define :have_no_stdout do
+  match do |actual_output|
+    stdout = WinRMSpecs.stdout(actual_output)
+    stdout == '\r\n' || stdout == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{WinRMSpecs.stdout(actual_output)}' would have no stdout"
+  end
+end
+
+RSpec::Matchers.define :have_no_stderr do
+  match do |actual_output|
+    stderr = WinRMSpecs.stderr(actual_output)
+    stderr == '\r\n' || stderr == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{WinRMSpecs.stderr(actual_output)}' would have no stderr"
+  end
+end
+
+RSpec::Matchers.define :have_exit_code do |expected_exit_code|
+  match do |actual_output|
+    expected_exit_code == actual_output[:exitcode]
+  end
+  failure_message do |actual_output|
+    "expected exit code #{expected_exit_code}, but got #{actual_output[:exitcode]}"
+  end
+end
+
+RSpec::Matchers.define :be_a_uid do
+  match do |actual|
+    # WinRM1.1 returns uuid's prefixed with 'uuid:' where as later versions do not
+    actual && actual.to_s.match(/^(uuid:)*\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$/)
+  end
+  failure_message do |actual|
+    "expected a uid, but got '#{actual}'"
+  end
+end