capistrano 1.2.0 → 1.3.0

data/CHANGELOG

@@ -1,4 +1,34 @@
-*SVN*
+*1.3.0* (December 23, 2006)
+
+* Deprecate rake integration in favor of invoking `cap' directly [Jamis Buck]
+
+* Make sure the CVS module references the repository explicitly in cvs_log [weyus@att.net]
+
+* Remove trace messages when loading a file [Jamis Buck]
+
+* Cleaner error messages for authentication failures and command errors [Jamis Buck]
+
+* Added support for ~/.caprc, also -x and -c switches. [Jamis Buck]
+
+* Updated migrate action to use db:migrate task in Rails instead of the deprecated migrate task [DHH]
+
+* Allow SSH user and port to be encoded in the hostname strings [Ezra Zygmuntowicz]
+
+* Fixed that new checkouts were not group-writable [DHH, Jamis Buck]
+
+* Fixed that cap setup would use 755 on the deploy_to and shared directory roots instead of 775 [DHH]
+
+* Don't run the cleanup task on servers marked no_release [Jamis Buck]
+
+* Fix typo in default_io_proc so it correctly checks the stream parameter to see if it is the error stream [Stephen Haberman]
+
+* Make sure assets in images, javascripts, and stylesheets are touched after updating the code, to ensure the asset timestamping feature of rails works correctly [Jamis Buck]
+
+* Added warning if password is prompted for and termios is not installed [John Labovitz]
+
+* Added :as option to sudo, so you can specify who the command is executed as [Mark Imbriaco]
+
+*1.2.0* (September 14, 2006)
 
 * Add experimental 'shell' task [Jamis Buck]
 

data/lib/capistrano/actor.rb

@@ -38,7 +38,7 @@ module Capistrano
     self.transfer_factory = Transfer
 
     self.default_io_proc = Proc.new do |ch, stream, out|
-      level = out == :error ? :important : :info
+      level = stream == :err ? :important : :info
       ch[:actor].logger.send(level, out, "#{stream} :: #{ch[:host]}")
     end
 
@@ -277,9 +277,10 @@ module Capistrano
       # in order to prevent _each host_ from prompting when the password was
       # wrong, let's track which host prompted first and only allow subsequent
       # prompts from that host.
-      prompt_host = nil
+      prompt_host = nil      
+      user = options[:as].nil? ? '' : "-u #{options[:as]}"
       
-      run "#{sudo_command} #{command}", options do |ch, stream, out|
+      run "#{sudo_command} #{user} #{command}", options do |ch, stream, out|
         if out =~ /^Password:/
           ch.send_data "#{password}\n"
         elsif out =~ /try again/

data/lib/capistrano/cli.rb

@@ -16,11 +16,7 @@ module Capistrano
     # This requires the termios library to be installed (which, unfortunately,
     # is not available for Windows).
     begin
-      if !defined?(USE_TERMIOS) || USE_TERMIOS
-        require 'termios'
-      else
-        raise LoadError
-      end
+      require 'termios'
 
       # Enable or disable stdin echoing to the terminal.
       def self.echo(enable)
@@ -43,6 +39,10 @@ module Capistrano
     # if termios is not available, echo suppression will not be available
     # either.
     def self.with_echo
+      unless @warned_about_echo
+        puts "WARNING: Password will echo -- install the 'termios' gem to hide your password." if !defined?(Termios) && RUBY_PLATFORM !~ /mswin/
+        @warned_about_echo = true
+      end
       echo(false)
       yield
     ensure
@@ -96,7 +96,7 @@ module Capistrano
     def initialize(args = ARGV)
       @args = args
       @options = { :recipes => [], :actions => [], :vars => {},
-        :pre_vars => {} }
+        :pre_vars => {}, :dotfile => default_dotfile }
 
       OptionParser.new do |opts|
         opts.banner = "Usage: #{$0} [options] [args]"
@@ -110,6 +110,14 @@ module Capistrano
           "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."
@@ -147,6 +155,12 @@ module Capistrano
           @options[:pre_vars][name.to_sym] = value
         end
 
+        opts.on("-x", "--skip-config",
+          "Disables the loading of the default personal config",
+          "file. Specifying -C after this option will reenable",
+          "it. (Default: config file is loaded)"
+        ) { @options[:dotfile] = nil }
+
         opts.separator ""
         opts.separator "Framework Integration Options --------"
         opts.separator ""
@@ -245,6 +259,7 @@ 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"
@@ -254,6 +269,8 @@ DETAIL
 
         actor = config.actor
         options[:actions].each { |action| actor.send action }
+      rescue Exception => error
+        handle_error(error)
       end
 
       # Load the Rails generator and apply it to the specified directory.
@@ -288,6 +305,16 @@ DETAIL
         end
       end
 
+      def default_dotfile
+        File.join(home_directory, ".caprc")
+      end
+
+      def home_directory
+        ENV["HOME"] ||
+          (ENV["HOMEPATH"] && "#{ENV["HOMEDRIVE"]}#{ENV["HOMEPATH"]}") ||
+          "/"
+      end
+
       def look_for_default_recipe_file!
         DEFAULT_RECIPES.each do |file|
           if File.exist?(file)
@@ -300,5 +327,15 @@ DETAIL
       def look_for_raw_actions!
         @options[:actions].concat(@args)
       end
+
+      def handle_error(error)
+        case error
+        when Net::SSH::AuthenticationFailed
+          abort "authentication failed for `#{error.message}'"
+        when Capistrano::Command::Error
+          abort(error.message)
+        else raise error
+        end
+      end
   end
 end

data/lib/capistrano/command.rb

@@ -3,6 +3,8 @@ module Capistrano
   # This class encapsulates a single command to be executed on a set of remote
   # machines, in parallel.
   class Command
+    class Error < RuntimeError; end
+
     attr_reader :servers, :command, :options, :actor
 
     def initialize(servers, command, callback, options, actor) #:nodoc:
@@ -42,7 +44,7 @@ module Capistrano
       logger.trace "command finished"
 
       if failed = @channels.detect { |ch| ch[:status] != 0 }
-        raise "command #{@command.inspect} failed on #{failed[:host]}"
+        raise Error, "command #{@command.inspect} failed on #{failed[:host]}"
       end
 
       self

data/lib/capistrano/configuration.rb

@@ -146,11 +146,9 @@ module Capistrano
         load :string => File.read(file), :name => options[:name] || file
 
       elsif options[:string]
-        logger.trace "loading configuration #{options[:name] || "<eval>"}"
         instance_eval(options[:string], options[:name] || "<eval>")
 
       elsif options[:proc]
-        logger.trace "loading configuration #{eval("__FILE__", options[:proc])}"
         instance_eval(&options[:proc])
 
       else

data/lib/capistrano/gateway.rb

@@ -30,7 +30,6 @@ module Capistrano
 
     def initialize(server, config) #:nodoc:
       @config = config
-      @pending_forward_requests = {}
       @next_port = MAX_PORT
       @terminate_thread = false
       @port_guard = Mutex.new
@@ -70,12 +69,15 @@ module Capistrano
     def connect_to(server)
       connection = nil
       @config.logger.trace "establishing connection to #{server} via gateway"
-      port = next_port
+      local_port = next_port
 
       thread = Thread.new do
         begin
-          @session.forward.local(port, server, 22)
-          connection = SSH.connect('127.0.0.1', @config, port)
+          user, server_stripped, port = SSH.parse_server(server)   
+          @config.ssh_options[:username] = user if user
+          remote_port = port || 22
+          @session.forward.local(local_port, server_stripped, remote_port)
+          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

data/lib/capistrano/generators/rails/deployment/templates/capistrano.rake

@@ -12,6 +12,9 @@ def cap(*parameters)
 
   require 'capistrano/cli'
 
+  STDERR.puts "Capistrano/Rake integration is deprecated."
+  STDERR.puts "Please invoke the 'cap' command directly: `cap #{parameters.join(" ")}'"
+
   Capistrano::CLI.new(parameters.map { |param| param.to_s }).execute!
 end
 

data/lib/capistrano/recipes/standard.rb

@@ -37,7 +37,7 @@ 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 #{releases_path} #{shared_path}/system &&
+    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
   CMD
@@ -70,6 +70,8 @@ task :update_code, :except => { :no_release => true } do
 
   source.checkout(self)
 
+  run "chmod -R g+w #{release_path}"
+
   run <<-CMD
     rm -rf #{release_path}/log #{release_path}/public/system &&
     ln -nfs #{shared_path}/log #{release_path}/log &&
@@ -82,6 +84,12 @@ task :update_code, :except => { :no_release => true } do
     ln -nfs #{shared_path}/pids #{release_path}/tmp/pids; true
   CMD
 
+  # update the asset timestamps so they are in sync across all servers. This
+  # 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"
+
   # uncache the list of releases, so that the next time it is called it will
   # include the newly released path.
   @releases = nil
@@ -150,7 +158,7 @@ task :migrate, :roles => :db, :only => { :primary => true } do
   end
 
   run "cd #{directory} && " +
-      "#{rake} RAILS_ENV=#{rails_env} #{migrate_env} migrate"
+      "#{rake} RAILS_ENV=#{rails_env} #{migrate_env} db:migrate"
 end
 
 desc <<-DESC
@@ -212,7 +220,7 @@ releases are retained, but this can be configured with the 'keep_releases'
 variable. This will use sudo to do the delete by default, but you can specify
 that run should be used by setting the :use_sudo variable to false.
 DESC
-task :cleanup do
+task :cleanup, :except => { :no_release => true } do
   count = (self[:keep_releases] || 5).to_i
   if count >= releases.length
     logger.important "no old releases to clean up"

data/lib/capistrano/scm/cvs.rb

@@ -117,7 +117,7 @@ module Capistrano
         end
 
         def cvs_log(path,branch)
-          `cd #{path || "."} && cvs -q log -N -r#{branch}`
+          `cd #{path || "."} && cvs -d #{configuration.repository} -q log -N -r#{branch}`
         end
 
         def cvs_local

data/lib/capistrano/ssh.rb

@@ -27,12 +27,35 @@ module Capistrano
                         :password => password_value,
                         :port => port,
                         :auth_methods => methods.shift }.merge(config.ssh_options)
-        Net::SSH.start(server,ssh_options,&block)
+                        
+        user, server_stripped, port = parse_server(server)         
+        ssh_options[:username] = user if user   
+        ssh_options[:port] = port if port
+        
+        Net::SSH.start(server_stripped,ssh_options,&block)
       rescue Net::SSH::AuthenticationFailed
         raise if methods.empty?
         password_value = config.password
         retry
       end
     end
+    
+    # This regex is used for its byproducts, the $1-9 match vars.
+    # This regex will always match the ssh hostname and if there 
+    # is a username or port they will be matched as well. This 
+    # allows us to set the username and ssh port right in the 
+    # server string:  "username@123.12.123.12:8088"
+    # This remains fully backwards compatible and can still be
+    # intermixed with the old way of doing things. usernames
+    # and ports will be used from the server string if present
+    # but they will fall back to the regular defaults when not
+    # present. Returns and array like:
+    # ['bob', 'demo.server.com', '8088']
+    # will always at least return the server:
+    # [nil, 'demo.server.com', nil]
+    def self.parse_server(server)
+      server =~ /^(?:([^;,:=]+)@|)(.*?)(?::(\d+)|)$/
+      [$1, $2, $3]
+    end  
   end
 end

data/lib/capistrano/version.rb

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

data/test/actor_test.rb

@@ -316,6 +316,15 @@ class ActorTest < Test::Unit::TestCase
     @actor.foo
     assert_instance_of GatewayConnectionFactory, @actor.factory
   end
+  
+  def test_establish_connection_uses_gateway_if_specified_with_username_and_port
+    @actor.configuration.gateway = "demo@10.example.com:8088"
+    @actor.define_task :foo, :roles => :db do
+      run "do this"
+    end
+    @actor.foo
+    assert_instance_of GatewayConnectionFactory, @actor.factory
+  end
 
   def test_run_when_not_pretend
     @actor.define_task :foo do

data/test/ssh_test.rb

@@ -42,6 +42,39 @@ class SSHTest < Test::Unit::TestCase
       MockSSH.invocations.first[1][:auth_methods]
     assert_nil MockSSH.invocations.first[2]
   end
+  
+  def test_explicit_ssh_ports_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('demo.server.i:8088', @config)
+    end
+
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 'demo', MockSSH.invocations.first[1][:username]
+  end
+  
+  def test_explicit_ssh_username_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i', @config)
+    end
+
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal 22, MockSSH.invocations.first[1][:port]
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+  end
+  
+  def test_explicit_ssh_username_and_port_in_server_string_no_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i:8088', @config)
+    end
+
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+  end
 
   def test_publickey_auth_succeeds_explicit_port_no_block
     Net.const_during(:SSH, MockSSH) do
@@ -53,6 +86,53 @@ class SSHTest < Test::Unit::TestCase
     assert_nil MockSSH.invocations.first[2]
   end
 
+
+  def test_explicit_ssh_ports_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('demo.server.i:8088', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+  
+  def test_explicit_ssh_username_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal 22, MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+  
+  def test_explicit_ssh_username_and_port_in_server_string_with_block
+    Net.const_during(:SSH, MockSSH) do
+      Capistrano::SSH.connect('bob@demo.server.i:8088', @config) do |session|
+      end
+    end
+    assert_equal 'demo.server.i', MockSSH.invocations.first[0]
+    assert_equal '8088', MockSSH.invocations.first[1][:port]
+    assert_equal 1, MockSSH.invocations.length
+    assert_equal 'bob', MockSSH.invocations.first[1][:username]
+    assert_instance_of Proc, MockSSH.invocations.first[2]
+  end
+
+  def test_parse_server
+    assert_equal(['bob', 'demo.server.i', '8088'], 
+                 Capistrano::SSH.parse_server("bob@demo.server.i:8088"))
+    assert_equal([nil, 'demo.server.i', '8088'], 
+                 Capistrano::SSH.parse_server("demo.server.i:8088"))                 
+    assert_equal(['bob', 'demo.server.i', nil], 
+                 Capistrano::SSH.parse_server("bob@demo.server.i"))
+    assert_equal([nil, 'demo.server.i', nil], 
+                 Capistrano::SSH.parse_server("demo.server.i"))
+  end  
+
   def test_publickey_auth_succeeds_with_block
     Net.const_during(:SSH, MockSSH) do
       Capistrano::SSH.connect('demo.server.i', @config) do |session|

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: capistrano
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
-date: 2006-09-14 00:00:00 -06:00
+  version: 1.3.0
+date: 2006-12-23 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