capsaicin 0.1.9 → 0.1.10

data/Rakefile

@@ -15,7 +15,7 @@ begin
     s.email = "joe@ankhcraft.com"
     s.rubyforge_project = "capsaicin"
 
-    s.add_dependency 'capistrano', ['>= 2.0']
+    s.add_dependency 'capistrano', ['>= 2.5']
     s.add_dependency 'archive-tar-minitar', ['>= 0.5']
   end
 rescue LoadError
@@ -26,7 +26,6 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'
   test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
 end
 
 begin
@@ -34,7 +33,6 @@ begin
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
     test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
   end
 rescue LoadError
   task :rcov do

data/VERSION.yml

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

data/capsaicin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capsaicin}
-  s.version = "0.1.9"
+  s.version = "0.1.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joe Khoobyar"]
-  s.date = %q{2010-06-15}
+  s.date = %q{2010-06-16}
   s.description = %q{Spicy capistrano extensions for various needs}
   s.email = %q{joe@ankhcraft.com}
   s.extra_rdoc_files = [
@@ -39,6 +39,7 @@ Gem::Specification.new do |s|
      "lib/capsaicin/sys.rb",
      "lib/capsaicin/ui.rb",
      "test/capsaicin/files/local_test.rb",
+     "test/capsaicin/invocation_test.rb",
      "test/helper.rb"
   ]
   s.homepage = %q{http://github.com/joekhoobyar/capsaicin}
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Joe Khoobyar's spicy capistrano extensions}
   s.test_files = [
     "test/capsaicin/files/local_test.rb",
+     "test/capsaicin/invocation_test.rb",
      "test/helper.rb"
   ]
 
@@ -57,14 +59,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<capistrano>, [">= 2.0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.5"])
       s.add_runtime_dependency(%q<archive-tar-minitar>, [">= 0.5"])
     else
-      s.add_dependency(%q<capistrano>, [">= 2.0"])
+      s.add_dependency(%q<capistrano>, [">= 2.5"])
       s.add_dependency(%q<archive-tar-minitar>, [">= 0.5"])
     end
   else
-    s.add_dependency(%q<capistrano>, [">= 2.0"])
+    s.add_dependency(%q<capistrano>, [">= 2.5"])
     s.add_dependency(%q<archive-tar-minitar>, [">= 0.5"])
   end
 end

data/lib/capistrano/recipes/deploy/strategy/local_copy.rb

@@ -28,9 +28,6 @@ module Capistrano # :nodoc:
           FileUtils.rm_rf destination rescue nil
         end
 
-        def check! # :nodoc:
-        end
-
         private
 
           def local_copy_dir # :nodoc:

data/lib/capsaicin/files/remote.rb

@@ -17,6 +17,14 @@ module Capsaicin
         end
       end
 
+      FILE_TESTS.each do |m,t|
+        class_eval <<-EODEF
+          def #{m}(a, options={})
+            _t "test #{t}", a
+          end
+        EODEF
+      end
+
       def chmod(mode, list, options={})
         _r 'chmod', Array(list).unshift(mode.to_s(8))
       end
@@ -36,14 +44,6 @@ module Capsaicin
         _r 'install', src.push(dest)
       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
@@ -56,6 +56,15 @@ module Capsaicin
         logger.trace "interrupted (Ctrl-C)" if logger
       end
 
+      def put(data, path, options={})
+        case _via
+        when :system, :local_run
+          FileUtils::Verbose.copy_stream StringIO.new(from), to
+        else
+          upload StringIO.new(data), path, options
+        end
+      end
+
       def upload(from, to, options={}, &block)
         case _via
         when :system, :local_run
@@ -70,11 +79,20 @@ module Capsaicin
               to2, to = to, "/tmp/#{tof}-#{Time.now.utc.to_i}"
             end
           end
+	        options = options.dup
+	        mode = options.delete(:mode)
           @config.upload(from, to, options, &block)
           if to2
-            run "chmod 0644 #{to}"
-            cp to, to2
-            run "rm -f #{to}"
+            begin
+	            run "chmod 0644 #{to}", :via=>:run
+	            cp to, to2
+	            if mode
+		            mode = mode.is_a?(Numeric) ? '0'+mode.to_s(8) : mode.to_s
+		            run "chmod #{mode} #{to2}"
+		          end
+	          ensure
+	            run "rm -f #{to}", :via=>:run
+	          end
           end
         end
       end
@@ -88,28 +106,6 @@ module Capsaicin
         end
       end
       
-      def put(data, path, options={})
-        case _via
-        when :system, :local_run
-          FileUtils::Verbose.copy_stream StringIO.new(from), to
-        else
-          if _via.to_s[0,4] == 'sudo'
-            if path[-1]==?/ || path[-1]==?\\ || directory?(path)
-              abort "Target path is a directory!"
-            else
-              pathf = File.basename path
-              path2, path = path, "/tmp/#{pathf}-#{Time.now.utc.to_i}"
-            end
-          end
-          @config.put(data, path, options)
-          if path2
-            run "chmod 0644 #{path}"
-            cp path, path2
-            run "rm -f #{path}"
-          end
-        end
-      end
-
       def cd(dir, options={})
         if block_given?
           dir, dir2 = pwd, dir

data/lib/capsaicin/invocation.rb

@@ -1,28 +1,62 @@
 module Capsaicin
 
   module Invocation
-
+    
+    def self.included(base)
+      [:run, :sudo].each do |k|
+	      base.send :alias_method, :"#{k}_without_override", k
+	      base.send :alias_method, k, :"#{k}_with_override"
+      end
+    end
+    
+    # Allows overriding the default behavior of +run+ by setting
+    # :override_run_method and (optionally) :override_runner
+		def run_with_override(cmd, options={}, &block)
+		  via = options[:via] || fetch(:override_run_method, :run)
+      if cmd.include?(sudo) or :run == via
+        run_without_override cmd, options, &block
+      else
+        options = options.dup
+        as = fetch(:override_runner, nil) and options[:as] ||= as
+	      send via, cmd, options, &block
+	    end
+		end
+    
+    # Allows overriding the default behavior of +sudo+ by setting
+    # :override_sudo_method and (optionally) :override_sudo_runner
+		def sudo_with_override(*args, &block)
+      options = Hash===args.last ? args.pop.dup : {}
+      as = fetch(:override_sudo_runner, nil) and options[:as] ||= as
+      args << options unless options.empty?
+      if :sudo == (via = fetch(:override_sudo_method, :sudo))
+        options[:via] = :run
+	      sudo_without_override *args, &block
+      else
+	      send via, *args, &block
+			end
+		end
+    
     # Automatically uses the :run_method variable to run things.
     # Equivalent to +invoke_command *args, :via=>fetch(:run_method, :run)+
     def vrun(*args, &block)
-      options = Hash===args.last ? args.pop.dup :  {}
-      options[:via] = fetch(:run_method, :run)
+      options = Hash===args.last ? args.pop.dup : {}
+      options[:via] ||= fetch(:run_method, :run)
       invoke_command *args.push(options), &block
     end
 
     # Automatically uses the :run_method variable to run things.
     # Equivalent to +capture *args, :via=>fetch(:run_method, :run)+
     def vcapture(*args, &block)
-      options = Hash===args.last ? args.pop.dup :  {}
-      options[:via] = fetch(:run_method, :run)
+      options = Hash===args.last ? args.pop.dup : {}
+      options[:via] ||= fetch(:run_method, :run)
       capture *args.push(options), &block
     end
 
     # Automatically uses the :run_method variable to run things.
     # Equivalent to +stream *args, :via=>fetch(:run_method, :run)+
     def vstream(*args, &block)
-      options = Hash===args.last ? args.pop.dup :  {}
-      options[:via] = fetch(:run_method, :run)
+      options = Hash===args.last ? args.pop.dup : {}
+      options[:via] ||= fetch(:run_method, :run)
       stream *args.push(options), &block
     end
 
@@ -46,25 +80,29 @@ module Capsaicin
     # 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
+      options = Hash===args.last ? args.pop.dup : {}
+      options[:as] ||= fetch(:runner, nil)
+      sudo_without_override *args.push(options), &block
     end
     
-    # Extremely helpful if you only have permission to: sudo su SOMEUSER -c "command"
+    # 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
+      options = Hash===args.last ? args.pop.dup : {}
+      options[:as] ||= fetch(:runner, nil)
+      return sudo_as(options, &block) if args.empty?   # compatibility with capistrano's +sudo+
+      args[0] = "su #{options.delete(:as)} -c '#{args[0].gsub("'","'\"'\"'")}'"
+      sudo_without_override *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 = Hash===args.last ? args.pop.dup : {}
+      options[:as] ||= fetch(:runner, nil)
+      return sudo_as(options, &block) if args.empty?   # compatibility with capistrano's +sudo+
       options[:shell] = false
-      cmd = args[0].gsub(/[$\\`"]/) { |m| "\\#{m}" }
-      args[0] = "echo \"#{cmd}\" | #{sudo} su - #{fetch(:runner, nil)}"
-      run *args.push(options), &block
+      cmd     = args[0].gsub(/[$\\`"]/) { |m| "\\#{m}" }
+      args[0] = "echo \"#{cmd}\" | #{sudo_without_override} su - #{options.delete(:as)}"
+      run_without_override *args.push(options), &block
     end
   end
 end

data/lib/capsaicin/service/command.rb

@@ -2,12 +2,12 @@ module Capsaicin
   module Service
     module Command
 
-      # Check for the existance of a generic Windows NT service.
+      # Check for the existance of a command-based service.
       def command?(start, stop)
         files.executable? start and files.executable? stop
       end
 
-      # Defines a recipe to control a generic Windows NT service.
+      # Defines a recipe to control a command-based service.
       #
       def command(id,start,stop,*args)
         options = Hash===args.last ? args.pop : {}
@@ -21,12 +21,12 @@ module Capsaicin
 
           desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:start]}" if svc_desc
           task :start, options do
-            send(via || fetch(:run_method, :local_run), start)
+            send(via || fetch(:run_method, :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)
+            send(via || fetch(:run_method, :run), stop)
           end
 
           unless extras.key? :restart
@@ -40,7 +40,7 @@ module Capsaicin
           extras.each do |k,cmd|
 	          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[k]}" if svc_desc
 	          task k, options do
-	            send(via || fetch(:run_method, :local_run), cmd)
+	            send(via || fetch(:run_method, :run), cmd)
 	          end
           end
         

data/test/capsaicin/invocation_test.rb

@@ -0,0 +1,112 @@
+require 'helper'
+require 'tmpdir'
+require 'capsaicin/invocation'
+
+class Capsaicin::InvocationTest < Test::Unit::TestCase
+
+  def setup
+    @ext = CapistranoMock.new
+    class << @ext
+	    include Capsaicin::Invocation
+	  end
+  end
+  
+  def teardown
+  end
+
+  def test_vrun
+    check_run_methods :vrun, :invoke_command
+  end
+    
+  def test_vcapture
+    check_run_methods :vcapture, :capture
+  end
+    
+  def test_vstream
+    check_run_methods :vstream, :stream
+  end
+    
+  def test_sudo_as
+    check_as_methods :sudo_as, :sudo
+  end
+
+  def test_sudo_su
+    check_as_methods(:sudo_su, :sudo) {|c,as| ["su #{as} -c '#{c}'", {}] }
+  end
+
+  def test_sudo_su_escapes_single_quotes
+    check_as_methods(:sudo_su, :sudo,"echo 'abc'") do |c,as|
+      ["su #{as} -c 'echo '\"'\"'abc'\"'\"''", {}]
+    end
+  end
+
+  def test_sudo_su_to
+    check_as_methods(:sudo_su_to, :run) do |c,as|
+      ["echo \"uptime\" | sudo su - #{as}", {:shell=>false}]
+    end
+  end
+
+  def test_run_without_override
+    @ext.run 'uptime'
+    assert_equal [%w(uptime) << {}], @ext.invocations[:run].last
+  end
+
+  def test_run_with_override
+    @ext.set :override_run_method, :sudo
+    @ext.set :override_runnner, :admin
+    @ext.run 'uptime'
+    assert_equal [%w(uptime)], @ext.invocations[:sudo].last
+  end
+
+  def test_sudo_without_override
+    @ext.sudo 'uptime'
+    assert_equal [%w(uptime)], @ext.invocations[:sudo].last
+  end
+
+  def test_sudo_with_override
+    @ext.set :override_sudo_method, :sudo_as
+    @ext.set :override_sudo_runner, :admin
+    @ext.sudo 'uptime'
+    assert_equal [%w(uptime) << {:as=>:admin}], @ext.invocations[:sudo].last
+    @ext.set :override_sudo_method, :sudo_su_to
+    @ext.sudo 'uptime'
+    assert_equal [["echo \"uptime\" | sudo su - admin", {:shell=>false}]], @ext.invocations[:run].last
+  end
+
+private
+
+  def check_run_methods(method,key)
+    [:run, :sudo].each do |via|
+	    @ext.send method, 'uptime'
+	    assert_equal [%w(uptime) << {:via=>via}], @ext.invocations[key].last
+	    @ext.set :run_method, :sudo
+	  end
+    [:sudo, :run].each do |via|
+	    @ext.send method, 'uptime', &block=Proc.new{}
+	    assert_equal [%w(uptime) << {:via=>via}, block], @ext.invocations[key].last
+	    @ext.unset :run_method
+    end
+    @ext.send method, 'uptime', :via=>:sudo
+    assert_equal [%w(uptime) << {:via=>:sudo}], @ext.invocations[key].last
+  end    
+
+  def check_as_methods(method,key,cmd='uptime',&p)
+    p ||= lambda{|c,as| [c, {:as=>as}] }
+    [nil, :admin].each do |as|
+	    @ext.send method,cmd 
+	    assert_equal [p[cmd,as]], @ext.invocations[key].last
+	    @ext.set :runner, :admin
+	  end
+    @ext.send method, cmd, :as=>:busybody
+    assert_equal [p[cmd,:busybody]], @ext.invocations[key].last
+    [:admin, nil].each do |as|
+	    @ext.send method, cmd, &block=Proc.new{}
+	    assert_equal [p[cmd,as], block], @ext.invocations[key].last
+	    @ext.unset :runner
+    end
+    @ext.send method, cmd, :as=>:busybody
+    assert_equal [p[cmd,:busybody]], @ext.invocations[key].last
+    @ext.send method, :as=>:busybody
+    assert_equal [[{:as=>:busybody}]], @ext.invocations[:sudo].last
+  end    
+end

data/test/helper.rb

@@ -2,9 +2,14 @@ require 'stringio'
 require 'test/unit'
 require 'rubygems'
 require 'capistrano/logger'
+require 'capistrano/configuration/variables'
 
 class CapistranoMock
 
+  include Capistrano::Configuration::Variables
+  
+  attr_reader :invocations
+
   def logbuf
     @logbuf ||= StringIO.new
   end
@@ -17,4 +22,21 @@ class CapistranoMock
     @logger
   end
 
+  %w(invoke_command capture stream run).each do |k|
+    class_eval %Q{
+  def #{k}(*args, &block)
+    args = [args]
+    args << block if block
+    ((@invocations ||= {})[:#{k}] ||= []) << args
+  end
+}
+  end
+
+  def sudo(*args, &block)
+    return 'sudo' if args.empty?
+    args = [args]
+    args << block if block
+    ((@invocations ||= {})[:sudo] ||= []) << args
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 9
-  version: 0.1.9
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - Joe Khoobyar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 -04:00
+date: 2010-06-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,8 +26,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 0
-        version: "2.0"
+        - 5
+        version: "2.5"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -75,6 +75,7 @@ files:
 - lib/capsaicin/sys.rb
 - lib/capsaicin/ui.rb
 - test/capsaicin/files/local_test.rb
+- test/capsaicin/invocation_test.rb
 - test/helper.rb
 has_rdoc: true
 homepage: http://github.com/joekhoobyar/capsaicin
@@ -108,4 +109,5 @@ specification_version: 3
 summary: Joe Khoobyar's spicy capistrano extensions
 test_files: 
 - test/capsaicin/files/local_test.rb
+- test/capsaicin/invocation_test.rb
 - test/helper.rb