capistrano-edge 2.5.6

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

@@ -0,0 +1,83 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the Bazaar-NG revision
+      # control system (http://bazaar-vcs.org/).
+      class Bzr < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "bzr"
+
+        # Bazaar-NG doesn't support any pseudo-id's, so we'll use the convention
+        # in this adapter that the :head symbol means the most recently
+        # committed revision.
+        def head
+          :head
+        end
+
+        # Returns the command that will check out the given revision to the
+        # given destination.
+        def checkout(revision, destination)
+          scm :checkout, "--lightweight", revswitch(revision), repository, destination
+        end
+
+        # The bzr 'update' command does not support updating to a specific
+        # revision, so this just does update, followed by revert (unless
+        # updating to head).
+        def sync(revision, destination)
+          commands = [scm(:update, destination)]
+          commands << [scm(:revert, revswitch(revision), destination)] if revision != head
+          commands.join(" && ")
+        end
+
+        # The bzr 'export' does an export similar to other SCM systems
+        def export(revision, destination)
+          scm :export, revswitch(revision), destination, repository
+        end
+
+        # The bzr "diff" command doesn't accept a repository argument, so it
+        # must be run from within a working tree.
+        def diff(from, to=nil)
+          switch = "-r#{from}"
+          switch << "..#{to}" if to
+
+          scm :diff, switch
+        end
+
+        # Returns a log of changes between the two revisions (inclusive).
+        def log(from, to=nil)
+          scm :log, "--short", "-r#{from}..#{to}", repository
+        end
+
+        # Attempts to translate the given revision identifier to a "real"
+        # revision. If the identifier is :head, the "bzr revno" command will
+        # be yielded, and the block must execute the command and return the
+        # output. The revision will be extracted from the output and returned.
+        # If the 'revision' argument, on the other hand, is not :head, it is
+        # simply returned.
+        def query_revision(revision)
+          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 || revision.nil?
+              nil
+            else
+              "-r #{revision}"
+            end
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # Implements the Capistrano SCM interface for the CVS revision
+      # control system.
+      class Cvs < Base
+        # Sets the default command name for this SCM. Users may override this
+        # by setting the :scm_command variable.
+        default_command "cvs"
+
+        # CVS 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)
+          [ prep_destination(destination),
+            scm(verbose, cvs_root, :checkout, cvs_revision(revision), cvs_destination(destination), variable(:scm_module))
+          ].join(' && ')
+        end
+
+        # Returns the command that will do an "cvs update" to the given
+        # revision, for the working copy at the given destination.
+        def sync(revision, destination)
+          [ prep_destination(destination),
+            scm(verbose, cvs_root, :update, cvs_revision(revision), cvs_destination(destination))
+          ].join(' && ')
+        end
+
+        # Returns the command that will do an "cvs export" of the given revision
+        # to the given destination.
+        def export(revision, destination)
+          [ prep_destination(destination),
+            scm(verbose, cvs_root, :export, cvs_revision(revision), cvs_destination(destination), variable(:scm_module))
+          ].join(' && ')
+        end
+
+        # Returns the command that will do an "cvs diff" for the two revisions.
+        def diff(from, to=nil)
+          rev_type = revision_type(from)
+          if rev_type == :date
+            range_args = "-D '#{from}' -D '#{to || 'now'}'"
+          else
+            range_args = "-r '#{from}' -r '#{to || head}'"
+          end
+          scm cvs_root, :diff, range_args
+        end
+
+        # Returns an "cvs log" command for the two revisions.
+        def log(from, to=nil)
+          rev_type = revision_type(from)
+          if rev_type == :date
+            range_arg = "-d '#{from}<#{to || 'now'}'"
+          else
+            range_arg = "-r '#{from}:#{to || head}'"
+          end
+          scm cvs_root, :log, range_arg
+        end
+
+        # Unfortunately, cvs doesn't support the concept of a revision number like 
+        # subversion and other SCM's do.  For now, we'll rely on getting the timestamp
+        # of the latest checkin under the revision that's passed to us.
+        def query_revision(revision)
+          return revision if revision_type(revision) == :date
+          revision = yield(scm(cvs_root, :log, "-r#{revision}")).
+                       grep(/^date:/).
+                       map { |line| line[/^date: (.*?);/, 1] }.
+                       sort.last + " UTC"
+          return 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
+            # prompting for a password
+            "#{variable(:scm_password) || variable(:password)}\n"
+          when %r{\(yes/no\)}
+            # let's be agreeable...
+            "yes\n"
+          end
+        end
+
+        private
+
+          # Constructs the CVSROOT command-line option
+          def cvs_root
+            root = ""
+            root << "-d #{repository} " if repository
+            root
+          end
+          
+          # Constructs the destination dir command-line option
+          def cvs_destination(destination)
+            dest = ""
+            if destination
+              dest_parts = destination.split(/\//);
+              dest << "-d #{dest_parts.pop}"
+            end
+            dest
+          end
+          
+          # attempts to guess what type of revision we're working with
+          def revision_type(rev)
+            return :date if rev =~ /^\d{4}\/\d{2}\/\d{2} \d{2}:\d{2}:\d{2} UTC$/ # i.e 2007-05-15 08:13:25 UTC
+            return :date if rev =~ /^\d{4}\/\d{2}\/\d{2} \d{2}:\d{2}:\d{2}$/ # i.e 2007-05-15 08:13:25
+            return :revision if rev =~ /^\d/ # i.e. 1.2.1
+            return :tag # i.e. RELEASE_1_2
+          end
+          
+          # constructs the appropriate command-line switch for specifying a
+          # "revision" in CVS.  This could be a tag, branch, revision (i.e. 1.3)
+          # or a date (to be used with -d)
+          def cvs_revision(rev)
+            revision = ""
+            revision << case revision_type(rev)
+              when :date
+                "-D \"#{rev}\"" if revision_type(rev) == :date
+              when :revision
+                "-r #{rev}"
+              else
+                "-r #{head}"
+            end
+            return revision
+          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
+
+          def prep_destination(destination)
+            dest_parts = destination.split(/\//);
+            checkout_dir = dest_parts.pop
+            dest = dest_parts.join('/')
+            "mkdir -p #{ dest } && cd #{ dest }"
+          end
+      end
+
+    end
+  end
+end

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/git.rb

@@ -0,0 +1,274 @@
+require 'capistrano/recipes/deploy/scm/base'
+
+module Capistrano
+  module Deploy
+    module SCM
+
+      # An SCM module for using Git as your source control tool with Capistrano
+      # 2.0.  If you are using Capistrano 1.x, use this plugin instead:
+      #
+      #   http://scie.nti.st/2007/3/16/capistrano-with-git-shared-repository
+      #
+      # Assumes you are using a shared Git repository.
+      #
+      # Parts of this plugin borrowed from Scott Chacon's version, which I
+      # found on the Capistrano mailing list but failed to be able to get
+      # working.
+      #
+      # FEATURES:
+      #
+      #   * Very simple, only requiring 2 lines in your deploy.rb.
+      #   * Can deploy different branches, tags, or any SHA1 easily.
+      #   * Supports prompting for password / passphrase upon checkout.
+      #     (I am amazed at how some plugins don't do this)
+      #   * Supports :scm_command, :scm_password, :scm_passphrase Capistrano
+      #     directives.
+      #
+      # CONFIGURATION
+      # -------------
+      #
+      # Use this plugin by adding the following line in your config/deploy.rb:
+      #
+      #   set :scm, :git
+      #
+      # Set <tt>:repository</tt> to the path of your Git repo:
+      #
+      #   set :repository, "someuser@somehost:/home/myproject"
+      #
+      # The above two options are required to be set, the ones below are
+      # optional.
+      #
+      # You may set <tt>:branch</tt>, which is the reference to the branch, tag,
+      # or any SHA1 you are deploying, for example:
+      #
+      #   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:
+      #
+      #   set :scm_command, "/opt/local/bin/git"
+      #
+      # For compatibility with deploy scripts that may have used the 1.x
+      # version of this plugin before upgrading, <tt>:git</tt> is still
+      # recognized as an alias for :scm_command.
+      #
+      # Set <tt>:scm_password</tt> to the password needed to clone your repo
+      # if you don't have password-less (public key) entry:
+      #
+      #   set :scm_password, "my_secret'
+      #
+      # Otherwise, you will be prompted for a password.
+      #
+      # <tt>:scm_passphrase</tt> is also supported.
+      #
+      # The remote cache strategy is also supported.
+      #
+      #   set :repository_cache, "git_master"
+      #   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
+      # together with the :remote_cache strategy
+      #
+      #   set :git_shallow_clone, 1
+      #
+      # For those that don't like to leave your entire repository on
+      # your production server you can:
+      #
+      #   set :deploy_via, :export
+      #
+      # To deploy from a local repository:
+      #
+      #   set :repository, "file://."
+      #   set :deploy_via, :copy
+      #
+      # AUTHORS
+      # -------
+      #
+      # Garry Dolley http://scie.nti.st
+      # Contributions by Geoffrey Grosenbach http://topfunky.com
+      #              Scott Chacon http://jointheconversation.org
+      #                          Alex Arnell http://twologic.com
+      #                                   and Phillip Goldenburg
+
+      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.
+        default_command "git"
+
+        # When referencing "head", use the branch we want to deploy or, by
+        # default, Git's reference of HEAD (the latest changeset in the default
+        # branch, usually called "master").
+        def head
+          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
+          remote = origin
+
+          args = []
+          args << "-o #{remote}" unless remote == 'origin'
+          if depth = configuration[:git_shallow_clone]
+            args << "--depth #{depth}"
+          end
+
+          execute = []
+          if args.empty?
+            execute << "#{git} clone #{verbose} #{configuration[:repository]} #{destination}"
+          else
+            execute << "#{git} clone #{verbose} #{args.join(' ')} #{configuration[:repository]} #{destination}"
+          end
+
+          # checkout into a local branch rather than a detached HEAD
+          execute << "cd #{destination} && #{git} checkout #{verbose} -b deploy #{revision}"
+          
+          if configuration[:git_enable_submodules]
+            execute << "#{git} submodule #{verbose} init"
+            execute << "#{git} submodule #{verbose} sync"
+            execute << "#{git} submodule #{verbose} update"
+          end
+
+          execute.join(" && ")
+        end
+        
+        # An expensive export. Performs a checkout as above, then
+        # removes the repo.
+        def export(revision, destination)
+          checkout(revision, destination) << " && rm -Rf #{destination}/.git"
+        end
+
+        # Merges the changes to 'head' since the last fetch, for remote_cache
+        # deployment strategy
+        def sync(revision, destination)
+          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
+
+          # since we're in a local branch already, just reset to specified revision rather than merge
+          execute << "#{git} fetch #{verbose} #{remote} && #{git} reset #{verbose} --hard #{revision}"
+
+          if configuration[:git_enable_submodules]
+            execute << "#{git} submodule #{verbose} init"
+            execute << "for mod in `#{git} submodule status | awk '{ print $2 }'`; do #{git} config -f .git/config submodule.${mod}.url `#{git} config -f .gitmodules --get submodule.${mod}.url` && echo Synced $mod; done"
+            execute << "#{git} submodule #{verbose} sync"
+            execute << "#{git} submodule #{verbose} update"
+          end
+
+          execute.join(" && ")
+        end
+
+        # Returns a string of diffs between two revisions
+        def diff(from, to=nil)
+          from << "..#{to}" if to
+          scm :diff, from
+        end
+
+        # Returns a log of changes between the two revisions (inclusive).
+        def log(from, to=nil)
+          scm :log, "#{from}..#{to}"
+        end
+
+        # Getting the actual commit id, in case we were passed a tag
+        # or partial sha or something - it will return the sha if you pass a sha, too
+        def query_revision(revision)
+          raise ArgumentError, "Deploying remote branches is no longer supported.  Specify the remote branch as a local branch for the git repository you're deploying from (ie: '#{revision.gsub('origin/', '')}' rather than '#{revision}')." if revision =~ /^origin\//
+          return revision if revision =~ /^[0-9a-f]{40}$/
+          command = scm('ls-remote', repository, revision)
+          result = yield(command)
+          revdata = result.split(/[\t\n]/)
+          newrev = nil
+          revdata.each_slice(2) do |refs|
+            rev, ref = *refs
+            if ref.sub(/refs\/.*?\//, '').strip == revision
+              newrev = rev
+              break
+            end
+          end
+          raise "Unable to resolve revision for '#{revision}' on repository '#{repository}'." unless newrev =~ /^[0-9a-f]{40}$/
+          return newrev
+        end
+
+        def command
+          # For backwards compatibility with 1.x version of this module
+          configuration[:git] || super
+        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)
+          host = state[:channel][:host]
+          logger.info "[#{host} :: #{stream}] #{text}"
+          case text
+          when /\bpassword.*:/i
+            # git is prompting for a password
+            unless pass = configuration[:scm_password]
+              pass = Capistrano::CLI.password_prompt
+            end
+            "#{pass}\n"
+          when %r{\(yes/no\)}
+            # git is asking whether or not to connect
+            "yes\n"
+          when /passphrase/i
+            # git is asking for the passphrase for the user's key
+            unless pass = configuration[:scm_passphrase]
+              pass = Capistrano::CLI.password_prompt
+            end
+            "#{pass}\n"
+          when /accept \(t\)emporarily/
+            # git is asking whether to accept the certificate
+            "t\n"
+          end
+        end
+
+        private
+
+          # 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