ridley-connectors 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cc8a35d12c2f0a211941000d82e951c738d1f0b
-  data.tar.gz: 8793248c34607319be63abfbab2f0b5831f6ef2a
+  metadata.gz: e90348caa597256c09723c5a29428f75187dbb81
+  data.tar.gz: 3c6de11adb749a25c8873e3a061f6a1e33512010
 SHA512:
-  metadata.gz: b6c08b024e392d443a050676e690e591342973c6fb105b4961f904cf2b1937eff4f2516751d6a2ad9d292ae58bbb2afc1456c675dc8d736e8d7b75aeae9813ac
-  data.tar.gz: 74a3bba5e041055a7b2cfc02c38aff93132feeed3cbe4144d29f19f6c43c1897e9b9576f1a629339379aa01550d10d86673c5c3137a1a48d438dacde9f3a3919
+  metadata.gz: 7af3ff66ae8b1d47e67c8d10d382246432a550a8ef88f3c3c92fdf35619956554e3beb135ad40ba6759eb42be70eca5b656e24ea74a99e329ab141a1ee2913cc
+  data.tar.gz: a36958116a5abd3ea500eb33e73a7dbacde1efefd36426238a0dcabdc40c50cefc4a0a3384d8a9aea4b25fbc2d4fce4c76f444d139d133f5b671919cbf1e1f6f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v.2.1.0
+
+* [#21](https://github.com/RiotGames/ridley-connectors/pull/21) Fix bootstrappers and pathing to files moved from Ridley
+* [#22](https://github.com/RiotGames/ridley-connectors/pull/22) Added a new option to allow connector_for to pick a connector more intelligently
+
 ## v.2.0.1
 
 * [#18](https://github.com/RiotGames/ridley-connectors/pull/18) Move more connector-specific code out of ridley and into ridley-connectors

data/lib/ridley-connectors/bootstrap_context.rb

@@ -68,7 +68,7 @@ module Ridley
 
       # @return [Pathname]
       def templates_path
-        Ridley.root.join('bootstrappers')
+        Ridley::Connectors.bootstrappers
       end
 
       # @return [String]

data/lib/ridley-connectors/command_context.rb

@@ -28,7 +28,7 @@ module Ridley
         # @return [Pathname]
         def template_file(filename = nil)
           return @template_file if filename.nil?
-          @template_file = Ridley.scripts.join("#{filename}.erb")
+          @template_file = Ridley::Connectors.scripts.join("#{filename}.erb")
         end
       end
 

data/lib/ridley-connectors/host_commander.rb

@@ -26,6 +26,9 @@ module Ridley
     PORT_CHECK_TIMEOUT = 3
     RETRY_COUNT = 3
 
+    DEFAULT_WINDOWS_CONNECTOR = "winrm"
+    DEFAULT_LINUX_CONNECTOR = "ssh"
+
     CONNECTOR_PORT_ERRORS = [
       Errno::ETIMEDOUT, Timeout::Error, SocketError, 
       Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EADDRNOTAVAIL,
@@ -60,6 +63,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 [String] :connector
+    #   a connector type to prefer
     #
     # @return [HostConnector::Response]
     def run(host, command, options = {})
@@ -102,6 +107,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 [String] :connector
+    #   a connector type to prefer
     #
     # @return [HostConnector::Response]
     def chef_client(host, options = {})
@@ -125,6 +132,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 [String] :connector
+    #   a connector type to prefer
     #
     # @return [HostConnector::Response]
     def put_secret(host, secret, options = {})
@@ -148,6 +157,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 [String] :connector
+    #   a connector type to prefer
     #
     # @return [HostConnector::Response]
     def ruby_script(host, command_lines, options = {})
@@ -173,6 +184,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 [String] :connector
+    #   a connector type to prefer
     #
     # @return [HostConnector::Response]
     def uninstall_chef(host, options = {})
@@ -188,6 +201,8 @@ module Ridley
     #   * :timeout (Float) [5.0] timeout value for testing SSH connection
     # @option options [Hash] :winrm
     #   * :port (Fixnum) the winrm port to connect on the node the bootstrap will be performed on (5985)
+    # @option options [String] :connector
+    #   a connector type to prefer
     # @param block [Proc]
     #   an optional block that is yielded the best HostConnector
     #
@@ -199,10 +214,12 @@ module Ridley
       options[:winrm][:port] ||= HostConnector::WinRM::DEFAULT_PORT
       options[:retries]      ||= RETRY_COUNT
 
-      if connector_port_open?(host, options[:winrm][:port], options[:winrm][:timeout], options[:retries])
+      connector = options[:connector]
+
+      if (connector == DEFAULT_WINDOWS_CONNECTOR || connector.nil?) && connector_port_open?(host, options[:winrm][:port], options[:winrm][:timeout], options[:retries])
         options.delete(:ssh)
         winrm
-      elsif connector_port_open?(host, options[:ssh][:port], options[:ssh][:timeout], options[:retries])
+      elsif (connector == DEFAULT_LINUX_CONNECTOR || connector.nil?) && connector_port_open?(host, options[:ssh][:port], options[:ssh][:timeout], options[:retries])
         options.delete(:winrm)
         ssh
       else

data/lib/ridley-connectors/resources/node_resource.rb

@@ -95,10 +95,12 @@ module Ridley
     # host.
     #
     # @param [String] host
+    # @option options [String] :connector
+    #   a connectory type to prefer
     #
     # @return [HostConnector::Response]
-    def chef_run(host)
-      host_commander.chef_client(host, ssh: ssh, winrm: winrm)
+    def chef_run(host, options = {})
+      host_commander.chef_client(host, ssh: ssh, winrm: winrm, connector: options[:connector])
     rescue Errors::HostConnectionError => ex
       abort(ex)
     end
@@ -107,10 +109,12 @@ module Ridley
     # the given host.
     #
     # @param [String] host
+    # @option options [String] :connector
+    #   a connectory type to prefer
     #
     # @return [HostConnector::Response]
-    def put_secret(host)
-      host_commander.put_secret(host, encrypted_data_bag_secret, ssh: ssh, winrm: winrm)
+    def put_secret(host, options = {})
+      host_commander.put_secret(host, encrypted_data_bag_secret, ssh: ssh, winrm: winrm, connector: options[:connector])
     end
 
     # Executes an arbitrary ruby script using the best worker available
@@ -118,10 +122,12 @@ module Ridley
     #
     # @param [String] host
     # @param [Array<String>] command_lines
+    # @option options [String] :connector
+    #   a connectory type to prefer    
     #
     # @return [HostConnector::Response]
-    def ruby_script(host, command_lines)
-      host_commander.ruby_script(host, command_lines, ssh: ssh, winrm: winrm)
+    def ruby_script(host, command_lines, options = {})
+      host_commander.ruby_script(host, command_lines, ssh: ssh, winrm: winrm, connector: options[:connector])
     end
 
     # Executes the given command on a node using the best worker
@@ -131,8 +137,8 @@ module Ridley
     # @param [String] command
     #
     # @return [HostConnector::Response]
-    def run(host, command)
-      host_commander.run(host, command, ssh: ssh, winrm: winrm)
+    def run(host, command, options = {})
+      host_commander.run(host, command, ssh: ssh, winrm: winrm, connector: options[:connector])
     end
     alias_method :execute_command, :run
 

data/lib/ridley-connectors/version.rb

@@ -1,5 +1,5 @@
 module Ridley
   module Connectors
-    VERSION = "2.0.1"
+    VERSION = "2.1.0"
   end
 end

data/lib/ridley-connectors.rb

@@ -3,10 +3,23 @@ require 'celluloid/io'
 require 'ridley'
 
 module Ridley
-  class << self
-    # @return [Pathname]
-    def scripts
-      root.join('scripts')
+  module Connectors
+    class << self
+
+      # @return [Pathname]
+      def root
+        @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+      end
+
+      # @return [Pathname]
+      def scripts
+        root.join('scripts')
+      end
+
+      # @return [Pathname]
+      def bootstrappers
+        root.join('bootstrappers')
+      end
     end
   end
 

data/ridley-connectors.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'celluloid-io', '~> 0.16.0.pre'
   s.add_dependency 'erubis'
   s.add_dependency 'net-ssh'
-  s.add_dependency 'ridley',       '~> 3.0'
+  s.add_dependency 'ridley',       '~> 3.1'
   s.add_dependency 'winrm',        '~> 1.1.0'
 
   s.add_development_dependency 'buff-ruby_engine', '~> 0.1'

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

@@ -208,5 +208,43 @@ describe Ridley::HostCommander do
       subject.should_receive(:winrm)
       subject.connector_for(host, winrm: nil, ssh: nil)
     end
+
+    context "when a connector of winrm is given" do
+      let(:options) do
+        { ssh: { port: 22, timeout: 3 }, winrm: { port: 5985, timeout: 3 }, retries: 3, connector: "winrm" }
+      end
+      let(:winrm) { double }
+
+      it "should return winrm if winrm is open" do
+        subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT, anything, anything).and_return(true)
+        subject.stub(:winrm).and_return(winrm)
+        expect(subject.connector_for(host, options)).to eql(winrm)
+      end
+
+      it "should return nil if winrm is closed" do
+        subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT, anything, anything).and_return(false)
+        expect(subject.connector_for(host, options)).to be_nil
+      end
+    end
+
+    context "when a connector of ssh is given" do
+      let(:options) do
+        { ssh: { port: 22, timeout: 3 }, winrm: { port: 5985, timeout: 3 }, retries: 3, connector: "ssh" }
+      end
+      let(:ssh) { double }
+
+      it "should return ssh if ssh is open" do
+        subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::SSH::DEFAULT_PORT, anything, anything).and_return(true)
+        subject.stub(:ssh).and_return(ssh)
+        subject.should_not_receive(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT, anything, anything)
+        expect(subject.connector_for(host, options)).to eql(ssh)
+      end
+
+      it "should return nil if ssh is closed" do
+        subject.stub(:connector_port_open?).with(host, Ridley::HostConnector::SSH::DEFAULT_PORT, anything, anything).and_return(false)
+        subject.should_not_receive(:connector_port_open?).with(host, Ridley::HostConnector::WinRM::DEFAULT_PORT, anything, anything)
+        expect(subject.connector_for(host, options)).to be_nil
+      end
+    end
   end
 end

data/spec/unit/ridley-connectors/resources/node_resource_spec.rb

@@ -11,9 +11,11 @@ describe Ridley::NodeResource do
       encrypted_data_bag_secret: double('encrypted_data_bag_secret'),
       ssh: double('ssh'),
       winrm: double('winrm'),
-      chef_version: double('chef_version')
+      chef_version: double('chef_version'),
+      connector: nil
     }
   end
+
   let(:instance) do
     inst = described_class.new(double, options)
     inst.stub(host_commander: host_commander)
@@ -21,21 +23,23 @@ describe Ridley::NodeResource do
   end
 
   describe "#bootstrap" do
+    let(:bootstrap_options) { options.delete(:connector); options }
+
     it "sends the message #bootstrap to the instance's host_commander" do
-      host_commander.should_receive(:bootstrap).with(host, options)
+      host_commander.should_receive(:bootstrap).with(host, bootstrap_options)
       instance.bootstrap(host)
     end
 
     it "passes pre-configured options to #bootstrap" do
-      host_commander.should_receive(:bootstrap).with(host, options)
+      host_commander.should_receive(:bootstrap).with(host, bootstrap_options)
       instance.bootstrap(host)
     end
   end
 
   describe "#chef_run" do
     it "sends the message #chef_client to the instance's host_commander" do
-      host_commander.should_receive(:chef_client).with(host, ssh: instance.ssh, winrm: instance.winrm)
-      instance.chef_run(host)
+      host_commander.should_receive(:chef_client).with(host, ssh: instance.ssh, winrm: instance.winrm, connector: nil)
+      instance.chef_run(host, options)
     end
   end
 
@@ -43,8 +47,8 @@ describe Ridley::NodeResource do
     let(:secret) { options[:encrypted_data_bag_secret] }
 
     it "sends the message #put_secret to the instance's host_commander" do
-      host_commander.should_receive(:put_secret).with(host, secret, options.slice(:ssh, :winrm))
-      instance.put_secret(host)
+      host_commander.should_receive(:put_secret).with(host, secret, options.slice(:ssh, :winrm, :connector))
+      instance.put_secret(host, options)
     end
   end
 
@@ -52,8 +56,8 @@ describe Ridley::NodeResource do
     let(:command_lines) { ["puts 'hello'", "puts 'there'"] }
 
     it "sends the message #ruby_script to the instance's host_commander" do
-      host_commander.should_receive(:ruby_script).with(host, command_lines, ssh: instance.ssh, winrm: instance.winrm)
-      instance.ruby_script(host, command_lines)
+      host_commander.should_receive(:ruby_script).with(host, command_lines, ssh: instance.ssh, winrm: instance.winrm, connector: nil)
+      instance.ruby_script(host, command_lines, options)
     end
   end
 
@@ -61,8 +65,8 @@ describe Ridley::NodeResource do
     let(:command) { "echo 'hello winrm_connectorld'" }
 
     it "sends the message #run to the instance's host_commander" do
-      host_commander.should_receive(:run).with(host, command, ssh: instance.ssh, winrm: instance.winrm)
-      instance.run(host, command)
+      host_commander.should_receive(:run).with(host, command, ssh: instance.ssh, winrm: instance.winrm, connector: nil)
+      instance.run(host, command, options)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridley-connectors
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jamie Winsor
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement