RubyGems - capistrano - Versions diffs - 1.1.0 - Mend

capistrano 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

data/bin/cap +11 -0
data/examples/sample.rb +113 -0
data/lib/capistrano.rb +1 -0
data/lib/capistrano/actor.rb +438 -0
data/lib/capistrano/cli.rb +295 -0
data/lib/capistrano/command.rb +90 -0
data/lib/capistrano/configuration.rb +243 -0
data/lib/capistrano/extensions.rb +38 -0
data/lib/capistrano/gateway.rb +118 -0
data/lib/capistrano/generators/rails/deployment/deployment_generator.rb +25 -0
data/lib/capistrano/generators/rails/deployment/templates/capistrano.rake +46 -0
data/lib/capistrano/generators/rails/deployment/templates/deploy.rb +122 -0
data/lib/capistrano/generators/rails/loader.rb +20 -0
data/lib/capistrano/logger.rb +59 -0
data/lib/capistrano/recipes/standard.rb +242 -0
data/lib/capistrano/recipes/templates/maintenance.rhtml +53 -0
data/lib/capistrano/scm/base.rb +62 -0
data/lib/capistrano/scm/baz.rb +118 -0
data/lib/capistrano/scm/bzr.rb +70 -0
data/lib/capistrano/scm/cvs.rb +124 -0
data/lib/capistrano/scm/darcs.rb +27 -0
data/lib/capistrano/scm/perforce.rb +139 -0
data/lib/capistrano/scm/subversion.rb +122 -0
data/lib/capistrano/ssh.rb +39 -0
data/lib/capistrano/transfer.rb +90 -0
data/lib/capistrano/utils.rb +26 -0
data/lib/capistrano/version.rb +30 -0
data/test/actor_test.rb +294 -0
data/test/command_test.rb +43 -0
data/test/configuration_test.rb +233 -0
data/test/fixtures/config.rb +5 -0
data/test/fixtures/custom.rb +3 -0
data/test/scm/cvs_test.rb +186 -0
data/test/scm/subversion_test.rb +137 -0
data/test/ssh_test.rb +104 -0
data/test/utils.rb +50 -0
metadata +107 -0

data/lib/capistrano/recipes/templates/maintenance.rhtml ADDED

@@ -0,0 +1,53 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>System down for maintenance</title>
+  <style type="text/css">
+    div.outer {
+      position: absolute;
+      left: 50%;
+      top: 50%;
+      width: 500px;
+      height: 300px;
+      margin-left: -260px;
+      margin-top: -150px;
+    }
+    .DialogBody {
+      margin: 0;
+      padding: 10px;
+      text-align: left;
+      border: 1px solid #ccc;
+      border-right: 1px solid #999;
+      border-bottom: 1px solid #999;
+      background-color: #fff;
+    }
+    body { background-color: #fff; }
+  </style>
+</head>
+<body>
+  <div class="outer">
+     <div class="DialogBody" style="text-align: center;">
+       <div style="text-align: center; width: 200px; margin: 0 auto;">
+         <p style="color: red; font-size: 16px; line-height: 20px;">
+           The system is down for <%= reason ? reason : "maintenance" %>
+           as of <%= Time.now.strftime("%H:%M %Z") %>.
+         </p>
+         <p style="color: #666;">
+           It'll be back <%= deadline ? "by #{deadline}" : "shortly" %>.
+         </p>
+       </div>
+     </div>
+  </div>
+</body>
+</html>

data/lib/capistrano/scm/base.rb ADDED

@@ -0,0 +1,62 @@
+module Capistrano
+  module SCM
+    # The ancestor class of the various SCM module implementations.
+    class Base
+      attr_reader :configuration
+      def initialize(configuration) #:nodoc:
+        @configuration = configuration
+      end
+      def latest_revision
+        nil
+      end
+      def current_revision(actor)
+        raise "#{self.class} doesn't support querying the deployed revision"
+      end
+      def diff(actor, from=nil, to=nil)
+        raise "#{self.class} doesn't support diff(from, to)"
+      end
+      def update(actor)
+        raise "#{self.class} doesn't support update(actor)"
+      end
+      private
+        def run_checkout(actor, guts, &block)
+          log = "#{configuration.deploy_to}/revisions.log"
+          directory = File.basename(configuration.release_path)
+          command = <<-STR
+            if [[ ! -d #{configuration.release_path} ]]; then
+              #{guts}
+              #{logging_commands(directory)}
+            fi
+          STR
+          actor.run(command, &block)
+        end
+        def run_update(actor, guts, &block)
+          command = <<-STR
+            #{guts}
+            #{logging_commands}
+          STR
+          actor.run(command, &block)
+        end
+        def logging_commands(directory = nil)
+          log = "#{configuration.deploy_to}/revisions.log"
+          "(test -e #{log} || touch #{log} && chmod 666 #{log}) && " +
+          "echo `date +\"%Y-%m-%d %H:%M:%S\"` $USER #{configuration.revision} #{directory} >> #{log};"
+        end
+    end
+  end
+end

data/lib/capistrano/scm/baz.rb ADDED

@@ -0,0 +1,118 @@
+require 'capistrano/scm/base'
+module Capistrano
+  module SCM
+    # An SCM module for using Bazaar as your source control tool. This
+    # module is used by default, but you can explicitly specify it by
+    # placing the following line in your configuration:
+    #
+    #   set :scm, :baz
+    #
+    # Also, this module accepts a <tt>:baz</tt> configuration variable,
+    # which (if specified) will be used as the full path to the svn
+    # executable on the remote machine:
+    #
+    #   set :baz, "/opt/local/bin/baz"
+    #
+    # Set the version you wish to deploy as the repository variable,
+    # for example:
+    #
+    #   set :repository, "you@example.com--dev/yourstuff--trunk--1.0"
+    #
+    # Ensure that you have already registered the archive on the target
+    # machines.
+    #
+    # As bazaar keeps a great deal of extra information on a checkout,
+    # you will probably want to use export instead:
+    #
+    #   set :checkout, "export"
+    #
+    # TODO: provide setup recipe to register archive
+    class Baz < Base
+      # Return an integer identifying the last known revision in the baz
+      # repository. (This integer is currently the revision number.)
+      def latest_revision
+        `#{baz} revisions #{configuration.repository}`.split.last =~ /\-(\d+)$/
+        $1
+      end
+      # Return the number of the revision currently deployed.
+      def current_revision(actor)
+        latest = actor.releases.last
+        grep = %(grep " #{latest}$" #{configuration.deploy_to}/revisions.log)
+        result = ""
+        actor.run(grep, :once => true) do |ch, str, out|
+          result << out if str == :out
+          raise "could not determine current revision" if str == :err
+        end
+        date, time, user, rev, dir = result.split
+        raise "current revision not found in revisions.log" unless dir == latest
+        rev.to_i
+      end
+      # Return a string containing the diff between the two revisions. +from+
+      # and +to+ may be in any format that bzr recognizes as a valid revision
+      # identifier. If +from+ is +nil+, it defaults to the last deployed
+      # revision. If +to+ is +nil+, it defaults to the last developed revision.
+      def diff(actor, from=nil, to=nil)
+        from ||= current_revision(actor)
+        to ||= latest_revision
+        from = baz_revision_name(from)
+        to = baz_revision_name(to)
+        `#{baz} delta --diffs -A #{baz_archive} #{baz_version}--#{from} #{baz_version}--#{to}`
+      end
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command.
+      def checkout(actor)
+        op = configuration[:checkout] || "get"
+        from = baz_revision_name(configuration.revision)
+        command = "#{baz} #{op} #{configuration.repository}--#{from} #{actor.release_path} &&"
+        run_checkout(actor, command, &baz_stream_handler(actor))
+      end
+      def update(actor)
+        command = "cd #{actor.current_path} && #{baz} update &&"
+        run_update(actor, command, &baz_stream_handler(actor))
+      end
+      private
+        def baz
+          configuration[:baz] || "baz"
+        end
+        def baz_revision_name(number)
+          if number.to_i == 0 then
+            "base-0"
+          else
+            "patch-#{number}"
+          end
+        end
+        def baz_archive
+          configuration[:repository][/(.*)\//, 1]
+        end
+        def baz_version
+          configuration[:repository][/\/(.*)$/, 1]
+        end
+        def baz_stream_handler(actor)
+          Proc.new do |ch, stream, out|
+            prefix = "#{stream} :: #{ch[:host]}"
+            actor.logger.info out, prefix
+            if out =~ /\bpassword.*:/i
+              actor.logger.info "baz is asking for a password", prefix
+              ch.send_data "#{actor.password}\n"
+            elsif out =~ %r{passphrase}
+              message = "baz needs your key's passphrase, sending empty string"
+              actor.logger.info message, prefix
+              ch.send_data "\n"
+            end
+          end
+        end
+    end
+  end
+end

data/lib/capistrano/scm/bzr.rb ADDED

@@ -0,0 +1,70 @@
+require 'capistrano/scm/base'
+module Capistrano
+  module SCM
+    # An SCM module for using Bazaar-NG (bzr) as your source control tool.
+    # You can use it by placing the following line in your configuration:
+    #
+    #   set :scm, :bzr
+    #
+    # Also, this module accepts a <tt>:bzr</tt> configuration variable,
+    # which (if specified) will be used as the full path to the bzr
+    # executable on the remote machine:
+    #
+    #   set :bzr, "/opt/local/bin/bzr"
+    class Bzr < Base
+      # Return an integer identifying the last known revision in the bzr
+      # repository. (This integer is currently the revision number.)
+      def latest_revision
+        `#{bzr} revno #{configuration.repository}`.to_i
+      end
+      # Return the number of the revision currently deployed.
+      def current_revision(actor)
+        command = "#{bzr} revno #{actor.release_path} &&"
+        run_update(actor, command, &bzr_stream_handler(actor))
+      end
+      # Return a string containing the diff between the two revisions. +from+
+      # and +to+ may be in any format that bzr recognizes as a valid revision
+      # identifier. If +from+ is +nil+, it defaults to the last deployed
+      # revision. If +to+ is +nil+, it defaults to the last developed revision.
+      # Pay attention to the fact that as of now bzr does NOT support
+      # diff on remote locations.
+      def diff(actor, from=nil, to=nil)
+        from ||= current_revision(actor)
+        to ||= ""
+        `#{bzr} diff -r #{from}..#{to} #{configuration.repository}`
+      end
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command. If
+      # bzr asks for a password this will automatically provide it (assuming
+      # the requested password is the same as the password for logging into the
+      # remote server.)
+      def checkout(actor)
+        op = configuration[:checkout] || "branch"
+        command = "#{bzr} #{op} -r#{configuration.revision} #{configuration.repository} #{actor.release_path} &&"
+        run_checkout(actor, command, &bzr_stream_handler(actor))
+      end
+      def update(actor)
+        command = "cd #{actor.current_path} && #{bzr} pull -q &&"
+        run_update(actor, command, &bzr_stream_handler(actor))
+      end
+      private
+        def bzr
+          configuration[:bzr] || "bzr"
+        end
+        def bzr_stream_handler(actor)
+          Proc.new do |ch, stream, out|
+            prefix = "#{stream} :: #{ch[:host]}"
+            actor.logger.info out, prefix
+          end
+        end
+    end
+  end
+end

data/lib/capistrano/scm/cvs.rb ADDED

@@ -0,0 +1,124 @@
+require 'time'
+require 'capistrano/scm/base'
+module Capistrano
+  module SCM
+    # An SCM module for using CVS as your source control tool. You can
+    # specify it by placing the following line in your configuration:
+    #
+    #   set :scm, :cvs
+    #
+    # Also, this module accepts a <tt>:cvs</tt> configuration variable,
+    # which (if specified) will be used as the full path to the cvs
+    # executable on the remote machine:
+    #
+    #   set :cvs, "/opt/local/bin/cvs"
+    #
+    # You can specify the location of your local copy (used to query
+    # the revisions, etc.) via the <tt>:local</tt> variable, which defaults to
+    # ".".
+    #
+    # You may also specify a <tt>:branch</tt> configuration variable,
+    # which (if specified) will be used in the '-r' option to the cvs
+    # check out command.  If it is not set, the module will determine if a
+    # branch is being used in the CVS sandbox relative to
+    # <tt>:local</tt> and act accordingly.
+    #
+    #   set :branch, "prod-20060124"
+    #
+    # Also, you can specify the CVS_RSH variable to use on the remote machine(s)
+    # via the <tt>:cvs_rsh</tt> variable. This defaults to the value of the
+    # CVS_RSH environment variable locally, or if it is not set, to "ssh".
+    class Cvs < Base
+      def initialize(configuration)
+        super(configuration)
+        if not configuration.respond_to?(:branch) then
+          configuration.set(:branch) { self.current_branch }
+        else
+          @current_branch = configuration[:branch]
+        end
+     end
+      # Return a string representing the date of the last revision (CVS is
+      # seriously retarded, in that it does not give you a way to query when
+      # the last revision was made to the repository, so this is a fairly
+      # expensive operation...)
+      def latest_revision
+        return @latest_revision if @latest_revision
+        configuration.logger.debug "querying latest revision..."
+        @latest_revision = cvs_log(cvs_local, configuration.branch).
+          split(/\r?\n/).
+          grep(/^date: (.*?);/) { Time.parse($1).strftime("%Y-%m-%d %H:%M:%S") }.
+          sort.
+          last
+      end
+      # Return a string representing the branch that the sandbox
+      # relative to <tt>:local</tt> contains.
+      def current_branch
+        return @current_branch if @current_branch
+        configuration.logger.debug "determining current_branch..."
+        @current_branch = cvs_branch(cvs_local)
+      end
+      # Check out (on all servers associated with the current task) the latest
+      # revision, using a branch if necessary. Uses the given actor instance
+      # to execute the command.
+      def checkout(actor)
+        cvs = configuration[:cvs] || "cvs"
+        cvs_rsh = configuration[:cvs_rsh] || ENV['CVS_RSH'] || "ssh"
+        if "HEAD" == configuration.branch then
+            branch_option = ""
+        else
+            branch_option = "-r #{configuration.branch}"
+        end
+        command = <<-CMD
+          cd #{configuration.releases_path};
+          CVS_RSH="#{cvs_rsh}" #{cvs} -d #{configuration.repository} -Q co -D "#{configuration.revision}" #{branch_option} -d #{File.basename(actor.release_path)} #{actor.application};
+        CMD
+        run_checkout(actor, command) do |ch, stream, out|
+          prefix = "#{stream} :: #{ch[:host]}"
+          actor.logger.info out, prefix
+          if out =~ %r{password:}
+            actor.logger.info "CVS is asking for a password", prefix
+            ch.send_data "#{actor.password}\n"
+          elsif out =~ %r{^Enter passphrase}
+            message = "CVS needs your key's passphrase and cannot proceed"
+            actor.logger.info message, prefix
+            raise message
+          end
+        end
+      end
+      private
+        # Look for a 'CVS/Tag' file in the path.  If this file exists
+        # and contains a Line starting with 'T' then this CVS sandbox is
+        # 'tagged' with a branch.  In the default case return 'HEAD'
+        def cvs_branch(path)
+          branch = "HEAD"
+          branch_file = File.join(path || ".", "CVS", "Tag")
+          if File.exists?(branch_file) then
+            File.open(branch_file) do |f|
+              possible_branch = f.find { |l| l =~ %r{^T} }
+              branch = possible_branch.strip[1..-1] if possible_branch
+            end
+          end
+          branch
+        end
+        def cvs_log(path,branch)
+          `cd #{path || "."} && cvs -q log -N -r#{branch}`
+        end
+        def cvs_local
+          configuration.local || "."
+        end
+    end
+  end
+end

data/lib/capistrano/scm/darcs.rb ADDED

@@ -0,0 +1,27 @@
+require 'capistrano/scm/base'
+module Capistrano
+  module SCM
+    # An SCM module for using darcs as your source control tool. Use it by
+    # specifying the following line in your configuration:
+    #
+    #   set :scm, :darcs
+    #
+    # Also, this module accepts a <tt>:darcs</tt> configuration variable,
+    # which (if specified) will be used as the full path to the darcs
+    # executable on the remote machine:
+    #
+    #   set :darcs, "/opt/local/bin/darcs"
+    class Darcs < Base
+      # Check out (on all servers associated with the current task) the latest
+      # revision. Uses the given actor instance to execute the command.
+      def checkout(actor)
+        darcs = configuration[:darcs] ? configuration[:darcs] : "darcs"
+        revision = configuration[:revision] ? %(--to-match "#{configuration.revision}") : ""
+        run_checkout(actor, "#{darcs} get -q --set-scripts-executable #{revision} #{configuration.repository} #{actor.release_path};")
+      end
+    end
+  end
+end