ridley-connectors 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d377ab3a3c31432e8159a2211ed1d9bd3594bef1
-  data.tar.gz: 59ed27aaa0c2ac8693364c9da424993cf90db674
+  metadata.gz: 8931876ade720f3abe20d2e445e71104241df5a1
+  data.tar.gz: 4980b60e12f779d067baea1cf83dc7d700c7d996
 SHA512:
-  metadata.gz: 0bfa41714c7a6d903ac7e900b2334757c88b012c162eab16ba9d89155bfbfe12a89739e89da244c0b5321c650dfaffb8cbe2aae52a25e89f14baefb54b315e26
-  data.tar.gz: bb63aa0722d6810dcad2a2251afdd2d407255dd312972d28872550994060597563b36d17926f2e7230eeaf5617ef764ceb195a0364f478091eb66cf4aeb04173
+  metadata.gz: 55fe74b96c38964ee8ccb8dbc51863bdd802deaeb95a75f607dab2c2b67eb4a3c65a35a678b46cb5221b30111f52e77e96efe1a807727a4166c572f7ae57d59d
+  data.tar.gz: 4416bbcb1b1dfc7ad830fa41fbcebab58a2ab1655d508a41cd2dfc14d57d2ddee116afaa0c4571c3de1c0042b4e5f06b031519f1615fc4559851d22274ef8f17

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v.1.2.1
+
+* [#8](https://github.com/RiotGames/ridley-connectors/pull/8) Add a flag to execute Ruby scripts on Windows machines using a batch file
+* [#9](https://github.com/RiotGames/ridley-connectors/pull/9) Fix a bug where a nil value for SSH or WinRM config would cause a NoMethodError
+
 ## v.1.2.0
 
 * Bumping internal dependency on Ridley to at least 2.4.2

data/lib/ridley-connectors/host_commander.rb

@@ -170,7 +170,8 @@ module Ridley
     #
     # @return [HostConnector::SSH, HostConnector::WinRM]
     def connector_for(host, options = {})
-      options = options.reverse_merge(ssh: Hash.new, winrm: Hash.new)
+      options[:ssh]          ||= Hash.new
+      options[:winrm]        ||= Hash.new
       options[:ssh][:port]   ||= HostConnector::SSH::DEFAULT_PORT
       options[:winrm][:port] ||= HostConnector::WinRM::DEFAULT_PORT
 

data/lib/ridley-connectors/host_connector/winrm.rb

@@ -29,6 +29,8 @@ module Ridley
       #   * :user (String) a user that will login to each node and perform the bootstrap command on
       #   * :password (String) the password for the user that will perform the bootstrap (required)
       #   * :port (Fixnum) the winrm port to connect on the node the bootstrap will be performed on (5985)
+      # @option options [TrueClass, FalseClass] :force_batch_file
+      #   Always use a batch file to run the command regardless of command length.
       #
       # @return [HostConnector::Response]
       def run(host, command, options = {})
@@ -49,7 +51,7 @@ module Ridley
         HostConnector::Response.new(host).tap do |response|
           begin
             command_uploaders << command_uploader = CommandUploader.new(connection)
-            command = get_command(command, command_uploader)
+            command = get_command(command, command_uploader, force_batch_file: options[:force_batch_file])
 
             log.info "Running WinRM command: '#{command}' on: '#{host}' as: '#{user}'"
 
@@ -93,10 +95,14 @@ module Ridley
       # limit. Otherwise, we return an execution of the command as a batch file.
       #
       # @param  command [String]
+      # @param  options [Hash]
+      #
+      # @option options [TrueClass, FalseClass] :force_batch_file
+      #   Always use a batch file to run the command regardless of command length.
       #
       # @return [String]
-      def get_command(command, command_uploader)
-        if command.length < CommandUploader::CHUNK_LIMIT
+      def get_command(command, command_uploader, options = {})
+        if !options[:force_batch_file] && command.length < CommandUploader::CHUNK_LIMIT
           command
         else
           log.debug "Detected a command that was longer than #{CommandUploader::CHUNK_LIMIT} characters. " +
@@ -159,7 +165,10 @@ module Ridley
         run(host, command, options)
       end
 
-      # Execute line(s) of Ruby code on a node using Chef's embedded Ruby
+      # Execute line(s) of Ruby code on a node using Chef's embedded
+      # Ruby. This will always run via a batch file due to WinRM
+      # having difficulty handling long ruby scripts being passed via
+      # ruby -e.
       #
       # @param [String] host
       #   the host to perform the action on
@@ -174,7 +183,7 @@ module Ridley
       # @return [HostConnector::Response]
       def ruby_script(host, command_lines, options = {})
         command = "#{EMBEDDED_RUBY_PATH} -e \"#{command_lines.join(';')}\""
-        run(host, command, options)
+        run(host, command, options.merge(force_batch_file: true))
       end
 
       # Uninstall Chef from a node

data/lib/ridley-connectors/version.rb

@@ -1,5 +1,5 @@
 module Ridley
   module Connectors
-    VERSION = '1.2.0'
+    VERSION = '1.2.1'
   end
 end

data/spec/unit/ridley-connectors/host_commander_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe Ridley::HostCommander do
   subject { described_class.new }
+  let(:host) { "fake.riotgames.com" }
 
   describe "#run" do
-    let(:host) { "fake.riotgames.com" }
     let(:command) { "ls" }
     let(:options) do
       { ssh: { port: 22 }, winrm: { port: 5985 } }
@@ -18,7 +18,6 @@ describe Ridley::HostCommander do
 
       it "sends a #run message to the ssh host connector" do
         subject.send(:ssh).should_receive(:run).with(host, command, options)
-
         subject.run(host, command, options)
       end
     end
@@ -38,7 +37,6 @@ describe Ridley::HostCommander do
   end
 
   describe "#bootstrap" do
-    let(:host) { "fake.riotgames.com" }
     let(:options) do
       { ssh: { port: 22 }, winrm: { port: 5985 } }
     end
@@ -71,7 +69,6 @@ describe Ridley::HostCommander do
   end
 
   describe "#chef_client" do
-    let(:host) { "fake.riotgames.com" }
     let(:options) do
       { ssh: { port: 22 }, winrm: { port: 5985 } }
     end
@@ -104,7 +101,6 @@ describe Ridley::HostCommander do
   end
 
   describe "#put_secret" do
-    let(:host) { "fake.riotgames.com" }
     let(:secret) { "something_secret" }
     let(:options) do
       { ssh: { port: 22 }, winrm: { port: 5985 } }
@@ -138,7 +134,6 @@ describe Ridley::HostCommander do
   end
 
   describe "#ruby_script" do
-    let(:host) { "fake.riotgames.com" }
     let(:command_lines) { ["line one"] }
     let(:options) do
       { ssh: { port: 22 }, winrm: { port: 5985 } }
@@ -170,4 +165,25 @@ describe Ridley::HostCommander do
       end
     end
   end
+
+  describe "#connector_for" do
+    it "should return winrm if winrm is open" do
+      subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT).and_return(true)
+      subject.should_receive(:winrm)
+      subject.connector_for(host)
+    end
+    
+    it "should return winrm if winrm is open" do
+      subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT).and_return(false)
+      subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::SSH::DEFAULT_PORT, nil).and_return(true)
+      subject.should_receive(:ssh)
+      subject.connector_for(host)
+    end
+
+    it "should still set the default ports if an explicit nil is passed in" do
+      subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT).and_return(true)
+      subject.should_receive(:winrm)
+      subject.connector_for(host, winrm: nil, ssh: nil)
+    end
+  end
 end

data/spec/unit/ridley-connectors/host_connector/winrm_spec.rb

@@ -99,6 +99,16 @@ describe Ridley::HostConnector::WinRM do
         expect(result.stderr).to eql("WinRM::WinRMHTTPTransportError")
       end
     end
+
+    context "when the force_batch_file is true" do
+      let(:options_with_force_batch_file) { options.merge(force_batch_file: true) }
+      subject(:result) { connector.run(host, command, options_with_force_batch_file) }
+      it "should always use a command uploader when a force_batch_file is set to true" do
+        command_uploader_stub.should_receive(:upload).with(command)
+        command_uploader_stub.should_receive(:command).and_return(command)
+        result
+      end
+    end
   end
 
   describe "#bootstrap" do
@@ -156,7 +166,7 @@ describe Ridley::HostConnector::WinRM do
     it "receives a ruby call with the command" do
       connector.should_receive(:run).with(host,
         "#{described_class::EMBEDDED_RUBY_PATH} -e \"puts 'hello';puts 'there'\"",
-        options
+        options.merge(force_batch_file: true)
       )
 
       ruby_script

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridley-connectors
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jamie Winsor
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid