ridley-connectors 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1d5f17ffd3feb5cafb982a127e2395f533e8413
+  data.tar.gz: 489a86773e6532a1e39896062c4057625cd64d0e
+SHA512:
+  metadata.gz: 0e0d43263f510aafd2f797e00d6401af61bd6f98dce4461804de9d6c538808b709c45eef96ed2ea963ad61af8255da5cd0a19936b84fd6293a747a5f0792568d
+  data.tar.gz: b4e15afa128530307f6b21c8dc857a6c26c1807d5ed53aecd3461efd68a126fee293eb6395bcb2be96522a71cd4374d766473f712a158d5624906af228ec8d31

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw[op]
+.DS_Store
+.rspec
+.bin/
+vendor/

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,10 @@
+script: "bundle exec thor spec:all"
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+bundler_args: --without development

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v.1.0.1
+
+* [#3](https://github.com/RiotGames/ridley-connectors/pull/3) Fix the broken Ridley::Client
+
+## v.1.0.0
+
+* [Ridley #227](https://github.com/RiotGames/ridley/pull/227) Move code out of Ridley and into its own gem
+  * See the [Ridley 2.0.0 Changelog](https://github.com/RiotGames/ridley/blob/v2.0.0/CHANGELOG.md) for more details.

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'yard'
+  gem 'spork'
+  gem 'guard', '>= 1.5.0'
+  gem 'guard-yard'
+  gem 'guard-rspec'
+  gem 'guard-spork', platforms: :ruby
+end
+
+group :test do
+  gem 'rspec', '~> 2.14.0'
+  gem 'webmock'
+  gem 'thor'
+end

data/Guardfile

@@ -0,0 +1,22 @@
+notification :off
+
+guard 'spork' do
+  watch('Gemfile')
+  watch('spec/spec_helper.rb')     { :rspec }
+  watch(%r{^spec/support/.+\.rb$}) { :rspec }
+end
+
+guard 'yard', stdout: '/dev/null', stderr: '/dev/null' do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.c})
+end
+
+guard 'rspec', cli: "--color --drb --format Fuubar", all_on_start: false, all_after_pass: false do
+  watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^spec/acceptance/.+_spec\.rb$})
+
+  watch(%r{^lib/(.+)\.rb$})          { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')       { "spec" }
+  watch(%r{^spec/support/.+\.rb$})   { "spec" }
+end

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright 2012-2013 Riot Games
+
+    Jamie Winsor (<jamie@vialstudios.com>)
+    Kyle Allan (<kallan@riotgames.com>)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,107 @@
+# Ridley Connectors
+[![Gem Version](https://badge.fury.io/rb/ridley-connectors.png)](http://badge.fury.io/rb/ridley-connectors)
+[![Build Status](https://secure.travis-ci.org/RiotGames/ridley-connectors.png?branch=master)](http://travis-ci.org/RiotGames/ridley-connectors)
+[![Dependency Status](https://gemnasium.com/RiotGames/ridley-connectors.png?travis)](https://gemnasium.com/RiotGames/ridley-connectors)
+[![Code Climate](https://codeclimate.com/github/RiotGames/ridley-connectors.png)](https://codeclimate.com/github/RiotGames/ridley-connectors)
+
+An extension on [Ridley](https://github.com/RiotGames/ridley) adding support for connecting and communicating with nodes in Chef.
+
+Installation
+------------
+Add ridley-connectors to your `Gemfile`:
+
+```ruby
+gem 'ridley-connectors'
+```
+
+And run the `bundle` command to install. Alternatively, you can install the gem directly:
+
+    $ gem install ridley-connectors
+
+Usage
+-----
+You can use ridley-connectors just like using Ridley.
+
+```ruby
+require 'ridley'
+```
+
+### Creating a new Ridley client
+
+```ruby
+ridley = Ridley.new(
+  server_url: "https://api.opscode.com/organizations/ridley",
+  client_name: "me",
+  client_key: "/Users/me/.chef/me.pem"
+)
+```
+
+ridley-connectors exposes all the usual features of Ridley, but adds some sugar for interacting with nodes.
+
+```ruby
+ridley.node.bootstrap("hostname.to.bootstrap.com") # Bootstraps a hostname or IP
+ridley.node.put_secret("hostname") # Puts your configured encrypted data bag secret onto a hostname or IP
+ridley.node.chef_run("hostname") # Runs Chef on a hostname or IP
+
+```
+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.
+
+Authors and Contributors
+------------------------
+- Jamie Winsor (<jamie@vialstudios.com>)
+- Kyle Allan (<kallan@riotgames.com>)
+
+Thank you to all of our [Contributors](https://github.com/RiotGames/ridley-connectors/graphs/contributors), testers, and users.

data/Thorfile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'bundler'
+require 'bundler/setup'
+require 'ridley-connectors'
+
+class Default < Thor
+
+  require 'thor/rake_compat'
+
+  include Thor::RakeCompat
+  Bundler::GemHelper.install_tasks
+
+  desc "build", "Build ridley-connectors-#{Ridley::Connectors::VERSION}.gem into the pkg directory"
+  def build
+    Rake::Task["build"].execute
+  end
+
+  desc "install", "Build and install ridley-connectors-#{Ridley::Connectors::VERSION}.gem into system gems"
+  def install
+    Rake::Task["install"].execute
+  end
+
+  desc "release", "Create tag v#{Ridley::Connectors::VERSION} and build and push ridley-connectors-#{Ridley::Connectors::VERSION}.gem to Rubygems"
+  def release
+    Rake::Task["release"].execute
+  end
+
+  class Spec < Thor
+    namespace :spec
+    default_task :all
+
+    desc "all", "run all tests"
+    def all
+      exec "rspec --color --format=documentation spec"
+    end
+  end
+end

data/lib/ridley-connectors/chef_objects/node_object.rb

@@ -0,0 +1,17 @@
+module Ridley
+  class NodeObject
+    # 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
+  end
+end

data/lib/ridley-connectors/client.rb

@@ -0,0 +1,54 @@
+module Ridley
+  class Client
+    attr_accessor :ssh
+    attr_accessor :winrm
+
+    # @option options [String] :server_url
+    #   URL to the Chef API
+    # @option options [String] :client_name
+    #   name of the client used to authenticate with the Chef API
+    # @option options [String] :client_key
+    #   filepath to the client's private key used to authenticate with the Chef API
+    # @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
+    #   URI query unencoded key/value pairs
+    # @option options [Hash] :headers
+    #   unencoded HTTP header key/value pairs
+    # @option options [Hash] :request
+    #   request options
+    # @option options [Hash] :ssl
+    #   * :verify (Boolean) [true] set to false to disable SSL verification
+    # @option options [URI, String, Hash] :proxy
+    #   URI, String, or Hash of HTTP proxy options
+    # @option options [Integer] :pool_size (4)
+    #   size of the connection pool
+    #
+    # @raise [Errors::ClientKeyFileNotFoundOrInvalid] if the option for :client_key does not contain
+    #   a file path pointing to a readable client key, or is a string containing a valid key
+    alias_method :old_initialize, :initialize
+    def initialize(options = {})
+      old_initialize(options)
+      @options = options.reverse_merge(
+        ssh: Hash.new,
+        winrm: Hash.new,
+      ).deep_symbolize_keys
+
+      @ssh   = @options[:ssh]
+      @winrm = @options[:winrm]
+    end
+  end
+end

data/lib/ridley-connectors/host_commander.rb

@@ -0,0 +1,231 @@
+module Ridley
+  class ConnectorSupervisor < ::Celluloid::SupervisionGroup
+    # @param [Celluloid::Registry] registry
+    def initialize(registry)
+      super(registry)
+      supervise_as :ssh, HostConnector::SSH
+      supervise_as :winrm, HostConnector::WinRM
+    end
+  end
+
+  class HostCommander
+    include Celluloid
+    include Ridley::Logging
+
+    PORT_CHECK_TIMEOUT = 3
+
+    finalizer :finalize_callback
+
+    def initialize
+      @connector_registry   = Celluloid::Registry.new
+      @connector_supervisor = ConnectorSupervisor.new_link(@connector_registry)
+    end
+
+    # Execute a shell command on a node
+    #
+    # @param [String] host
+    #   the host to perform the action on
+    # @param [String] command
+    #
+    # @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
+    # @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 run(host, command, options = {})
+      execute(__method__, host, command, options)
+    end
+
+    # Bootstrap a node
+    #
+    # @param [String] host
+    #   the host to perform the action on
+    #
+    # @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
+    # @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 bootstrap(host, options = {})
+      execute(__method__, host, options)
+    end
+
+    # Perform a chef client run on a node
+    #
+    # @param [String] host
+    #   the host to perform the action on
+    #
+    # @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
+    # @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 chef_client(host, options = {})
+      execute(__method__, host, options)
+    end
+
+    # Write your encrypted data bag secret on a node
+    #
+    # @param [String] host
+    #   the host to perform the action on
+    # @param [String] secret
+    #   your organization's encrypted data bag secret
+    #
+    # @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
+    # @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 put_secret(host, secret, options = {})
+      execute(__method__, host, secret, options)
+    end
+
+    # Execute line(s) of Ruby code on a node using Chef's embedded Ruby
+    #
+    # @param [String] host
+    #   the host to perform the action on
+    # @param [Array<String>] command_lines
+    #   An Array of lines of the command to be executed
+    #
+    # @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
+    # @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 ruby_script(host, command_lines, options = {})
+      execute(__method__, host, command_lines, 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 = {})
+      execute(__method__, host, options)
+    end
+
+    # Finds and returns the best HostConnector for a given host
+    #
+    # @param [String] host
+    #   the host to attempt to connect to
+    # @option options [Hash] :ssh
+    #   * :port (Fixnum) the ssh port to connect on the node the bootstrap will be performed on (22)
+    #   * :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)
+    # @param block [Proc]
+    #   an optional block that is yielded the best HostConnector
+    #
+    # @return [HostConnector::SSH, HostConnector::WinRM]
+    def connector_for(host, options = {})
+      options = options.reverse_merge(ssh: Hash.new, winrm: Hash.new)
+      options[:ssh][:port]   ||= HostConnector::SSH::DEFAULT_PORT
+      options[:winrm][:port] ||= HostConnector::WinRM::DEFAULT_PORT
+
+      if connector_port_open?(host, options[:winrm][:port])
+        options.delete(:ssh)
+        winrm
+      elsif connector_port_open?(host, options[:ssh][:port], options[:ssh][:timeout])
+        options.delete(:winrm)
+        ssh
+      else
+        raise Errors::HostConnectionError, "No connector ports open on '#{host}'"
+      end
+    end
+
+    private
+
+      def execute(method, host, *args)
+        options = args.last.is_a?(Hash) ? args.pop : Hash.new
+
+        connector_for(host, options).send(method, host, *args, options)
+      rescue Errors::HostConnectionError => ex
+        abort(ex)
+      rescue Resolv::ResolvError => ex
+        abort Errors::DNSResolvError.new(ex)
+      end
+
+      # Checks to see if the given port is open for TCP connections
+      # on the given host.
+      #
+      # @param [String] host
+      #   the host to attempt to connect to
+      # @param [Fixnum] port
+      #   the port to attempt to connect on
+      # @param [Float] wait_time ({PORT_CHECK_TIMEOUT})
+      #   the number of seconds to wait
+      #
+      # @return [Boolean]
+      def connector_port_open?(host, port, wait_time = nil)
+        defer {
+          Timeout.timeout(wait_time || PORT_CHECK_TIMEOUT) { Celluloid::IO::TCPSocket.new(host, port).close; true }
+        }
+      rescue Errno::ETIMEDOUT, Timeout::Error, SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EADDRNOTAVAIL => ex
+        false
+      end
+
+      def finalize_callback
+        @connector_supervisor.async.terminate if @connector_supervisor && @connector_supervisor.alive?
+      end
+
+      def ssh
+        @connector_registry[:ssh]
+      end
+
+      def winrm
+        @connector_registry[:winrm]
+      end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Ridley
+  module HostConnector
+    class Response
+      attr_reader :host
+
+      attr_accessor :stdout
+      attr_accessor :stderr
+      attr_accessor :exit_code
+      attr_accessor :exit_signal
+
+      def initialize(host, options = {})
+        @host        = host
+        @stdout      = options[:stdout] || String.new
+        @stderr      = options[:stderr] || String.new
+        @exit_code   = options[:exit_code] || -1
+        @exit_signal = options[:exit_signal] || nil
+      end
+
+      # Return true if the response was not successful
+      #
+      # @return [Boolean]
+      def error?
+        self.exit_code != 0
+      end
+    end
+  end
+end