ridley 0.12.4 → 1.0.0.rc1

data/lib/ridley/resources/node_resource.rb

@@ -14,6 +14,8 @@ module Ridley
     attr_reader :winrm
     attr_reader :chef_version
 
+    finalizer :finalize_callback
+
     # @param [Celluloid::Registry] connection_registry
     #
     # @option options [String] :server_url
@@ -43,48 +45,45 @@ module Ridley
       @ssh                       = options[:ssh]
       @winrm                     = options[:winrm]
       @chef_version              = options[:chef_version]
+      @host_commander            = HostCommander.new_link
     end
 
-    # @overload bootstrap(nodes, options = {})
-    #   @param [Array<String>, String] nodes
+    # @param [String] host
     #
-    #   @option options [Hash] ssh
-    #     * :user (String) a shell user that will login to each node and perform the bootstrap command on (required)
-    #     * :password (String) the password for the shell user that will perform the bootstrap
-    #     * :keys (Array, String) an array of keys (or a single key) to authenticate the ssh user with instead of a password
-    #     * :timeout (Float) [5.0] timeout value for SSH bootstrap
-    #   @option options [Hash] :winrm
-    #     * :user (String) a user that will login to each node and perform the bootstrap command on (required)
-    #     * :password (String) the password for the user that will perform the bootstrap
-    #     * :port (Fixnum) the winrm port to connect on the node the bootstrap will be performed on (5985)
-    #   @option options [String] :validator_client
-    #   @option options [String] :validator_path
-    #     filepath to the validator used to bootstrap the node (required)
-    #   @option options [String] :bootstrap_proxy
-    #     URL to a proxy server to bootstrap through (default: nil)
-    #   @option options [String] :encrypted_data_bag_secret_path
-    #     filepath on your host machine to your organizations encrypted data bag secret (default: nil)
-    #   @option options [Hash] :hints
-    #     a hash of Ohai hints to place on the bootstrapped node (default: Hash.new)
-    #   @option options [Hash] :attributes
-    #     a hash of attributes to use in the first Chef run (default: Hash.new)
-    #   @option options [Array] :run_list
-    #     an initial run list to bootstrap with (default: Array.new)
-    #   @option options [String] :chef_version
-    #     version of Chef to install on the node (default: nil)
-    #   @option options [String] :environment
-    #     environment to join the node to (default: '_default')
-    #   @option options [Boolean] :sudo
-    #     bootstrap with sudo (default: true)
-    #   @option options [String] :template
-    #     bootstrap template to use (default: omnibus)
+    # @option options [Hash] ssh
+    #   * :user (String) a shell user that will login to each node and perform the bootstrap command on (required)
+    #   * :password (String) the password for the shell user that will perform the bootstrap
+    #   * :keys (Array, String) an array of keys (or a single key) to authenticate the ssh user with instead of a password
+    #   * :timeout (Float) [5.0] timeout value for SSH bootstrap
+    # @option options [Hash] :winrm
+    #   * :user (String) a user that will login to each node and perform the bootstrap command on (required)
+    #   * :password (String) the password for the user that will perform the bootstrap
+    #   * :port (Fixnum) the winrm port to connect on the node the bootstrap will be performed on (5985)
+    # @option options [String] :validator_client
+    # @option options [String] :validator_path
+    #   filepath to the validator used to bootstrap the node (required)
+    # @option options [String] :bootstrap_proxy
+    #   URL to a proxy server to bootstrap through (default: nil)
+    # @option options [String] :encrypted_data_bag_secret_path
+    #   filepath on your host machine to your organizations encrypted data bag secret (default: nil)
+    # @option options [Hash] :hints
+    #   a hash of Ohai hints to place on the bootstrapped node (default: Hash.new)
+    # @option options [Hash] :attributes
+    #   a hash of attributes to use in the first Chef run (default: Hash.new)
+    # @option options [Array] :run_list
+    #   an initial run list to bootstrap with (default: Array.new)
+    # @option options [String] :chef_version
+    #   version of Chef to install on the node (default: nil)
+    # @option options [String] :environment
+    #   environment to join the node to (default: '_default')
+    # @option options [Boolean] :sudo
+    #   bootstrap with sudo (default: true)
+    # @option options [String] :template
+    #   bootstrap template to use (default: omnibus)
     #
-    # @return [SSH::ResponseSet]
-    def bootstrap(*args)
-      args = args.dup
-      opts = args.extract_options!
-
-      options = opts.reverse_merge(
+    # @return [HostConnector::Response]
+    def bootstrap(host, options = {})
+      options = options.reverse_merge(
         server_url: server_url,
         validator_path: validator_path,
         validator_client: validator_client,
@@ -94,7 +93,7 @@ module Ridley
         chef_version: chef_version
       )
 
-      Bootstrapper.new(args, options).run
+      host_commander.bootstrap(host, options)
     end
 
     # Executes a Chef run using the best worker available for the given
@@ -104,10 +103,7 @@ module Ridley
     #
     # @return [HostConnector::Response]
     def chef_run(host)
-      worker = HostConnector.new(host, ssh: ssh, winrm: winrm)
-      worker.chef_client
-    ensure
-      worker.terminate if worker && worker.alive?
+      host_commander.chef_client(host, ssh: ssh, winrm: winrm)
     end
 
     # Puts a secret on the host using the best worker available for
@@ -117,10 +113,7 @@ module Ridley
     #
     # @return [HostConnector::Response]
     def put_secret(host)
-      worker = HostConnector.new(host, ssh: ssh, winrm: winrm)
-      worker.put_secret(encrypted_data_bag_secret)
-    ensure
-      worker.terminate if worker && worker.alive?
+      host_commander.put_secret(host, encrypted_data_bag_secret, ssh: ssh, winrm: winrm)
     end
 
     # Executes an arbitrary ruby script using the best worker available
@@ -131,10 +124,7 @@ module Ridley
     #
     # @return [HostConnector::Response]
     def ruby_script(host, command_lines)
-      worker = HostConnector.new(host, ssh: ssh, winrm: winrm)
-      worker.ruby_script(command_lines)
-    ensure
-      worker.terminate if worker && worker.alive?
+      host_commander.ruby_script(host, command_lines, ssh: ssh, winrm: winrm)
     end
 
     # Executes the given command on a node using the best worker
@@ -145,10 +135,7 @@ module Ridley
     #
     # @return [Array<Symbol, HostConnector::Response>]
     def execute_command(host, command)
-      worker = HostConnector.new(host, ssh: ssh, winrm: winrm)
-      worker.run(command)
-    ensure
-      worker.terminate if worker && worker.alive?
+      host_commander.run(host, command, ssh: ssh, winrm: winrm)
     end
 
     # Merges the given data with the the data of the target node on the remote
@@ -164,7 +151,7 @@ module Ridley
     # @raise [Errors::ResourceNotFound]
     #   if the target node is not found
     #
-    # @return [Ridley::NodeResource]
+    # @return [Ridley::NodeObject]
     def merge_data(target, options = {})
       unless node = find(target)
         abort Errors::ResourceNotFound.new
@@ -172,5 +159,14 @@ module Ridley
 
       update(node.merge_data(options))
     end
+
+    private
+
+      # @return [Ridley::HostCommander]
+      attr_reader :host_commander
+
+      def finalize_callback
+        @host_commander.terminate if @host_commander && @host_commander.alive?
+      end
   end
 end

data/lib/ridley/version.rb

@@ -1,3 +1,3 @@
 module Ridley
-  VERSION = "0.12.4"
+  VERSION = "1.0.0.rc1"
 end

data/ridley.gemspec

@@ -23,9 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'erubis'
   s.add_runtime_dependency 'faraday',                 '>= 0.8.4'
   s.add_runtime_dependency 'hashie',                  '>= 2.0.2'
-  s.add_runtime_dependency 'mixlib-log',              '>= 1.3.0'
   s.add_runtime_dependency 'mixlib-shellout',         '>= 1.1.0'
-  s.add_runtime_dependency 'mixlib-config',           '>= 1.1.0'
   s.add_runtime_dependency 'mixlib-authentication',   '>= 1.3.0'
   s.add_runtime_dependency 'net-http-persistent',     '>= 2.8'
   s.add_runtime_dependency 'net-ssh'

data/spec/spec_helper.rb

@@ -19,13 +19,13 @@ def setup_rspec
     config.filter_run focus: true
     config.run_all_when_everything_filtered = true
 
-    config.before(:suite) { Ridley::RSpec::ChefServer.start }
-
-    config.before(:all) do
-      Ridley.logger = Celluloid.logger = nil
+    config.before(:suite) do
       WebMock.disable_net_connect!(allow_localhost: true, net_http_connect_on_start: true)
+      Ridley::RSpec::ChefServer.start
     end
 
+    config.before(:all) { Ridley.logger = Celluloid.logger = nil }
+
     config.before(:each) do
       Celluloid.shutdown
       Celluloid.boot

data/spec/support/chef_server.rb

@@ -3,8 +3,6 @@ require_relative 'spec_helpers'
 
 module Ridley::RSpec
   module ChefServer
-    PORT = 8889
-
     class << self
       include Ridley::SpecHelpers
 
@@ -17,7 +15,7 @@ module Ridley::RSpec
       end
 
       def server
-        @server ||= ChefZero::Server.new(port: PORT)
+        @server ||= ChefZero::Server.new(port: PORT, generate_real_keys: false)
       end
 
       def server_url
@@ -43,6 +41,10 @@ module Ridley::RSpec
       end
     end
 
+    include Ridley::SpecHelpers
+
+    PORT = 8889
+
     def chef_client(name, hash = Hash.new)
       load_data(:clients, name, hash)
     end
@@ -67,6 +69,10 @@ module Ridley::RSpec
       load_data(:roles, name, hash)
     end
 
+    def chef_zero_connection
+      Ridley::Connection.new(ChefServer.server_url, "reset", fixtures_path.join('reset.pem').to_s)
+    end
+
     private
 
       def load_data(key, name, hash)

data/spec/unit/ridley/{bootstrap_bindings/unix_template_binding_spec.rb → bootstrap_context/unix_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Ridley::UnixTemplateBinding do
+describe Ridley::BootstrapContext::Unix do
   let(:options) do
     {
       server_url: "https://api.opscode.com/organizations/vialstudios",
@@ -34,7 +34,7 @@ describe Ridley::UnixTemplateBinding do
     end
   end
 
-  subject { Ridley::UnixTemplateBinding.new(options) }
+  subject { described_class.new(options) }
 
   describe "MixinMethods" do
 

data/spec/unit/ridley/{bootstrap_bindings/windows_template_binding_spec.rb → bootstrap_context/windows_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Ridley::WindowsTemplateBinding do
+describe Ridley::BootstrapContext::Windows do
   let(:options) do
     {
       server_url: "https://api.opscode.com/organizations/vialstudios",
@@ -30,7 +30,7 @@ describe Ridley::WindowsTemplateBinding do
     end
   end
 
-  subject { Ridley::WindowsTemplateBinding.new(options) }
+  subject { described_class.new(options) }
 
   describe "MixinMethods" do
     describe "#templates_path" do

data/spec/unit/ridley/{mixin/bootstrap_binding_spec.rb → bootstrap_context_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Ridley::BootstrapBinding do
+describe Ridley::BootstrapContext::Base do
   let(:host) { "reset.riotgames.com" }
   let(:options) do
     {
@@ -13,11 +13,7 @@ describe Ridley::BootstrapBinding do
   end
 
   describe "ClassMethods" do
-    subject do
-      Class.new do
-        include Ridley::BootstrapBinding
-      end
-    end
+    subject { described_class }
 
     describe ":included" do
       context "when a class includes Ridley::BootstrapBinding" do

data/spec/unit/ridley/host_commander_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe Ridley::HostCommander do
+  describe "ClassMethods" do
+    subject { described_class }
+
+    describe "::connector_port_open?" do
+      let(:host) { "127.0.0.1" }
+      let(:port) { 22 }
+      let(:socket) { double(close: nil) }
+
+      before { TCPSocket.stub(:new).and_return(socket) }
+
+      subject(:result) { described_class.connector_port_open?(host, port) }
+
+      context "when a port is open" do
+        it { should be_true }
+
+        it "closes the opened socket" do
+          socket.should_receive(:close)
+          result
+        end
+      end
+
+      context "when a port is closed" do
+        before { TCPSocket.stub(:new).and_raise(Errno::ECONNREFUSED) }
+
+        it { should be_false }
+      end
+
+      context "when host is unreachable" do
+        before { TCPSocket.stub(:new).and_raise(SocketError) }
+
+        it { should be_false }
+      end
+    end
+  end
+
+  subject { described_class.new }
+
+  describe "#run" do
+    let(:host) { "reset.riotgames.com" }
+    let(:command) { "ls" }
+    let(:options) do
+      { ssh: { port: 22 }, winrm: { port: 5985 } }
+    end
+
+    context "when communicating to a unix node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(false)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(true)
+      end
+
+      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
+
+    context "when communicating to a windows node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(true)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(false)
+      end
+
+      it "sends a #run message to the ssh host connector" do
+        subject.send(:winrm).should_receive(:run).with(host, command, options)
+
+        subject.run(host, command, options)
+      end
+    end
+  end
+
+  describe "#bootstrap" do
+    let(:host) { "reset.riotgames.com" }
+    let(:options) do
+      { ssh: { port: 22 }, winrm: { port: 5985 } }
+    end
+
+    context "when communicating to a unix node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(false)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(true)
+      end
+
+      it "sends a #bootstrap message to the ssh host connector" do
+        subject.send(:ssh).should_receive(:bootstrap).with(host, options)
+
+        subject.bootstrap(host, options)
+      end
+    end
+
+    context "when communicating to a windows node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(true)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(false)
+      end
+
+      it "sends a #bootstrap message to the ssh host connector" do
+        subject.send(:winrm).should_receive(:bootstrap).with(host, options)
+
+        subject.bootstrap(host, options)
+      end
+    end
+  end
+
+  describe "#chef_client" do
+    let(:host) { "reset.riotgames.com" }
+    let(:options) do
+      { ssh: { port: 22 }, winrm: { port: 5985 } }
+    end
+
+    context "when communicating to a unix node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(false)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(true)
+      end
+
+      it "sends a #chef_client message to the ssh host connector" do
+        subject.send(:ssh).should_receive(:chef_client).with(host, options)
+
+        subject.chef_client(host, options)
+      end
+    end
+
+    context "when communicating to a windows node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(true)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(false)
+      end
+
+      it "sends a #chef_client message to the ssh host connector" do
+        subject.send(:winrm).should_receive(:chef_client).with(host, options)
+
+        subject.chef_client(host, options)
+      end
+    end
+  end
+
+  describe "#put_secret" do
+    let(:host) { "reset.riotgames.com" }
+    let(:secret) { "something_secret" }
+    let(:options) do
+      { ssh: { port: 22 }, winrm: { port: 5985 } }
+    end
+
+    context "when communicating to a unix node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(false)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(true)
+      end
+
+      it "sends a #put_secret message to the ssh host connector" do
+        subject.send(:ssh).should_receive(:put_secret).with(host, secret, options)
+
+        subject.put_secret(host, secret, options)
+      end
+    end
+
+    context "when communicating to a windows node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(true)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(false)
+      end
+
+      it "sends a #put_secret message to the ssh host connector" do
+        subject.send(:winrm).should_receive(:put_secret).with(host, secret, options)
+
+        subject.put_secret(host, secret, options)
+      end
+    end
+  end
+
+  describe "#ruby_script" do
+    let(:host) { "reset.riotgames.com" }
+    let(:command_lines) { ["line one"] }
+    let(:options) do
+      { ssh: { port: 22 }, winrm: { port: 5985 } }
+    end
+
+    context "when communicating to a unix node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(false)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(true)
+      end
+
+      it "sends a #ruby_script message to the ssh host connector" do
+        subject.send(:ssh).should_receive(:ruby_script).with(host, command_lines, options)
+
+        subject.ruby_script(host, command_lines, options)
+      end
+    end
+
+    context "when communicating to a windows node" do
+      before do
+        described_class.stub(:connector_port_open?).with(host, options[:winrm][:port]).and_return(true)
+        described_class.stub(:connector_port_open?).with(host, options[:ssh][:port], anything).and_return(false)
+      end
+
+      it "sends a #ruby_script message to the ssh host connector" do
+        subject.send(:winrm).should_receive(:ruby_script).with(host, command_lines, options)
+
+        subject.ruby_script(host, command_lines, options)
+      end
+    end
+  end
+end