capistrano 2.1.0 → 2.2.0

data/CHANGELOG

@@ -1,3 +1,50 @@
+*2.2.0* February 27, 2008
+
+* Fix git submodule support to init on sync [halorgium]
+
+* Add alternative server-centric role definition method [James Duncan Davidson]
+
+* Add support for password prompts from the Mercurial SCM [ches]
+
+* Add support for :max_hosts option in task definition or run() [Rob Holland <rob@inversepath.com>]
+
+* Distributed git support for better operability with remote_cache strategy [voidlock]
+
+* Use a default line length in help text if line length is otherwise too small [Jamis Buck]
+
+* Fix incorrect reference to the 'setup' task in task documentation [rajeshduggal]
+
+* Don't try to kill the spawner process on deploy:stop if no spawner process exists [Jamis Buck]
+
+* Dynamic roles (e.g. role(:app) { "host.name" }) [dmasover]
+
+* Implement Bzr#next_revision so that pending changes can be reported correctly [casret]
+
+* Use a proper export command for bzr SCM [drudru]
+
+* Use checkout instead of merge for git SCM [nuttycom]
+
+* Fix typo in Subversion SCM module, encountered when an update fails [kemiller]
+
+* Fix documentation typo in upload.rb [evolving_jerk]
+
+* Added test case to show that the :scm_command is honored by the git SCM module [grempe]
+
+* Fail gracefully when double-colons are used to delimit namespaces [richie]
+
+* Add support for :git_enable_submodules variable, to enable submodules with the git SCM [halorgium]
+
+* If subversion asks for a password, prompt as a last resort [Jamis Buck]
+
+* Use checkout --lightweight for bzr checkout, instead of branch [michiels]
+
+* Make sure bzr SCM works when revision is head (or unspecified) [michiels]
+
+* Support p4sync_flags and p4client_root variables for Perforce [gseidman]
+
+* Prepare for Net::SSH v2 by making sure Capistrano only tries to load Net::SSH versions less than 1.99.0 [Jamis Buck]
+
+
 *2.1.0* October 14, 2007
 
 * Default to 0664 instead of 0660 on upload [Jamis Buck]

data/lib/capistrano/cli/help.rb

@@ -84,7 +84,9 @@ module Capistrano
         text.each_line do |line|
           indentation = line[/^\s+/] || ""
           indentation_size = indentation.split(//).inject(0) { |c,s| c + (s[0] == ?\t ? 8 : 1) }
-          lines = line.strip.gsub(/(.{1,#{output_columns - indentation_size}})(?:\s+|\Z)/, "\\1\n").split(/\n/)
+          line_length = output_columns - indentation_size
+          line_length = MIN_MAX_LEN if line_length < MIN_MAX_LEN
+          lines = line.strip.gsub(/(.{1,#{line_length}})(?:\s+|\Z)/, "\\1\n").split(/\n/)
           if lines.empty?
             formatted << "\n"
           else

data/lib/capistrano/configuration/connections.rb

@@ -1,3 +1,5 @@
+
+require 'enumerator'
 require 'capistrano/gateway'
 require 'capistrano/ssh'
 
@@ -95,6 +97,14 @@ module Capistrano
         end
       end
 
+      # Destroys sessions for each server in the list.
+      def teardown_connections_to(servers)
+        servers.each do |server|
+           @sessions[server].close
+           @sessions.delete(server)
+         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.
@@ -120,22 +130,32 @@ module Capistrano
         servers = [servers.first] if options[:once]
         logger.trace "servers: #{servers.map { |s| s.host }.inspect}"
 
-        # establish connections to those servers, as necessary
-        begin
-          establish_connections_to(servers)
-        rescue ConnectionError => error
-          raise error unless task && task.continue_on_error?
-          error.hosts.each do |h|
-            servers.delete(h)
-            failed!(h)
+        max_hosts = (options[:max_hosts] || (task && task.max_hosts) || servers.size).to_i
+        is_subset = max_hosts < servers.size
+
+        # establish connections to those servers in groups of max_hosts, as necessary
+        servers.each_slice(max_hosts) do |servers_slice|
+          begin
+            establish_connections_to(servers_slice)
+          rescue ConnectionError => error
+            raise error unless task && task.continue_on_error?
+            error.hosts.each do |h|
+              servers_slice.delete(h)
+              failed!(h)
+            end
+          end
+
+          begin
+            yield servers_slice
+          rescue RemoteError => error
+            raise error unless task && task.continue_on_error?
+            error.hosts.each { |h| failed!(h) }
           end
-        end
 
-        begin
-          yield servers
-        rescue RemoteError => error
-          raise error unless task && task.continue_on_error?
-          error.hosts.each { |h| failed!(h) }
+          # if dealing with a subset (e.g., :max_hosts is less than the
+          # number of servers available) teardown the subset of connections
+          # that were just made, so that we can make room for the next subset.
+          teardown_connections_to(servers_slice) if is_subset
         end
       end
 

data/lib/capistrano/configuration/namespaces.rb

@@ -116,7 +116,8 @@ module Capistrano
 
         ns = self
         until parts.empty?
-          ns = ns.namespaces[parts.shift.to_sym]
+          next_part = parts.shift
+          ns = next_part.empty? ? nil : ns.namespaces[next_part.to_sym]
           return nil if ns.nil?
         end
 

data/lib/capistrano/configuration/roles.rb

@@ -1,4 +1,5 @@
 require 'capistrano/server_definition'
+require 'capistrano/role'
 
 module Capistrano
   class Configuration
@@ -15,7 +16,7 @@ module Capistrano
 
       def initialize_with_roles(*args) #:nodoc:
         initialize_without_roles(*args)
-        @roles = Hash.new { |h,k| h[k] = [] }
+        @roles = Hash.new { |h,k| h[k] = Role.new }
       end
 
       # Define a new role and its associated servers. You must specify at least
@@ -41,11 +42,24 @@ module Capistrano
       # that call to "role":
       #
       #   role :web, "web2", "web3", :user => "www", :port => 2345
-      def role(which, *args)
+      def role(which, *args, &block)
         options = args.last.is_a?(Hash) ? args.pop : {}
         which = which.to_sym
+        roles[which].push(block, options) if block_given?
         args.each { |host| roles[which] << ServerDefinition.new(host, options) }
       end
+
+      # An alternative way to associate servers with roles. If you have a server
+      # that participates in multiple roles, this can be a DRYer way to describe
+      # the relationships. Pass the host definition as the first parameter, and
+      # the roles as the remaining parameters:
+      #
+      #   server "master.example.com", :web, :app
+      def server(host, *roles)
+        options = roles.last.is_a?(Hash) ? roles.pop : {}
+        raise ArgumentError, "you must associate a server with at least one role" if roles.empty?
+        roles.each { |name| role(name, host, options) }
+      end
     end
   end
 end

data/lib/capistrano/recipes/deploy.rb

@@ -110,11 +110,11 @@ namespace :deploy do
   desc <<-DESC
     Prepares one or more servers for deployment. Before you can use any \
     of the Capistrano deployment tasks with your project, you will need to \
-    make sure all of your servers have been prepared with `cap setup'. When \
+    make sure all of your servers have been prepared with `cap deploy:setup'. When \
     you add a new server to your cluster, you can easily run the setup task \
     on just that server by specifying the HOSTS environment variable:
 
-      $ cap HOSTS=new.server.com setup
+      $ cap HOSTS=new.server.com deploy:setup
 
     It is safe to run this task on servers that have already been set up; it \
     will not destroy any deployed revisions or data.
@@ -426,7 +426,7 @@ namespace :deploy do
     as = fetch(:runner, "app")
     via = fetch(:run_method, :sudo)
 
-    invoke_command "#{current_path}/script/process/reaper -a kill -r dispatch.spawner.pid", :via => via, :as => as
+    invoke_command "if [ -f #{current_path}/tmp/pids/dispatch.spawner.pid ]; then #{current_path}/script/process/reaper -a kill -r dispatch.spawner.pid; fi", :via => via, :as => as
     invoke_command "#{current_path}/script/process/reaper -a kill", :via => via, :as => as
   end
 

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

@@ -21,7 +21,7 @@ module Capistrano
         # Returns the command that will check out the given revision to the
         # given destination.
         def checkout(revision, destination)
-          scm :branch, revswitch(revision), repository, destination
+          scm :checkout, "--lightweight", revswitch(revision), repository, destination
         end
 
         # The bzr 'update' command does not support updating to a specific
@@ -33,13 +33,9 @@ module Capistrano
           commands.join(" && ")
         end
 
-        # The bzr 'export' command would work fine, except it doesn't let you
-        # specify the repository itself, so it only works if there is a working
-        # tree handy, locally. Since this needs to work even on a remote host
-        # where there is no working tree, we'll just do a checkout, followed
-        # by a deletion of the ".bzr" metadata directory.
+        # The bzr 'export' does an export similar to other SCM systems
         def export(revision, destination)
-          [checkout(revision, destination) && "rm -rf #{destination}/.bzr"].join(" && ")
+          scm :export, revswitch(revision), destination, repository
         end
 
         # The bzr "diff" command doesn't accept a repository argument, so it
@@ -63,17 +59,18 @@ module Capistrano
         # If the 'revision' argument, on the other hand, is not :head, it is
         # simply returned.
         def query_revision(revision)
-          if revision == head
-            yield(scm(:revno, repository)).chomp
-          else
-            revision
-          end
+          revision
+        end
+
+        # Increments the given revision number and returns it.
+        def next_revision(revision)
+          revision.to_i + 1
         end
 
         private
 
           def revswitch(revision)
-            if revision == :head
+            if revision == :head || revision.nil?
               nil
             else
               "-r #{revision}"

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

@@ -49,11 +49,28 @@ module Capistrano
       # You may set <tt>:branch</tt>, which is the reference to the branch, tag,
       # or any SHA1 you are deploying, for example:
       #
-      #   set :branch, "origin/master"
+      #   set :branch, "master"
       #
       # Otherwise, HEAD is assumed.  I strongly suggest you set this.  HEAD is
       # not always the best assumption.
       #
+      # You may also set <tt>:remote</tt>, which will be used as a name for remote
+      # tracking of repositories. This option is intended for use with the
+      # <tt>:remote_cache</tt> strategy in a distributed git environment.
+      #
+      # For example in the projects <tt>config/deploy.rb</tt>:
+      #
+      #   set :repository, "#{scm_user}@somehost:~/projects/project.git"
+      #   set :remote, "#{scm_user}"
+      #
+      # Then each person with deploy priveledges can add the following to their
+      # local <tt>~/.caprc</tt> file:
+      #
+      #   set :scm_user, 'someuser'
+      #
+      # Now any time a person deploys the project, their repository will be
+      # setup as a remote git repository within the cached repository.
+      #
       # The <tt>:scm_command</tt> configuration variable, if specified, will
       # be used as the full path to the git executable on the *remote* machine:
       #
@@ -78,7 +95,7 @@ module Capistrano
       #   set :deploy_via, :remote_cache
       #
       # For faster clone, you can also use shallow cloning.  This will set the
-      # '--depth' flag using the depth specified.  This *cannot* be used 
+      # '--depth' flag using the depth specified.  This *cannot* be used
       # together with the :remote_cache strategy
       #
       #   set :git_shallow_clone, 1
@@ -88,8 +105,9 @@ module Capistrano
       #
       # Garry Dolley http://scie.nti.st
       # Contributions by Geoffrey Grosenbach http://topfunky.com
-      #              and Scott Chacon http://jointheconversation.org
-      
+      #              Scott Chacon http://jointheconversation.org
+      #                      and Alex Arnell http://twologic.com
+
       class Git < Base
         # Sets the default command name for this SCM on your *local* machine.
         # Users may override this by setting the :scm_command variable.
@@ -102,38 +120,69 @@ module Capistrano
           configuration[:branch] || 'HEAD'
         end
 
+        def origin
+          configuration[:remote] || 'origin'
+        end
+
         # Performs a clone on the remote machine, then checkout on the branch
         # you want to deploy.
         def checkout(revision, destination)
-          git      = command
-
-          branch   = head
-
-          fail "No branch specified, use for example 'set :branch, \"origin/master\"' in your deploy.rb" unless branch
+          git    = command
+          remote = origin
 
+          args = []
+          args << "-o #{remote}" unless remote == 'origin'
           if depth = configuration[:git_shallow_clone]
-            execute  = "#{git} clone --depth #{depth} #{configuration[:repository]} #{destination} && "
+            args << "--depth #{depth}"
+          end
+
+          execute = []
+          if args.empty?
+            execute << "#{git} clone #{configuration[:repository]} #{destination}"
           else
-            execute  = "#{git} clone #{configuration[:repository]} #{destination} && "
+            execute << "#{git} clone #{args.join(' ')} #{configuration[:repository]} #{destination}"
           end
 
-          execute += "cd #{destination} && #{git} checkout -b deploy #{branch}" 
+          # checkout into a local branch rather than a detached HEAD
+          execute << "cd #{destination} && #{git} checkout -b deploy #{revision}"
+          
+          if configuration[:git_enable_submodules]
+            execute << "#{git} submodule init"
+            execute << "#{git} submodule update"
+          end
 
-          execute
+          execute.join(" && ")
         end
 
         # Merges the changes to 'head' since the last fetch, for remote_cache
         # deployment strategy
         def sync(revision, destination)
-          execute = "cd #{destination} && git fetch origin && "
+          git     = command
+          remote  = origin
+
+          execute = []
+          execute << "cd #{destination}"
+
+          # Use git-config to setup a remote tracking branches. Could use
+          # git-remote but it complains when a remote of the same name already
+          # exists, git-config will just silenty overwrite the setting every
+          # time. This could cause wierd-ness in the remote cache if the url
+          # changes between calls, but as long as the repositories are all
+          # based from each other it should still work fine.
+          if remote != 'origin'
+            execute << "#{git} config remote.#{remote}.url #{configuration[:repository]}"
+            execute << "#{git} config remote.#{remote}.fetch +refs/heads/*:refs/remotes/#{remote}/*"
+          end
 
-          if head == 'HEAD'
-            execute += "git merge origin/HEAD"
-          else
-            execute += "git merge #{head}"
+          # since we're in a local branch already, just reset to specified revision rather than merge
+          execute << "#{git} fetch #{remote} && #{git} reset --hard #{revision}"
+
+          if configuration[:git_enable_submodules]
+            execute << "#{git} submodule init"
+            execute << "#{git} submodule update"
           end
 
-          execute
+          execute.join(" && ")
         end
 
         # Returns a string of diffs between two revisions

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

@@ -70,24 +70,25 @@ module Capistrano
           logger.info "[#{stream}] #{text}"
           case text
           when /^user:/mi
-            if variable(:scm_user)
-              "#{variable(:scm_user)}\n"
+            # support :scm_user for backwards compatibility of this module
+            if user = variable(:scm_username) || variable(:scm_user)
+              "#{user}\n"
             else
-              raise "No variable :scm_user specified and Mercurial asked!\n" +
+              raise "No variable :scm_username specified and Mercurial asked!\n" +
                 "Prompt was: #{text}"
             end
-          when /^password:/mi
-            if variable(:scm_password)
-              "#{variable(:scm_password)}\n"
-            else
+          when /\bpassword:/mi
+            unless pass = scm_password_or_prompt
+              # fall back on old behavior of erroring out with msg
               raise "No variable :scm_password specified and Mercurial asked!\n" +
                 "Prompt was: #{text}"
             end
+            "#{pass}\n"
           when /yes\/no/i
             "yes\n"
           end
         end
-
+        
         private
 
         # Fine grained mercurial commands
@@ -122,6 +123,12 @@ module Capistrano
             else        "--verbose"
           end
         end
+        
+        # honor Cap 2.1+'s :scm_prefer_prompt if present
+        def scm_password_or_prompt
+          @scm_password_or_prompt ||= variable(:scm_password) ||
+            (Capistrano::CLI.password_prompt("hg password: ") if variable(:scm_prefer_prompt))
+        end
 
       end
     end

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

@@ -25,21 +25,21 @@ module Capistrano
         # destination directory. The perforce client has a fixed destination so
         # the files must be copied from there to their intended resting place.
         def checkout(revision, destination)
-          p4_sync(revision, destination, "-f")
+          p4_sync(revision, destination, p4sync_flags)
         end
         
         # Returns the command that will sync the given revision to the given
         # destination directory. The perforce client has a fixed destination so
         # the files must be copied from there to their intended resting place.
         def sync(revision, destination)
-          p4_sync(revision, destination, "-f")
+          p4_sync(revision, destination, p4sync_flags)
         end
 
         # Returns the command that will sync the given revision to the given
         # destination directory. The perforce client has a fixed destination so
         # the files must be copied from there to their intended resting place.
         def export(revision, destination)
-          p4_sync(revision, destination, "-f")
+          p4_sync(revision, destination, p4sync_flags)
         end
                
         # Returns the command that will do an "p4 diff2" for the two revisions.
@@ -89,7 +89,6 @@ module Capistrano
           # a fixed destination so the files must be copied from there to their 
           # intended resting place.          
           def p4_sync(revision, destination, options="")
-            p4client_root = "`#{command} #{authentication} client -o | grep ^Root | cut -f2`"
             scm authentication, :sync, options, "#{rev_no(revision)}", "&& cp -rf #{p4client_root} #{destination}"          
           end
 
@@ -108,6 +107,14 @@ module Capistrano
           def p4passwd
             variable(:p4passwd) || variable(:scm_password)
           end
+
+          def p4sync_flags
+            variable(:p4sync_flags) || "-f"
+          end
+
+          def p4client_root
+            variable(:p4client_root) || "`#{command} #{authentication} client -o | grep ^Root | cut -f2`"
+          end
           
           def rev_no(revision)                     
             case revision.to_s

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

@@ -72,7 +72,7 @@ module Capistrano
           case text
           when /\bpassword.*:/i
             # subversion is prompting for a password
-            "#{variable(:scm_password) || variable(:password)}\n"
+            "#{scm_password_prompt}\n"
           when %r{\(yes/no\)}
             # subversion is asking whether or not to connect
             "yes\n"
@@ -80,7 +80,7 @@ module Capistrano
             # subversion is asking for the passphrase for the user's key
             "#{variable(:scm_passphrase)}\n"
           when /The entry \'(.+?)\' is no longer a directory/
-            raise Capisrano::Error, "subversion can't update because directory '#{$1}' was replaced. Please add it to svn:ignore."
+            raise Capistrano::Error, "subversion can't update because directory '#{$1}' was replaced. Please add it to svn:ignore."
           when /accept \(t\)emporarily/
             # subversion is asking whether to accept the certificate
             "t\n"
@@ -107,6 +107,12 @@ module Capistrano
           def verbose
             variable(:scm_verbose) ? nil : "-q"
           end
+
+          def scm_password_prompt
+            @scm_password_prompt ||= variable(:scm_password) ||
+              variable(:password) ||
+              Capistrano::CLI.password_prompt("Subversion password: ")
+          end
       end
 
     end

data/lib/capistrano/role.rb

@@ -0,0 +1,112 @@
+
+module Capistrano
+  class Role
+    include Enumerable
+
+    def initialize(*list)
+      @static_servers = []
+      @dynamic_servers = []
+      push(*list)
+    end
+
+    def each(&block)
+      servers.each &block
+    end
+
+    def push(*list)
+      options = list.last.is_a?(Hash) ? list.pop : {}
+      list.each do |item|
+        if item.respond_to?(:call)
+          @dynamic_servers << DynamicServerList.new(item, options)
+        else
+          @static_servers << self.class.wrap_server(item, options)
+        end
+      end
+    end
+    alias_method :<<, :push
+
+    def servers
+      @static_servers + dynamic_servers
+    end
+    alias_method :to_ary, :servers
+
+    def empty?
+      servers.empty?
+    end
+
+    # Resets the cache, so that proc values may be recalculated.
+    # There should be a command in Configuration::Roles to do this,
+    # but I haven't needed it yet, and I'm not sure yet
+    # what to call that command. Suggestions?
+    def reset!
+      @dynamic_servers.each { |item| item.reset! }
+    end
+
+    # Clears everything. I still thing this should be 'clear!', but that's not
+    # the way Array does it.
+    def clear
+      @dynamic_servers.clear
+      @static_servers.clear
+    end
+
+    # Mostly for documentation purposes. Doesn't seem to do anything.
+    protected
+
+    # This is the combination of a block, a hash of options, and a cached value.
+    # It is protected because it is an implementation detail -- the original
+    # implementation was two lists (blocks and cached results of calling them).
+    class DynamicServerList
+      def initialize (block, options)
+        @block = block
+        @options = options
+        @cached = []
+        @is_cached = false
+      end
+
+      # Convert to a list of ServerDefinitions
+      def to_ary
+        unless @is_cached
+          @cached = Role::wrap_list(@block.call(@options), @options)
+          @is_cached = true
+        end
+        @cached
+      end
+
+      # Clear the cached value
+      def reset!
+        @cached.clear
+        @is_cached = false
+      end
+    end
+
+    # Attribute reader for the cached results of executing the blocks in turn
+    def dynamic_servers
+      @dynamic_servers.inject([]) { |list, item| list.concat item }
+    end
+
+    # Wraps a string in a ServerDefinition, if it isn't already.
+    # This and wrap_list should probably go in ServerDefinition in some form.
+    def self.wrap_server (item, options)
+      item.is_a?(ServerDefinition) ? item : ServerDefinition.new(item, options)
+    end
+
+    # Turns a list, or something resembling a list, into a properly-formatted
+    # ServerDefinition list. Keep an eye on this one -- it's entirely too
+    # magical for its own good. In particular, if ServerDefinition ever inherits
+    # from Array, this will break.
+    def self.wrap_list (*list)
+      options = list.last.is_a?(Hash) ? list.pop : {}
+      if list.length == 1
+        if list.first.nil?
+          return []
+        elsif list.first.is_a?(Array)
+          list = list.first
+        end
+      end
+      options.merge! list.pop if list.last.is_a?(Hash)
+      list.map do |item|
+        self.wrap_server item, options
+      end
+    end
+  end
+end

data/lib/capistrano/ssh.rb

@@ -1,3 +1,9 @@
+begin
+  require 'rubygems'
+  gem 'net-ssh', "< 1.99.0"
+rescue LoadError, NameError
+end
+
 require 'net/ssh'
 
 module Capistrano

data/lib/capistrano/task_definition.rb

@@ -3,12 +3,13 @@ require 'capistrano/server_definition'
 module Capistrano
   # Represents the definition of a single task.
   class TaskDefinition
-    attr_reader :name, :namespace, :options, :body, :desc, :on_error
+    attr_reader :name, :namespace, :options, :body, :desc, :on_error, :max_hosts
 
     def initialize(name, namespace, options={}, &block)
       @name, @namespace, @options = name, namespace, options
       @desc = @options.delete(:desc)
       @on_error = options.delete(:on_error)
+      @max_hosts = options[:max_hosts] && options[:max_hosts].to_i
       @body = block or raise ArgumentError, "a task requires a block"
       @servers = nil
     end

data/lib/capistrano/upload.rb

@@ -1,3 +1,9 @@
+begin
+  require 'rubygems'
+  gem 'net-sftp', "< 1.99.0"
+rescue LoadError, NameError
+end
+
 require 'net/sftp'
 require 'net/sftp/operations/errors'
 require 'capistrano/errors'
@@ -42,7 +48,7 @@ module Capistrano
     #
     # * data: required. Should refer to a String containing the contents of
     #   the file to upload.
-    # * mode: optional. The "mode" of the destination file. Defaults to 0660.
+    # * mode: optional. The "mode" of the destination file. Defaults to 0664.
     # * logger: optional. Should point to a Capistrano::Logger instance, if
     #   given.
     def initialize(sessions, filename, options)

data/lib/capistrano/version.rb

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

data/test/configuration/connections_test.rb

@@ -217,7 +217,6 @@ class ConfigurationConnectionsTest < Test::Unit::TestCase
     @config.current_task = mock_task(:on_error => :continue)
     @config.expects(:find_servers_for_task).with(@config.current_task, {}).returns(list)
     Capistrano::SSH.expects(:connect).times(2).raises(Exception).then.returns(:success)
-    @config.expects(:failed!).with(server("cap1"))
     @config.execute_on_servers do |servers|
       assert_equal %w(cap2), servers.map { |s| s.host }
     end
@@ -260,7 +259,7 @@ class ConfigurationConnectionsTest < Test::Unit::TestCase
       assert_equal %w(cap2), servers.map { |s| s.host }
     end
   end
-
+  
   def test_connect_should_establish_connections_to_all_servers_in_scope
     assert @config.sessions.empty?
     @config.current_task = mock_task
@@ -269,7 +268,43 @@ class ConfigurationConnectionsTest < Test::Unit::TestCase
     @config.connect!
     assert_equal %w(cap1 cap2 cap3), @config.sessions.keys.sort.map { |s| s.host }
   end
-
+  
+  def test_execute_on_servers_should_only_run_on_tasks_max_hosts_hosts_at_once
+    cap1 = server("cap1")
+    cap2 = server("cap2")
+    connection1 = mock()
+    connection2 = mock()
+    connection1.expects(:close)
+    connection2.expects(:close)
+    @config.current_task = mock_task(:max_hosts => 1)
+    @config.expects(:find_servers_for_task).with(@config.current_task, {}).returns([cap1, cap2])
+    Capistrano::SSH.expects(:connect).times(2).returns(connection1).then.returns(connection2)
+    block_called = 0
+    @config.execute_on_servers do |servers|
+      block_called += 1
+      assert_equal 1, servers.size
+    end
+    assert_equal 2, block_called
+  end
+  
+  def test_execute_on_servers_should_only_run_on_max_hosts_hosts_at_once
+    cap1 = server("cap1")
+    cap2 = server("cap2")
+    connection1 = mock()
+    connection2 = mock()
+    connection1.expects(:close)
+    connection2.expects(:close)
+    @config.current_task = mock_task(:max_hosts => 1)
+    @config.expects(:find_servers_for_task).with(@config.current_task, {}).returns([cap1, cap2])
+    Capistrano::SSH.expects(:connect).times(2).returns(connection1).then.returns(connection2)
+    block_called = 0
+    @config.execute_on_servers do |servers|
+      block_called += 1
+      assert_equal 1, servers.size
+    end
+    assert_equal 2, block_called
+  end
+  
   def test_connect_should_honor_once_option
     assert @config.sessions.empty?
     @config.current_task = mock_task
@@ -283,6 +318,11 @@ class ConfigurationConnectionsTest < Test::Unit::TestCase
 
     def mock_task(options={})
       continue_on_error = options[:on_error] == :continue
-      stub("task", :fully_qualified_name => "name", :options => options, :continue_on_error? => continue_on_error)
+      stub("task",
+        :fully_qualified_name => "name",
+        :options => options,
+        :continue_on_error? => continue_on_error,
+        :max_hosts => options[:max_hosts]
+      )
     end
 end

data/test/configuration/namespace_dsl_test.rb

@@ -294,4 +294,12 @@ class ConfigurationNamespacesDSLTest < Test::Unit::TestCase
     @config.namespace(:outer) { namespace(:middle) { namespace(:inner) {} } }
     assert_equal @config, @config.namespaces[:outer].namespaces[:middle].namespaces[:inner].top
   end
+
+  def test_find_task_should_return_nil_when_empty_inner_task
+    @config.namespace :outer do
+      namespace :inner do
+      end
+    end
+    assert_nil @config.find_task("outer::inner")
+  end
 end

data/test/configuration/roles_test.rb

@@ -1,5 +1,6 @@
 require "#{File.dirname(__FILE__)}/../utils"
 require 'capistrano/configuration/roles'
+require 'capistrano/server_definition'
 
 class ConfigurationRolesTest < Test::Unit::TestCase
   class MockConfig
@@ -29,13 +30,34 @@ class ConfigurationRolesTest < Test::Unit::TestCase
   def test_role_with_one_argument_should_add_to_roles_collection
     @config.role :app, "app1.capistrano.test"
     assert_equal [:app], @config.roles.keys
-    assert_equal %w(app1.capistrano.test), @config.roles[:app].map { |s| s.host }
+    assert_role_equals %w(app1.capistrano.test)
+  end
+
+  def test_role_block_returning_single_string_is_added_to_roles_collection
+    @config.role :app do
+      'app1.capistrano.test'
+    end
+    assert_role_equals %w(app1.capistrano.test)
   end
 
   def test_role_with_multiple_arguments_should_add_each_to_roles_collection
     @config.role :app, "app1.capistrano.test", "app2.capistrano.test"
     assert_equal [:app], @config.roles.keys
-    assert_equal %w(app1.capistrano.test app2.capistrano.test), @config.roles[:app].map { |s| s.host }
+    assert_role_equals %w(app1.capistrano.test app2.capistrano.test)
+  end
+
+  def test_role_with_block_and_strings_should_add_both_to_roles_collection
+    @config.role :app, 'app1.capistrano.test' do
+      'app2.capistrano.test'
+    end
+    assert_role_equals %w(app1.capistrano.test app2.capistrano.test)
+  end
+
+  def test_role_block_returning_array_should_add_each_to_roles_collection
+    @config.role :app do
+      ['app1.capistrano.test', 'app2.capistrano.test']
+    end
+    assert_role_equals %w(app1.capistrano.test app2.capistrano.test)
   end
 
   def test_role_with_options_should_apply_options_to_each_argument
@@ -44,4 +66,78 @@ class ConfigurationRolesTest < Test::Unit::TestCase
       assert_equal({:extra => :value}, server.options)
     end
   end
-end
+
+  def test_role_with_options_should_apply_options_to_block_results
+    @config.role :app, :extra => :value do
+      ['app1.capistrano.test', 'app2.capistrano.test']
+    end
+    @config.roles[:app].each do |server|
+      assert_equal({:extra => :value}, server.options)
+    end
+  end
+
+  def test_options_should_apply_only_to_this_argument_set
+    @config.role :app, 'app1.capistrano.test', 'app2.capistrano.test' do
+      ['app3.capistrano.test', 'app4.capistrano.test']
+    end
+    @config.role :app, 'app5.capistrano.test', 'app6.capistrano.test', :extra => :value do
+      ['app7.capistrano.test', 'app8.capistrano.test']
+    end
+    @config.role :app, 'app9.capistrano.test'
+
+    option_hosts = ['app5.capistrano.test', 'app6.capistrano.test', 'app7.capistrano.test', 'app8.capistrano.test']
+    @config.roles[:app].each do |server|
+      if (option_hosts.include? server.host)
+        assert_equal({:extra => :value}, server.options)
+      else
+        assert_not_equal({:extra => :value}, server.options)
+      end
+    end
+  end
+
+  # Here, the source should be more readable than the method name
+  def test_role_block_returns_options_hash_is_merged_with_role_options_argument
+    @config.role :app, :first => :one, :second => :two do
+      ['app1.capistrano.test', 'app2.capistrano.test', {:second => :please, :third => :three}]
+    end
+    @config.roles[:app].each do |server|
+      assert_equal({:first => :one, :second => :please, :third => :three}, server.options)
+    end
+  end
+
+  def test_role_block_can_override_role_options_argument
+    @config.role :app, :value => :wrong do
+      Capistrano::ServerDefinition.new('app.capistrano.test')
+    end
+    @config.roles[:app].servers
+    @config.roles[:app].servers.each do |server|
+      assert_not_equal({:value => :wrong}, server.options)
+    end
+  end
+
+  def test_role_block_can_return_nil
+    @config.role :app do
+      nil
+    end
+    assert_role_equals ([])
+  end
+
+  def test_role_block_can_return_empty_array
+    @config.role :app do
+      []
+    end
+    assert_role_equals ([])
+  end
+
+  def test_role_definitions_via_server_should_associate_server_with_roles
+    @config.server "www.capistrano.test", :web, :app
+    assert_equal %w(www.capistrano.test), @config.roles[:app].map { |s| s.host }
+    assert_equal %w(www.capistrano.test), @config.roles[:web].map { |s| s.host }
+  end
+
+  private
+
+    def assert_role_equals(list)
+      assert_equal list, @config.roles[:app].map { |s| s.host }
+    end
+end

data/test/deploy/scm/git_test.rb

@@ -15,18 +15,28 @@ class DeploySCMGitTest < Test::Unit::TestCase
 
   def test_head
     assert_equal "HEAD", @source.head
+    
+    # With :branch
     @config[:branch] = "master"
     assert_equal "master", @source.head
   end
 
+  def test_origin
+    assert_equal "origin", @source.origin
+    @config[:remote] = "username"
+    assert_equal "username", @source.origin
+  end
+
   def test_checkout
     @config[:repository] = "git@somehost.com:project.git"
     dest = "/var/www"
-    assert_equal "git clone git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy HEAD", @source.checkout('Not used', dest)
+    rev = 'c2d9e79'
+    assert_equal "git clone git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy #{rev}", @source.checkout(rev, dest)
 
-    # With branch
-    @config[:branch] = "origin/foo"
-    assert_equal "git clone git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy origin/foo", @source.checkout('Not used', dest)
+    # With :scm_command
+    git = "/opt/local/bin/git"
+    @config[:scm_command] = git
+    assert_equal "#{git} clone git@somehost.com:project.git /var/www && cd /var/www && #{git} checkout -b deploy #{rev}", @source.checkout(rev, dest)
   end
 
   def test_diff
@@ -51,22 +61,41 @@ class DeploySCMGitTest < Test::Unit::TestCase
 
   def test_sync
     dest = "/var/www"
-    assert_equal "cd #{dest} && git fetch origin && git merge origin/HEAD", @source.sync('Not used', dest)
+    rev = 'c2d9e79'
+    assert_equal "cd #{dest} && git fetch origin && git reset --hard #{rev}", @source.sync(rev, dest)
+
+    # With :scm_command
+    git = "/opt/local/bin/git"
+    @config[:scm_command] = git
+    assert_equal "cd #{dest} && #{git} fetch origin && #{git} reset --hard #{rev}", @source.sync(rev, dest)
+  end
+
+  def test_sync_with_remote
+    dest = "/var/www"
+    rev = 'c2d9e79'
+    remote = "username"
+    repository = "git@somehost.com:project.git"
+
+    @config[:repository] = repository
+    @config[:remote] = remote
 
-    # With branch
-    @config[:branch] = "origin/foo"
-    assert_equal "cd #{dest} && git fetch origin && git merge origin/foo", @source.sync('Not used', dest)
+    assert_equal "cd #{dest} && git config remote.#{remote}.url #{repository} && git config remote.#{remote}.fetch +refs/heads/*:refs/remotes/#{remote}/* && git fetch #{remote} && git reset --hard #{rev}", @source.sync(rev, dest)
   end
 
   def test_shallow_clone
     @config[:repository] = "git@somehost.com:project.git"
     @config[:git_shallow_clone] = 1
     dest = "/var/www"
-    assert_equal "git clone --depth 1 git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy HEAD", @source.checkout('Not used', dest)
+    rev = 'c2d9e79'
+    assert_equal "git clone --depth 1 git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy #{rev}", @source.checkout(rev, dest)
+  end
 
-    # With branch
-    @config[:branch] = "origin/foo"
-    assert_equal "git clone --depth 1 git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy origin/foo", @source.checkout('Not used', dest)
+  def test_remote_clone
+    @config[:repository] = "git@somehost.com:project.git"
+    @config[:remote] = "username"
+    dest = "/var/www"
+    rev = 'c2d9e79'
+    assert_equal "git clone -o username git@somehost.com:project.git /var/www && cd /var/www && git checkout -b deploy #{rev}", @source.checkout(rev, dest)
   end
 
   # Tests from base_test.rb, makin' sure we didn't break anything up there!

data/test/deploy/scm/mercurial_test.rb

@@ -0,0 +1,123 @@
+require "#{File.dirname(__FILE__)}/../../utils"
+require 'capistrano/recipes/deploy/scm/mercurial'
+
+class DeploySCMMercurialTest < Test::Unit::TestCase
+  class TestSCM < Capistrano::Deploy::SCM::Mercurial
+    default_command "hg"
+  end
+
+  def setup
+    @config = { }
+    def @config.exists?(name); key?(name); end
+
+    @source = TestSCM.new(@config)
+  end
+
+  def test_head
+    assert_equal "tip", @source.head
+  end
+
+  def test_checkout
+    @config[:repository] = "http://example.com/project-hg"
+    dest = "/var/www"
+    assert_equal "hg clone --noupdate http://example.com/project-hg /var/www && hg update --repository /var/www --clean 8a8e00b8f11b", @source.checkout('8a8e00b8f11b', dest)
+  end
+
+  def test_diff
+    assert_equal "hg diff --rev tip", @source.diff('tip')
+    assert_equal "hg diff --rev 1 --rev 2", @source.diff('1', '2')
+  end
+
+  def test_log
+    assert_equal "hg log --rev 8a8e00b8f11b", @source.log('8a8e00b8f11b')
+    assert_equal "hg log --rev 0:3", @source.log('0', '3')
+  end
+
+  def test_query_revision
+    assert_equal "hg log -r 8a8e00b8f11b --template '{node|short}'", @source.query_revision('8a8e00b8f11b') { |o| o }
+  end
+
+  def test_username_should_be_backwards_compatible
+    # older versions of this module required :scm_user var instead
+    # of the currently preferred :scm_username
+    require 'capistrano/logger'
+    @config[:scm_user] = "fred"
+    text = "user:"
+    assert_equal "fred\n", @source.handle_data(:test_state, :test_stream, text)
+    # :scm_username takes priority
+    @config[:scm_username] = "wilma"
+    assert_equal "wilma\n", @source.handle_data(:test_state, :test_stream, text)
+  end
+
+  def test_sync
+    dest = "/var/www"
+    assert_equal "hg pull --repository /var/www && hg update --repository /var/www --clean 8a8e00b8f11b", @source.sync('8a8e00b8f11b', dest)
+
+    # With :scm_command
+    @config[:scm_command] = "/opt/local/bin/hg"
+    assert_equal "/opt/local/bin/hg pull --repository /var/www && /opt/local/bin/hg update --repository /var/www --clean 8a8e00b8f11b", @source.sync('8a8e00b8f11b', dest)
+  end
+  
+  def test_export
+    dest = "/var/www"
+    assert_raise(NotImplementedError) { @source.export('8a8e00b8f11b', dest) }
+  end
+  
+  def test_sends_password_if_set
+    require 'capistrano/logger'
+    text = "password:"
+    @config[:scm_password] = "opensesame"
+    assert_equal "opensesame\n", @source.handle_data(:test_state, :test_stream, text)
+  end
+  
+  def test_prompts_for_password_if_preferred
+    require 'capistrano/logger'
+    require 'capistrano/cli'
+    Capistrano::CLI.stubs(:password_prompt).with("hg password: ").returns("opensesame")
+    @config[:scm_prefer_prompt] = true
+    text = "password:"
+    assert_equal "opensesame\n", @source.handle_data(:test_state, :test_stream, text)
+  end
+
+
+  # Tests from base_test.rb, makin' sure we didn't break anything up there!
+  def test_command_should_default_to_default_command
+    assert_equal "hg", @source.command
+    @source.local { assert_equal "hg", @source.command }
+  end
+
+  def test_command_should_use_scm_command_if_available
+    @config[:scm_command] = "/opt/local/bin/hg"
+    assert_equal "/opt/local/bin/hg", @source.command
+  end
+
+  def test_command_should_use_scm_command_in_local_mode_if_local_scm_command_not_set
+    @config[:scm_command] = "/opt/local/bin/hg"
+    @source.local { assert_equal "/opt/local/bin/hg", @source.command }
+  end
+
+  def test_command_should_use_local_scm_command_in_local_mode_if_local_scm_command_is_set
+    @config[:scm_command] = "/opt/local/bin/hg"
+    @config[:local_scm_command] = "/usr/local/bin/hg"
+    assert_equal "/opt/local/bin/hg", @source.command
+    @source.local { assert_equal "/usr/local/bin/hg", @source.command }
+  end
+
+  def test_command_should_use_default_if_scm_command_is_default
+    @config[:scm_command] = :default
+    assert_equal "hg", @source.command
+  end
+
+  def test_command_should_use_default_in_local_mode_if_local_scm_command_is_default
+    @config[:scm_command] = "/foo/bar/hg"
+    @config[:local_scm_command] = :default
+    @source.local { assert_equal "hg", @source.command }
+  end
+
+  def test_local_mode_proxy_should_treat_messages_as_being_in_local_mode
+    @config[:scm_command] = "/foo/bar/hg"
+    @config[:local_scm_command] = :default
+    assert_equal "hg", @source.local.command
+    assert_equal "/foo/bar/hg", @source.command
+  end
+end

metadata

@@ -1,33 +1,59 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: capistrano
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
-date: 2007-10-14 00:00:00 -06:00
-summary: Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH.
-require_paths: 
-- lib
-email: jamis@37signals.com
-homepage: http://www.capify.org
-rubyforge_project: 
-description: 
-autorequire: capistrano
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 2.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.10
+    - - <
+      - !ruby/object:Gem::Version 
+        version: 1.99.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    - - <
+      - !ruby/object:Gem::Version 
+        version: 1.99.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jamis@37signals.com
+executables: 
+- cap
+- capify
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - bin/cap
 - bin/capify
@@ -91,6 +117,7 @@ files:
 - lib/capistrano/recipes/templates
 - lib/capistrano/recipes/templates/maintenance.rhtml
 - lib/capistrano/recipes/upgrade.rb
+- lib/capistrano/role.rb
 - lib/capistrano/server_definition.rb
 - lib/capistrano/shell.rb
 - lib/capistrano/ssh.rb
@@ -125,6 +152,7 @@ files:
 - test/deploy/scm/accurev_test.rb
 - test/deploy/scm/base_test.rb
 - test/deploy/scm/git_test.rb
+- test/deploy/scm/mercurial_test.rb
 - test/deploy/strategy
 - test/deploy/strategy/copy_test.rb
 - test/extensions_test.rb
@@ -144,44 +172,31 @@ files:
 - README
 - MIT-LICENSE
 - CHANGELOG
-test_files: []
-
+has_rdoc: true
+homepage: http://www.capify.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: 
-- cap
-- capify
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: net-ssh
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.10
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: net-sftp
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.1.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: highline
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
+rubyforge_project: capistrano
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH.
+test_files: []
+