capistrano 2.12.0 → 2.13.5

data/lib/capistrano/recipes/deploy.rb

@@ -1,5 +1,6 @@
 require 'benchmark'
 require 'yaml'
+require 'shellwords'
 require 'capistrano/recipes/deploy/scm'
 require 'capistrano/recipes/deploy/strategy'
 
@@ -22,7 +23,7 @@ _cset(:repository)  { abort "Please specify the repository that houses your appl
 # are not sufficient.
 # =========================================================================
 
-_cset :scm, :subversion
+_cset(:scm) { scm_default }
 _cset :deploy_via, :checkout
 
 _cset(:deploy_to) { "/u/apps/#{application}" }
@@ -31,9 +32,6 @@ _cset(:revision)  { source.head }
 _cset :rails_env, "production"
 _cset :rake, "rake"
 
-_cset :maintenance_basename, "maintenance"
-_cset(:maintenance_template_path) { File.join(File.dirname(__FILE__), "templates", "maintenance.rhtml") }
-
 # =========================================================================
 # These variables should NOT be changed unless you are very confident in
 # what you are doing. Make sure you understand all the implications of your
@@ -79,6 +77,33 @@ _cset(:latest_release) { exists?(:deploy_timestamped) ? release_path : current_r
 # These are helper methods that will be available to your recipes.
 # =========================================================================
 
+# Checks known version control directories to intelligently set the version 
+# control in-use. For example, if a .svn directory exists in the project, 
+# it will set the :scm variable to :subversion, if a .git directory exists 
+# in the project, it will set the :scm variable to :git and so on. If no 
+# directory is found, it will default to :git.
+def scm_default
+  if File.exist? '.git'
+    :git
+  elsif File.exist? '.accurev'
+    :accurev
+  elsif File.exist? '.bzr'
+    :bzr
+  elsif File.exist? '.cvs'
+    :cvs
+  elsif File.exist? '_darcs'
+    :darcs
+  elsif File.exist? '.hg'
+    :mercurial
+  elsif File.exist? '.perforce'
+    :perforce
+  elsif File.exist? '.svn'
+    :subversion
+  else
+    :none
+  end
+end
+
 # Auxiliary helper method for the `deploy:check' task. Lets you set up your
 # own dependencies.
 def depend(location, type, *args)
@@ -240,23 +265,29 @@ namespace :deploy do
     using the :public_children variable.
   DESC
   task :finalize_update, :except => { :no_release => true } do
-    run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+    escaped_release = latest_release.to_s.shellescape
+    commands = []
+    commands << "chmod -R -- g+w #{escaped_release}" if fetch(:group_writable, true)
 
     # mkdir -p is making sure that the directories are there for some SCM's that don't
     # save empty folders
-    run <<-CMD
-      rm -rf #{latest_release}/log #{latest_release}/public/system #{latest_release}/tmp/pids &&
-      mkdir -p #{latest_release}/public &&
-      mkdir -p #{latest_release}/tmp
-    CMD
-    shared_children.map do |d|
-      run "ln -s #{shared_path}/#{d.split('/').last} #{latest_release}/#{d}"
+    shared_children.map do |dir|
+      d = dir.shellescape
+      if (dir.rindex('/')) then
+        commands += ["rm -rf -- #{escaped_release}/#{d}",
+                     "mkdir -p -- #{escaped_release}/#{dir.slice(0..(dir.rindex('/'))).shellescape}"]
+      else
+        commands << "rm -rf -- #{escaped_release}/#{d}"
+  		end
+      commands << "ln -s -- #{shared_path}/#{dir.split('/').last.shellescape} #{escaped_release}/#{d}"
     end
 
+    run commands.join(' && ') if commands.any?
+
     if fetch(:normalize_asset_timestamps, true)
       stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
-      asset_paths = fetch(:public_children, %w(images stylesheets javascripts)).map { |p| "#{latest_release}/public/#{p}" }.join(" ")
-      run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
+      asset_paths = fetch(:public_children, %w(images stylesheets javascripts)).map { |p| "#{escaped_release}/public/#{p}" }
+      run("find #{asset_paths.join(" ").shellescape} -exec touch -t -- #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }) if asset_paths.any?
     end
   end
 
@@ -522,73 +553,4 @@ namespace :deploy do
       system(source.local.log(from))
     end
   end
-
-  namespace :web do
-    desc <<-DESC
-      Present a maintenance page to visitors. Disables your application's web \
-      interface by writing a "#{maintenance_basename}.html" file to each web server. The \
-      servers must be configured to detect the presence of this file, and if \
-      it is present, always display it instead of performing the request.
-
-      By default, the maintenance page will just say the site is down for \
-      "maintenance", and will be back "shortly", but you can customize the \
-      page by specifying the REASON and UNTIL environment variables:
-
-        $ cap deploy:web:disable \\
-              REASON="hardware upgrade" \\
-              UNTIL="12pm Central Time"
-
-      You can use a different template for the maintenance page by setting the \
-      :maintenance_template_path variable in your deploy.rb file. The template file \ 
-      should either be a plaintext or an erb file.
-
-      Further customization will require that you write your own task.
-    DESC
-    task :disable, :roles => :web, :except => { :no_release => true } do
-      require 'erb'
-      on_rollback { run "rm -f #{shared_path}/system/#{maintenance_basename}.html" }
-
-      warn <<-EOHTACCESS
-
-        # Please add something like this to your site's Apache htaccess to redirect users to the maintenance page.
-        # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
-
-        ErrorDocument 503 /system/#{maintenance_basename}.html
-        RewriteEngine On
-        RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
-        RewriteCond %{DOCUMENT_ROOT}/system/#{maintenance_basename}.html -f
-        RewriteCond %{SCRIPT_FILENAME} !#{maintenance_basename}.html
-        RewriteRule ^.*$  -  [redirect=503,last]
-
-        # Or if you are using Nginx add this to your server config:
-
-        if (-f $document_root/system/maintenance.html) {
-          return 503;
-        }
-        error_page 503 @maintenance;
-        location @maintenance {
-          rewrite  ^(.*)$  /system/maintenance.html last;
-          break;
-        }
-      EOHTACCESS
-
-      reason = ENV['REASON']
-      deadline = ENV['UNTIL']
-
-      template = File.read(maintenance_template_path)
-      result = ERB.new(template).result(binding)
-
-      put result, "#{shared_path}/system/#{maintenance_basename}.html", :mode => 0644
-    end
-
-    desc <<-DESC
-      Makes the application web-accessible again. Removes the \
-      "#{maintenance_basename}.html" page generated by deploy:web:disable, which (if your \
-      web servers are configured correctly) will make your application \
-      web-accessible again.
-    DESC
-    task :enable, :roles => :web, :except => { :no_release => true } do
-      run "rm -f #{shared_path}/system/#{maintenance_basename}.html"
-    end
-  end
 end

data/lib/capistrano/recipes/deploy/assets.rb

@@ -16,7 +16,7 @@ namespace :deploy do
       for the assets directory. Assets are shared across deploys to avoid \
       mid-deploy mismatches between old application html asking for assets \
       and getting a 404 file not found error. The assets cache is shared \
-      for efficiency. If you cutomize the assets path prefix, override the \
+      for efficiency. If you customize the assets path prefix, override the \
       :assets_prefix variable to match.
     DESC
     task :symlink, :roles => assets_role, :except => { :no_release => true } do

data/lib/capistrano/recipes/deploy/scm/git.rb

@@ -190,7 +190,6 @@ module Capistrano
 
           if variable(:git_enable_submodules)
             execute << "#{git} submodule #{verbose} init"
-            execute << "for mod in `#{git} submodule status | awk '{ print $2 }'`; do #{git} config -f .git/config submodule.${mod}.url `#{git} config -f .gitmodules --get submodule.${mod}.url` && echo Synced $mod; done"
             execute << "#{git} submodule #{verbose} sync"
             if false == variable(:git_submodules_recursive)
               execute << "#{git} submodule #{verbose} update --init"

data/lib/capistrano/recipes/deploy/scm/none.rb

@@ -37,6 +37,13 @@ module Capistrano
         def query_revision(revision)
           revision
         end
+        
+        # log: There's no log, so it just echos from and to.
+        
+        def log(from="", to="")
+          "No SCM: #{from} - #{to}"
+        end
+        
       end
 
     end

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

@@ -73,7 +73,7 @@ module Capistrano
         private
 
           def logger
-            @logger ||= configuration[:logger] || Capistrano::Logger.new(:output => STDOUT)
+            @logger ||= configuration.logger || Capistrano::Logger.new(:output => STDOUT)
           end
 
           # The revision to deploy. Must return a real revision identifier,

data/lib/capistrano/shell.rb

@@ -251,10 +251,10 @@ HELP
           puts "scoping #{scope_type} #{scope_value}"
         end
       end
-    end
 
-    # All open sessions, needed to satisfy the Command::Processable include
-    def sessions
-      configuration.sessions.values
+      # All open sessions, needed to satisfy the Command::Processable include
+      def sessions
+        configuration.sessions.values
+      end
     end
 end

data/lib/capistrano/version.rb

@@ -1,16 +1,11 @@
-require 'scanf'
 module Capistrano
-
   class Version
-
     MAJOR = 2
-    MINOR = 12
-    PATCH = 0
+    MINOR = 13
+    PATCH = 5
 
     def self.to_s
       "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
-
   end
-
 end

data/test/command_test.rb

@@ -254,6 +254,14 @@ class CommandTest < Test::Unit::TestCase
     Capistrano::Command.new("echo $CAPISTRANO:OTHER$", [session])
   end
 
+  def test_input_stream_closed_when_eof_option_is_true
+    channel = nil
+    session = setup_for_extracting_channel_action { |ch| channel = ch }
+    channel.expects(:eof!)
+    Capistrano::Command.new("cat", [session], :data => "here we go", :eof => true)
+    assert_equal({ :data => 'here we go', :eof => true }, channel[:options])
+  end
+
   private
 
     def mock_session(channel=nil)

data/test/configuration/actions/inspect_test.rb

@@ -9,13 +9,19 @@ class ConfigurationActionsInspectTest < Test::Unit::TestCase
   def setup
     @config = MockConfig.new
     @config.stubs(:logger).returns(stub_everything)
+    @config.stubs(:sudo).returns('sudo')
   end
 
   def test_stream_should_pass_options_through_to_run
-    @config.expects(:invoke_command).with("tail -f foo.log", :once => true)
+    @config.expects(:invoke_command).with("tail -f foo.log", :once => true, :eof => true)
     @config.stream("tail -f foo.log", :once => true)
   end
 
+  def test_stream_with_sudo_should_avoid_closing_stdin
+    @config.expects(:invoke_command).with("sudo tail -f foo.log", :once => true, :eof => false)
+    @config.stream("sudo tail -f foo.log", :once => true)
+  end
+
   def test_stream_should_emit_stdout_via_puts
     @config.expects(:invoke_command).yields(mock("channel"), :out, "something streamed")
     @config.expects(:puts).with("something streamed")
@@ -33,10 +39,15 @@ class ConfigurationActionsInspectTest < Test::Unit::TestCase
   end
 
   def test_capture_should_pass_options_merged_with_once_to_run
-    @config.expects(:invoke_command).with("hostname", :foo => "bar", :once => true)
+    @config.expects(:invoke_command).with("hostname", :foo => "bar", :once => true, :eof => true)
     @config.capture("hostname", :foo => "bar")
   end
 
+  def test_capture_with_sudo_should_avoid_closing_stdin
+    @config.expects(:invoke_command).with("sudo hostname", :foo => "bar", :once => true, :eof => false)
+    @config.capture("sudo hostname", :foo => "bar")
+  end
+
   def test_capture_with_stderr_should_emit_stderr_via_warn
     ch = mock("channel")
     ch.expects(:[]).with(:server).returns(server("capistrano"))

data/test/configuration/actions/invocation_test.rb

@@ -45,7 +45,7 @@ class ConfigurationActionsInvocationTest < Test::Unit::TestCase
   end
 
   def test_run_options_should_be_passed_to_execute_on_servers
-    @config.expects(:execute_on_servers).with(:foo => "bar")
+    @config.expects(:execute_on_servers).with(:foo => "bar", :eof => true)
     @config.run "ls", :foo => "bar"
   end
 
@@ -115,6 +115,11 @@ class ConfigurationActionsInvocationTest < Test::Unit::TestCase
     @config.sudo "ls"
   end
 
+  def test_sudo_should_keep_input_stream_open
+    @config.expects(:execute_on_servers).with(:foo => "bar")
+    @config.sudo "ls", :foo => "bar"
+  end
+
   def test_sudo_should_use_sudo_variable_definition
     @config.expects(:run).with("/opt/local/bin/sudo -p 'sudo password: ' ls", {})
     @config.options[:sudo] = "/opt/local/bin/sudo"

data/test/configuration/callbacks_test.rb

@@ -39,11 +39,35 @@ class ConfigurationCallbacksTest < Test::Unit::TestCase
     @config.before :bar, :foo, "bing:blang", :zip => :zing
   end
 
+  def test_before_should_map_before_deploy_symlink
+    @config.before "deploy:symlink", "bing:blang", "deploy:symlink"
+    assert_equal "bing:blang", @config.callbacks[:before][0].source
+    assert_equal "deploy:create_symlink", @config.callbacks[:before][1].source
+    assert_equal ["deploy:create_symlink"], @config.callbacks[:before][1].only
+  end
+
+  def test_before_should_map_before_deploy_symlink_array
+    @config.before ["deploy:symlink", "bingo:blast"], "bing:blang"
+    assert_equal ["deploy:create_symlink", "bingo:blast"], @config.callbacks[:before].last.only
+  end
+
   def test_after_should_delegate_to_on
     @config.expects(:on).with(:after, :foo, "bing:blang", {:only => :bar, :zip => :zing})
     @config.after :bar, :foo, "bing:blang", :zip => :zing
   end
 
+  def test_after_should_map_before_deploy_symlink
+    @config.after "deploy:symlink", "bing:blang", "deploy:symlink"
+    assert_equal "bing:blang", @config.callbacks[:after][0].source
+    assert_equal "deploy:create_symlink", @config.callbacks[:after][1].source
+    assert_equal ["deploy:create_symlink"], @config.callbacks[:after][1].only
+  end
+
+  def test_after_should_map_before_deploy_symlink_array
+    @config.after ["deploy:symlink", "bingo:blast"], "bing:blang"
+    assert_equal ["deploy:create_symlink", "bingo:blast"], @config.callbacks[:after].last.only
+  end
+
   def test_on_with_single_reference_should_add_task_callback
     @config.on :before, :a_test
     assert_equal 1, @config.callbacks[:before].length

data/test/configuration/namespace_dsl_test.rb

@@ -321,7 +321,7 @@ class ConfigurationNamespacesDSLTest < Test::Unit::TestCase
     Kernel.module_eval do
       def some_weird_method() 'kernel' end
     end
-    
+
     @config.namespace(:clash2) {}
     namespace = @config.namespaces[:clash2]
     assert_equal 'config', namespace.some_weird_method
@@ -329,4 +329,4 @@ class ConfigurationNamespacesDSLTest < Test::Unit::TestCase
     Kernel.send :remove_method, :some_weird_method
     @config.class.send :remove_method, :some_weird_method
   end
-end
+end

data/test/configuration_test.rb

@@ -16,7 +16,7 @@ class ConfigurationTest < Test::Unit::TestCase
     process_args = Proc.new do |tree, session, opts|
       tree.fallback.command == "echo 'hello world'" &&
       session == [:session] &&
-      opts == { :logger => @config.logger }
+      opts == { :logger => @config.logger, :eof => true }
     end
 
     Capistrano::Command.expects(:process).with(&process_args)

data/test/deploy/scm/git_test.rb

@@ -127,7 +127,7 @@ class DeploySCMGitTest < Test::Unit::TestCase
 
     # with submodules
     @config[:git_enable_submodules] = true
-    assert_equal "cd #{dest} && #{git} fetch -q origin && #{git} fetch --tags -q origin && #{git} reset -q --hard #{rev} && #{git} submodule -q init && for mod in `#{git} submodule status | awk '{ print $2 }'`; do #{git} config -f .git/config submodule.${mod}.url `#{git} config -f .gitmodules --get submodule.${mod}.url` && echo Synced $mod; done && #{git} submodule -q sync && export GIT_RECURSIVE=$([ ! \"`#{git} --version`\" \\< \"git version 1.6.5\" ] && echo --recursive) && #{git} submodule -q update --init $GIT_RECURSIVE && #{git} clean -q -d -x -f", @source.sync(rev, dest)
+    assert_equal "cd #{dest} && #{git} fetch -q origin && #{git} fetch --tags -q origin && #{git} reset -q --hard #{rev} && #{git} submodule -q init && #{git} submodule -q sync && export GIT_RECURSIVE=$([ ! \"`#{git} --version`\" \\< \"git version 1.6.5\" ] && echo --recursive) && #{git} submodule -q update --init $GIT_RECURSIVE && #{git} clean -q -d -x -f", @source.sync(rev, dest)
   end
 
   def test_sync_with_remote

data/test/deploy/strategy/copy_test.rb

@@ -6,10 +6,11 @@ require 'stringio'
 class DeployStrategyCopyTest < Test::Unit::TestCase
   def setup
     @config = { :application => "captest",
-                :logger => Capistrano::Logger.new(:output => StringIO.new),
                 :releases_path => "/u/apps/test/releases",
                 :release_path => "/u/apps/test/releases/1234567890",
                 :real_revision => "154" }
+    @config.stubs(:logger).returns(stub_everything)
+
     @source = mock("source")
     @config.stubs(:source).returns(@source)
     @strategy = Capistrano::Deploy::Strategy::Copy.new(@config)

data/test/logger_formatting_test.rb

@@ -0,0 +1,94 @@
+require File.expand_path("../utils", __FILE__)
+require 'capistrano/logger'
+require 'stringio'
+
+Capistrano::Logger.class_eval do
+  # Allows formatters to be changed during tests
+  def self.formatters=(formatters)
+    @formatters = formatters
+    @sorted_formatters = nil
+  end
+end
+
+class LoggerFormattingTest < Test::Unit::TestCase
+  def setup
+    @io = StringIO.new
+    @io.stubs(:tty?).returns(true)
+    @logger = Capistrano::Logger.new(:output => @io, :level => 3)
+  end
+
+  def test_matching_with_style_and_color
+    Capistrano::Logger.formatters = [{ :match => /^err ::/, :color => :red, :style => :underscore, :level => 0 }]
+    @logger.log(0, "err :: Error Occurred")
+    assert @io.string.include? "\e[4;31merr :: Error Occurred\e[0m"
+  end
+
+  def test_style_without_color
+    Capistrano::Logger.formatters = [{ :match => /.*/, :style => :underscore, :level => 0 }]
+    @logger.log(0, "test message")
+    # Default color should be blank (0m)
+    assert @io.string.include? "\e[4;0mtest message\e[0m"
+  end
+
+  def test_prepending_text
+    Capistrano::Logger.formatters = [{ :match => /^executing/, :level => 0, :prepend => '== Currently ' }]
+    @logger.log(0, "executing task")
+    assert @io.string.include? '== Currently executing task'
+  end
+
+  def test_replacing_matched_text
+    Capistrano::Logger.formatters = [{ :match => /^executing/, :level => 0, :replace => 'running' }]
+    @logger.log(0, "executing task")
+    assert @io.string.include? 'running task'
+  end
+
+  def test_prepending_timestamps
+    Capistrano::Logger.formatters = [{ :match => /.*/, :level => 0, :timestamp => true }]
+    @logger.log(0, "test message")
+    assert @io.string.match /\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} test message/
+  end
+
+  def test_formatter_priorities
+    Capistrano::Logger.formatters = [
+      { :match => /.*/, :color => :red,  :level => 0, :priority => -10 },
+      { :match => /.*/, :color => :blue, :level => 0, :priority => -20, :prepend => '###' }
+    ]
+
+    @logger.log(0, "test message")
+    # Only the red formatter (color 31) should be applied.
+    assert @io.string.include? "\e[31mtest message"
+    # The blue formatter should not have prepended $$$
+    assert !@io.string.include?('###')
+  end
+
+  def test_no_formatting_if_no_color_or_style
+    Capistrano::Logger.formatters = []
+    @logger.log(0, "test message")
+    assert @io.string.include? "*** test message"
+  end
+
+  def test_formatter_log_levels
+    Capistrano::Logger.formatters = [{ :match => /.*/, :color => :blue, :level => 3 }]
+    @logger.log(0, "test message")
+    # Should not match log level
+    assert @io.string.include? "*** test message"
+
+    clear_logger
+    @logger.log(3, "test message")
+    # Should match log level and apply blue color
+    assert @io.string.include? "\e[34mtest message"
+  end
+
+  private
+
+  def colorize(message, color, style = nil)
+    style = "#{style};" if style
+    "\e[#{style}#{color}m" + message + "\e[0m"
+  end
+
+  def clear_logger
+    @io = StringIO.new
+    @io.stubs(:tty?).returns(true)
+    @logger.device = @io
+  end
+end