capistrano 1.3.1 → 1.4.0

data/CHANGELOG

@@ -1,3 +1,29 @@
+*1.4.0* (February 3, 2007)
+
+* Use the auth info for subversion more consistently [Jamis Buck]
+
+* Add a "capture" helper, for capturing the stdout of a remote command and returning it as a string [Jamis Buck]
+
+* Add a "get" helper, to pull a file from a remote server to the localhost [bmihelac]
+
+* Fix gateway to actually increment local_port if a port is in use, so that multiple capistrano instances can run at the same time [Mark Imbriaco]
+
+* Refactor the permissions tweaking in update_code to a separate task so that people on shared hosts can override it as necessary [jaw6]
+
+* Set umask during the setup task, so that intermediate directories are created with the proper permissions [NeilW]
+
+* Removed -c/--caprc switch, since the new load order renders it meaningless (just use -f now) [Mike Bailey]
+
+* Make sure the standard recipe loads first, so that .caprc and friends can override what it defines. [Mike Bailey]
+
+* Add support for a system-wide capistrano config file [Mike Bailey]
+
+* Make cold_deploy call update instead of deploy (to avoid invoking the restart task).
+
+* Make the touch command run by update_code set the TZ to UTC, for consistent setting of asset timestamps. [NeilW]
+
+* Fix off-by-one bug in show_tasks width-computation [NeilW]
+
 *1.3.1* (January 5, 2007)
 
 * Fix connection problems when using gateways [Ezra Zygmuntowicz]

data/lib/capistrano/actor.rb

@@ -261,6 +261,47 @@ module Capistrano
         end
       end
     end
+    
+    # Get file remote_path from FIRST server targetted by
+    # the current task and transfer it to local machine as path. It will use
+    # SFTP if Net::SFTP is installed; otherwise it will fall back to using
+    # 'cat', which may cause corruption in binary files.
+    #
+    # get "#{deploy_to}/current/log/production.log", "log/production.log.web"
+    def get(remote_path, path, options = {})
+      if Capistrano::SFTP && options.fetch(:sftp, true)
+        execute_on_servers(options.merge(:once => true)) do |servers|
+          logger.debug "downloading #{servers.first}:#{remote_path} to #{path}" 
+          sessions[servers.first].sftp.connect do |tsftp|
+            tsftp.get_file remote_path, path
+          end
+          logger.trace "download finished" 
+        end
+      else
+        logger.important "Net::SFTP is not available; using remote 'cat' to get file, which may cause file corruption"
+        File.open(path, "w") do |destination|
+          run "cat #{remote_path}", :once => true do |ch, stream, data|
+            case stream
+            when :out then destination << data
+            when :err then raise "error while downloading #{remote_path}: #{data.inspect}"
+            end
+          end
+        end
+      end
+    end
+
+    # Executes the given command on the first server targetted by the current
+    # task, collects it's stdout into a string, and returns the string.
+    def capture(command, options={})
+      output = ""
+      run(command, options.merge(:once => true)) do |ch, stream, data|
+        case stream
+        when :out then output << data
+        when :err then raise "error processing #{command.inspect}: #{data.inspect}"
+        end
+      end
+      output
+    end
 
     # Like #run, but executes the command via <tt>sudo</tt>. This assumes that
     # the sudo password (if required) is the same as the password for logging

data/lib/capistrano/cli.rb

@@ -96,7 +96,7 @@ module Capistrano
     def initialize(args = ARGV)
       @args = args
       @options = { :recipes => [], :actions => [], :vars => {},
-        :pre_vars => {}, :dotfile => default_dotfile }
+        :pre_vars => {}, :sysconf => default_sysconf, :dotfile => default_dotfile }
 
       OptionParser.new do |opts|
         opts.banner = "Usage: #{$0} [options] [args]"
@@ -109,15 +109,7 @@ module Capistrano
           "An action to execute. Multiple actions may",
           "be specified, and are loaded in the given order."
         ) { |value| @options[:actions] << value }
-
-        opts.on("-c", "--caprc FILE",
-          "Specify an alternate personal config file to load.",
-          "(Default: #{@options[:dotfile]})"
-        ) do |value|
-          abort "The config file `#{value}' does not exist" unless File.exist?(value)
-          @options[:dotfile] = value
-        end
-
+        
         opts.on("-f", "--file FILE",
           "A recipe file to load. Multiple recipes may",
           "be specified, and are loaded in the given order."
@@ -214,7 +206,7 @@ as the argument to --apply-to, like this:
   cap --apply-to ~/projects/myapp
 
 You'll wind up with a sample deployment recipe in config/deploy.rb and some new
-rake tasks in config/tasks.
+rake tasks in lib/tasks.
 
 (Currently, --apply-to only works with Rails applications.)
 DETAIL
@@ -259,10 +251,15 @@ DETAIL
         config.set :pretend, options[:pretend]
 
         options[:pre_vars].each { |name, value| config.set(name, value) }
-        config.load(@options[:dotfile]) if @options[:dotfile] && File.exist?(@options[:dotfile])
 
         # load the standard recipe definition
         config.load "standard"
+        
+        # load systemwide config/recipe definition
+        config.load(@options[:sysconf]) if @options[:sysconf] && File.exist?(@options[:sysconf])        
+        
+        # load user config/recipe definition
+        config.load(@options[:dotfile]) if @options[:dotfile] && File.exist?(@options[:dotfile])
 
         options[:recipes].each { |recipe| config.load(recipe) }
         options[:vars].each { |name, value| config.set(name, value) }
@@ -305,10 +302,19 @@ DETAIL
         end
       end
 
+      def default_sysconf
+        File.join(sysconf_directory, "capistrano.conf")
+      end
+      
       def default_dotfile
         File.join(home_directory, ".caprc")
       end
 
+      def sysconf_directory
+        # I'm guessing at where Windows users would keep their conf file.
+        ENV["SystemRoot"] || '/etc'
+      end
+      
       def home_directory
         ENV["HOME"] ||
           (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||

data/lib/capistrano/gateway.rb

@@ -80,7 +80,7 @@ module Capistrano
           connection = SSH.connect('127.0.0.1', @config, local_port)
           @config.logger.trace "connection to #{server} via gateway established"
         rescue Errno::EADDRINUSE
-          port = next_port
+          local_port = next_port
           retry
         rescue Exception => e
           puts e.class.name

data/lib/capistrano/recipes/standard.rb

@@ -26,7 +26,7 @@ task :show_tasks do
   puts "Available tasks"
   puts "---------------"
   each_task do |info|
-    wrap_length = 80 - info[:longest]
+    wrap_length = 80 - info[:longest] - 1
     lines = info[:desc].gsub(/(.{1,#{wrap_length}})(?:\s|\Z)+/, "\\1\n").split(/\n/)
     puts "%-#{info[:longest]}s %s" % [info[:task], lines.shift]
     puts "%#{info[:longest]}s %s" % ["", lines.shift] until lines.empty?
@@ -37,9 +37,10 @@ end
 desc "Set up the expected application directory structure on all boxes"
 task :setup, :except => { :no_release => true } do
   run <<-CMD
-    mkdir -p -m 775 #{deploy_to} #{releases_path} #{shared_path} #{shared_path}/system &&
-    mkdir -p -m 777 #{shared_path}/log &&
-    mkdir -p -m 777 #{shared_path}/pids
+    umask 02 &&
+    mkdir -p #{deploy_to} #{releases_path} #{shared_path} #{shared_path}/system &&
+    mkdir -p #{shared_path}/log &&
+    mkdir -p #{shared_path}/pids
   CMD
 end
 
@@ -61,6 +62,14 @@ task :enable_web, :roles => :web do
   delete "#{shared_path}/system/maintenance.html"
 end
 
+desc <<-DESC
+Sets group permissions on checkout. Useful for team environments, bad on
+shared hosts. Override this task if you're on a shared host.
+DESC
+task :set_permissions, :except => { :no_release => true } do
+  run "chmod -R g+w #{release_path}"
+end
+
 desc <<-DESC
 Update all servers with the latest release of the source code. All this does
 is do a checkout (as defined by the selected scm module).
@@ -70,7 +79,7 @@ task :update_code, :except => { :no_release => true } do
 
   source.checkout(self)
 
-  run "chmod -R g+w #{release_path}"
+  set_permissions
 
   run <<-CMD
     rm -rf #{release_path}/log #{release_path}/public/system &&
@@ -88,7 +97,7 @@ task :update_code, :except => { :no_release => true } do
   # lets the asset timestamping feature of rails work correctly
   stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
   asset_paths = %w(images stylesheets javascripts).map { |p| "#{release_path}/public/#{p}" }
-  run "find #{asset_paths.join(" ")} -exec touch -t #{stamp} {} \\;; true"
+  run "TZ=UTC find #{asset_paths.join(" ")} -exec touch -t #{stamp} {} \\;; true"
 
   # uncache the list of releases, so that the next time it is called it will
   # include the newly released path.
@@ -245,11 +254,11 @@ task :spinner, :roles => :app do
 end
 
 desc <<-DESC
-Used only for deploying when the spinner isn't running. It invokes deploy,
+Used only for deploying when the spinner isn't running. It invokes 'update',
 and when it finishes it then invokes the spinner task (to start the spinner).
 DESC
 task :cold_deploy do
-  deploy
+  update
   spinner
 end
 

data/lib/capistrano/scm/subversion.rb

@@ -50,7 +50,7 @@ module Capistrano
         from ||= current_revision(actor)
         to ||= "HEAD"
 
-        `svn diff #{configuration.repository}@#{from} #{configuration.repository}@#{to}`
+        `svn diff #{authorization} #{configuration.repository}@#{from} #{configuration.repository}@#{to}`
       end
 
       # Check out (on all servers associated with the current task) the latest
@@ -60,8 +60,7 @@ module Capistrano
       # remote server.)
       def checkout(actor)
         op = configuration[:checkout] || "co"
-        username = configuration[:svn_username] ? "--username #{configuration[:svn_username]}" : ""
-        command = "#{svn} #{op} #{username} -q -r#{configuration.revision} #{configuration.repository} #{actor.release_path} &&"
+        command = "#{svn} #{op} #{authorization} -q -r#{configuration.revision} #{configuration.repository} #{actor.release_path} &&"
         run_checkout(actor, command, &svn_stream_handler(actor)) 
       end
 
@@ -78,8 +77,14 @@ module Capistrano
           configuration[:svn] || "svn"
         end
 
+        def authorization
+          username = configuration[:svn_username] ? "--username #{configuration[:svn_username]}" : ""
+          password = configuration[:svn_password] ? "--password #{configuration[:svn_password]}" : ""
+          "#{username} #{password}"
+        end
+
         def svn_log(path)
-          `svn log -q --limit 1 #{path}`
+          `svn log #{authorization} -q --limit 1 #{path}`
         end
 
         def svn_password

data/lib/capistrano/version.rb

@@ -19,8 +19,8 @@ module Capistrano
     end
 
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")
     

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: capistrano
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
-date: 2007-01-05 00:00:00 -07:00
+  version: 1.4.0
+date: 2007-02-03 00:00:00 -07:00
 summary: Capistrano is a framework and utility for executing commands in parallel on multiple remote machines, via SSH. The primary goal is to simplify and automate the deployment of web applications.
 require_paths: 
 - lib