winrm 1.7.3 → 1.8.0

data/preamble

@@ -1,17 +1,17 @@
-=begin
-  This file is part of WinRM; the Ruby library for Microsoft WinRM.
-
-  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.
-=end
+=begin
+  This file is part of WinRM; the Ruby library for Microsoft WinRM.
+
+  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.
+=end

data/spec/auth_timeout_spec.rb

@@ -1,16 +1,16 @@
-# encoding: UTF-8
-# This test may only be meaningful with kerberos auth
-# Against server 2012, a kerberos connection will require reauth (get a 401)
-# if there are no requests for >= 15 seconds
-
-describe 'Verify kerberos will reauth when necessary', kerberos: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  it 'work with a 18 second sleep' do
-    ps_command = 'Start-Sleep -s 18'
-    output = @winrm.run_powershell_script(ps_command)
-    output[:exitcode].should == 0
-  end
-end
+# encoding: UTF-8
+# This test may only be meaningful with kerberos auth
+# Against server 2012, a kerberos connection will require reauth (get a 401)
+# if there are no requests for >= 15 seconds
+
+describe 'Verify kerberos will reauth when necessary', kerberos: true do
+  before(:all) do
+    @winrm = winrm_connection
+  end
+
+  it 'work with a 18 second sleep' do
+    ps_command = 'Start-Sleep -s 18'
+    output = @winrm.run_powershell_script(ps_command)
+    output[:exitcode].should == 0
+  end
+end

data/spec/cmd_spec.rb

@@ -1,102 +1,102 @@
-# encoding: UTF-8
-describe 'winrm client cmd', integration: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  describe 'empty string' do
-    subject(:output) { @winrm.cmd('') }
-    it { should have_exit_code 0 }
-    it { should have_no_stdout }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig' do
-    subject(:output) { @winrm.cmd('ipconfig') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'echo \'hello world\' using apostrophes' do
-    subject(:output) { @winrm.cmd("echo 'hello world'") }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/'hello world'/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'echo "string with trailing \\" using double quotes' do
-    # This is a regression test for #131.  " is converted to " when serializing
-    # the command to SOAP/XML.  Any naive substitution performed on such a serialized
-    # string can result in any \& sequence being interpreted as a back-substitution.
-    subject(:output) { @winrm.cmd('echo "string with trailing \\"') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/string with trailing \\/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'capturing output from stdout and stderr' do
-    subject(:output) do
-      # Note: Multiple lines doesn't work:
-      # script = <<-eos
-      # echo Hello
-      # echo , world! 1>&2
-      # eos
-
-      script = 'echo Hello & echo , world! 1>&2'
-
-      @captured_stdout = ''
-      @captured_stderr = ''
-      @winrm.cmd(script) do |stdout, stderr|
-        @captured_stdout << stdout if stdout
-        @captured_stderr << stderr if stderr
-      end
-    end
-
-    it 'should have stdout' do
-      expect(output.stdout).to eq("Hello \r\n")
-      expect(output.stdout).to eq(@captured_stdout)
-    end
-
-    it 'should have stderr' do
-      expect(output.stderr).to eq(", world! \r\n")
-      expect(output.stderr).to eq(@captured_stderr)
-    end
-
-    it 'should have output' do
-      expect(output.output).to eq("Hello \r\n, world! \r\n")
-    end
-  end
-
-  describe 'ipconfig with /all argument' do
-    subject(:output) { @winrm.cmd('ipconfig', %w(/all)) }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'dir with incorrect argument /z' do
-    subject(:output) { @winrm.cmd('dir /z') }
-    it { should have_exit_code 1 }
-    it { should have_no_stdout }
-    it { should have_stderr_match(/Invalid switch/) }
-  end
-
-  describe 'ipconfig && echo error 1>&2' do
-    subject(:output) { @winrm.cmd('ipconfig && echo error 1>&2') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_stderr_match(/error/) }
-  end
-
-  describe 'ipconfig with a block' do
-    subject(:stdout) do
-      outvar = ''
-      @winrm.cmd('ipconfig') do |stdout, _stderr|
-        outvar << stdout
-      end
-      outvar
-    end
-    it { should match(/Windows IP Configuration/) }
-  end
-end
+# encoding: UTF-8
+describe 'winrm client cmd', integration: true do
+  before(:all) do
+    @winrm = winrm_connection
+  end
+
+  describe 'empty string' do
+    subject(:output) { @winrm.cmd('') }
+    it { should have_exit_code 0 }
+    it { should have_no_stdout }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig' do
+    subject(:output) { @winrm.cmd('ipconfig') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'echo \'hello world\' using apostrophes' do
+    subject(:output) { @winrm.cmd("echo 'hello world'") }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/'hello world'/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'echo "string with trailing \\" using double quotes' do
+    # This is a regression test for #131.  " is converted to &quot; when serializing
+    # the command to SOAP/XML.  Any naive substitution performed on such a serialized
+    # string can result in any \& sequence being interpreted as a back-substitution.
+    subject(:output) { @winrm.cmd('echo "string with trailing \\"') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/string with trailing \\/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'capturing output from stdout and stderr' do
+    subject(:output) do
+      # Note: Multiple lines doesn't work:
+      # script = <<-eos
+      # echo Hello
+      # echo , world! 1>&2
+      # eos
+
+      script = 'echo Hello & echo , world! 1>&2'
+
+      @captured_stdout = ''
+      @captured_stderr = ''
+      @winrm.cmd(script) do |stdout, stderr|
+        @captured_stdout << stdout if stdout
+        @captured_stderr << stderr if stderr
+      end
+    end
+
+    it 'should have stdout' do
+      expect(output.stdout).to eq("Hello \r\n")
+      expect(output.stdout).to eq(@captured_stdout)
+    end
+
+    it 'should have stderr' do
+      expect(output.stderr).to eq(", world! \r\n")
+      expect(output.stderr).to eq(@captured_stderr)
+    end
+
+    it 'should have output' do
+      expect(output.output).to eq("Hello \r\n, world! \r\n")
+    end
+  end
+
+  describe 'ipconfig with /all argument' do
+    subject(:output) { @winrm.cmd('ipconfig', %w(/all)) }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'dir with incorrect argument /z' do
+    subject(:output) { @winrm.cmd('dir /z') }
+    it { should have_exit_code 1 }
+    it { should have_no_stdout }
+    it { should have_stderr_match(/Invalid switch/) }
+  end
+
+  describe 'ipconfig && echo error 1>&2' do
+    subject(:output) { @winrm.cmd('ipconfig && echo error 1>&2') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_stderr_match(/error/) }
+  end
+
+  describe 'ipconfig with a block' do
+    subject(:stdout) do
+      outvar = ''
+      @winrm.cmd('ipconfig') do |stdout, _stderr|
+        outvar << stdout
+      end
+      outvar
+    end
+    it { should match(/Windows IP Configuration/) }
+  end
+end

data/spec/command_executor_spec.rb

@@ -233,16 +233,7 @@ describe WinRM::CommandExecutor, unit: true do
         expect(output).to eq echo_output
       end
 
-      describe 'when shell is closed on server' do
-        before do
-          @times_called = 0
-
-          allow(service).to receive(:run_command) do
-            @times_called += 1
-            fail WinRM::WinRMWSManFault.new('oops', '2150858843') if @times_called == 1
-          end
-        end
-
+      shared_examples 'retry shell command' do
         it 'does not close the current shell' do
           expect(service).not_to receive(:close_shell)
 
@@ -261,6 +252,32 @@ describe WinRM::CommandExecutor, unit: true do
           executor.run_cmd('echo', ['Hello'])
         end
       end
+
+      describe 'when shell is closed on server' do
+        before do
+          @times_called = 0
+
+          allow(service).to receive(:run_command) do
+            @times_called += 1
+            fail WinRM::WinRMWSManFault.new('oops', '2150858843') if @times_called == 1
+          end
+        end
+
+        include_examples 'retry shell command'
+      end
+
+      describe 'when shell accesses a deleted registry key' do
+        before do
+          @times_called = 0
+
+          allow(service).to receive(:run_command) do
+            @times_called += 1
+            fail WinRM::WinRMWSManFault.new('oops', '2147943418') if @times_called == 1
+          end
+        end
+
+        include_examples 'retry shell command'
+      end
     end
 
     describe 'when called many times over time' do

data/spec/command_output_decoder_spec.rb

@@ -1,37 +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
+# 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