winrm 1.8.1 → 2.0.0

data/{spec → tests/integration}/wql_spec.rb

@@ -1,14 +1,16 @@
-# encoding: UTF-8
-describe 'winrm client wql', integration: true do
-  before(:all) do
-    @winrm = winrm_connection
-  end
-
-  it 'should query Win32_OperatingSystem' do
-    output = @winrm.run_wql('select * from Win32_OperatingSystem')
-    expect(output).to_not be_empty
-    output_caption = output[:win32_operating_system][0][:caption]
-    expect(output_caption).to include('Microsoft')
-    expect(output_caption).to include('Windows')
-  end
-end
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe 'winrm client wql' do
+  before(:all) do
+    @winrm = winrm_connection
+  end
+
+  it 'should query Win32_OperatingSystem' do
+    output = @winrm.run_wql('select * from Win32_OperatingSystem')
+    expect(output).to_not be_empty
+    output_caption = output[:win32_operating_system][0][:caption]
+    expect(output_caption).to include('Microsoft')
+    expect(output_caption).to include('Windows')
+  end
+end

data/{spec → tests}/matchers.rb

@@ -1,74 +1,60 @@
-# 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
+RSpec::Matchers.define :have_stdout_match do |expected_stdout|
+  match do |actual_output|
+    !expected_stdout.match(actual_output.stdout).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stdout}' would match #{expected_stdout}"
+  end
+end
+
+RSpec::Matchers.define :have_stderr_match do |expected_stderr|
+  match do |actual_output|
+    !expected_stderr.match(actual_output.stderr).nil?
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stderr}' would match #{expected_stderr}"
+  end
+end
+
+RSpec::Matchers.define :have_no_stdout do
+  match do |actual_output|
+    stdout = actual_output.stdout
+    stdout == '\r\n' || stdout == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stdout}' would have no stdout"
+  end
+end
+
+RSpec::Matchers.define :have_no_stderr do
+  match do |actual_output|
+    stderr = actual_output.stderr
+    stderr == '\r\n' || stderr == ''
+  end
+  failure_message do |actual_output|
+    "expected that '#{actual_output.stderr}' 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

data/tests/spec/configuration_spec.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+require 'winrm/connection_opts'
+
+describe WinRM::ConnectionOpts do
+  context 'when there are no overrides' do
+    describe '#create_with_defaults' do
+      it 'throws a validation error' do
+        expect { WinRM::ConnectionOpts.create_with_defaults({}) }.to raise_error
+      end
+    end
+  end
+  context 'when username, password, and endpoint are given' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman'
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'creates a ConnectionOpts object' do
+        config = WinRM::ConnectionOpts.create_with_defaults(overrides)
+        expect(config[:user]).to eq(overrides[:user])
+        expect(config[:password]).to eq(overrides[:password])
+        expect(config[:endpoint]).to eq(overrides[:endpoint])
+      end
+    end
+  end
+  context 'when overrides are provided' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman',
+        transport: :ssl
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'creates a ConnectionOpts object with overrides' do
+        config = WinRM::ConnectionOpts.create_with_defaults(overrides)
+        expect(config[:transport]).to eq(overrides[:transport])
+      end
+    end
+  end
+  context 'when receive_timeout is specified' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman',
+        receive_timeout: 120
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'creates a ConnectionOpts object with the correct receive_timeout' do
+        config = WinRM::ConnectionOpts.create_with_defaults(overrides)
+        expect(config[:receive_timeout]).to eq(overrides[:receive_timeout])
+      end
+    end
+  end
+  context 'when operation_timeout is specified' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman',
+        operation_timeout: 120
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'creates a ConnectionOpts object with the correct timeouts' do
+        config = WinRM::ConnectionOpts.create_with_defaults(overrides)
+        expect(config[:operation_timeout]).to eq(overrides[:operation_timeout])
+        expect(config[:receive_timeout]).to eq(overrides[:operation_timeout] + 10)
+      end
+    end
+  end
+  context 'when invalid data types are given' do
+    let(:overrides) do
+      {
+        user: 'Administrator',
+        password: 'password',
+        endpoint: 'http://localhost:5985/wsman',
+        operation_timeout: 'PT60S'
+      }
+    end
+    describe '#create_with_defaults' do
+      it 'raises an error' do
+        expect { WinRM::ConnectionOpts.create_with_defaults(overrides) }.to raise_error
+      end
+    end
+  end
+end

data/tests/spec/connection_spec.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+require 'winrm'
+require 'winrm/shells/cmd'
+require 'winrm/shells/power_shell'
+
+describe WinRM::Connection do
+  context 'new' do
+    it 'creates a new winrm session' do
+      connection = WinRM::Connection.new(default_connection_opts)
+      expect(connection).not_to be_nil
+    end
+  end
+
+  context 'shell(:cmd)' do
+    it 'creates a new cmd session' do
+      connection = WinRM::Connection.new(default_connection_opts)
+      cmd_shell = connection.shell(:cmd)
+      expect(cmd_shell).not_to be_nil
+      expect(cmd_shell).to be_an_instance_of(WinRM::Shells::Cmd)
+    end
+  end
+
+  context 'shell(:powershell)' do
+    it 'creates a new powershell session' do
+      connection = WinRM::Connection.new(default_connection_opts)
+      cmd_shell = connection.shell(:powershell)
+      expect(cmd_shell).not_to be_nil
+      expect(cmd_shell).to be_an_instance_of(WinRM::Shells::Powershell)
+    end
+  end
+
+  context 'shell(:not_a_real_shell_type)' do
+    it 'raises a descriptive error' do
+      connection = WinRM::Connection.new(default_connection_opts)
+      expect { connection.shell(:not_a_real_shell_type) }.to raise_error(WinRM::InvalidShellError)
+    end
+  end
+end

data/{spec → tests/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' 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/tests/spec/http/transport_factory_spec.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+require 'winrm/exceptions'
+require 'winrm/http/transport_factory'
+
+module WinRM
+  module HTTP
+    # Remove the gssapi stuff in kerberos init for tests
+    class HttpGSSAPI < HttpTransport
+      def initialize(endpoint, realm, opts, service = nil)
+      end
+    end
+  end
+end
+
+describe WinRM::HTTP::TransportFactory do
+  describe '#create_transport' do
+    let(:transport) { :negotiate }
+    let(:options) do
+      {
+        transport: transport,
+        endpoint: 'endpoint',
+        user: 'user'
+      }
+    end
+
+    it 'creates a negotiate transport' do
+      options[:transport] = :negotiate
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::HttpNegotiate)
+    end
+
+    it 'creates a plaintext transport' do
+      options[:transport] = :plaintext
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::HttpPlaintext)
+    end
+
+    it 'creates a basic auth ssl transport' do
+      options[:transport] = :ssl
+      options[:basic_auth_only] = true
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::BasicAuthSSL)
+    end
+
+    it 'creates a client cert ssl transport' do
+      options[:transport] = :ssl
+      options[:client_cert] = 'cert'
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::ClientCertAuthSSL)
+    end
+
+    it 'creates a negotiate over ssl transport' do
+      options[:transport] = :ssl
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::HttpNegotiate)
+    end
+
+    it 'creates a kerberos transport' do
+      options[:transport] = :kerberos
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::HttpGSSAPI)
+    end
+
+    it 'creates a transport from a stringified transport' do
+      options[:transport] = 'negotiate'
+      expect(subject.create_transport(options)).to be_a(WinRM::HTTP::HttpNegotiate)
+    end
+
+    it 'raises when transport type does not exist' do
+      options[:transport] = :fancy
+      expect { subject.create_transport(options) }.to raise_error(WinRM::InvalidTransportError)
+    end
+  end
+end