winrm 2.3.0 → 2.3.1

data/tests/spec/shells/cmd_spec.rb

@@ -1,75 +0,0 @@
-require 'winrm/shells/cmd'
-
-describe WinRM::Shells::Cmd do
-  let(:retry_limit) { 1 }
-  let(:shell_id) { 'shell_id' }
-  let(:output) { 'output' }
-  let(:create_shell_payload) { 'create_shell_payload' }
-  let(:close_shell_payload) { 'close_shell_payload' }
-  let(:cleanup_payload) { 'cleanup_payload' }
-  let(:command) { 'run this command' }
-  let(:arguments) { ['args'] }
-  let(:command_response) { "<a xmlns:rsp='foo'><rsp:CommandId>command_id</rsp:CommandId></a>" }
-  let(:connection_options) { { max_commands: 100, retry_limit: retry_limit, retry_delay: 0 } }
-  let(:transport) { double('transport', send_request: nil) }
-
-  before do
-    allow_any_instance_of(WinRM::WSMV::CloseShell).to receive(:build)
-      .and_return(close_shell_payload)
-    allow_any_instance_of(WinRM::WSMV::CreateShell).to receive(:build)
-      .and_return(create_shell_payload)
-    allow_any_instance_of(WinRM::WSMV::CleanupCommand).to receive(:build)
-      .and_return(cleanup_payload)
-    allow_any_instance_of(WinRM::WSMV::ReceiveResponseReader).to receive(:read_output)
-      .and_return(output)
-    allow(transport).to receive(:send_request)
-      .with(create_shell_payload)
-      .and_return(REXML::Document.new("<blah Name='ShellId'>#{shell_id}</blah>"))
-    allow(transport).to receive(:send_request)
-      .with(/#{command}/)
-      .and_return(REXML::Document.new(command_response))
-  end
-
-  subject { described_class.new(connection_options, transport, Logging.logger['test']) }
-
-  describe '#run' do
-    it 'opens a shell and gets shell id' do
-      subject.run(command, arguments)
-      expect(subject.shell_id).to eq shell_id
-    end
-
-    it 'sends create shell through transport' do
-      expect(transport).to receive(:send_request).with(create_shell_payload)
-      subject.run(command, arguments)
-    end
-
-    it 'returns output from generated command' do
-      expect(subject.run(command, arguments)).to eq output
-    end
-
-    it 'sends command through transport' do
-      expect(transport).to receive(:send_request).with(/#{command}/)
-      subject.run(command, arguments)
-    end
-
-    it 'sends cleanup message through transport' do
-      expect(transport).to receive(:send_request).with(cleanup_payload)
-      subject.run(command, arguments)
-    end
-  end
-
-  describe '#close' do
-    it 'sends close shell through transport' do
-      subject.run(command, arguments)
-      expect(transport).to receive(:send_request).with(close_shell_payload)
-      subject.close
-    end
-
-    it 'creates a shell closer with default shell uri' do
-      allow(WinRM::WSMV::CloseShell).to receive(:new) do |_, opts|
-        expect(opts[:shell_uri]).to be nil
-      end.and_call_original
-      subject.close
-    end
-  end
-end

data/tests/spec/shells/powershell_spec.rb

@@ -1,221 +0,0 @@
-require 'winrm/shells/power_shell'
-
-describe WinRM::Shells::Powershell do
-  let(:retry_limit) { 1 }
-  let(:max_envelope_size_kb) { 150 }
-  let(:shell_id) { 'bc1bfbba-8215-4a04-b2df-7a3ac0310e16' }
-  let(:output) { 'output' }
-  let(:command_id) { '4218A578-0F18-4B19-82C3-46B433319126' }
-  let(:keepalive_payload) { 'keepalive_payload' }
-  let(:configuration_payload) { 'configuration_payload' }
-  let(:command_payload) { 'command_payload' }
-  let(:create_shell_payload) { 'create_shell_payload' }
-  let(:close_shell_payload) { 'close_shell_payload' }
-  let(:cleanup_payload) { 'cleanup_payload' }
-  let(:command) { 'command' }
-  let(:output_message) { double('output_message', build: 'output_message') }
-  let(:connection_options) { { max_commands: 100, retry_limit: retry_limit, retry_delay: 0 } }
-  let(:transport) { double('transport', send_request: nil) }
-  let(:protocol_version) { 2.2 }
-  let(:test_data1) do
-    <<-EOH
-      <Obj RefId="0">
-        <MS>
-          <Version N="protocolversion">#{protocol_version}</Version>
-          <Version N="PSVersion">2.0</Version>
-          <Version N="SerializationVersion">1.1.0.1</Version>
-        </MS>
-      </Obj>
-    EOH
-  end
-  let(:test_data2) { '<Obj RefId="0"><MS><I32 N="RunspaceState">2</I32></MS></Obj>' }
-  let(:message1) do
-    WinRM::PSRP::Message.new(
-      shell_id,
-      WinRM::PSRP::Message::MESSAGE_TYPES[:session_capability],
-      test_data1,
-      command_id
-    )
-  end
-  let(:message2) do
-    WinRM::PSRP::Message.new(
-      shell_id,
-      WinRM::PSRP::Message::MESSAGE_TYPES[:runspacepool_state],
-      test_data2,
-      command_id
-    )
-  end
-  let(:fragment1) { WinRM::PSRP::Fragment.new(1, message1.bytes) }
-  let(:fragment2) { WinRM::PSRP::Fragment.new(1, message2.bytes) }
-  let(:test_data_stdout1) { Base64.strict_encode64(fragment1.bytes.pack('C*')) }
-  let(:test_data_stdout2) { Base64.strict_encode64(fragment2.bytes.pack('C*')) }
-
-  {
-    'powershell' => {
-      keepalive_template_path: 'get_powershell_keepalive_response.xml.erb',
-      config: "<a xmlns:cfg='f'><cfg:MaxEnvelopeSizekb>" \
-        '<%= max_envelope_size_kb %></cfg:MaxEnvelopeSizekb></a>',
-      command: "<a xmlns:rsp='foo'><rsp:CommandId><%= command_id %></rsp:CommandId></a>"
-    },
-    'omi' => {
-      keepalive_template_path: 'get_omi_powershell_keepalive_response.xml.erb',
-      config: File.read('tests/spec/stubs/responses/get_omi_config_response.xml'),
-      command: "<p:CommandResponse xmlns:p='foo'><p:CommandId>" \
-        '<%= command_id %></p:CommandId></p:CommandResponse>'
-    }
-  }.each_pair do |server_type, response|
-    context "with server type #{server_type}" do
-      let(:command_response) { ERB.new(response[:command]).result(binding) }
-
-      before do
-        config_response = ERB.new(response[:config]).result(binding)
-        test_data_xml_template = ERB.new(stubbed_response(response[:keepalive_template_path]))
-
-        allow(SecureRandom).to receive(:uuid).and_return(command_id)
-        allow(subject).to receive(:command_output_message)
-          .with(shell_id, command_id)
-          .and_return(output_message)
-        allow_any_instance_of(WinRM::WSMV::CreatePipeline).to receive(:build)
-          .and_return(command_payload)
-        allow_any_instance_of(WinRM::WSMV::CloseShell).to receive(:build)
-          .and_return(close_shell_payload)
-        allow_any_instance_of(WinRM::WSMV::InitRunspacePool).to receive(:build)
-          .and_return(create_shell_payload)
-        allow_any_instance_of(WinRM::WSMV::Configuration).to receive(:build)
-          .and_return(configuration_payload)
-        allow_any_instance_of(WinRM::WSMV::CleanupCommand).to receive(:build)
-          .and_return(cleanup_payload)
-        allow_any_instance_of(WinRM::WSMV::KeepAlive).to receive(:build)
-          .and_return(keepalive_payload)
-        allow_any_instance_of(WinRM::PSRP::ReceiveResponseReader).to receive(:read_output)
-          .with(output_message).and_return(output)
-        allow(transport).to receive(:send_request).with(configuration_payload) do |_|
-          # parse real XML with ResponseHandler to raise WinRMSoapFault
-          WinRM::ResponseHandler.new(config_response, 500).parse_to_xml if server_type == 'omi'
-          REXML::Document.new(config_response)
-        end
-        allow(transport).to receive(:send_request)
-          .with(create_shell_payload)
-          .and_return(REXML::Document.new("<blah Name='ShellId'>#{shell_id}</blah>"))
-        allow(transport).to receive(:send_request)
-          .with(command_payload)
-          .and_return(REXML::Document.new(command_response))
-        allow(transport).to receive(:send_request)
-          .with(keepalive_payload)
-          .and_return(REXML::Document.new(test_data_xml_template.result(binding)))
-      end
-
-      subject { described_class.new(connection_options, transport, Logging.logger['test']) }
-
-      describe '#run' do
-        it 'opens a shell and gets shell id' do
-          subject.run(command)
-          expect(subject.shell_id).to eq shell_id
-        end
-
-        it 'sends create shell through transport' do
-          expect(transport).to receive(:send_request).with(create_shell_payload)
-          subject.run(command)
-        end
-
-        it 'sends keepalive shell through transport' do
-          expect(transport).to receive(:send_request).with(keepalive_payload)
-          subject.run(command)
-        end
-
-        it 'returns output from generated command' do
-          expect(subject.run(command)).to eq output
-        end
-
-        it 'sends command through transport' do
-          expect(transport).to receive(:send_request).with(command_payload)
-          subject.run(command)
-        end
-
-        it 'sends cleanup message through transport' do
-          expect(transport).to receive(:send_request).with(cleanup_payload)
-          subject.run(command)
-        end
-
-        # OMI server doesn't respond to configuration so these tests are irrelevant there
-        context 'non admin user', if: server_type == 'powershell' do
-          before do
-            allow(transport).to receive(:send_request)
-              .with(configuration_payload)
-              .and_raise(WinRM::WinRMWSManFault.new('no access for you', '5'))
-          end
-
-          context 'protocol version 2.1' do
-            let(:protocol_version) { 2.1 }
-            let(:command) { 'c' * 200000 }
-
-            it 'sets the fragmenter max_blob_length' do
-              expect_any_instance_of(WinRM::PSRP::MessageFragmenter).to receive(:max_blob_length=)
-                .with(153600)
-              subject.run(command)
-            end
-
-            it 'fragments messages smaller than max envelope size' do
-              allow_any_instance_of(WinRM::WSMV::CreatePipeline).to receive(:build)
-                .and_call_original
-              allow(transport).to receive(:send_request).with(/CommandLine/) do |payload|
-                expect(payload.length).to eq 206512
-              end.and_return(REXML::Document.new(command_response))
-              subject.run(command)
-            end
-          end
-
-          context 'protocol version 2.2' do
-            let(:protocol_version) { 2.2 }
-            let(:command) { 'c' * 200000 }
-
-            it 'sets the fragmenter max_blob_length' do
-              expect_any_instance_of(WinRM::PSRP::MessageFragmenter).to receive(:max_blob_length=)
-                .with(512000)
-              subject.run(command)
-            end
-
-            it 'fragments messages smaller than max envelope size' do
-              allow_any_instance_of(WinRM::WSMV::CreatePipeline).to receive(:build)
-                .and_call_original
-              allow(transport).to receive(:send_request).with(/CommandLine/) do |payload|
-                expect(payload.length).to eq 276028
-              end.and_return(REXML::Document.new(command_response))
-              subject.run(command)
-            end
-          end
-        end
-
-        context 'fragment large command' do
-          let(:command) { 'c' * 200000 }
-
-          it 'fragments messages as large as max envelope size' do
-            allow_any_instance_of(WinRM::WSMV::CreatePipeline).to receive(:build).and_call_original
-            allow(transport).to receive(:send_request).with(/CommandLine/) do |payload|
-              fallback = subject.max_fragment_blob_size ==
-                         WinRM::PSRP::MessageFragmenter::DEFAULT_BLOB_LENGTH
-              # OMI server uses default blob size b/c config endpoint unavailable
-              expect(payload.length).to eq fallback ? 45404 : max_envelope_size_kb * 1024
-            end.and_return(REXML::Document.new(command_response))
-            subject.run(command)
-          end
-        end
-      end
-
-      describe '#close' do
-        it 'sends close shell through transport' do
-          subject.run(command)
-          expect(transport).to receive(:send_request).with(close_shell_payload)
-          subject.close
-        end
-
-        it 'creates a shell closer with powershell uri' do
-          allow(WinRM::WSMV::CloseShell).to receive(:new) do |_, opts|
-            expect(opts[:shell_uri]).to be WinRM::WSMV::Header::RESOURCE_URI_POWERSHELL
-          end.and_call_original
-          subject.close
-        end
-      end
-    end
-  end
-end

data/tests/spec/spec_helper.rb

@@ -1,46 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'winrm'
-require 'json'
-require_relative '../matchers'
-
-# Unit test spec helper
-module SpecUnitHelper
-  def stubbed_response(file)
-    File.read("tests/spec/stubs/responses/#{file}")
-  end
-
-  def stubbed_clixml(file)
-    File.read("tests/spec/stubs/clixml/#{file}")
-  end
-
-  def default_connection_opts
-    {
-      user: 'Administrator',
-      password: 'password',
-      endpoint: 'http://localhost:5985/wsman',
-      max_envelope_size: 153600,
-      session_id: '05A2622B-B842-4EB8-8A78-0225C8A993DF',
-      operation_timeout: 60,
-      locale: 'en-US'
-    }
-  end
-end
-
-# Strip leading whitespace from each line that is the same as the
-# amount of whitespace on the first line of the string.
-# Leaves _additional_ indentation on later lines intact.
-# and remove newlines.
-class String
-  def unindent
-    gsub(/^#{self[/\A[ \t]*/]}/, '').delete("\n")
-  end
-
-  def to_byte_string
-    force_encoding(Encoding::ASCII_8BIT)
-  end
-end
-
-RSpec.configure do |config|
-  config.include(SpecUnitHelper)
-end

data/tests/spec/stubs/clixml/error_record.xml.erb

@@ -1,84 +0,0 @@
-<?xml version="1.0"?>
-<Obj RefId="0">
-    <TN RefId="0">
-        <T>System.Management.Automation.ErrorRecord</T>
-        <T>System.Object</T>
-    </TN>
-    <ToString><%= error_message %></ToString>
-    <MS>
-        <B N="writeErrorStream">true</B>
-        <Obj N="Exception" RefId="1">
-            <TN RefId="1">
-                <T>Microsoft.PowerShell.Commands.WriteErrorException</T>
-                <T>Microsoft.PowerShell.CoreClr.Stubs.SystemException</T>
-                <T>System.Exception</T>
-                <T>System.Object</T>
-            </TN>
-            <ToString>Microsoft.PowerShell.Commands.WriteErrorException: <%= error_message %></ToString>
-            <Props>
-                <S N="Message"><%= error_message %></S>
-                <Obj N="Data" RefId="2">
-                    <TN RefId="2">
-                        <T>System.Collections.ListDictionaryInternal</T>
-                        <T>System.Object</T>
-                    </TN>
-                    <DCT/>
-                </Obj>
-                <Nil N="InnerException"/>
-                <Nil N="StackTrace"/>
-                <Nil N="HelpLink"/>
-                <Nil N="Source"/>
-                <I32 N="HResult">-2146233088</I32>
-            </Props>
-        </Obj>
-        <Nil N="TargetObject"/>
-        <S N="FullyQualifiedErrorId"><%= error_id %></S>
-        <Obj N="InvocationInfo" RefId="3">
-            <TN RefId="3">
-                <T>System.Management.Automation.InvocationInfo</T>
-                <T>System.Object</T>
-            </TN>
-            <ToString>System.Management.Automation.InvocationInfo</ToString>
-            <Props>
-                <Nil N="MyCommand"/>
-                <Obj N="BoundParameters" RefId="4">
-                    <TN RefId="4">
-                        <T>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
-                        <T>System.Object</T>
-                    </TN>
-                    <DCT/>
-                </Obj>
-                <Obj N="UnboundArguments" RefId="5">
-                    <TN RefId="5">
-                        <T>System.Collections.Generic.List`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
-                        <T>System.Object</T>
-                    </TN>
-                    <LST/>
-                </Obj>
-                <I32 N="ScriptLineNumber">1</I32>
-                <I32 N="OffsetInLine">1</I32>
-                <I64 N="HistoryId">1</I64>
-                <S N="ScriptName"/>
-                <S N="Line">write-error '<%= error_message %>'</S>
-                <S N="PositionMessage">At line:1 char:1_x000D__x000A_+ write-error '<%= error_message %>'_x000D__x000A_+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</S>
-                <S N="PSScriptRoot"><%= script_root %></S>
-                <Nil N="PSCommandPath"/>
-                <S N="InvocationName"/>
-                <I32 N="PipelineLength">0</I32>
-                <I32 N="PipelinePosition">0</I32>
-                <B N="ExpectingInput">false</B>
-                <S N="CommandOrigin">Internal</S>
-                <Nil N="DisplayScriptPosition"/>
-            </Props>
-        </Obj>
-        <I32 N="ErrorCategory_Category">0</I32>
-        <S N="ErrorCategory_Activity">Write-Error</S>
-        <S N="ErrorCategory_Reason">WriteErrorException</S>
-        <S N="ErrorCategory_TargetName"/>
-        <S N="ErrorCategory_TargetType"/>
-        <S N="ErrorCategory_Message"><%= category_message %></S>
-        <B N="SerializeExtendedInfo">false</B>
-        <S N="ErrorDetails_ScriptStackTrace"><%= stack_trace %></S>
-        <Nil N="PSMessageDetails"/>
-    </MS>
-</Obj>

data/tests/spec/stubs/clixml/pipeline_state.xml.erb

@@ -1,88 +0,0 @@
-<?xml version="1.0"?>
-<Obj RefId="0">
-	<MS>
-		<I32 N="PipelineState"><%= pipeline_state %></I32>
-		<Obj N="ExceptionAsErrorRecord" RefId="1">
-			<TN RefId="0">
-				<T>System.Management.Automation.ErrorRecord</T>
-				<T>System.Object</T>
-			</TN>
-			<ToString><%= error_message %></ToString>
-			<MS>
-				<Obj N="Exception" RefId="2">
-					<TN RefId="1">
-						<T>System.Management.Automation.RuntimeException</T>
-						<T>Microsoft.PowerShell.CoreClr.Stubs.SystemException</T>
-						<T>System.Exception</T>
-						<T>System.Object</T>
-					</TN>
-					<ToString>System.Management.Automation.RuntimeException: <%= error_message %></ToString>
-					<Props>
-						<S N="ErrorRecord"><%= error_message %></S>
-						<B N="WasThrownFromThrowStatement">true</B>
-						<S N="Message"><%= error_message %></S>
-						<Obj N="Data" RefId="3">
-							<TN RefId="2">
-								<T>System.Collections.ListDictionaryInternal</T>
-								<T>System.Object</T>
-							</TN>
-							<DCT />
-						</Obj>
-						<Nil N="InnerException" />
-						<Nil N="StackTrace" />
-						<Nil N="HelpLink" />
-						<Nil N="Source" />
-						<I32 N="HResult">-2146233088</I32>
-					</Props>
-				</Obj>
-				<S N="TargetObject"><%= error_message %></S>
-				<S N="FullyQualifiedErrorId"><%= error_id %></S>
-				<Obj N="InvocationInfo" RefId="4">
-					<TN RefId="3">
-						<T>System.Management.Automation.InvocationInfo</T>
-						<T>System.Object</T>
-					</TN>
-					<ToString>System.Management.Automation.InvocationInfo</ToString>
-					<Props>
-						<Nil N="MyCommand" />
-						<Obj N="BoundParameters" RefId="5">
-							<TN RefId="4">
-								<T>System.Collections.Generic.Dictionary`2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
-								<T>System.Object</T>
-							</TN>
-							<DCT />
-						</Obj>
-						<Obj N="UnboundArguments" RefId="6">
-							<TN RefId="5">
-								<T>System.Collections.Generic.List`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]</T>
-								<T>System.Object</T>
-							</TN>
-							<LST />
-						</Obj>
-						<I32 N="ScriptLineNumber">1</I32>
-						<I32 N="OffsetInLine">1</I32>
-						<I64 N="HistoryId">-1</I64>
-						<S N="ScriptName"></S>
-						<S N="Line">throw '<%= error_message %>'</S>
-						<S N="PositionMessage">At line:1 char:1_x000D__x000A_+ throw '<%= error_message %>'_x000D__x000A_+ ~~~~~~~~~~~~~~~~~~~~~~~~</S>
-						<S N="PSScriptRoot"></S>
-						<Nil N="PSCommandPath" />
-						<S N="InvocationName"></S>
-						<I32 N="PipelineLength">0</I32>
-						<I32 N="PipelinePosition">0</I32>
-						<B N="ExpectingInput">false</B>
-						<S N="CommandOrigin">Internal</S>
-						<Nil N="DisplayScriptPosition" />
-					</Props>
-				</Obj>
-				<I32 N="ErrorCategory_Category">14</I32>
-				<S N="ErrorCategory_Activity"></S>
-				<S N="ErrorCategory_Reason">RuntimeException</S>
-				<S N="ErrorCategory_TargetName"><%= error_message %></S><S N="ErrorCategory_TargetType">String</S>
-				<S N="ErrorCategory_Message"><%= category_message %></S>
-				<B N="SerializeExtendedInfo">false</B>
-				<S N="ErrorDetails_ScriptStackTrace">at &lt;ScriptBlock&gt;, &lt;No file&gt;: line 1</S>
-			</MS>
-		</Obj>
-	</MS>
-</Obj>