sprinkle 0.4.2 → 0.5.0.rc1

data/lib/sprinkle/configurable.rb

@@ -24,8 +24,9 @@ module Sprinkle
       @options[sym] || @package.send(sym, *args, &block) # try the parents options if unknown
     end
     
+    # both nil and false should return false
     def option?(sym)
-      !@options[sym].nil?
+      !!@options[sym]
     end
   end
 end

data/lib/sprinkle/deployment.rb

@@ -52,7 +52,9 @@ module Sprinkle
       # the actor. For more information on what configuration options are
       # available, view the corresponding Sprinkle::Actors page.
       def delivery(type, &block) #:doc:
-        @style = ("Sprinkle::Actors::" + type.to_s.titleize).constantize.new &block
+        type=type.to_s.titleize
+        type="SSH" if type=="Ssh"
+        @style = ("Sprinkle::Actors::" + type).constantize.new &block
       end
 
       def method_missing(sym, *args, &block) #:nodoc:
@@ -62,11 +64,29 @@ module Sprinkle
       def respond_to?(sym) #:nodoc:
         !!@defaults[sym]
       end
+      
+      def active_policies
+        if role=Sprinkle::OPTIONS[:only_role]
+          role=role.to_sym
+          POLICIES.select {|x| [x.roles].flatten.include?(role) }
+        else
+          POLICIES
+        end
+      end
 
       def process #:nodoc:
-        POLICIES.each do |policy|
+        active_policies.each do |policy|
           policy.process(self)
         end
+      rescue Sprinkle::Errors::RemoteCommandFailure => e
+        e.print_summary
+        exit
+      rescue Sprinkle::Errors::TransferFailure => e
+        e.print_summary
+        exit
+      ensure
+        # do any cleanup our actor may need to close network sockets, etc
+        @style.teardown if @style.respond_to?(:teardown)        
       end
     end
   end

data/lib/sprinkle/errors/pretty_failure.rb

@@ -0,0 +1,41 @@
+module Sprinkle
+  module Errors
+    
+    class PrettyFailure < StandardError #:nodoc:
+      
+      attr_accessor :details
+      
+      def initialize(installer, details={}, previous_error=nil)
+        @installer = installer
+        @details = details
+        @previous_error = previous_error
+      end
+            
+      def log(s, o)
+        puts s
+        puts "-" * (s.length+2)
+        puts o
+        puts
+      end
+      
+      def boxed(s)
+        puts red("-"*54)
+        puts red("| #{s.center(50)} |")
+        puts red("-"*54)
+        puts
+      end
+      
+      private
+      
+      def color(code, s)
+        "\033[%sm%s\033[0m"%[code,s]
+      end
+      
+      def red(s)
+        color(31, s)
+      end
+      
+    end
+    
+  end
+end

data/lib/sprinkle/errors/remote_command_failure.rb

@@ -0,0 +1,24 @@
+module Sprinkle
+  module Errors
+    
+    class RemoteCommandFailure < PrettyFailure #:nodoc:
+      
+      def print_summary
+        summary
+        log "Command", @details[:command]
+        # capistrano returns this
+        log "Hosts", @details[:hosts] if @details[:hosts]
+        # ssh actor returns error and stdout outputs
+        log "STDERR", @details[:error] unless @details[:error].blank?
+        log "STDOUT", @details[:stdout] unless @details[:stdout].blank?
+        log "Actor error message", @details[:message] if @details[:message]
+      end
+      
+      def summary
+        boxed("Package '#{@installer.package.name}' returned error code #{@details[:code]}.")
+      end      
+      
+    end
+    
+  end
+end

data/lib/sprinkle/errors/transfer_failure.rb

@@ -0,0 +1,28 @@
+module Sprinkle
+  module Errors
+    
+    class TransferFailure < PrettyFailure #:nodoc:
+            
+      def self.no_permission(installer,e)
+        tf=TransferFailure.new(installer, {}, e)
+        tf.details[:error]=e.message
+        tf
+      end
+      
+      def print_summary
+        summary
+        # log "Command", @details[:command]
+        log "ERROR", @details[:error]
+        if details[:error] =~ /Permission denied/
+          log "HINTS", "You may want to try passing the :sudo option to transfer."
+        end
+      end
+      
+      def summary
+        boxed("Package '#{@installer.package.name}' could not transfer #{@installer.source}")
+      end
+         
+    end
+    
+  end
+end

data/lib/sprinkle/installers/apt.rb

@@ -1,7 +1,5 @@
 module Sprinkle
   module Installers
-    # = Apt Package Installer
-    #
     # The Apt package installer uses the +apt-get+ command to install
     # packages. The apt installer has only one option which can be
     # modified which is the +dependencies_only+ option. When this is
@@ -13,38 +11,41 @@ module Sprinkle
     # First, a simple installation of the magic_beans package:
     #
     #   package :magic_beans do
-    #     description "Beans beans they're good for your heart..."
     #     apt 'magic_beans_package'
+    #     verify { has_apt 'magic_beans_package' }
     #   end
     #
     # Second, only build the magic_beans dependencies:
     #
     #   package :magic_beans_depends do
-    #     apt 'magic_beans_package' { dependencies_only true }
+    #     apt 'magic_beans_package' do
+    #       dependencies_only true 
+    #     end
     #   end
     #
     # As you can see, setting options is as simple as creating a
     # block and calling the option as a method with the value as 
     # its parameter.
-    class Apt < Installer
-      attr_accessor :packages #:nodoc:
-
+    class Apt < PackageInstaller
       def initialize(parent, *packages, &block) #:nodoc:
-        packages.flatten!
-        
-        options = { :dependencies_only => false }
-        options.update(packages.pop) if packages.last.is_a?(Hash)
-        
-        super parent, options, &block
-        
-        @packages = packages
+        super parent, *packages, &block
+        @options.reverse_merge!(:dependencies_only => false)
+      end
+
+      auto_api
+      
+      verify_api do
+        def has_apt(package)
+          @commands << "dpkg --status #{package} | grep \"ok installed\""
+        end
       end
 
       protected
 
         def install_commands #:nodoc:
           command = @options[:dependencies_only] ? 'build-dep' : 'install'
-          "env DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get --force-yes -qyu #{command} #{@packages.join(' ')}"
+          noninteractive = "env DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive"
+          "#{noninteractive} #{sudo_cmd}apt-get --force-yes -qyu #{command} #{@packages.join(' ')}"
         end
 
     end

data/lib/sprinkle/installers/binary.rb

@@ -1,16 +1,27 @@
 module Sprinkle
   module Installers
-    # = Binary Installer
+    # The Binary installer will download a binary archive and then extract
+    # it in the directory specified by the prefix option.
     # 
-    # binary "http://some.url.com/archive.tar.gz" do
-    #  prefix   "/home/user/local"
-    #  archives "/home/user/sources"
-    # end 
+    # == Example Usage
     #
+    #  binary "http://some.url.com/archive.tar.gz" do
+    #    prefix   "/home/user/local"
+    #    archives "/home/user/sources"
+    #  end 
+    # 
+    # This example will download archive.tar.gz to /home/user/sources and then
+    # extract it into /home/user/local.
     class Binary < Installer
+      
+      api do
+        def binary(source, options = {}, &block)
+          install Sprinkle::Installers::Binary.new(self, source, options, &block)
+        end
+      end
+      
       def initialize(parent, binary_archive, options = {}, &block) #:nodoc:
         @binary_archive = binary_archive
-        @options = options
         super parent, options, &block
       end
 
@@ -24,10 +35,14 @@ module Sprinkle
 
       def install_commands #:nodoc:
         commands = [ "bash -c 'wget -cq --directory-prefix=#{@options[:archives].first} #{@binary_archive}'" ]
-        commands << "bash -c 'cd #{@options[:prefix].first} && #{extract_command} #{@options[:archives].first}/#{@binary_archive.split("/").last}'"
+        commands << "bash -c \"cd #{@options[:prefix].first} && #{extract_command} '#{@options[:archives].first}/#{archive_name}'\""
+      end
+
+      def archive_name #:nodoc:
+        @archive_name ||= @binary_archive.split("/").last.gsub('%20', ' ')
       end
 
-      def extract_command(archive_name = @binary_archive.split("/").last)
+      def extract_command #:nodoc:
         case archive_name
         when /(tar.gz)|(tgz)$/
           'tar xzf'

data/lib/sprinkle/installers/brew.rb

@@ -9,24 +9,31 @@ module Sprinkle
     #
     #   package :magic_beans do
     #     description "Beans beans they're good for your heart..."
-    #     brew 'magic_beans_package'
+    #     brew 'ntp'
+    #
+    #     verify { has_brew 'ntp' }
+    #
     #   end
     #
-    class Brew < Installer
-      attr_accessor :formulas #:nodoc:
+    class Brew < PackageInstaller
 
-      def initialize(parent, *formulas, &block) #:nodoc:
-        formulas.flatten!
-        
-        super parent, &block
-        
-        @formulas = formulas
+      api do
+        def brew(*names, &block)
+          @recommends << :homebrew
+          install_package(*names, &block)
+        end
+      end
+      
+      verify_api do
+        def has_brew(package)
+          @commands << "brew list | grep  #{package}"
+        end
       end
 
       protected
 
         def install_commands #:nodoc:
-          "brew install #{@formulas.join(' ')}"
+          "brew install #{@packages.join(' ')}"
         end
 
     end

data/lib/sprinkle/installers/bsd_port.rb

@@ -1,10 +1,8 @@
 module Sprinkle
   module Installers
-    # = OpenBSD and FreeBSD Port Installer
-    #
-    # The Port installer installs OpenBSD and FreeBSD ports.
+    # The BSD Port installer installs OpenBSD and FreeBSD ports.
     # Before usage, the ports sytem must be installed and
-    # read on the target operating system.
+    # ready on the target operating system.
     # 
     # == Example Usage
     #
@@ -16,9 +14,15 @@ module Sprinkle
     #
     class BsdPort < Installer
       attr_accessor :port #:nodoc:
+      
+      api do
+        def bsd_port(port, options ={}, &block)
+          install Sprinkle::Installers::BsdPort.new(self, port, options, &block)
+        end
+      end
 
-      def initialize(parent, port, &block) #:nodoc:
-        super parent, &block
+      def initialize(parent, port, options={}, &block) #:nodoc:
+        super parent, options, &block
         @port = port
       end
 

data/lib/sprinkle/installers/deb.rb

@@ -1,7 +1,5 @@
 module Sprinkle
   module Installers
-    # = Deb Package Installer
-    #
     # The Deb installer installs deb packages sourced from a remote URL
     # 
     # == Example Usage
@@ -12,14 +10,9 @@ module Sprinkle
     #     deb 'http://debs.example.com/magic_beans.deb'
     #   end
     #
-    class Deb < Installer
-      attr_accessor :packages #:nodoc:
-
-      def initialize(parent, packages, &block) #:nodoc:
-        super parent, &block
-        packages = [packages] unless packages.is_a? Array
-        @packages = packages
-      end
+    class Deb < PackageInstaller
+      
+      auto_api
 
       protected
 

data/lib/sprinkle/installers/freebsd_pkg.rb

@@ -1,8 +1,6 @@
 module Sprinkle
   module Installers
-    # = FreeBSD Package Installer
-    #
-    # The Pkg package installer installs FreeBSD packages.
+    # The FreeBSDPkg installer installs FreeBSD packages.
     # 
     # == Example Usage
     #
@@ -17,14 +15,10 @@ module Sprinkle
     #   package :magic_beans do
     #     freebsd_pkg %w(magic_beans magic_sauce)
     #   end
-    class FreebsdPkg < Installer
-      attr_accessor :packages #:nodoc:
-
-      def initialize(parent, packages, &block) #:nodoc:
-        super parent, &block
-        packages = [packages] unless packages.is_a? Array
-        @packages = packages
-      end
+    #
+    class FreebsdPkg < PackageInstaller
+      
+      auto_api
 
       protected
 

data/lib/sprinkle/installers/freebsd_portinstall.rb

@@ -19,9 +19,15 @@ module Sprinkle
     #
     class FreebsdPortinstall < Installer
       attr_accessor :port #:nodoc:
+      
+      api do
+        def freebsd_portinstall(port, options={}, &block)
+          install Sprinkle::Installers::FreebsdPortinstall.new(self, port, options, &block)
+        end
+      end
 
-      def initialize(parent, port, &block) #:nodoc:
-        super parent, &block
+      def initialize(parent, port, options={}, &block) #:nodoc:
+        super parent, options, &block
         @port = port
       end
 

data/lib/sprinkle/installers/gem.rb

@@ -1,8 +1,6 @@
 module Sprinkle
   module Installers
-    # = Ruby Gem Package Installer
-    #
-    # The gem package installer installs ruby gems.
+    # The gem package installer installs Ruby gems.
     #
     # The installer has a single optional configuration: source.
     # By changing source you can specify a given ruby gems
@@ -29,6 +27,14 @@ module Sprinkle
     # block and calling the option as a method with the value as 
     # its parameter.
     class Gem < Installer
+      
+      api do
+        def gem(name, options = {}, &block)
+          @recommends << :rubygems
+          install Sprinkle::Installers::Gem.new(self, name, options, &block)
+        end
+      end
+      
       attr_accessor :gem #:nodoc:
 
       def initialize(parent, gem, options = {}, &block) #:nodoc:

data/lib/sprinkle/installers/group.rb

@@ -1,13 +1,37 @@
 module Sprinkle
   module Installers
     class Group < Installer
-      def initialize(package, groupname, options, &block)
-        super package, &block
+      # The user installer helps add groups.  You may pass flags as an option.
+      # 
+      # == Example Usage
+      #
+      #   package :users do
+      #     add_group 'webguys', :flags => "--shell /usr/bin/zsh"
+      #
+      #     verify do
+      #       has_group 'webguys'
+      #     end
+      #   end
+      
+      api do
+        def add_group(group, options={},  &block)
+          install Sprinkle::Installers::Group.new(self, group, options, &block)
+        end
+      end
+      
+      verify_api do
+        def has_group(group)
+          @commands << "id -g #{group}"
+        end
+      end
+      
+      def initialize(package, groupname, options, &block) #:nodoc:
+        super package, options, &block
         @groupname = groupname
-        @options = options
       end
+      
       protected 
-      def install_commands
+      def install_commands #:nodoc:
         "addgroup #{@options[:flags]} #{@groupname}"
       end
     end