capsaicin 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joe Khoobyar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= capsaicin
+
+Joe Khoobyar's spicy capistrano extensions.
+
+== Copyright
+
+Copyright (c) 2009 Joe Khoobyar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "capsaicin"
+    s.homepage = "http://github.com/joekhoobyar/capsaicin"
+    s.summary = "Joe Khoobyar's spicy capistrano extensions"
+    s.description = %Q{Spicy capistrano extensions for various needs}
+
+    s.authors = ["Joe Khoobyar"]
+    s.email = "joe@ankhcraft.com"
+
+    s.add_dependency 'capistrano', ['>= 2.0']
+    s.add_dependency 'archive-tar-minitar', ['>= 0.5']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# ---------  RDoc Documentation ---------
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << "Capsaicin" <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README*'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+end
+
+task :default => :build
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 1

data/lib/capsaicin.rb

@@ -0,0 +1,10 @@
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "capsaicin requires capistrano 2.0 or later"
+end
+require 'capistrano'
+
+require File.join(File.dirname(__FILE__), %w(capsaicin sys))
+require File.join(File.dirname(__FILE__), %w(capsaicin invocation))
+require File.join(File.dirname(__FILE__), %w(capsaicin files))
+require File.join(File.dirname(__FILE__), %w(capsaicin service))
+require File.join(File.dirname(__FILE__), %w(capsaicin ui))

data/lib/capsaicin/bundle.rb

@@ -0,0 +1,7 @@
+module Capsaicin
+  module Bundle
+    
+  end
+
+  Capistrano.plugin :bundle
+end

data/lib/capsaicin/files.rb

@@ -0,0 +1,47 @@
+module Capsaicin
+  module Files
+
+    COMMANDS = [ %w(mkdir mkdir_p rmdir cp cp_r rm rm_f rm_r rm_rf
+                    chmod chmod_R chown chown_R touch),
+                %w(ln ln_s ln_sf mv install) ]
+
+    FILE_TESTS = [
+      %w(blockdev? -b),
+      %w(chardev? -c),
+      %w(directory? -d),
+      %w(exists? -e),
+      %w(file? -f),
+      %w(grpowned? -G),
+      %w(owned? -O),
+      %w(pipe? -p),
+      %w(readable? -r),
+      %w(setgid? -g),
+      %w(setuid? -u),
+      %w(size? -s),
+      %w(socket? -S),
+      %w(sticky? -k),
+      %w(symlink? -h),
+      %w(writable? -w),
+      %w(executable? -x)
+    ]
+
+    LOCAL_RUN_METHODS = [:system, :local_run]
+
+    require File.join(File.dirname(__FILE__), %w(files local.rb))
+    require File.join(File.dirname(__FILE__), %w(files remote.rb))
+
+    class_eval(Local.public_instance_methods(false).map do |m|
+      "def #{m}(*args, &block)\n  send(_via.to_s + '_files').#{m}(*args, &block)\nend"
+    end.join("\n"), __FILE__, __LINE__)
+
+    def _via
+      if LOCAL_RUN_METHODS.include? @config.fetch(:run_method, nil)
+        :local
+      else
+        :remote
+      end
+    end
+  end
+end
+
+Capistrano.plugin :files, Capsaicin::Files

data/lib/capsaicin/files/local.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+
+module Capsaicin
+  module Files
+    module Local
+
+      include FileUtils::Verbose
+
+      public *COMMANDS.flatten
+      public :pwd
+
+      FILE_TESTS.each do |m,t|
+        class_eval <<-EODEF, __FILE__, __LINE__
+          def #{m}(a, options={})
+            logger.trace "test #{t} \#{a.gsub ' ', '\\ '}" if logger 
+            File.#{m} a
+          end
+        EODEF
+      end
+
+      def tail_f(file, n=10)
+        unless defined? File::Tail::Logfile then gem 'file-tail'; require 'file/tail' end
+        File::Tail::Logfile.tail(file, :backward=>n) do |line| puts line end
+      rescue Interrupt
+        logger.trace "interrupted (Ctrl-C)" if logger
+      end
+
+      def upload(from, to)
+        cp from, to
+      end
+
+      def download(from, to)
+        cp from, to
+      end
+
+      def cd(dir, options={})
+        if block_given?
+          dir, dir2 = pwd, dir
+          cd dir2
+          yield
+        end  
+        cd dir
+      end
+
+    end
+  end
+end
+
+Capistrano.plugin :local_files, Capsaicin::Files::Local

data/lib/capsaicin/files/remote.rb

@@ -0,0 +1,117 @@
+require 'fileutils'
+
+module Capsaicin
+  module Files
+    module Remote
+
+      COMMANDS.each_with_index do |l,n|
+        l.each do |m|
+          k, f = m.split('_')
+          f = ' -' + f if f
+          class_eval <<-EODEF, __FILE__, __LINE__
+            def #{m}(*args)
+              options = args.pop if Hash === args.last
+              _r '#{k}#{f}', args#{', ' + (n+1).to_s if n > 0}
+            end
+          EODEF
+        end
+      end
+
+      FILE_TESTS.each do |m,t|
+        class_eval <<-EODEF
+          def #{m}(a, options={})
+            _t "test #{t}", a
+          end
+        EODEF
+      end
+
+      def tail_f(file, n=10)
+        cmd = "tail -n #{n} -f #{_q file}"
+        case v = _via
+        when :system, :local_run
+          send v, cmd
+        else
+          stream cmd, :via => v
+        end
+      rescue Interrupt
+        logger.trace "interrupted (Ctrl-C)" if logger
+      end
+
+      def upload(*args)
+        case _via
+        when :system, :local_run
+          cp(*args)
+        else
+          @config.upload(*args)
+        end
+      end
+
+      def download(*args)
+        case _via
+        when :system, :local_run
+          cp(*args)
+        else
+          @config.download(*args)
+        end
+      end
+
+      def cd(dir, options={})
+        if block_given?
+          dir, dir2 = pwd, dir
+          _r 'cd', dir2
+          yield
+        end  
+        _r 'cd', dir
+      end
+
+      def pwd
+        capture 'pwd', :via => _via
+      end
+
+    private
+
+      def _t(cmd, args=nil, min=nil)
+        cmd = _a cmd, args, min
+        if _via == :system then
+          local_run(cmd)
+        else
+          capture("#{cmd}; echo $?", :via => _via).strip == '0'
+        end
+      end
+
+      def _r(cmd, args=nil, min=nil)
+        cmd = _a cmd, args, min
+        if _via != :system then
+          invoke_command cmd, :via => _via
+        else
+          local_run cmd
+        end          
+      end
+
+      def _a(cmd, args=nil, min=nil)
+        case args
+        when NilClass
+          raise ArgumentError unless min.nil? or min.zero?
+        when Array
+          args = args.flatten
+          raise ArgumentError if (min || 1) > args.length
+          cmd = "#{cmd} #{_q(*args)}" if args.any?
+        else
+          raise ArgumentError if min and min < 1
+          cmd = "#{cmd} #{_q args}"
+        end
+      end
+
+      def _q(*list)
+        list.map { |l| "'#{l.gsub("'", "\\'")}'" }.join ' '
+      end
+
+      def _via
+        @config.fetch(:run_method, nil)
+      end
+
+    end
+  end
+end
+
+Capistrano.plugin :remote_files, Capsaicin::Files::Remote

data/lib/capsaicin/invocation.rb

@@ -0,0 +1,48 @@
+module Capsaicin
+
+  module Invocation
+
+    # Capistrano's system() override is only available from the base deployment strategy.
+    # Also, we could do with a few more windows checks.
+    def local_run(*args, &block)
+      args.pop if Hash===args.last
+      cmd = args.join(' ')
+      if RUBY_PLATFORM =~ /win32|mingw|mswin/
+        cmd.gsub!('/','\\') # Replace / with \\
+        cmd.gsub!(/^cd /,'cd /D ') # Replace cd with cd /D
+        cmd.gsub!(/&& cd /,'&& cd /D ') # Replace cd with cd /D
+        logger.trace "executing locally: #{cmd}"
+        Kernel.system cmd
+      else
+        logger.trace "executing locally: #{cmd}"
+        Kernel.system cmd
+      end
+    end
+    
+    # Always uses :runner to sudo as someone. 
+    # Equivalent to:  sudo "command", :as => fetch(:runner,nil)
+    def sudo_as(*args, &block)
+      options = Hash===args.last ? args.pop.dup :  {}
+      options[:as] = fetch(:runner, nil)
+      sudo *args.push(options), &block
+    end
+    
+    # Extremely helpful if you only have permission to: sudo su SOMEUSER -c "command"
+    def sudo_su(*args, &block)
+      options = Hash===args.last ? args.pop.dup :  {}
+      args[0] = "su #{fetch(:runner, nil)} -c '#{args[0]}'"
+      sudo *args.push(options), &block
+    end
+    
+    # Extremely helpful if you only have permission to: sudo su - SOMEUSER
+    def sudo_su_to(*args, &block)
+      options = Hash===args.last ? args.pop.dup :  {}
+      options[:shell] = false
+      cmd = args[0].gsub(/[$\\`"]/) { |m| "\\#{m}" }
+      args[0] = "echo \"#{cmd}\" | #{sudo} su - #{fetch(:runner, nil)}"
+      run *args.push(options), &block
+    end
+  end
+
+  Capistrano::Configuration.send :include, Invocation
+end

data/lib/capsaicin/service.rb

@@ -0,0 +1,21 @@
+module Capsaicin
+
+  module Service
+
+    SVC_ACTION_CAPTIONS = Hash.new do |h,k|
+      h[k] = "#{k.to_s.capitalize} Service"
+    end.update :status => 'Check Status', 
+                :check => 'Check Config', 
+                :summary => 'Status Summary'
+
+    %w(lsb crm windows command).each do |k|
+      require File.join(File.dirname(__FILE__), 'service', k+'.rb')
+    end
+
+    include LSB, CRM, Windows, Command
+
+  end
+
+end
+
+Capistrano.plugin :service, Capsaicin::Service

data/lib/capsaicin/service/command.rb

@@ -0,0 +1,44 @@
+module Capsaicin
+  module Service
+    module Command
+
+      # Check for the existance of a generic Windows NT service.
+      def command?(start, stop)
+        files.executable? start and files.executable? stop
+      end
+
+      # Defines a recipe to control a generic Windows NT service.
+      #
+      def command(id,start,stop,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        extras = args.pop if Array === args.last
+        via = options.delete(:via)
+
+        namespace id do
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:start]}" if svc_desc
+          task :start, options do
+            send(via || fetch(:run_method, :local_run), start)
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:stop]}" if svc_desc
+          task :stop, options do
+            send(via || fetch(:run_method, :local_run), stop)
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:restart]}" if svc_desc
+          task :restart, options do
+            stop
+            start
+          end
+        
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capsaicin/service/crm.rb

@@ -0,0 +1,84 @@
+module Capsaicin
+  module Service
+    module CRM
+
+      DEFAULT_ACTIONS = [	[ :status, '-W' ],
+                          [ :summary, "-x | awk '/^raw xml:/ { exit }; { print }'" ],
+                          [ :start, "--meta -d 'target_role'" ],
+                          [ :stop, "--meta -p 'target_role' -v 'stopped'" ] ]
+
+      OCF_DEFAULT_ACTIONS = [ [ :validate, '-c -C' ],
+                              [ :monitor, '-c -m' ] ]
+
+      # Defines a recipe to control a cluster-managed service, using heartbeat or pacemaker.
+      #
+      def crm(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "/usr/sbin/crm_resource -r #{id.to_s.split(':').last}"
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+          task :default, options do
+              sudo "#{svc_cmd} -W"
+          end
+
+          svc_actions.each do |svc_action,svc_args|
+            svc_action = svc_action.intern unless Symbol===svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              sudo "#{svc_cmd} #{svc_args}"
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+
+      # Defines a recipe providing additional controls for a cluster-managed service, 
+      # using the ocf_resource tool which interoperates with heartbeat or pacemaker.
+      #
+      # For more information about ocf_resource and other add-ons for heartbeat/pacemaker,
+      # see http://github.com/joekhoobyar/ha-tools
+      #
+      def crm_ocf(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "ocf_resource -g #{id.to_s.split(':').last}"
+
+          svc_actions.each do |svc_action,svc_args|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              sudo "#{svc_cmd} #{svc_args}"
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capsaicin/service/lsb.rb

@@ -0,0 +1,48 @@
+module Capsaicin
+  module Service
+    module LSB
+
+      DEFAULT_ACTIONS = %w(status start stop restart)
+
+      # Check for the existance of a generic LSB initscript.
+      def lsb?(id, basedir="/etc/init.d")
+        files.exists? "#{basedir}/#{id.to_s.split(':').last}"
+      end
+
+      # Defines a recipe to control a generic LSB service.
+      #
+      def lsb(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        basedir = options.delete(:basedir)
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "#{basedir || '/etc/init.d'}/#{id.to_s.split(':').last}"
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+          task :default, options do
+              send(basedir ? run_method : :sudo, "#{svc_cmd} status")
+          end
+
+          svc_actions.each do |svc_action|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              send(basedir ? run_method : :sudo, "#{svc_cmd} #{svc_action}")
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/capsaicin/service/windows.rb

@@ -0,0 +1,62 @@
+module Capsaicin
+  module Service
+    module Windows
+
+      DEFAULT_ACTIONS = [:start, :stop]
+
+      # Check for the existance of a generic Windows NT service.
+      def windows?(id, verbose=false)
+        logger.trace "executing locally: sc query \"#{id}\"" if logger and verbose
+        $1.to_i if `sc query "#{id}"` =~ /STATE +: +([0-9])+ +([^ ]+)/
+      ensure
+        logger.trace "   service status => #{$2} (#{$1})" if logger and verbose
+      end
+
+      # Defines a recipe to control a generic Windows NT service.
+      #
+      def windows(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+
+          [:default, :status].each do |k|
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+            task k, options do
+              service.windows? id, true or
+                abort "Failed to get service status for #{svc_name}"
+            end
+          end
+
+          DEFAULT_ACTIONS.each do |svc_action|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              local_run "net #{svc_action} \"#{id}\""
+            end
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:restart]}" if svc_desc
+          task :restart, options do
+            case service.windows?(id)
+            when 4, 2; stop
+            when NilClass; abort "Failed to get service status for #{svc_name}"
+            end
+            start
+          end
+        
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capsaicin/sys.rb

@@ -0,0 +1,11 @@
+module Capsaicin
+  module LocalSys
+
+    def windows?
+      @windows ||= !! (RUBY_PLATFORM =~ /cygwin|mingw|win32|mswin|windows/)
+    end
+
+  end
+
+  Capistrano.plugin :local_sys, LocalSys
+end

data/lib/capsaicin/ui.rb

@@ -0,0 +1,20 @@
+module Capsaicin
+  module UI
+    module AskPass
+      def password_prompt(prompt='Password: ')
+        if cap_askpass = ENV['CAP_ASKPASS']
+          `#{cap_askpass} "#{prompt}"`.strip
+        else
+          password_prompt_console
+        end
+      end
+    end
+    
+    (class << Capistrano::CLI; self; end).class_eval do
+      alias :password_prompt_console :password_prompt
+      include AskPass
+      alias :password_prompt_askpass :password_prompt
+    end
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: capsaicin
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Joe Khoobyar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+description: Spicy capistrano extensions for various needs
+email: joe@ankhcraft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/capsaicin.rb
+- lib/capsaicin/bundle.rb
+- lib/capsaicin/files.rb
+- lib/capsaicin/files/local.rb
+- lib/capsaicin/files/remote.rb
+- lib/capsaicin/invocation.rb
+- lib/capsaicin/service.rb
+- lib/capsaicin/service/command.rb
+- lib/capsaicin/service/crm.rb
+- lib/capsaicin/service/lsb.rb
+- lib/capsaicin/service/windows.rb
+- lib/capsaicin/sys.rb
+- lib/capsaicin/ui.rb
+has_rdoc: true
+homepage: http://github.com/joekhoobyar/capsaicin
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Joe Khoobyar's spicy capistrano extensions
+test_files: []
+