ridley-connectors 2.0.0 → 2.0.1

data/lib/ridley-connectors/command_context.rb

@@ -0,0 +1,76 @@
+require 'erubis'
+
+module Ridley
+  module CommandContext
+    # A base class to provide common functionality between OS specific command contexts. A
+    # command context takes an options hash and binds it against a template file. You can then
+    # retrieve the command to be run on a node by calling {CommandContext::Base#command}.
+    #
+    # @example
+    #   my_context = MyCommandContext.new(message: "hello, world!")
+    #   my_context.command #=> "echo 'hello, world!'"
+    class Base
+      class << self
+        # Build a command context and immediately run it's command
+        #
+        # @param [Hash] options
+        #   an options hash to pass to the new CommandContext
+        def command(options = {})
+          new(options).command
+        end
+
+        # Set or get the path to the template file for the inheriting class
+        #
+        # @param [String] filename
+        #   the filename (without extension) of the template file to use to bind
+        #   the inheriting command context class to
+        #
+        # @return [Pathname]
+        def template_file(filename = nil)
+          return @template_file if filename.nil?
+          @template_file = Ridley.scripts.join("#{filename}.erb")
+        end
+      end
+
+      # @param [Hash] options
+      def initialize(options = {}); end
+
+      # @return [String]
+      def command
+        template.evaluate(self)
+      end
+
+      private
+
+        # @return [Erubis::Eruby]
+        def template
+          @template ||= Erubis::Eruby.new(IO.read(self.class.template_file).chomp)
+        end
+    end
+
+    # A command context for Unix based OSes
+    class Unix < Base
+      # @return [Boolean]
+      attr_reader :sudo
+
+      # @option options [Boolean] :sudo (true)
+      #   bootstrap with sudo (default: true)
+      def initialize(options = {})
+        options = options.reverse_merge(sudo: true)
+        @sudo   = options[:sudo]
+      end
+
+      # @return [String]
+      def command
+        sudo ? "sudo #{super}" : super
+      end
+    end
+
+    # A command context for Windows based OSes
+    class Windows < Base; end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/command_context/*.rb"].sort.each do |path|
+  require_relative "command_context/#{File.basename(path, '.rb')}"
+end

data/lib/ridley-connectors/command_context/unix_uninstall.rb

@@ -0,0 +1,42 @@
+module Ridley
+  module CommandContext
+    # Context class for generating an uninstall command for Unix based OSes
+    class UnixUninstall < CommandContext::Unix
+      template_file 'unix_uninstall_omnibus'
+
+      # @return [Boolean]
+      attr_reader :skip_chef
+
+      # @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.
+      def initialize(options = {})
+        super(options)
+        options    = options.reverse_merge(skip_chef: false)
+        @skip_chef = options[:skip_chef]
+      end
+
+      # The path to the Chef configuration directory on the target host
+      #
+      # @return [String]
+      def config_directory
+        "/etc/chef"
+      end
+
+      # The path to the Chef data directory on the target host
+      #
+      # @return [String]
+      def data_directory
+        "/var/chef"
+      end
+
+      # The path to the Omnibus Chef installation on the target host
+      #
+      # @return [String]
+      def install_directory
+        "/opt/chef"
+      end
+    end
+  end
+end

data/lib/ridley-connectors/command_context/windows_uninstall.rb

@@ -0,0 +1,35 @@
+module Ridley
+  module CommandContext
+    # Context class for generating an uninstall command for Unix based OSes
+    class WindowsUninstall < CommandContext::Windows
+      template_file 'windows_uninstall_omnibus'
+
+      # @return [Boolean]
+      attr_reader :skip_chef
+
+      # @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.
+      def initialize(options = {})
+        super(options)
+        options    = options.reverse_merge(skip_chef: false)
+        @skip_chef = options[:skip_chef]
+      end
+
+      # The path to the Chef configuration directory on the target host
+      #
+      # @return [String]
+      def config_directory
+        "C:\\chef"
+      end
+
+      # The path to the Omnibus Chef installation on the target host
+      #
+      # @return [String]
+      def install_directory
+        "C:\\opscode\\chef"
+      end
+    end
+  end
+end

data/lib/ridley-connectors/errors.rb

@@ -0,0 +1,29 @@
+module Ridley
+  module Errors
+    module ConnectorsError; end
+
+    class HostConnectionError < RidleyError
+      include ConnectorsError
+    end
+
+    class DNSResolvError < HostConnectionError
+      include ConnectorsError
+    end
+
+    class BootstrapError < RidleyError; end
+    class RemoteCommandError < RidleyError; end
+    class RemoteScriptError < RemoteCommandError; end
+    class CommandNotProvided < RemoteCommandError
+      attr_reader :connector_type
+
+      # @params [Symbol] connector_type
+      def initialize(connector_type)
+        @connector_type = connector_type
+      end
+
+      def to_s
+        "No command provided in #{connector_type.inspect}, however the #{connector_type.inspect} connector was selected."
+      end
+    end
+  end
+end

data/lib/ridley-connectors/host_commander.rb

@@ -28,7 +28,8 @@ module Ridley
 
     CONNECTOR_PORT_ERRORS = [
       Errno::ETIMEDOUT, Timeout::Error, SocketError, 
-      Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EADDRNOTAVAIL
+      Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::EADDRNOTAVAIL,
+      Resolv::ResolvError
     ]
 
     if Buff::RubyEngine.jruby?
@@ -190,7 +191,7 @@ module Ridley
     # @param block [Proc]
     #   an optional block that is yielded the best HostConnector
     #
-    # @return [HostConnector::SSH, HostConnector::WinRM]
+    # @return [HostConnector::SSH, HostConnector::WinRM, NilClass]
     def connector_for(host, options = {})
       options[:ssh]          ||= Hash.new
       options[:winrm]        ||= Hash.new
@@ -205,20 +206,33 @@ module Ridley
         options.delete(:winrm)
         ssh
       else
-        raise Errors::HostConnectionError, "No connector ports open on '#{host}'"
+        nil
       end
     end
 
     private
 
+      # A helper method for sending the provided method to a proper
+      # connector actor.
+      #
+      # @param [Symbol] method
+      #   the method to call on the connector actor
+      # @param [String] host
+      #   the host to connect to
+      # @param [Array] args
+      #   the splatted args passed to the method
+      #
+      # @return [HostConnector::Response]
       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)
+        connector = connector_for(host, options)
+        if connector.nil?
+          log.warn { "No connector ports open on '#{host}'" }
+          HostConnector::Response.new(host, stderr: "No connector ports open on '#{host}'")
+        else
+          connector.send(method, host, *args, options)
+        end
       end
 
       # Checks to see if the given port is open for TCP connections
@@ -242,7 +256,10 @@ module Ridley
           }
         rescue *CONNECTOR_PORT_ERRORS => ex
           @retry_count -= 1
-          retry if @retry_count > 0
+          if @retry_count > 0
+            log.info { "Retrying connector_port_open? on '#{host}' #{port} due to: #{ex.class}" }
+            retry
+          end
           false
         end
       end

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

@@ -63,6 +63,9 @@ module Ridley
           rescue Net::SSH::Exception => ex
             response.exit_code = -1
             response.stderr    = ex.inspect
+          rescue => ex
+            response.exit_code = -1
+            response.stderr    = "An unknown error occurred: #{ex.class} - #{ex.message}"
           end
 
           case response.exit_code

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

@@ -50,8 +50,13 @@ module Ridley
 
         HostConnector::Response.new(host).tap do |response|
           begin
-            command_uploaders << command_uploader = CommandUploader.new(connection)
-            command = get_command(command, command_uploader, force_batch_file: options[:force_batch_file])
+            if options[:force_batch_file] || command.length > CommandUploader::CHUNK_LIMIT
+              log.debug "Detected a command that was longer than #{CommandUploader::CHUNK_LIMIT} characters. " +
+                "Uploading command as a file to the host."
+              command_uploaders << command_uploader = CommandUploader.new(connection)
+              command_uploader.upload(command)
+              command = command_uploader.command
+            end
 
             log.info "Running WinRM command: '#{command}' on: '#{host}' as: '#{user}'"
 
@@ -72,6 +77,15 @@ module Ridley
           rescue ::WinRM::WinRMHTTPTransportError => ex
             response.exit_code = :transport_error
             response.stderr    = ex.message
+          rescue SocketError, Errno::EHOSTUNREACH
+            response.exit_code = -1
+            response.stderr    = "Host unreachable"
+          rescue Errno::ECONNREFUSED
+            response.exit_code = -1
+            response.stderr    = "Connection refused"
+          rescue => ex
+            response.exit_code = -1
+            response.stderr    = "An unknown error occurred: #{ex.class} - #{ex.message}"
           end
 
           case response.exit_code
@@ -79,6 +93,8 @@ module Ridley
             log.info "Successfully ran WinRM command on: '#{host}' as: '#{user}'"
           when :transport_error
             log.info "A transport error occured while attempting to run a WinRM command on: '#{host}' as: '#{user}'"
+          when -1
+            log.info "Failed to run WinRM command on: '#{host}' as: '#{user}'"
           else
             log.info "Successfully ran WinRM command on: '#{host}' as: '#{user}', but it failed"
           end
@@ -86,29 +102,9 @@ module Ridley
       ensure
         begin
           command_uploaders.map(&:cleanup)
-        rescue ::WinRM::WinRMHTTPTransportError => ex
-          log.info "Error cleaning up leftover Powershell scripts on some hosts"
-        end
-      end
-
-      # Returns the command if it does not break the WinRM command length
-      # 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, 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. " +
-            "Uploading command as a file to the host."
-          command_uploader.upload(command)
-          command_uploader.command
+        rescue ::WinRM::WinRMHTTPTransportError, SocketError, Errno::EHOSTUNREACH, Errno::ECONNREFUSED => ex
+          log.info "Error cleaning up leftover Powershell scripts on some hosts due to: " +
+            "#{ex.class} - #{ex.message}"
         end
       end
 

data/lib/ridley-connectors/version.rb

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

data/ridley-connectors.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'celluloid',    '~> 0.16.0.pre'
   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 'winrm',        '~> 1.1.0'

data/scripts/unix_uninstall_omnibus.erb

@@ -0,0 +1,31 @@
+bash -c '
+if [ -f "/etc/lsb-release" ]; then
+  platform=$(grep DISTRIB_ID /etc/lsb-release | cut -d "=" -f 2 | tr "[A-Z]" "[a-z]")
+elif [ -f "/etc/debian_version" ]; then
+  platform="debian"
+elif [ -f "/etc/redhat-release" ]; then
+  platform="el"
+elif [ -f "/etc/system-release" ]; then
+  platform=$(sed "s/^\(.\+\) release.\+/\1/" /etc/system-release | tr "[A-Z]" "[a-z]")
+  if [ "$platform" = "amazon linux ami" ]; then
+    platform="el"
+  fi
+elif [ -f "/etc/SuSE-release" ]; then
+  platform="el"
+fi
+
+<% unless skip_chef -%>
+echo "Un-Installing installed Chef package"
+case "$platform" in
+  "el") yum remove chef -y ;;
+  "debian") apt-get purge chef -y ;;
+esac
+<% end -%>
+
+rm -Rdf <%= config_directory %>
+rm -Rdf <%= data_directory %>
+
+<% unless skip_chef -%>
+rm -Rdf <%= install_directory %>
+<% end -%>
+'

data/scripts/windows_uninstall_omnibus.erb

@@ -0,0 +1,10 @@
+$productName      = "Chef"
+$installDirectory = "<%= install_directory %>"
+$configDirectory  = "<%= config_directory %>"
+
+<% unless skip_chef -%>
+$app = Get-WmiObject -Class Win32_Product | Where-Object {  $_.Name -match $productName  }
+If ($app) { $app.Uninstall() }
+If (Test-Path $installDirectory) { Remove-Item -Recurse -Force $installDirectory }
+<% end -%>
+If (Test-Path $configDirectory) { Remove-Item -Recurse -Force $configDirectory }

data/spec/spec_helper.rb

@@ -15,6 +15,9 @@ def setup_rspec
       WebMock.disable_net_connect!(allow_localhost: true, net_http_connect_on_start: true)
     end
 
+    config.filter_run focus: true
+    config.run_all_when_everything_filtered = true
+
     config.before(:all) { Ridley.logger = Celluloid.logger = nil }
 
     config.before(:each) do

data/spec/unit/ridley-connectors/bootstrap_context/unix_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Ridley::BootstrapContext::Unix do
+  let(:options) do
+    {
+      server_url: "https://api.opscode.com/organizations/vialstudios",
+      validator_client: "chef-validator",
+      validator_path: fixtures_path.join("my-fake.pem").to_s,
+      encrypted_data_bag_secret: File.read(fixtures_path.join("my-fake.pem"))
+    }
+  end
+
+  describe "ClassMethods" do
+    subject { described_class }
+
+    describe "::new" do
+      context "when no sudo option is passed through" do
+        it "sets a default value of 'true' to 'sudo'" do
+          options.delete(:sudo)
+          obj = subject.new(options)
+
+          obj.send(:sudo).should be_true
+        end
+      end
+
+      context "when the sudo option is passed through as false" do
+        it "sets the value of sudo to 'false' if provided" do
+          options.merge!(sudo: false)
+          obj = subject.new(options)
+
+          obj.send(:sudo).should be_false
+        end
+      end
+    end
+  end
+
+  subject { described_class.new(options) }
+
+  describe "MixinMethods" do
+
+    describe "#templates_path" do
+      it "returns a pathname" do
+        subject.templates_path.should be_a(Pathname)
+      end
+    end
+
+    describe "#first_boot" do
+      it "returns a string" do
+        subject.first_boot.should be_a(String)
+      end
+    end
+
+    describe "#encrypted_data_bag_secret" do
+      it "returns a string" do
+        subject.encrypted_data_bag_secret.should be_a(String)
+      end
+    end
+
+    describe "#validation_key" do
+      it "returns a string" do
+        subject.validation_key.should be_a(String)
+      end
+    end
+
+    describe "template" do
+      it "returns a string" do
+        subject.template.should be_a(Erubis::Eruby)
+      end
+    end
+  end
+
+  describe "#boot_command" do
+    it "returns a string" do
+      subject.boot_command.should be_a(String)
+    end
+  end
+
+  describe "#chef_run" do
+    it "returns a string" do
+      subject.chef_run.should be_a(String)
+    end
+  end
+
+  describe "#chef_config" do
+    it "returns a string" do
+      subject.chef_config.should be_a(String)
+    end
+  end
+
+  describe "#default_template" do
+    it "returns a string" do
+      subject.default_template.should be_a(String)
+    end
+  end
+
+  describe "#bootstrap_directory" do
+    it "returns a string" do
+      subject.bootstrap_directory.should be_a(String)
+    end
+  end
+end