mbailey-capistrano 2.5.5

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

@@ -0,0 +1,121 @@
+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, arguments, 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, arguments, 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, arguments, 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+$/
+          command = scm(:info, repository, authentication, "-r#{revision}")
+          result = yield(command)
+          yaml = YAML.load(result)
+          raise "tried to run `#{command}' and got unexpected result #{result.inspect}" unless Hash === yaml
+          yaml['Last Changed Rev'] || yaml['Revision']
+        end
+
+        # Increments the given revision number and returns it.
+        def next_revision(revision)
+          revision.to_i + 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)
+          host = state[:channel][:host]
+	        logger.info "[#{host} :: #{stream}] #{text}"
+          case text
+          when /\bpassword.*:/i
+            # subversion is prompting for a password
+            "#{scm_password_prompt}\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 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"
+          end
+        end
+
+        private
+
+          # If a username is configured for the SCM, return the command-line
+          # switches for that. Note that we don't need to return the password
+          # switch, since Capistrano will check for that prompt in the output
+          # and will respond appropriately.
+          def authentication
+            username = variable(:scm_username)
+            return "" unless username
+            result = "--username #{variable(:scm_username)} "
+            result << "--password #{variable(:scm_password)} " unless variable(:scm_auth_cache) || variable(:scm_prefer_prompt)
+            result << "--no-auth-cache " unless variable(:scm_auth_cache)
+            result
+          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 scm_password_prompt
+            @scm_password_prompt ||= variable(:scm_password) ||
+              variable(:password) ||
+              Capistrano::CLI.password_prompt("Subversion password: ")
+          end
+      end
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,79 @@
+require 'capistrano/recipes/deploy/dependencies'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # This class defines the abstract interface for all Capistrano
+      # deployment strategies. Subclasses must implement at least the
+      # #deploy! method.
+      class Base
+        attr_reader :configuration
+
+        # Instantiates a strategy with a reference to the given configuration.
+        def initialize(config={})
+          @configuration = config
+        end
+
+        # Executes the necessary commands to deploy the revision of the source
+        # code identified by the +revision+ variable. Additionally, this
+        # should write the value of the +revision+ variable to a file called
+        # REVISION, in the base of the deployed revision. This file is used by
+        # other tasks, to perform diffs and such.
+        def deploy!
+          raise NotImplementedError, "`deploy!' is not implemented by #{self.class.name}"
+        end
+
+        # Performs a check on the remote hosts to determine whether everything
+        # is setup such that a deploy could succeed.
+        def check!
+          Dependencies.new(configuration) do |d|
+            d.remote.directory(configuration[:releases_path]).or("`#{configuration[:releases_path]}' does not exist. Please run `cap deploy:setup'.")
+            d.remote.writable(configuration[:deploy_to]).or("You do not have permissions to write to `#{configuration[:deploy_to]}'.")
+            d.remote.writable(configuration[:releases_path]).or("You do not have permissions to write to `#{configuration[:releases_path]}'.")
+          end
+        end
+          
+        protected
+
+          # This is to allow helper methods like "run" and "put" to be more
+          # easily accessible to strategy implementations.
+          def method_missing(sym, *args, &block)
+            if configuration.respond_to?(sym)
+              configuration.send(sym, *args, &block)
+            else
+              super
+            end
+          end
+
+          # A wrapper for Kernel#system that logs the command being executed.
+          def system(*args)
+            cmd = args.join(' ')
+            if RUBY_PLATFORM =~ /win32/
+              cmd.gsub!('/','\\') # Replace / with \\
+              cmd.gsub!(/^cd /,'cd /D ') # Replace cd with cd /D
+              cmd.gsub!(/&& cd /,'&& cd /D ') # Replace cd with cd /D
+              logger.trace "executing locally: #{cmd}"
+              super(cmd)
+            else
+              logger.trace "executing locally: #{cmd}"
+              super
+            end
+          end
+
+        private
+
+          def logger
+            @logger ||= configuration[:logger] || Capistrano::Logger.new(:output => STDOUT)
+          end
+
+          # The revision to deploy. Must return a real revision identifier,
+          # and not a pseudo-id.
+          def revision
+            configuration[:real_revision]
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'capistrano/recipes/deploy/strategy/remote'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # Implements the deployment strategy which does an SCM checkout on each
+      # target host. This is the default deployment strategy for Capistrano.
+      class Checkout < Remote
+        protected
+
+          # Returns the SCM's checkout command for the revision to deploy.
+          def command
+            @command ||= source.checkout(revision, configuration[:release_path])
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,210 @@
+require 'capistrano/recipes/deploy/strategy/base'
+require 'fileutils'
+require 'tempfile'  # Dir.tmpdir
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # This class implements the strategy for deployments which work
+      # by preparing the source code locally, compressing it, copying the
+      # file to each target host, and uncompressing it to the deployment
+      # directory.
+      #
+      # By default, the SCM checkout command is used to obtain the local copy
+      # of the source code. If you would rather use the export operation,
+      # you can set the :copy_strategy variable to :export.
+      #
+      #   set :copy_strategy, :export
+      #
+      # For even faster deployments, you can set the :copy_cache variable to
+      # true. This will cause deployments to do a new checkout of your
+      # repository to a new directory, and then copy that checkout. Subsequent
+      # deploys will just resync that copy, rather than doing an entirely new
+      # checkout. Additionally, you can specify file patterns to exclude from
+      # the copy when using :copy_cache; just set the :copy_exclude variable
+      # to a file glob (or an array of globs).
+      #
+      #   set :copy_cache, true
+      #   set :copy_exclude, ".git/*"
+      #
+      # Note that :copy_strategy is ignored when :copy_cache is set. Also, if
+      # you want the copy cache put somewhere specific, you can set the variable
+      # to the path you want, instead of merely 'true':
+      #
+      #   set :copy_cache, "/tmp/caches/myapp"
+      #
+      # This deployment strategy also supports a special variable,
+      # :copy_compression, which must be one of :gzip, :bz2, or
+      # :zip, and which specifies how the source should be compressed for
+      # transmission to each host.
+      class Copy < Base
+        # Obtains a copy of the source code locally (via the #command method),
+        # compresses it to a single file, copies that file to all target
+        # servers, and uncompresses it on each of them into the deployment
+        # directory.
+        def deploy!
+          if copy_cache
+            if File.exists?(copy_cache)
+              logger.debug "refreshing local cache to revision #{revision} at #{copy_cache}"
+              system(source.sync(revision, copy_cache))
+            else
+              logger.debug "preparing local cache at #{copy_cache}"
+              system(source.checkout(revision, copy_cache))
+            end
+
+            logger.debug "copying cache to deployment staging area #{destination}"
+            Dir.chdir(copy_cache) do
+              FileUtils.mkdir_p(destination)
+              queue = Dir.glob("*", File::FNM_DOTMATCH)
+              while queue.any?
+                item = queue.shift
+                name = File.basename(item)
+
+                next if name == "." || name == ".."
+                next if copy_exclude.any? { |pattern| File.fnmatch(pattern, item) }
+
+                if File.symlink?(item)
+                  FileUtils.ln_s(File.readlink(File.join(copy_cache, item)), File.join(destination, item))
+                elsif File.directory?(item)
+                  queue += Dir.glob("#{item}/*", File::FNM_DOTMATCH)
+                  FileUtils.mkdir(File.join(destination, item))
+                else
+                  FileUtils.ln(File.join(copy_cache, item), File.join(destination, item))
+                end
+              end
+            end
+          else
+            logger.debug "getting (via #{copy_strategy}) revision #{revision} to #{destination}"
+            system(command)
+
+            if copy_exclude.any?
+              logger.debug "processing exclusions..."
+              if copy_exclude.any?
+                copy_exclude.each do |pattern| 
+                  delete_list = Dir.glob(File.join(destination, pattern), File::FNM_DOTMATCH)
+                  # avoid the /.. trap that deletes the parent directories
+                  delete_list.delete_if { |dir| dir =~ /\/\.\.$/ }
+                  FileUtils.rm_rf(delete_list.compact)
+                end
+              end
+            end
+          end
+
+          File.open(File.join(destination, "REVISION"), "w") { |f| f.puts(revision) }
+
+          logger.trace "compressing #{destination} to #{filename}"
+          Dir.chdir(tmpdir) { system(compress(File.basename(destination), File.basename(filename)).join(" ")) }
+
+          upload(filename, remote_filename)
+          run "cd #{configuration[:releases_path]} && #{decompress(remote_filename).join(" ")} && rm #{remote_filename}"
+        ensure
+          FileUtils.rm filename rescue nil
+          FileUtils.rm_rf destination rescue nil
+        end
+
+        def check!
+          super.check do |d|
+            d.local.command(source.local.command) if source.local.command
+            d.local.command(compress(nil, nil).first)
+            d.remote.command(decompress(nil).first)
+          end
+        end
+
+        # Returns the location of the local copy cache, if the strategy should
+        # use a local cache + copy instead of a new checkout/export every
+        # time. Returns +nil+ unless :copy_cache has been set. If :copy_cache
+        # is +true+, a default cache location will be returned.
+        def copy_cache
+          @copy_cache ||= configuration[:copy_cache] == true ?
+            File.join(Dir.tmpdir, configuration[:application]) :
+            configuration[:copy_cache]
+        end
+
+        private
+
+          # Specify patterns to exclude from the copy. This is only valid
+          # when using a local cache.
+          def copy_exclude
+            @copy_exclude ||= Array(configuration.fetch(:copy_exclude, []))
+          end
+
+          # Returns the basename of the release_path, which will be used to
+          # name the local copy and archive file.
+          def destination
+            @destination ||= File.join(tmpdir, File.basename(configuration[:release_path]))
+          end
+
+          # Returns the value of the :copy_strategy variable, defaulting to
+          # :checkout if it has not been set.
+          def copy_strategy
+            @copy_strategy ||= configuration.fetch(:copy_strategy, :checkout)
+          end
+
+          # Should return the command(s) necessary to obtain the source code
+          # locally.
+          def command
+            @command ||= case copy_strategy
+            when :checkout
+              source.checkout(revision, destination)
+            when :export
+              source.export(revision, destination)
+            end
+          end
+
+          # Returns the name of the file that the source code will be
+          # compressed to.
+          def filename
+            @filename ||= File.join(tmpdir, "#{File.basename(destination)}.#{compression.extension}")
+          end
+
+          # The directory to which the copy should be checked out
+          def tmpdir
+            @tmpdir ||= configuration[:copy_dir] || Dir.tmpdir
+          end
+
+          # The directory on the remote server to which the archive should be
+          # copied
+          def remote_dir
+            @remote_dir ||= configuration[:copy_remote_dir] || "/tmp"
+          end
+
+          # The location on the remote server where the file should be
+          # temporarily stored.
+          def remote_filename
+            @remote_filename ||= File.join(remote_dir, File.basename(filename))
+          end
+
+          # A struct for representing the specifics of a compression type.
+          # Commands are arrays, where the first element is the utility to be
+          # used to perform the compression or decompression.
+          Compression = Struct.new(:extension, :compress_command, :decompress_command)
+          
+          # The compression method to use, defaults to :gzip.
+          def compression
+            type = configuration[:copy_compression] || :gzip
+            case type
+            when :gzip, :gz   then Compression.new("tar.gz",  %w(tar czf), %w(tar xzf))
+            when :bzip2, :bz2 then Compression.new("tar.bz2", %w(tar cjf), %w(tar xjf))
+            when :zip         then Compression.new("zip",     %w(zip -qr), %w(unzip -q))
+            else raise ArgumentError, "invalid compression type #{type.inspect}"
+            end
+          end
+          
+          # Returns the command necessary to compress the given directory
+          # into the given file.
+          def compress(directory, file)
+            compression.compress_command + [file, directory]
+          end
+
+          # Returns the command necessary to decompress the given file,
+          # relative to the current working directory. It must also
+          # preserve the directory structure in the file.
+          def decompress(file)
+            compression.decompress_command + [file]
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'capistrano/recipes/deploy/strategy/remote'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # Implements the deployment strategy which does an SCM export on each
+      # target host.
+      class Export < Remote
+        protected
+
+          # Returns the SCM's export command for the revision to deploy.
+          def command
+            @command ||= source.export(revision, configuration[:release_path])
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'capistrano/recipes/deploy/strategy/base'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # An abstract superclass, which forms the base for all deployment
+      # strategies which work by grabbing the code from the repository directly
+      # from remote host. This includes deploying by checkout (the default),
+      # and deploying by export.
+      class Remote < Base
+        # Executes the SCM command for this strategy and writes the REVISION
+        # mark file to each host.
+        def deploy!
+          scm_run "#{command} && #{mark}"
+        end
+
+        def check!
+          super.check do |d|
+            d.remote.command(source.command)
+          end
+        end
+
+        protected
+
+          # Runs the given command, filtering output back through the
+          # #handle_data filter of the SCM implementation.
+          def scm_run(command)
+            run(command) do |ch,stream,text|
+              ch[:state] ||= { :channel => ch }
+              output = source.handle_data(ch[:state], stream, text)
+              ch.send_data(output) if output
+            end
+          end
+
+          # An abstract method which must be overridden in subclasses, to
+          # return the actual SCM command(s) which must be executed on each
+          # target host in order to perform the deployment.
+          def command
+            raise NotImplementedError, "`command' is not implemented by #{self.class.name}"
+          end
+
+          # Returns the command which will write the identifier of the
+          # revision being deployed to the REVISION file on each host.
+          def mark
+            "(echo #{revision} > #{configuration[:release_path]}/REVISION)"
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'capistrano/recipes/deploy/strategy/remote'
+
+module Capistrano
+  module Deploy
+    module Strategy
+
+      # Implements the deployment strategy that keeps a cached checkout of
+      # the source code on each remote server. Each deploy simply updates the
+      # cached checkout, and then does a copy from the cached copy to the
+      # final deployment location.
+      class RemoteCache < Remote
+        # Executes the SCM command for this strategy and writes the REVISION
+        # mark file to each host.
+        def deploy!
+          update_repository_cache
+          copy_repository_cache
+        end
+
+        def check!
+          super.check do |d|
+            d.remote.writable(shared_path)
+          end
+        end
+
+        private
+
+          def repository_cache
+            File.join(shared_path, configuration[:repository_cache] || "cached-copy")
+          end
+
+          def update_repository_cache
+            logger.trace "updating the cached checkout on all servers"
+            command = "if [ -d #{repository_cache} ]; then " +
+              "#{source.sync(revision, repository_cache)}; " +
+              "else #{source.checkout(revision, repository_cache)}; fi"
+            scm_run(command)
+          end
+
+          def copy_repository_cache
+            logger.trace "copying the cached version to #{configuration[:release_path]}"
+            if copy_exclude.empty? 
+              run "cp -RPp #{repository_cache} #{configuration[:release_path]} && #{mark}"
+            else
+              exclusions = copy_exclude.map { |e| "--exclude=\"#{e}\"" }.join(' ')
+              run "rsync -lrpt #{exclusions} #{repository_cache}/* #{configuration[:release_path]} && #{mark}"
+            end
+          end
+          
+          def copy_exclude
+            @copy_exclude ||= Array(configuration.fetch(:copy_exclude, []))
+          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

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

@@ -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 ? deadline : "shortly" %>.
+         </p>
+       </div>
+     </div>
+  </div>
+
+</body>
+</html>