winrm 2.0.3 → 2.1.0

data/tests/integration/auth_timeout_spec.rb

@@ -1,18 +1,18 @@
-# encoding: UTF-8
-require_relative 'spec_helper'
-
-# 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
-    @powershell = winrm_connection.shell(:powershell)
-  end
-
-  it 'work with a 18 second sleep' do
-    ps_command = 'Start-Sleep -s 18'
-    output = @powershell.run(ps_command)
-    expect(output.exitcode).to eq(0)
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+# 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
+    @powershell = winrm_connection.shell(:powershell)
+  end
+
+  it 'work with a 18 second sleep' do
+    ps_command = 'Start-Sleep -s 18'
+    output = @powershell.run(ps_command)
+    expect(output.exitcode).to eq(0)
+  end
+end

data/tests/integration/cmd_spec.rb

@@ -1,110 +1,131 @@
-# encoding: UTF-8
-require_relative 'spec_helper'
-
-describe 'winrm client cmd' do
-  before(:all) do
-    @cmd_shell = winrm_connection.shell(:cmd)
-  end
-
-  describe 'empty string' do
-    subject(:output) { @cmd_shell.run('') }
-    it { should have_exit_code 0 }
-    it { should have_no_stdout }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig' do
-    subject(:output) { @cmd_shell.run('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) { @cmd_shell.run("echo 'hello world'") }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/'hello world'/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'multi stream output from large file' do
-    subject(:output) { @cmd_shell.run('type c:\windows\logs\dism\dism.log') }
-    it { should have_exit_code 0 }
-    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) { @cmd_shell.run('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 = ''
-      @cmd_shell.run(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) { @cmd_shell.run('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) { @cmd_shell.run('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) { @cmd_shell.run('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 = ''
-      @cmd_shell.run('ipconfig') do |stdout, _stderr|
-        outvar << stdout
-      end
-      outvar
-    end
-    it { should match(/Windows IP Configuration/) }
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe 'winrm client cmd' do
+  before(:all) do
+    @cmd_shell = winrm_connection.shell(:cmd)
+  end
+
+  describe 'empty string' do
+    subject(:output) { @cmd_shell.run('') }
+    it { should have_exit_code 0 }
+    it { should have_no_stdout }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig' do
+    subject(:output) { @cmd_shell.run('ipconfig') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'codepage' do
+    let(:options) { Hash.new }
+    let(:shell) { winrm_connection.shell(:cmd, options) }
+
+    after { shell.close }
+
+    subject(:output) { shell.run('chcp') }
+
+    it 'should default to UTF-8 (65001)' do
+      should have_stdout_match(/Active code page: 65001/)
+    end
+
+    context 'when changing the codepage' do
+      let(:options) { { codepage: 437 } }
+
+      it 'sets the codepage to the one given' do
+        should have_stdout_match(/Active code page: 437/)
+      end
+    end
+  end
+
+  describe 'echo \'hello world\' using apostrophes' do
+    subject(:output) { @cmd_shell.run("echo 'hello world'") }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/'hello world'/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'multi stream output from large file' do
+    subject(:output) { @cmd_shell.run('type c:\windows\logs\dism\dism.log') }
+    it { should have_exit_code 0 }
+    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) { @cmd_shell.run('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 = ''
+      @cmd_shell.run(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) { @cmd_shell.run('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) { @cmd_shell.run('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) { @cmd_shell.run('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 = ''
+      @cmd_shell.run('ipconfig') do |stdout, _stderr|
+        outvar << stdout
+      end
+      outvar
+    end
+    it { should match(/Windows IP Configuration/) }
+  end
+end

data/tests/integration/config-example.yml

@@ -1,16 +1,16 @@
-# 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
-#  realm: "your.realm"
-#  endpoint: "http://<yourserver>:5985/wsman"
-
-# 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"
-user: vagrant
-password: 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
+#  realm: "your.realm"
+#  endpoint: "http://<yourserver>:5985/wsman"
+
+# 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"
+user: vagrant
+password: vagrant

data/tests/integration/issue_59_spec.rb

@@ -1,26 +1,26 @@
-# encoding: UTF-8
-require_relative 'spec_helper'
-
-describe 'issue 59' do
-  describe 'long running script without output' do
-    let(:logged_output) { StringIO.new }
-    let(:logger)        { Logging.logger(logged_output) }
-
-    before do
-      opts = connection_opts.dup
-      opts[:operation_timeout] = 1
-      conn = WinRM::Connection.new(opts)
-      conn.logger = logger
-      @powershell = conn.shell(:powershell)
-    end
-
-    it 'should not error' do
-      out = @powershell.run('$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
+require_relative 'spec_helper'
+
+describe 'issue 59' do
+  describe 'long running script without output' do
+    let(:logged_output) { StringIO.new }
+    let(:logger)        { Logging.logger(logged_output) }
+
+    before do
+      opts = connection_opts.dup
+      opts[:operation_timeout] = 1
+      conn = WinRM::Connection.new(opts)
+      conn.logger = logger
+      @powershell = conn.shell(:powershell)
+    end
+
+    it 'should not error' do
+      out = @powershell.run('$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/tests/integration/powershell_spec.rb

@@ -1,165 +1,165 @@
-# encoding: UTF-8
-require_relative 'spec_helper'
-
-describe 'winrm client powershell' do
-  before(:all) do
-    @powershell = winrm_connection.shell(:powershell)
-  end
-
-  describe 'ipconfig' do
-    subject(:output) { @powershell.run('ipconfig') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/Windows IP Configuration/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig with invalid args' do
-    subject(:output) { @powershell.run('ipconfig blah') }
-    it { should have_exit_code 1 }
-  end
-
-  describe 'throw' do
-    subject(:output) { @powershell.run("throw 'an error occured'") }
-    it { should have_exit_code 0 }
-    it { should have_stderr_match(/an error occured/) }
-  end
-
-  describe 'exit' do
-    subject(:output) { @powershell.run('exit 5') }
-    it { should have_exit_code 5 }
-  end
-
-  describe 'echo \'hello world\' using apostrophes' do
-    subject(:output) { @powershell.run("echo 'hello world'") }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/hello world/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'handling special XML characters' do
-    subject(:output) { @powershell.run("echo 'hello & <world>'") }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/hello & <world>/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'dir with incorrect argument /z' do
-    subject(:output) { @powershell.run('dir /z') }
-    it { should have_stderr_match(/Cannot find path/) }
-    it { should have_no_stdout }
-  end
-
-  describe 'Math area calculation' do
-    subject(:output) do
-      @powershell.run <<-EOH
-        $diameter = 4.5
-        $area = [Math]::pow([Math]::PI * ($diameter/2), 2)
-        Write-Host $area
-      EOH
-    end
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/49.9648722805149/) }
-    it { should have_no_stderr }
-  end
-
-  describe 'ipconfig with a block' do
-    subject(:stdout) do
-      outvar = ''
-      @powershell.run('ipconfig') do |stdout, _stderr|
-        outvar << stdout
-      end
-      outvar
-    end
-    it { should match(/Windows IP Configuration/) }
-  end
-
-  describe 'capturing output from Write-Host and Write-Error' do
-    subject(:output) do
-      script = <<-eos
-      Write-Host 'Hello'
-      $host.ui.WriteErrorLine(', world!')
-      eos
-
-      @captured_stdout = ''
-      @captured_stderr = ''
-      @powershell.run(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 'capturing output from pipeline followed by Host' do
-    subject(:output) do
-      script = <<-eos
-      Write-Output 'output'
-      $host.UI.Writeline('host')
-      eos
-
-      @captured_stdout = ''
-      @captured_stderr = ''
-      @powershell.run(script) do |stdout, stderr|
-        @captured_stdout << stdout if stdout
-        @captured_stderr << stderr if stderr
-      end
-    end
-
-    it 'should print from the pipeline first' do
-      expect(output.stdout).to start_with("output\r\n")
-    end
-
-    it 'should write to host last' do
-      expect(output.stdout).to end_with("host\r\n")
-    end
-  end
-
-  describe 'it should handle utf-8 characters' do
-    subject(:output) { @powershell.run('echo "✓1234-äöü"') }
-    it { should have_exit_code 0 }
-    it { should have_stdout_match(/✓1234-äöü/) }
-  end
-
-  describe 'output exceeds a single fragment' do
-    subject(:output) { @powershell.run('Write-Output $("a"*600000)') }
-    it { should have_exit_code 0 }
-    it 'has assebled the output' do
-      expect(output.stdout).to eq('a' * 600000 + "\r\n")
-    end
-  end
-
-  describe 'command exceeds a single fragment' do
-    subject(:output) { @powershell.run("$var='#{'a' * 600000}';Write-Output 'long var'") }
-    it { should have_exit_code 0 }
-    it 'has sent the output' do
-      expect(output.stdout).to eq("long var\r\n")
-    end
-  end
-
-  describe 'reading pipeline messages' do
-    subject(:messages) { @powershell.send_pipeline_command('ipconfig') }
-
-    it 'returns multiple messages' do
-      expect(messages.length).to be > 1
-    end
-    it 'first message is pipeline output' do
-      expect(messages.first.type).to eq(WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_output])
-    end
-    it 'last message is pipeline state' do
-      expect(messages.last.type).to eq(WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state])
-    end
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe 'winrm client powershell' do
+  before(:all) do
+    @powershell = winrm_connection.shell(:powershell)
+  end
+
+  describe 'ipconfig' do
+    subject(:output) { @powershell.run('ipconfig') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/Windows IP Configuration/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig with invalid args' do
+    subject(:output) { @powershell.run('ipconfig blah') }
+    it { should have_exit_code 1 }
+  end
+
+  describe 'throw' do
+    subject(:output) { @powershell.run("throw 'an error occured'") }
+    it { should have_exit_code 0 }
+    it { should have_stderr_match(/an error occured/) }
+  end
+
+  describe 'exit' do
+    subject(:output) { @powershell.run('exit 5') }
+    it { should have_exit_code 5 }
+  end
+
+  describe 'echo \'hello world\' using apostrophes' do
+    subject(:output) { @powershell.run("echo 'hello world'") }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/hello world/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'handling special XML characters' do
+    subject(:output) { @powershell.run("echo 'hello & <world>'") }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/hello & <world>/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'dir with incorrect argument /z' do
+    subject(:output) { @powershell.run('dir /z') }
+    it { should have_stderr_match(/Cannot find path/) }
+    it { should have_no_stdout }
+  end
+
+  describe 'Math area calculation' do
+    subject(:output) do
+      @powershell.run <<-EOH
+        $diameter = 4.5
+        $area = [Math]::pow([Math]::PI * ($diameter/2), 2)
+        Write-Host $area
+      EOH
+    end
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/49.9648722805149/) }
+    it { should have_no_stderr }
+  end
+
+  describe 'ipconfig with a block' do
+    subject(:stdout) do
+      outvar = ''
+      @powershell.run('ipconfig') do |stdout, _stderr|
+        outvar << stdout
+      end
+      outvar
+    end
+    it { should match(/Windows IP Configuration/) }
+  end
+
+  describe 'capturing output from Write-Host and Write-Error' do
+    subject(:output) do
+      script = <<-eos
+      Write-Host 'Hello'
+      $host.ui.WriteErrorLine(', world!')
+      eos
+
+      @captured_stdout = ''
+      @captured_stderr = ''
+      @powershell.run(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 'capturing output from pipeline followed by Host' do
+    subject(:output) do
+      script = <<-eos
+      Write-Output 'output'
+      $host.UI.Writeline('host')
+      eos
+
+      @captured_stdout = ''
+      @captured_stderr = ''
+      @powershell.run(script) do |stdout, stderr|
+        @captured_stdout << stdout if stdout
+        @captured_stderr << stderr if stderr
+      end
+    end
+
+    it 'should print from the pipeline first' do
+      expect(output.stdout).to start_with("output\r\n")
+    end
+
+    it 'should write to host last' do
+      expect(output.stdout).to end_with("host\r\n")
+    end
+  end
+
+  describe 'it should handle utf-8 characters' do
+    subject(:output) { @powershell.run('echo "✓1234-äöü"') }
+    it { should have_exit_code 0 }
+    it { should have_stdout_match(/✓1234-äöü/) }
+  end
+
+  describe 'output exceeds a single fragment' do
+    subject(:output) { @powershell.run('Write-Output $("a"*600000)') }
+    it { should have_exit_code 0 }
+    it 'has assebled the output' do
+      expect(output.stdout).to eq('a' * 600000 + "\r\n")
+    end
+  end
+
+  describe 'command exceeds a single fragment' do
+    subject(:output) { @powershell.run("$var='#{'a' * 600000}';Write-Output 'long var'") }
+    it { should have_exit_code 0 }
+    it 'has sent the output' do
+      expect(output.stdout).to eq("long var\r\n")
+    end
+  end
+
+  describe 'reading pipeline messages' do
+    subject(:messages) { @powershell.send_pipeline_command('ipconfig') }
+
+    it 'returns multiple messages' do
+      expect(messages.length).to be > 1
+    end
+    it 'first message is pipeline output' do
+      expect(messages.first.type).to eq(WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_output])
+    end
+    it 'last message is pipeline state' do
+      expect(messages.last.type).to eq(WinRM::PSRP::Message::MESSAGE_TYPES[:pipeline_state])
+    end
+  end
+end