sprinkle 0.3.1 → 0.3.2

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 pkg
 .DS_Store
 .idea

data/README.markdown

@@ -3,6 +3,7 @@
 * <http://redartisan.com/2008/5/27/sprinkle-intro>
 * <http://github.com/crafterm/sprinkle>
 * <http://github.com/benschwarz/passenger-stack>
+* <http://github.com/trevorturk/sprinkle-packages>
 * <http://www.vimeo.com/2888665>
 * <http://redartisan.lighthouseapp.com/projects/25275-sprinkle/tickets>
 
@@ -23,7 +24,7 @@ An example package description follows:
       version '1.8.6'
       source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz"
       requires :ruby_dependencies
-      
+
       verify do
         has_file '/usr/bin/ruby'
       end
@@ -65,17 +66,17 @@ appserver, database and webserver can be virtual packages, where the user will b
 multiple choices for the virtual package exist.
 
 Sprinkle is architected to be extendable in many ways, one of those areas is in its deployment of commands to
-remote hosts. Currently Sprinkle supports the use of Capistrano, Vlad, or a direct net/ssh connection to 
+remote hosts. Currently Sprinkle supports the use of Capistrano, Vlad, or a direct net/ssh connection to
 issue commands on remote hosts via ssh, but could also be extended to use any other command transport mechanism
 desired. Sprinkle can also be configured to simply issue installation commands to provision the local system.
 
-An full example Sprinkle deployment script for deploying Rails (via gems), MySQL (via APT), Apache (via source) 
+An full example Sprinkle deployment script for deploying Rails (via gems), MySQL (via APT), Apache (via source)
 and Git (via source with dependencies from APT):
 
     # Sprinkle Rails deployment script
     #
     # This is an example Sprinkle script, configured to install Rails from gems, Apache, Ruby and Git from source,
-    # and mysql and Git dependencies from apt on an Ubuntu system. Installation is configured to run via 
+    # and mysql and Git dependencies from apt on an Ubuntu system. Installation is configured to run via
     # Capistrano (and an accompanying deploy.rb recipe script). Source based packages are downloaded and built into
     # /usr/local on the remote system.
     #
@@ -158,7 +159,7 @@ and Git (via source with dependencies from APT):
       version '1.0.5'
       requires :mongrel
     end
-    
+
     package :git, :provides => :scm do
       description 'Git Distributed Version Control'
       version '1.5.6.3'

data/Rakefile

@@ -23,6 +23,10 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+task "inst"=>[:clobber, :build] do
+  puts `gem install pkg/sprinkle-*.gem`
+end
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/bin/sprinkle

@@ -73,6 +73,10 @@ def powder_cloud(options)
   Sprinkle::OPTIONS[:cloud] = OPTIONS[:cloud] || false
 end
 
+def verbosity(options)
+  Sprinkle::OPTIONS[:verbose] = OPTIONS[:verbose] || false
+end
+
 def log_level(options)
   Object.logger.level = ActiveSupport::BufferedLogger::Severity::DEBUG if options[:verbose]
 end
@@ -86,5 +90,6 @@ force_mode(OPTIONS)
 operation_mode(OPTIONS)
 powder_cloud(OPTIONS)
 log_level(OPTIONS)
+verbosity(OPTIONS)
 
 Sprinkle::Script.sprinkle File.read(powder), powder

data/lib/sprinkle.rb

@@ -2,7 +2,13 @@ require 'rubygems'
 require 'active_support'
 
 # Use active supports auto load mechanism
-ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__)
+require 'active_support/version'
+if ActiveSupport::VERSION::MAJOR > 2
+  require 'active_support/dependencies'
+  ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)
+else
+  ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__)
+end
 
 # Configure active support to log auto-loading of dependencies
 #ActiveSupport::Dependencies::RAILS_DEFAULT_LOGGER = Logger.new($stdout)

data/lib/sprinkle/actors/ssh.rb

@@ -29,7 +29,9 @@ module Sprinkle
 
       def process(name, commands, roles, suppress_and_return_failures = false)
         return process_with_gateway(name, commands, roles) if gateway_defined?
-        process_direct(name, commands, roles)
+        r = process_direct(name, commands, roles)
+        logger.debug green "process returning #{r}"
+        return r
       end
 
       def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false)
@@ -40,13 +42,17 @@ module Sprinkle
       protected
       
         def process_with_gateway(name, commands, roles)
+          res = []
           on_gateway do |gateway|
-            Array(roles).each { |role| execute_on_role(commands, role, gateway) }
+            Array(roles).each { |role| res << execute_on_role(commands, role, gateway) }
           end
+          !(res.include? false)
         end
         
         def process_direct(name, commands, roles)
-          Array(roles).each { |role| execute_on_role(commands, role) }
+          res = []
+          Array(roles).each { |role| res << execute_on_role(commands, role) }
+          !(res.include? false)
         end
         
         def transfer_with_gateway(name, source, destination, roles, recursive)
@@ -61,7 +67,9 @@ module Sprinkle
 
         def execute_on_role(commands, role, gateway = nil)
           hosts = @options[:roles][role]
-          Array(hosts).each { |host| execute_on_host(commands, host, gateway) }
+          res = []
+          Array(hosts).each { |host| res << execute_on_host(commands, host, gateway) }
+          !(res.include? false)
         end
 
         def transfer_to_role(source, destination, role, gateway = nil)
@@ -70,23 +78,54 @@ module Sprinkle
         end
         
         def execute_on_host(commands, host, gateway = nil)
+          res = nil
+          logger.debug(blue "executing #{commands.inspect} on #{host}.")
           if gateway # SSH connection via gateway
             gateway.ssh(host, @options[:user]) do |ssh|
-              execute_on_connection(commands, ssh)
+              res = execute_on_connection(commands, ssh)
+              ssh.loop
             end
           else # direct SSH connection
             Net::SSH.start(host, @options[:user], :password => @options[:password]) do |ssh|
-              execute_on_connection(commands, ssh)
+              res = execute_on_connection(commands, ssh)
+              ssh.loop
             end
           end
+          res.detect{|x| x!=0}.nil?
         end
-        
-        def execute_on_connection(commands, connection)
-          Array(commands).each do |command|
-            connection.exec! command do |ch, stream, data|
-              logger.send((stream == :stderr ? 'error' : 'debug'), data)
+
+        def execute_on_connection(commands, session)
+          res = []
+          Array(commands).each do |cmd|
+            session.open_channel do |channel|
+              channel.on_data do |ch, data|
+                logger.debug yellow("stdout said-->\n#{data}\n")
+              end
+              channel.on_extended_data do |ch, type, data|
+                next unless type == 1  # only handle stderr
+                logger.debug red("stderr said -->\n#{data}\n")
+              end
+
+              channel.on_request("exit-status") do |ch, data|
+                exit_code = data.read_long
+                if exit_code == 0
+                  logger.debug(green 'success')
+                else
+                  logger.debug(red('failed (%d).'%exit_code))
+                end
+                res << exit_code
+              end
+
+              channel.on_request("exit-signal") do |ch, data|
+                logger.debug red("#{cmd} was signaled!: #{data.read_long}")
+              end
+
+              channel.exec cmd  do  |ch, status|
+                logger.error("couldn't run remote command #{cmd}") unless status
+              end
             end
           end
+          res
         end
 
         def transfer_to_host(source, destination, host, recursive, gateway = nil)
@@ -100,18 +139,33 @@ module Sprinkle
             end
           end
         end
-        
+
         def transfer_on_connection(source, destination, recursive, connection)
-					scp = Net::SCP.new(connection)
-					scp.upload! source, destination, :recursive => recursive
+          scp = Net::SCP.new(connection)
+          scp.upload! source, destination, :recursive => recursive
+        end
+
+        private
+        def color(code, s)
+          "\033[%sm%s\033[0m"%[code,s]
+        end
+        def red(s)
+          color(31, s)
+        end
+        def yellow(s)
+          color(33, s)
+        end
+        def green(s)
+          color(32, s)
+        end
+        def blue(s)
+          color(34, s)
         end
 
-      private
-      
         def gateway_defined?
           !! @options[:gateway]
         end
-        
+
         def on_gateway(&block)
           gateway = Net::SSH::Gateway.new(@options[:gateway], @options[:user])
           block.call gateway

data/lib/sprinkle/actors/vlad.rb

@@ -13,7 +13,7 @@ module Sprinkle
     #     end
     #   end
     #
-    # script is given a list of files which capistrano will include and load.
+    # script is given a list of files which vlad will include and load.
     # These recipes are mainly to set variables such as :user, :password, and to 
     # set the app domain which will be sprinkled.
     class Vlad
@@ -36,18 +36,23 @@ module Sprinkle
       #   end
       def script(name)
         @loaded_recipes ||= []
-        self.load name
-        @loaded_recipes << script
+        require name
+        @loaded_recipes << name
       end
 
       def process(name, commands, roles, suppress_and_return_failures = false) #:nodoc:
-        commands = commands.join ' && ' if commands.is_a? Array
+        commands = Array(commands)
+        if use_sudo
+          commands = commands.map{|x| "sudo #{x}"}
+        end
+        commands = commands.join(' && ')
+        puts "executing #{commands}"
         t = remote_task(task_sym(name), :roles => roles) { run commands }
         
         begin
           t.invoke
           return true
-        rescue ::Vlad::CommandFailedError => e
+        rescue ::Rake::CommandFailedError => e
           return false if suppress_and_return_failures
           
           # Reraise error if we're not suppressing it
@@ -60,7 +65,7 @@ module Sprinkle
         begin
 					rsync source, destination
           return true
-        rescue ::Vlad::CommandFailedError => e
+        rescue ::Rake::CommandFailedError => e
           return false if suppress_and_return_failures
           
           # Reraise error if we're not suppressing it

data/lib/sprinkle/installers/binary.rb

@@ -36,7 +36,7 @@ module Sprinkle
         when /tar$/
           'tar xf'
         when /zip$/
-          'unzip'
+          'unzip -o'
         else
           raise "Unknown binary archive format: #{archive_name}"
         end

data/lib/sprinkle/installers/deb.rb

@@ -24,7 +24,10 @@ module Sprinkle
       protected
 
         def install_commands #:nodoc:
-          "wget -cq --directory-prefix=/tmp #{@packages.join(' ')}; dpkg -i #{@packages.collect{|p| "/tmp/#{package_name(p)}"}.join(" ")}"
+          [
+					"wget -cq --directory-prefix=/tmp #{@packages.join(' ')}", 
+					"dpkg -i #{@packages.collect{|p| "/tmp/#{package_name(p)}"}.join(" ")}"
+					]
         end
         
       private

data/lib/sprinkle/installers/freebsd_portinstall.rb

@@ -33,4 +33,4 @@ module Sprinkle
 
     end
   end
-end
+end

data/lib/sprinkle/installers/install_package.rb

@@ -0,0 +1,79 @@
+module Sprinkle
+  module Installers
+    class InstallPackage < Installer
+      cattr_accessor :installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        if packages.is_a?(Array) && packages.first.is_a?(Array)
+          packages = packages.first
+        else
+          packages = [packages] unless packages.is_a? Array
+        end
+
+        @packages = packages
+      end
+
+      protected
+
+      def install_commands #:nodoc:
+        case installer
+          when :smart
+            "smart install #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/smart-sprinkle"
+          when :yum
+            "yum install #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/yum-sprinkle"
+          else
+            raise "Unknown InstallPackage.installer"
+        end
+      end
+    end
+
+    class UninstallPackage < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        if packages.is_a?(Array) && packages.first.is_a?(Array)
+          packages = packages.first
+        else
+          packages = [packages] unless packages.is_a? Array
+        end
+
+        @packages = packages
+      end
+
+      protected
+
+      def install_commands #:nodoc:
+        case Sprinkle::Installers::InstallPackage.installer
+          when :smart
+            "smart remove #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/smart-sprinkle"
+          when :yum
+            "yum erase #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/yum-sprinkle"
+          else
+            raise "Unknown InstallPackage.installer"
+        end
+      end
+    end
+  end
+end
+
+module Sprinkle
+  module Package
+    class Package
+      def install_package(*names, &block)
+        @installers << Sprinkle::Installers::InstallPackage.new(self, names, &block)
+      end
+
+      def uninstall_package(*names, &block)
+        @installers << Sprinkle::Installers::UninstallPackage.new(self, names, &block)
+      end
+
+
+      alias_method :install_packages, :install_package
+      alias_method :uninstall_packages, :uninstall_package
+    end
+  end
+end
+

data/lib/sprinkle/installers/push_text.rb

@@ -37,7 +37,7 @@ module Sprinkle
       protected
 
         def install_commands #:nodoc:
-          "echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{'sudo ' if option?(:sudo)}tee -a #{@path}"
+          "#{"#{'sudo ' if option?(:sudo)}grep \"^#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}$\" #{@path} ||" if option?(:idempotent) }/bin/echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{'sudo ' if option?(:sudo)}tee -a #{@path}"
         end
 
     end

data/lib/sprinkle/installers/replace_text.rb

@@ -0,0 +1,45 @@
+module Sprinkle
+  module Installers
+    # = Replace text installer
+    #
+    # This installer replaces a text with another one in a file.
+    # 
+    # == Example Usage
+    #
+    # Change ssh port in /etc/ssh/sshd_config
+    #
+    #   package :magic_beans do
+    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config'
+    #   end
+    #
+    # If you user has access to 'sudo' and theres a file that requires
+    # priveledges, you can pass :sudo => true 
+    #
+    #   package :magic_beans do
+    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config', :sudo => true
+    #   end
+    #
+    # A special verify step exists for this very installer
+    # its known as file_contains, it will test that a file indeed
+    # contains a substring that you send it.
+    #
+    class ReplaceText < Installer
+      attr_accessor :regex, :text, :path #:nodoc:
+
+      def initialize(parent, regex, text, path, options={}, &block) #:nodoc:
+        super parent, options, &block
+        @regex = regex
+        @text = text
+        @path = path
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          logger.info "--> Replace '#{@regex}' with '#{@text}' in file #{@path}"
+          "#{'sudo ' if option?(:sudo)}sed -i 's/#{@regex.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/#{@text.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/g' #{@path}"
+        end
+
+    end
+  end
+end