capistrano 2.14.2 → 2.15.0

data/lib/capistrano/configuration/connections.rb

@@ -54,7 +54,7 @@ module Capistrano
             end
           end
         end
-        
+
         def connect_to(server)
           @options[:logger].debug "establishing connection to `#{server}' via gateway" if @options[:logger]
           local_host = ServerDefinition.new("127.0.0.1", :user => server.user, :port => gateway_for(server).open(server.host, server.port || 22))
@@ -106,7 +106,7 @@ module Capistrano
       # establish connections to servers defined via ServerDefinition objects.
       def connection_factory
         @connection_factory ||= begin
-          if exists?(:gateway)
+          if exists?(:gateway) && !fetch(:gateway).nil? && !fetch(:gateway).empty?
             logger.debug "establishing connection to gateway `#{fetch(:gateway).inspect}'"
             GatewayConnectionFactory.new(fetch(:gateway), self)
           else
@@ -139,44 +139,51 @@ module Capistrano
       def teardown_connections_to(servers)
         servers.each do |server|
           begin
-            sessions.delete(server).close
-          rescue IOError
+            session = sessions.delete(server)
+            session.close if session
+          rescue IOError, Net::SSH::Disconnect
             # the TCP connection is already dead
           end
         end
       end
 
-      # Determines the set of servers within the current task's scope and
-      # establishes connections to them, and then yields that list of
-      # servers.
-      def execute_on_servers(options={})
-        raise ArgumentError, "expected a block" unless block_given?
-
+      # Determines the set of servers within the current task's scope
+      def filter_servers(options={})
         if task = current_task
           servers = find_servers_for_task(task, options)
 
           if servers.empty?
             if ENV['HOSTFILTER'] || task.options.merge(options)[:on_no_matching_servers] == :continue
               logger.info "skipping `#{task.fully_qualified_name}' because no servers matched"
-              return
             else
-              raise Capistrano::NoMatchingServersError, "`#{task.fully_qualified_name}' is only run for servers matching #{task.options.inspect}, but no servers matched"
+              unless dry_run
+                raise Capistrano::NoMatchingServersError, "`#{task.fully_qualified_name}' is only run for servers matching #{task.options.inspect}, but no servers matched"
+              end
             end
           end
 
           if task.continue_on_error?
             servers.delete_if { |s| has_failed?(s) }
-            return if servers.empty?
           end
         else
           servers = find_servers(options)
-          if servers.empty?
+          if servers.empty? && !dry_run
             raise Capistrano::NoMatchingServersError, "no servers found to match #{options.inspect}" if options[:on_no_matching_servers] != :continue
-            return
           end
         end
 
         servers = [servers.first] if options[:once]
+        [task, servers.compact]
+      end
+
+      # Determines the set of servers within the current task's scope and
+      # establishes connections to them, and then yields that list of
+      # servers.
+      def execute_on_servers(options={})
+        raise ArgumentError, "expected a block" unless block_given?
+
+        task, servers = filter_servers(options)
+        return if servers.empty?
         logger.trace "servers: #{servers.map { |s| s.host }.inspect}"
 
         max_hosts = (options[:max_hosts] || (task && task.max_hosts) || servers.size).to_i

data/lib/capistrano/configuration/execution.rb

@@ -27,8 +27,8 @@ module Capistrano
       def task_call_frames
         Thread.current[:task_call_frames] ||= []
       end
-      
-      
+
+
       # The stack of tasks that have registered rollback handlers within the
       # current transaction. If this is nil, then there is no transaction
       # that is currently active.

data/lib/capistrano/configuration/loading.rb

@@ -141,9 +141,9 @@ module Capistrano
         # look to see if this specific configuration instance has ever seen
         # these arguments to require before
         if @loaded_features.include?(args)
-          return false 
+          return false
         end
-        
+
         @loaded_features << args
         begin
           original_instance, self.class.instance = self.class.instance, self

data/lib/capistrano/configuration/log_formatters.rb

@@ -63,9 +63,13 @@ module Capistrano
         end
       end
 
+      def default_log_formatters(formatters)
+        default_formatters = [*formatters]
+      end
+
       def disable_log_formatters
         @logger.disable_formatters = true
       end
     end
   end
-end
+end

data/lib/capistrano/configuration/roles.rb

@@ -68,7 +68,7 @@ module Capistrano
         raise ArgumentError, "you must associate a server with at least one role" if roles.empty?
         roles.each { |name| role(name, host, options) }
       end
-      
+
       def role_names_for_host(host)
         roles.map {|role_name, role| role_name if role.include?(host) }.compact || []
       end

data/lib/capistrano/configuration/servers.rb

@@ -13,8 +13,8 @@ module Capistrano
       # The options hash may include a :hosts option (which should specify
       # an array of host names or ServerDefinition instances), a :roles
       # option (specifying an array of roles), an :only option (specifying
-      # a hash of key/value pairs that any matching server must match), 
-      # an :exception option (like :only, but the inverse), and a 
+      # a hash of key/value pairs that any matching server must match),
+      # an :exception option (like :only, but the inverse), and a
       # :skip_hostfilter option to ignore the HOSTFILTER environment variable
       # described below.
       #
@@ -27,7 +27,7 @@ module Capistrano
       # will limit the result to hosts found in that (comma-separated) list.
       #
       # If the HOSTROLEFILTER environment variable is set, it will limit the
-      # result to hosts found in that (comma-separated) list of roles 
+      # result to hosts found in that (comma-separated) list of roles
       #
       # Usage:
       #
@@ -44,9 +44,9 @@ module Capistrano
       def find_servers(options={})
         return [] if options.key?(:hosts) && (options[:hosts].nil? || [] == options[:hosts])
         return [] if options.key?(:roles) && (options[:roles].nil? || [] == options[:roles])
-        
+
         hosts  = server_list_from(ENV['HOSTS'] || options[:hosts])
-        
+
         if hosts.any?
           if options[:skip_hostfilter]
             hosts.uniq
@@ -59,7 +59,7 @@ module Capistrano
 
           only   = options[:only] || {}
           except = options[:except] || {}
-          
+
           # If we don't have a def for a role it means its bogus, skip it so higher level can handle
           servers = roles.inject([]) { |list, role| list.concat(self.roles[role] || []) }
           servers = servers.select { |server| only.all? { |key,value| server.options[key] == value } }

data/lib/capistrano/errors.rb

@@ -1,11 +1,11 @@
 module Capistrano
-  
+
   Error = Class.new(RuntimeError)
 
   CaptureError            = Class.new(Capistrano::Error)
   NoSuchTaskError         = Class.new(Capistrano::Error)
   NoMatchingServersError  = Class.new(Capistrano::Error)
-  
+
   class RemoteError < Error
     attr_accessor :hosts
   end
@@ -13,7 +13,7 @@ module Capistrano
   ConnectionError     = Class.new(Capistrano::RemoteError)
   TransferError       = Class.new(Capistrano::RemoteError)
   CommandError        = Class.new(Capistrano::RemoteError)
-  
+
   LocalArgumentError  = Class.new(Capistrano::Error)
-  
+
 end

data/lib/capistrano/ext/multistage.rb

@@ -15,7 +15,7 @@ Capistrano::Configuration.instance.load do
     desc "Set the target stage to `#{name}'."
     task(name) do
       set :stage, name.to_sym
-      load "#{location}/#{stage}"
+      load "#{location}/#{stage}" if File.exist?(File.join(location, "#{stage}.rb"))
     end
   end
 
@@ -39,7 +39,7 @@ Capistrano::Configuration.instance.load do
         else
           abort "No stage specified. Please specify one of: #{stages.join(', ')} (e.g. `cap #{stages.first} #{ARGV.last}')"
         end
-      end 
+      end
     end
 
     desc "Stub out the staging config files."

data/lib/capistrano/logger.rb

@@ -31,7 +31,7 @@ module Capistrano
     }
 
     # Set up default formatters
-    @formatters = [
+    @default_formatters = [
       # TRACE
       { :match => /command finished/,          :color => :white,   :style => :dim, :level => 3, :priority => -10 },
       { :match => /executing locally/,         :color => :yellow,  :level => 3, :priority => -20 },
@@ -49,8 +49,21 @@ module Capistrano
       { :match => /^err ::/,                   :color => :red,     :level => 0, :priority => -10 },
       { :match => /.*/,                        :color => :blue,    :level => 0, :priority => -20 }
     ]
+    @formatters = @default_formatters
 
     class << self
+      def default_formatters
+        @default_formatters
+      end
+
+      def default_formatters=(defaults=nil)
+        @default_formatters = [defaults].flatten
+
+        # reset the formatters
+        @formatters = @default_formatters
+        @sorted_formatters = nil
+      end
+
       def add_formatter(options) #:nodoc:
         @formatters.push(options)
         @sorted_formatters = nil

data/lib/capistrano/recipes/deploy.rb

@@ -57,13 +57,13 @@ _cset(:shared_path)       { File.join(deploy_to, shared_dir) }
 _cset(:current_path)      { File.join(deploy_to, current_dir) }
 _cset(:release_path)      { File.join(releases_path, release_name) }
 
-_cset(:releases)          { capture("ls -x #{releases_path}", :except => { :no_release => true }).split.sort }
+_cset(:releases)          { capture("#{try_sudo} ls -x #{releases_path}", :except => { :no_release => true }).split.sort }
 _cset(:current_release)   { releases.length > 0 ? File.join(releases_path, releases.last) : nil }
 _cset(:previous_release)  { releases.length > 1 ? File.join(releases_path, releases[-2]) : nil }
 
-_cset(:current_revision)  { capture("cat #{current_path}/REVISION",     :except => { :no_release => true }).chomp }
-_cset(:latest_revision)   { capture("cat #{current_release}/REVISION",  :except => { :no_release => true }).chomp }
-_cset(:previous_revision) { capture("cat #{previous_release}/REVISION", :except => { :no_release => true }).chomp if previous_release }
+_cset(:current_revision)  { capture("#{try_sudo} cat #{current_path}/REVISION",     :except => { :no_release => true }).chomp }
+_cset(:latest_revision)   { capture("#{try_sudo} cat #{current_release}/REVISION",  :except => { :no_release => true }).chomp }
+_cset(:previous_revision) { capture("#{try_sudo} cat #{previous_release}/REVISION", :except => { :no_release => true }).chomp if previous_release }
 
 _cset(:run_method)        { fetch(:use_sudo, true) ? :sudo : :run }
 
@@ -74,14 +74,16 @@ _cset(:run_method)        { fetch(:use_sudo, true) ? :sudo : :run }
 # standalone case, or during deployment.
 _cset(:latest_release) { exists?(:deploy_timestamped) ? release_path : current_release }
 
+_cset :maintenance_basename, "maintenance"
+_cset(:maintenance_template_path) { File.join(File.dirname(__FILE__), "templates", "maintenance.rhtml") }
 # =========================================================================
 # 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 
+# 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'
@@ -127,6 +129,9 @@ end
 # logs the command then executes it locally.
 # returns the command output as a string
 def run_locally(cmd)
+  if dry_run
+    return logger.debug "executing locally: #{cmd.inspect}"
+  end
   logger.trace "executing locally: #{cmd.inspect}" if logger
   output_on_stdout = nil
   elapsed = Benchmark.realtime do
@@ -153,7 +158,7 @@ end
 # THUS, if you want to try to run something via sudo, and what to use the
 # root user, you'd just to try_sudo('something'). If you wanted to try_sudo as
 # someone else, you'd just do try_sudo('something', :as => "bob"). If you
-# always wanted sudo to run as a particular user, you could do 
+# always wanted sudo to run as a particular user, you could do
 # set(:admin_runner, "bob").
 def try_sudo(*args)
   options = args.last.is_a?(Hash) ? args.pop : {}
@@ -262,7 +267,7 @@ namespace :deploy do
     public/stylesheets, and public/javascripts so that the times are \
     consistent (so that asset timestamping works).  This touch process \
     is only carried out if the :normalize_asset_timestamps variable is \
-    set to true, which is the default The asset directories can be overridden \
+    set to true, which is the default. The asset directories can be overridden \
     using the :public_children variable.
   DESC
   task :finalize_update, :except => { :no_release => true } do
@@ -279,7 +284,7 @@ namespace :deploy do
                      "mkdir -p -- #{escaped_release}/#{dir.slice(0..(dir.rindex('/'))).shellescape}"]
       else
         commands << "rm -rf -- #{escaped_release}/#{d}"
-  		end
+      end
       commands << "ln -s -- #{shared_path}/#{dir.split('/').last.shellescape} #{escaped_release}/#{d}"
     end
 
@@ -287,8 +292,10 @@ namespace :deploy do
 
     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| "#{escaped_release}/public/#{p}" }
-      run("find #{asset_paths.join(" ")} -exec touch -t #{stamp} -- {} ';'; true",
+      asset_paths = fetch(:public_children, %w(images stylesheets javascripts)).
+        map { |p| "#{latest_release}/public/#{p}" }.
+        map { |p| p.shellescape }.join(" ")
+      run("find #{asset_paths} -exec touch -t #{stamp} -- {} ';'; true",
           :env => { "TZ" => "UTC" }) if asset_paths.any?
     end
   end
@@ -313,13 +320,13 @@ namespace :deploy do
   task :create_symlink, :except => { :no_release => true } do
     on_rollback do
       if previous_release
-        run "rm -f #{current_path}; ln -s #{previous_release} #{current_path}; true"
+        run "#{try_sudo} rm -f #{current_path}; #{try_sudo} ln -s #{previous_release} #{current_path}; true"
       else
         logger.important "no previous release to rollback to, rollback of symlink skipped"
       end
     end
 
-    run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+    run "#{try_sudo} rm -f #{current_path} && #{try_sudo} ln -s #{latest_release} #{current_path}"
   end
 
   desc <<-DESC
@@ -363,7 +370,7 @@ namespace :deploy do
     DESC
     task :revision, :except => { :no_release => true } do
       if previous_release
-        run "rm #{current_path}; ln -s #{previous_release} #{current_path}"
+        run "#{try_sudo} rm #{current_path}; #{try_sudo} ln -s #{previous_release} #{current_path}"
       else
         abort "could not rollback the code because there is no prior release"
       end
@@ -375,7 +382,7 @@ namespace :deploy do
       (if ever) need to be called directly.
     DESC
     task :cleanup, :except => { :no_release => true } do
-      run "if [ `readlink #{current_path}` != #{current_release} ]; then rm -rf #{current_release}; fi"
+      run "if [ `readlink #{current_path}` != #{current_release} ]; then #{try_sudo} rm -rf #{current_release}; fi"
     end
 
     desc <<-DESC
@@ -455,16 +462,7 @@ namespace :deploy do
   DESC
   task :cleanup, :except => { :no_release => true } do
     count = fetch(:keep_releases, 5).to_i
-    local_releases = capture("ls -xt #{releases_path}").split.reverse
-    if count >= local_releases.length
-      logger.important "no old releases to clean up"
-    else
-      logger.info "keeping #{count} of #{local_releases.length} deployed releases"
-      directories = (local_releases - local_releases.last(count)).map { |release|
-        File.join(releases_path, release) }.join(" ")
-
-      try_sudo "rm -rf #{directories}"
-    end
+    try_sudo "ls -1dt #{releases_path}/* | tail -n +#{count + 1} | xargs rm -rf"
   end
 
   desc <<-DESC
@@ -555,4 +553,73 @@ 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 break;
+          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