capistrano 1.4.2 → 2.0.0

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

@@ -0,0 +1,85 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the darcs revision
+      # control system (http://www.abridgegame.org/darcs/).
+      class Darcs < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "darcs"
+
+        # Because darcs does not have any support for pseudo-ids, we'll just
+        # return something here that we can use in the helpers below for
+        # determining whether we need to look up the latest revision.
+        def head
+          :head
+        end
+
+        # Returns the command that will check out the given revision to the
+        # given destination. The 'revision' parameter must be the 'hash' value
+        # for the revision in question, as given by 'darcs changes --xml-output'.
+        def checkout(revision, destination)
+          scm :get, verbose, "--repo-name=#{destination}", "--to-match='hash #{revision}'", repository
+        end
+
+        # Tries to update the destination repository in-place, to bring it up
+        # to the given revision. Note that because darcs' "pull" operation
+        # does not support a "to-match" argument (or similar), this basically
+        # nukes the destination directory and re-gets it.
+        def sync(revision, destination)
+          ["rm -rf #{destination}", checkout(revision, destination)].join(" && ")
+        end
+
+        # Darcs does not have a real 'export' option; there is 'darcs dist',
+        # but that presupposes a utility that can untar and ungzip the dist
+        # file. We'll cheat and just do a get, followed by a deletion of the
+        # _darcs metadata directory.
+        def export(revision, destination)
+          [checkout(revision, destination), "rm -rf #{destination}/_darcs"].join(" && ")
+        end
+
+        # Returns the command that will do a "darcs diff" for the two revisions.
+        # Each revision must be the 'hash' identifier of a darcs revision.
+        def diff(from, to=nil)
+          scm :diff, "--from-match 'hash #{from}'", to && "--to-match 'hash #{to}'"
+        end
+
+        # Returns the log of changes between the two revisions. Each revision
+        # must be the 'hash' identifier of a darcs revision.
+        def log(from, to=nil)
+          scm :changes, "--from-match 'hash #{from}'", to && "--to-match 'hash #{to}'", "--repo=#{repository}"
+        end
+
+        # Attempts to translate the given revision identifier to a "real"
+        # revision. If the identifier is a symbol, it is assumed to be a
+        # pseudo-id. Otherwise, it will be immediately returned. If it is a
+        # pseudo-id, a set of commands to execute will be yielded, and the
+        # result of executing those commands must be returned by the block.
+        # This method will then extract the actual revision hash from the
+        # returned data.
+        def query_revision(revision)
+          case revision
+          when :head
+            xml = yield(scm(:changes, "--last 1", "--xml-output", "--repo=#{repository}"))
+            return xml[/hash='(.*?)'/, 1]
+          else return revision
+          end
+        end
+
+        private
+
+          def verbose
+            case variable(:scm_verbose)
+            when nil then "-q"
+            when false then nil
+            else "-v"
+            end
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# Copyright 2007 Matthew Elder <sseses@gmail.com>
+# based on work by Tobias Luetke
+
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the Mercurial revision
+      # control system (http://www.selenic.com/mercurial/).
+      # Latest updates at http://tackletechnology.org/oss/cap2-mercurial
+      class Mercurial < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "hg"
+
+        # For mercurial HEAD == tip except that it bases this assumption on what
+        # tip is in the current repository (so push before you deploy)
+        def head
+          "tip"
+        end
+
+        # Clone the repository and update to the specified changeset.
+        def checkout(changeset, destination)
+          clone(destination) + " && " + update(changeset, destination)
+        end
+
+        # Pull from the repository and update to the specified changeset.
+        def sync(changeset, destination)
+          pull(destination) + " && " + update(changeset, destination)
+        end
+
+        # One day we will have hg archive, although i think its not needed
+        def export(revision, destination)
+          raise NotImplementedError, "`diff' is not implemented by #{self.class.name}" +
+          "use checkout strategy"
+        end
+
+        # Compute the difference between the two changesets +from+ and +to+
+        # as a unified diff.
+        def diff(from, to=nil)
+          scm :diff,
+              "--rev #{from}",
+              (to ? "--rev #{to}" : nil)
+        end
+
+        # Return a log of all changes between the two specified changesets,
+        # +from+ and +to+, inclusive or the log for +from+ if +to+ is omitted.
+        def log(from, to=nil)
+          scm :log,
+              verbose,
+              "--rev #{from}" +
+              (to ? ":#{to}" : "")
+        end
+
+        # Translates a tag to a changeset if needed or just returns changeset.
+        def query_revision(changeset)
+          cmd = scm :log,
+                    verbose,
+                    "-r #{changeset}",
+                    "--template '{node|short}'"
+                    yield cmd
+        end
+
+        # Determine response for SCM prompts
+        # user/pass can come from ssh and http distribution methods
+        # yes/no is for when ssh asks you about fingerprints
+        def handle_data(state, stream, text)
+          logger.info "[#{stream}] #{text}"
+          case text
+          when /^user:/mi
+            if variable(:scm_user)
+              "#{variable(:scm_user)}\n"
+            else
+              raise "No variable :scm_user specified and Mercurial asked!\n" +
+                "Prompt was: #{text}"
+            end
+          when /^password:/mi
+            if variable(:scm_password)
+              "#{variable(:scm_password)}\n"
+            else
+              raise "No variable :scm_password specified and Mercurial asked!\n" +
+                "Prompt was: #{text}"
+            end
+          when /yes\/no/i
+            "yes\n"
+          end
+        end
+
+        private
+
+        # Fine grained mercurial commands
+        def clone(destination) 
+          scm :clone,
+              verbose,
+              "--noupdate", # do not update to tip when cloning is done
+              repository,   # clone which repository?
+              destination   # and put the clone where?
+        end
+
+        def pull(destination)
+          scm :pull,
+              verbose,
+              "--repository #{destination}", # pull changes into what?
+              repository                     # and pull the changes from?
+        end
+
+        def update(changeset, destination)
+          scm :update,
+              verbose,
+              "--repository #{destination}", # update what?
+              "--clean",                     # ignore untracked changes
+              changeset                      # update to this changeset
+        end
+
+        # verbosity configuration grokking :)
+        def verbose
+          case variable(:scm_verbose)
+            when nil:   nil
+            when false: "--quiet"
+            else        "--verbose"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+# Notes: 
+#  no global verbose flag for scm_verbose
+#  sync, checkout and export are just sync in p4
+#  
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the Perforce revision
+      # control system (http://www.perforce.com).
+      class Perforce < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "p4"
+
+        # Perforce understands '#head' to refer to the latest revision in the
+        # depot.
+        def head
+          'head'
+        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 checkout(revision, destination)
+          p4_sync(revision, destination, "-f")
+        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")
+        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")
+        end
+               
+        # Returns the command that will do an "p4 diff2" for the two revisions.
+        def diff(from, to=head)
+          scm authentication, :diff2, "-u -db", "//#{p4client}/...#{rev_no(from)}", "//#{p4client}/...#{rev_no(to)}"
+        end
+
+        # Returns a "p4 changes" command for the two revisions.
+        def log(from=1, to=head)
+          scm authentication, :changes, "-s submitted", "//#{p4client}/...#{rev_no(from)},#(rev_no(to)}"
+        end
+
+        def query_revision(revision)
+          return revision if revision.to_s =~ /^\d+$/
+          command = scm(authentication, :changes, "-s submitted", "-m 1", "//#{p4client}/...#{rev_no(revision)}")
+          yield(command)[/Change (\d+) on/, 1]
+        end
+
+        # Determines what the response should be for a particular bit of text
+        # from the SCM. Password prompts, connection requests, passphrases,
+        # etc. are handled here.
+        def handle_data(state, stream, text)
+          case text
+          when /\(P4PASSWD\) invalid or unset\./i
+	          raise Capistrano::Error, "scm_password (or p4passwd) is incorrect or unset"
+          when /Can.t create a new user.*/i
+	          raise Capistrano::Error, "scm_username (or p4user) is incorrect or unset"
+          when /Perforce client error\:/i	 
+	          raise Capistrano::Error, "p4port is incorrect or unset"
+          when /Client \'[\w\-\_\.]+\' unknown.*/i
+	          raise Capistrano::Error, "p4client is incorrect or unset"
+          end	             
+        end
+
+        private
+
+          # Builds the set of authentication switches that perforce understands.
+          def authentication
+            [ p4port   && "-p #{p4port}",
+              p4user   && "-u #{p4user}",
+              p4passwd && "-P #{p4passwd}",
+              p4client && "-c #{p4client}" ].compact.join(" ")
+          end
+
+          # Returns the command that will sync the given revision to the given
+          # destination directory with specific options. The perforce client has 
+          # 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
+
+          def p4client
+            variable(:p4client)
+          end
+
+          def p4port
+            variable(:p4port)
+          end
+
+          def p4user
+            variable(:p4user) || variable(:scm_username)
+          end
+          
+          def p4passwd
+            variable(:p4passwd) || variable(:scm_password)
+          end
+          
+          def rev_no(revision)                     
+            case revision.to_s
+            when "head"
+              "#head"
+            when /^\d+/  
+              "@#{revision}"
+            else
+              revision
+            end          
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+require 'capistrano/recipes/deploy/scm/base'
+require 'yaml'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the Subversion revision
+      # control system (http://subversion.tigris.org).
+      class Subversion < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "svn"
+
+        # Subversion understands 'HEAD' to refer to the latest revision in the
+        # repository.
+        def head
+          "HEAD"
+        end
+
+        # Returns the command that will check out the given revision to the
+        # given destination.
+        def checkout(revision, destination)
+          scm :checkout, verbose, authentication, "-r#{revision}", repository, destination
+        end
+
+        # Returns the command that will do an "svn update" to the given
+        # revision, for the working copy at the given destination.
+        def sync(revision, destination)
+          scm :update, verbose, authentication, "-r#{revision}", destination
+        end
+
+        # Returns the command that will do an "svn export" of the given revision
+        # to the given destination.
+        def export(revision, destination)
+          scm :export, verbose, authentication, "-r#{revision}", repository, destination
+        end
+
+        # Returns the command that will do an "svn diff" for the two revisions.
+        def diff(from, to=nil)
+          scm :diff, repository, authentication, "-r#{from}:#{to || head}"
+        end
+
+        # Returns an "svn log" command for the two revisions.
+        def log(from, to=nil)
+          scm :log, repository, authentication, "-r#{from}:#{to || head}"
+        end
+
+        # Attempts to translate the given revision identifier to a "real"
+        # revision. If the identifier is an integer, it will simply be returned.
+        # Otherwise, this will yield a string of the commands it needs to be
+        # executed (svn info), and will extract the revision from the response.
+        def query_revision(revision)
+          return revision if revision =~ /^\d+$/
+          result = yield(scm(:info, repository, authentication, "-r#{revision}"))
+          YAML.load(result)['Revision']
+        end
+
+        # Determines what the response should be for a particular bit of text
+        # from the SCM. Password prompts, connection requests, passphrases,
+        # etc. are handled here.
+        def handle_data(state, stream, text)
+	        logger.info "[#{stream}] #{text}"
+          case text
+          when /\bpassword.*:/i
+            # subversion is prompting for a password
+            "#{variable(:scm_password) || variable(:password)}\n"
+          when %r{\(yes/no\)}
+            # subversion is asking whether or not to connect
+            "yes\n"
+          when /passphrase/i
+            # 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."
+          when /accept \(t\)emporarily/
+            # subversion is asking whether to accept the certificate
+            "t\n"
+          end
+        end
+
+        private
+
+          # If a username or password is configured for the SCM, return the
+          # command-line switches for those values.
+          def authentication
+            auth = ""
+            auth << "--username #{variable(:scm_username)} " if variable(:scm_username)
+            auth << "--password #{variable(:scm_password)} " if variable(:scm_password)
+            auth << "--no-auth-cache" if !auth.empty?
+            auth
+          end
+
+          # If verbose output is requested, return nil, otherwise return the
+          # command-line switch for "quiet" ("-q").
+          def verbose
+            variable(:scm_verbose) ? nil : "-q"
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Capistrano
+  module Deploy
+    module Strategy
+      def self.new(strategy, config={})
+        strategy_file = "capistrano/recipes/deploy/strategy/#{strategy}"
+        require(strategy_file)
+
+        strategy_const = strategy.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+        if const_defined?(strategy_const)
+          const_get(strategy_const).new(config)
+        else
+          raise Capistrano::Error, "could not find `#{name}::#{strategy_const}' in `#{strategy_file}'"
+        end
+      rescue LoadError
+        raise Capistrano::Error, "could not find any strategy named `#{strategy}'"
+      end
+    end
+  end
+end