ridley 1.7.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a78cdade0a4199cf9793a2f4eca28e61baf9e7
-  data.tar.gz: 9dd018fd3730ce690dad3be7eabb725621bb5ca3
+  metadata.gz: 1502e3edb782cbe22be2729744d1272bb81c9863
+  data.tar.gz: 26860b2a9731e88a3077d58ae1b46257c6055157
 SHA512:
-  metadata.gz: a23d46b865752707d88c46f48fcde018fe0f3643251d07b414f9029ba6c536d4c46e64ddd7a193b53058a034669ef2515cf67e4a27cd7bdbccbce8f7e3476e2a
-  data.tar.gz: 1c54de6e0a88d546024e42de38b0cfb0a633de0b1e03f3515fc75f8dd357c6cc40c451b105da999c01323561072f296dd04ad3f1a63cdb70d635ac3b28d5fb6e
+  metadata.gz: 13bae8f8d79d3baeea469c9cb082f143a6a6bbaf976cd61b8c936e51fc5603ae59dcc09fa17dbe696f894c3ca384fe3a064cdb57997ca4061f3ec6a043864b79
+  data.tar.gz: f536df4f30fd045955a06108adc8df2284fb4b6425d4fabc054bf262e2e8f8d06f5b9025cc8e1b25278bfe0daa199dc41fe2b3459d05503b5a8cb340d62d9f57

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.0.0
+
+* [#227](https://github.com/RiotGames/ridley/pull/227) HostCommander and HostConnector code has been moved into its own gem - [found here](https://github.com/RiotGames/ridley-connectors)
+  * As discussed by @jtimberman in [#225](https://github.com/RiotGames/ridley/issues/225) it makes sense to move this code based on Ridley's main purpose, and gives a decent performance boost to users who don't need this extra functionality.
+
 # 1.7.1
 
 * [#224](https://github.com/RiotGames/ridley/pull/224) Connection#stream will now return true/false on whether it copied the file that was streamed.

data/README.md

@@ -337,61 +337,6 @@ production_env.set_override_attribute("my_app.proxy.enabled", false)
 production_env.save #=> true
 ```
 
-Node Resource
--------------
-
-### Bootstrapping Unix nodes
-
-```ruby
-ridley = Ridley.new(
-  server_url: "https://api.opscode.com",
-  organization: "vialstudios",
-  validator_client: "vialstudios-validator",
-  validator_path: "/Users/reset/.chef/vialstudios-validator.pem",
-  ssh: {
-    user: "vagrant",
-    password: "vagrant"
-  }
-)
-
-ridley.node.bootstrap("33.33.33.10", "33.33.33.11")
-```
-
-### Bootstrapping Windows Nodes
-
-Windows Nodes are bootstrapped using a combination of WinRM, Batch, and PowerShell. You will probably need to tweak some settings on your Windows servers to ensure the commands are successful.
-
-#### WinRM Settings
-
-1. Enable WinRM: `winrm quickconfig` and say Yes.
-2. Set some WinRM settings to ensure that you don't get 401 Unauthorized responses and 500 Responses because of timeouts.
-
-```
-winrm set winrm/config/service/auth @{Basic="true"}
-winrm set winrm/config/service @{AllowUnencrypted="true"}
-winrm set winrm/config/service @{EnumerationTimeoutms="600000"}
-winrm set winrm/config @{MaxTimeoutms="600000"}
-winrm set winrm/config/client @{TrustedHosts="*"}
-```
-
-#### PowerShell Settings
-
-1. You should also configure your PowerShell profile, so that PowerShell commands have a more lenient timeout period.
-
-```
-mkdir C:\Users\my_user\Documents\WindowsPowerShell
-echo "$PSSessionOption = New-PSSessionOption -OpenTimeout 0 -CancelTimeout 0 -IdleTimeout 0 -OperationTimeout 0" > C:\Users\my_user\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1
-```
-
-Verify the PowerShell settings by opening up the PowerShell Console and entering `$PSSessionOption` and ensure those values are set, and that there are no errors output.
-
-The following links offer some information about configuring a machine's PowerShell settings:
-- [PowerShell Profiles](http://technet.microsoft.com/en-us/library/ee692764.aspx)
-- [The $PSSessionOptions Preference Variable](http://technet.microsoft.com/library/hh847796.aspx)
-- [Creating a new PSSessionOption](http://technet.microsoft.com/en-us/library/hh849703.aspx)
-
-You may also want to tweak your Windows boxes a bit more ex: turning UAC off, turning off the Windows Firewall.
-
 Role Resource
 -------------
 

data/lib/ridley.rb

@@ -71,8 +71,6 @@ module Ridley
   require_relative 'ridley/client'
   require_relative 'ridley/connection'
   require_relative 'ridley/chef'
-  require_relative 'ridley/host_commander'
-  require_relative 'ridley/host_connector'
   require_relative 'ridley/middleware'
   require_relative 'ridley/resource'
   require_relative 'ridley/resources'

data/lib/ridley/chef_objects/node_object.rb

@@ -124,20 +124,6 @@ module Ridley
       self.cloud_provider == "rackspace"
     end
 
-    # Executes a Chef run on the node
-    #
-    # @return [HostConnector::Response]
-    def chef_run
-      resource.chef_run(self.public_hostname)
-    end
-
-    # Puts the configured encrypted data bag secret on the node
-    #
-    # @return [HostConnector::Response]
-    def put_secret
-      resource.put_secret(self.public_hostname)
-    end
-
     # Merges the instaniated nodes data with the given data and updates
     # the remote with the merged results
     #

data/lib/ridley/client.rb

@@ -86,8 +86,6 @@ module Ridley
     attr_accessor :validator_client
     attr_accessor :validator_path
     attr_accessor :encrypted_data_bag_secret_path
-    attr_accessor :ssh
-    attr_accessor :winrm
     attr_accessor :chef_version
 
     # @option options [String] :server_url
@@ -99,16 +97,6 @@ module Ridley
     # @option options [String] :validator_client (nil)
     # @option options [String] :validator_path (nil)
     # @option options [String] :encrypted_data_bag_secret_path (nil)
-    # @option options [Hash] :ssh (Hash.new)
-    #   * :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
-    #   * :sudo (Boolean) [true] bootstrap with sudo
-    # @option options [Hash] :winrm (Hash.new)
-    #   * :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] :chef_version
     #   the version of Chef to use when bootstrapping
     # @option options [Hash] :params
@@ -128,14 +116,10 @@ module Ridley
     #   a file path pointing to a readable client key, or is a string containing a valid key
     def initialize(options = {})
       @options = options.reverse_merge(
-        ssh: Hash.new,
-        winrm: Hash.new,
         pool_size: 4
       ).deep_symbolize_keys
       self.class.validate_options(@options)
 
-      @ssh              = @options[:ssh]
-      @winrm            = @options[:winrm]
       @chef_version     = @options[:chef_version]
       @validator_client = @options[:validator_client]
 

data/lib/ridley/resources/node_resource.rb

@@ -5,165 +5,11 @@ module Ridley
     set_resource_path "nodes"
     represented_by Ridley::NodeObject
 
-    attr_reader :server_url
-    attr_reader :validator_path
-    attr_reader :validator_client
-    attr_reader :encrypted_data_bag_secret
-    attr_reader :ssh
-    attr_reader :winrm
-    attr_reader :chef_version
-
-    finalizer :finalize_callback
-
     # @param [Celluloid::Registry] connection_registry
-    #
-    # @option options [String] :server_url
-    #   URL to the Chef API
-    # @option options [Hash] ssh
-    #   * :user (String) a shell user that will login to each node and perform the bootstrap command on
-    #   * :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
-    #   * :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
-    # @option options [String] :validator_client
-    # @option options [String] :validator_path
-    #   filepath to the validator used to bootstrap the node
-    # @option options [String] :encrypted_data_bag_secret
-    #   your organizations encrypted data bag secret
-    # @option options [String] :chef_version
-    #   version of Chef to install on the node (default: nil)
     def initialize(connection_registry, options = {})
       super(connection_registry)
-      @server_url                = options[:server_url]
-      @validator_path            = options[:validator_path]
-      @validator_client          = options[:validator_client]
-      @encrypted_data_bag_secret = options[:encrypted_data_bag_secret]
-      @ssh                       = options[:ssh]
-      @winrm                     = options[:winrm]
-      @chef_version              = options[:chef_version]
-      @host_commander            = HostCommander.new_link
     end
 
-    # @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)
-    #
-    # @return [HostConnector::Response]
-    def bootstrap(host, options = {})
-      options = options.reverse_merge(
-        server_url: server_url,
-        validator_path: validator_path,
-        validator_client: validator_client,
-        encrypted_data_bag_secret: encrypted_data_bag_secret,
-        ssh: ssh,
-        winrm: winrm,
-        chef_version: chef_version
-      )
-
-      host_commander.bootstrap(host, options)
-    end
-
-    # Executes a Chef run using the best worker available for the given
-    # host.
-    #
-    # @param [String] host
-    #
-    # @return [HostConnector::Response]
-    def chef_run(host)
-      host_commander.chef_client(host, ssh: ssh, winrm: winrm)
-    rescue Errors::HostConnectionError => ex
-      abort(ex)
-    end
-
-    # Puts a secret on the host using the best worker available for
-    # the given host.
-    #
-    # @param [String] host
-    #
-    # @return [HostConnector::Response]
-    def put_secret(host)
-      host_commander.put_secret(host, encrypted_data_bag_secret, ssh: ssh, winrm: winrm)
-    end
-
-    # Executes an arbitrary ruby script using the best worker available
-    # for the given host.
-    #
-    # @param [String] host
-    # @param [Array<String>] command_lines
-    #
-    # @return [HostConnector::Response]
-    def ruby_script(host, command_lines)
-      host_commander.ruby_script(host, command_lines, ssh: ssh, winrm: winrm)
-    end
-
-    # Executes the given command on a node using the best worker
-    # available for the given host.
-    #
-    # @param [String] host
-    # @param [String] command
-    #
-    # @return [HostConnector::Response]
-    def run(host, command)
-      host_commander.run(host, command, ssh: ssh, winrm: winrm)
-    end
-    alias_method :execute_command, :run
-
-    # Executes the given command on a node using a platform specific
-    # command.
-    #
-    # @param [String] host
-    # @param [Hash] commands
-    #
-    # @example
-    #   platform_specific_run("host.example.com", linux: "hostname -f", windows: "echo %COMPUTERNAME%")
-    #
-    # @return [HostConnector::Response]
-    def platform_specific_run(host, commands)
-      case (type = host_commander.connector_for(host, ssh: ssh, winrm: winrm))
-      when HostConnector::SSH
-        raise Errors::CommandNotProvided.new(:ssh) unless commands[:ssh] and !commands[:ssh].empty?
-        run(host, commands[:ssh])
-      when HostConnector::WinRM
-        raise Errors::CommandNotProvided.new(:winrm) unless commands[:winrm] and !commands[:winrm].empty?
-        run(host, commands[:winrm])
-      else
-        raise RuntimeError, "#{type.class.to_s} is not a supported connector for #{self.class}##{__method__}"
-      end
-    end
-    alias_method :execute_platform_specific_command, :platform_specific_run
-
     # Merges the given data with the the data of the target node on the remote
     #
     # @param [Ridley::NodeResource, String] target
@@ -185,40 +31,5 @@ module Ridley
 
       update(node.merge_data(options))
     end
-
-    # Uninstall Chef from a node
-    #
-    # @param [String] host
-    #   the host to perform the action on
-    #
-    # @option options [Boolena] :skip_chef (false)
-    #   skip removal of the Chef package and the contents of the installation
-    #   directory. Setting this to true will only remove any data and configurations
-    #   generated by running Chef client.
-    # @option options [Hash] :ssh
-    #   * :user (String) a shell user that will login to each node and perform the bootstrap command on
-    #   * :password (String) the password for the shell user that will perform the bootstrap
-    #   * :keys (Array, String) an array of key(s) to authenticate the ssh user with instead of a password
-    #   * :timeout (Float) timeout value for SSH bootstrap (5.0)
-    #   * :sudo (Boolean) run as sudo (true)
-    # @option options [Hash] :winrm
-    #   * :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)
-    #
-    # @return [HostConnector::Response]
-    def uninstall_chef(host, options = {})
-      options = options.reverse_merge(ssh: ssh, winrm: winrm)
-      host_commander.uninstall_chef(host, 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 = "1.7.1"
+  VERSION = "2.0.0"
 end

data/ridley.gemspec

@@ -31,10 +31,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'json',                    '>= 1.7.7'
   s.add_dependency 'mixlib-authentication',   '>= 1.3.0'
   s.add_dependency 'net-http-persistent',     '>= 2.8'
-  s.add_dependency 'net-ssh'
   s.add_dependency 'retryable'
   s.add_dependency 'solve',                   '>= 0.4.4'
-  s.add_dependency 'winrm',                   '~> 1.1.0'
 
   s.add_development_dependency 'buff-ruby_engine', '~> 0.1'
 end

data/spec/unit/ridley/chef_objects/node_object_spec.rb

@@ -241,22 +241,6 @@ describe Ridley::NodeObject do
     end
   end
 
-  describe "#chef_run" do
-    it "sends the message #chef_run to the resource with the public_hostname of this instance" do
-      resource.should_receive(:chef_run).with(instance.public_hostname)
-
-      subject.chef_run
-    end
-  end
-
-  describe "#put_secret" do
-    it "sends the message #put_secret to the resource with the public_hostname of this instance" do
-      resource.should_receive(:put_secret).with(instance.public_hostname)
-
-      subject.put_secret
-    end
-  end
-
   describe "#merge_data" do
     before(:each) { subject.name = "reset.riotgames.com" }
 

data/spec/unit/ridley/client_spec.rb

@@ -6,8 +6,6 @@ describe Ridley::Client do
   let(:client_key) { fixtures_path.join("reset.pem").to_s }
   let(:organization) { "vialstudios" }
   let(:encrypted_data_bag_secret_path) { fixtures_path.join("reset.pem").to_s }
-  let(:ssh) { {user: "reset", password: "password1", port: "222"} }
-  let(:winrm) { {user: "reset", password: "password2", port: "5986"} }
   let(:chef_version) { "10.24.0-01" }
 
   let(:config) do
@@ -17,8 +15,6 @@ describe Ridley::Client do
       client_key: client_key,
       organization: organization,
       encrypted_data_bag_secret_path: encrypted_data_bag_secret_path,
-      ssh: ssh,
-      winrm: winrm,
       chef_version: chef_version
     }
   end
@@ -107,14 +103,6 @@ describe Ridley::Client do
         described_class.new(config).client_key.should == key
       end
 
-      it "assigns a 'ssh' attribute from the given 'ssh' option" do
-        described_class.new(config).ssh.should eql({user: "reset", password: "password1", port: "222"})
-      end
-
-      it "assigns a 'winrm' attribute from the given 'winrm' option" do
-        described_class.new(config).winrm.should eql({user: "reset", password: "password2", port: "5986"})
-      end
-
       it "assigns a 'chef_version' attribute from the given 'chef_version' option" do
         described_class.new(config).chef_version.should eql("10.24.0-01")
       end

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

@@ -1,143 +1,12 @@
 require 'spec_helper'
 
 describe Ridley::NodeResource do
-  let(:host) { "33.33.33.10" }
-  let(:worker) { double('worker', alive?: true, terminate: nil) }
-  let(:host_commander) { double('host-commander') }
-  let(:options) do
-    {
-      server_url: double('server_url'),
-      validator_path: double('validator_path'),
-      validator_client: double('validator_client'),
-      encrypted_data_bag_secret: double('encrypted_data_bag_secret'),
-      ssh: double('ssh'),
-      winrm: double('winrm'),
-      chef_version: double('chef_version')
-    }
-  end
   let(:instance) do
-    inst = described_class.new(double, options)
-    inst.stub(connection: chef_zero_connection, host_commander: host_commander)
+    inst = described_class.new(double)
+    inst.stub(connection: chef_zero_connection)
     inst
   end
 
-  describe "#bootstrap" do
-    it "sends the message #bootstrap to the instance's host_commander" do
-      host_commander.should_receive(:bootstrap).with(host, options)
-      instance.bootstrap(host)
-    end
-
-    it "passes pre-configured options to #bootstrap" do
-      host_commander.should_receive(:bootstrap).with(host, 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)
-    end
-  end
-
-  describe "#put_secret" 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)
-    end
-  end
-
-  describe "#ruby_script" 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)
-    end
-  end
-
-  describe "#run" do
-    let(:command) { "echo 'hello world'" }
-
-    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)
-    end
-  end
-
-  describe "#platform_specific_run" do
-    let(:ssh_command) { "hostname -f" }
-    let(:winrm_command) { "echo %COMPUTERNAME%" }
-    let(:ssh_connector) { Ridley::HostConnector::SSH.new }
-    let(:winrm_connector) { Ridley::HostConnector::WinRM.new }
-    let(:unsupported_connector) { Object.new }
-
-    describe "expecting the ssh connector" do
-      before do
-        host_commander.stub(:connector_for).and_return ssh_connector
-      end
-      it "sends the ssh command" do
-        instance.should_receive(:run).with(host, ssh_command)
-        instance.platform_specific_run(host, ssh: ssh_command, winrm: winrm_command)
-      end
-
-      it "raises an error if no command is provided for the ssh connector when the ssh connector is used" do
-        expect {
-          instance.platform_specific_run(host, winrm: winrm_command)
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-
-      it "raises an error if an empty command is provided for the ssh connector when the ssh connector is used" do
-        expect {
-          instance.platform_specific_run(host, ssh: "", winrm: winrm_command)
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-
-      it "raises an error if a nil command is provided for the ssh connector when the ssh connector is used" do
-        expect {
-          instance.platform_specific_run(host, ssh: nil, winrm: winrm_command)
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-    end
-
-    describe "expecting the winrm connector" do
-      before do
-        host_commander.stub(:connector_for).and_return winrm_connector
-      end
-      it "sends the ssh command if the connector is winrm" do
-        instance.should_receive(:run).with(host, winrm_command)
-        instance.platform_specific_run(host, ssh: ssh_command, winrm: winrm_command)
-      end
-
-      it "raises an error if no command is provided for the winrm connector when the winrm connector is used" do
-        expect {
-          instance.platform_specific_run(host, ssh: ssh_command)
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-
-      it "raises an error if an empty is provided for the winrm connector when the winrm connector is used" do
-        expect {
-          instance.platform_specific_run(host, ssh: ssh_command, winrm: "")
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-
-      it "raises a nil command is provided for the winrm connector when the winrm connector is used" do
-        expect {
-          instance.platform_specific_run(host, ssh: ssh_command, winrm: nil)
-        }.to raise_error(Ridley::Errors::CommandNotProvided)
-      end
-    end
-
-    it "raises a RuntimeError if an unsupported connector is used" do
-      host_commander.stub(:connector_for).and_return unsupported_connector
-      expect {
-        instance.platform_specific_run(host, ssh: ssh_command, winrm: winrm_command)
-      }.to raise_error(RuntimeError)
-    end
-  end
-
   describe "#merge_data" do
     let(:node_name) { "rspec-test" }
     let(:run_list) { [ "recipe[one]", "recipe[two]" ] }