square-eycap 0.4.13

data/History.txt

@@ -0,0 +1,154 @@
+== 0.4.12 / 2009-06-26
+  * removed condition for dbhost that was useless and tested db:clone_prod_to_staging
+
+== 0.4.11 / 2009-06-25
+  * changed nginx start and restart to give output to cap
+  * fixed db:clone_to_local task
+
+== 0.4.10 / 2009-06-24
+  * using nohup on nginx start and restart
+
+== 0.4.9 / 2009-06-22
+  * added nginx reload, upgrade and configtest - thanks Randy (ydnar)
+
+== 0.4.8 / there is no 0.4.8, just like there is no spoon.
+
+== 0.4.7 / 2009-05-12
+  * fixed bug in clone_prod_to_staging and clone_to_local db tasks for postgres
+  where the regex matching the password prompt for the restore was wrong
+
+== 0.4.6 / 2009-03-24
+  * fixed bug to restore clone_prod_to_staging using the compressed file
+
+== 0.4.5 / 2009-03-03
+  * happy square root day!
+  * added the staging restore to db:clone_prod_to_staging
+
+== 0.4.4 / 2009-03-03
+  * happy square root day!
+  * fixed the *correct* database.rb file for the db:clone_prod_to_staging
+
+== 0.4.3 / 2009-02-11
+  * updated db:dump command for Engine Yard Solo offering, fixing a bug where 
+  the dbname wasn't included.
+
+== 0.4.2 / 2009-02-11
+  * added condition to determine if the db:dump command is run against our
+  traditional offering or the new cloud offering
+  * fixed bug where if a production db host name doesn't have a -master at the
+  end it won't run the db:clone_prod_to_staging correctly
+
+== 0.4.1 / 2009-01-09
+  * fixed bug for passenger:restart
+
+== 0.4.0 / 2009-01-09
+  * add passenger:restart task
+  * add apache stop, start, restart and reload tasks
+  * Don't display database passwords in the logs, output, etc. use stdin instead
+
+== 0.3.11 / 2008-11-09
+  * filtered_remote_cache uses svn switch
+
+== 0.3.9 / 2008-09-29
+  * add reindex task for /engineyard/bin/acts_as_sphinx_searchd
+  * add reindex and configure task for /engineyard/bin/ultrasphinx_searchd
+  * add reindex and configure task for /engineyard/bin/thinking_sphinx_searchd
+
+== 0.3.8 / 2008-09-22
+  * add PostgreSQL support to the database.rb recipe.
+
+== 0.3.7 / 2008-08-23
+  * fix from customer for filtered_remote_cache to just use plain grep.
+
+== 0.3.6 / 2008-07-17
+  * features updated VERSION
+
+== 0.3.5 / 2008-07-17
+  * filtered_remote_cache uses cached checkout's repository root for comparison for speedier tagged/branched deploys
+
+== 0.3.4 / 2008-06-17
+  * rake install_gem_no_doc for faster install
+  * set role to db for backup_name task
+  * add migration support for merb
+
+== 0.3.3 / 2008-05-07
+  * add ey_logger to log deploys to server
+
+== 0.3.2 / 2008-04-29
+  * adding db:clone_to_local task to take a dump on the slice, fetch it, and load it into your dev db on your workstation
+  * only clone from replica database
+  * remove call to variable in task desc
+  * fix ferret symlinking
+  * gemspec for github
+
+== 0.3.1 / 2008-03-17
+  * Make the custom maintenance pages actually work!
+
+== 0.3.0 / 2008-03-05
+  * Adding custom maintenance pages is now as easy as copying a custom html file to #{shared_path}/system/maintenance.html.custom
+
+== 0.2.10 / 2008-03-02
+  * Symlink memcached.yml only on :memcached => true, except :no_release => true
+
+== 0.2.9 / 2008-02-27
+  * Fix a bug with ultrasphinx:configure running on multiple hosts
+
+== 0.2.8 / 2008-02-20
+  * Add tasks for solr starting,stopping, and log tailing.
+  * Add monit namespace and make appservers php/merb compatible
+  * Make ultrasphinx symlinking a little smarter
+  * Add tomcat tasks for spongecell
+
+== 0.2.6 / 2008-02-14
+  * Make mongrel restarts only apply to mongrel slices
+
+== 0.2.5 / 2008-02-11
+  * Added db cloning task
+
+== 0.2.4 / 2008-02-06
+  * Symlink memcached.yml in on deploy if you enable the callback
+
+== 0.2.3 / 2008-02-01
+  * Make log tailing environmentally aware.  Also add tasks to tail mongrel logs
+
+== 0.2.2 / 2008-01-25
+  * sphinx:configure ultrasphinx configuration task
+
+== 0.2.1 / 2008-01-25
+  * override default deploy recipe start/stop tasks
+
+== 0.2.0 / 2008-01-23
+  * sphinx:symlink ultrasphinx configuration directory
+
+== 0.1.9 / 2008-01-21
+  * Correct memcached tasks.
+
+== 0.1.8 / 2008-01-20
+  * Add memcached tasks
+
+== 0.1.7 / 2008-01-19
+  * fix symlink_configs task
+
+== 0.1.6 / 2008-01-19
+  * add restart tasks for backgroundrb
+
+== 0.1.5 / 2008-01-18
+  * fixed bug in filtered_remote_cache that prevented a changed checkout URL from taking over the cache
+
+== 0.1.4 / 2008-01-17
+  * added sphinx:[reindex|start|stop|restart] matches only app servers with :sphinx => true
+
+== 0.1.3 / 2008-01-17
+  * filtered_remote_cache to removes the cached copy of the source URL changed
+
+== 0.1.2 / 2008-01-15
+  * added filtered_remote_cache capistrano deployment strategy
+
+== 0.1.1 / 2008-01-15
+  * removed database tasks until problem with 'defer' is solved
+
+== 0.1.0 / 2008-01-14
+  * Bugfix for empty :application variable
+
+== 0.0.1 / 2008-01-14
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/capistrano/recipes/deploy/strategy/filtered_remote_cache.rb
+lib/capistrano/recipes/deploy/strategy/remote_cache.rb
+lib/eycap.rb
+lib/eycap/lib/ey_logger.rb
+lib/eycap/lib/ey_logger_hooks.rb
+lib/eycap/recipes.rb
+lib/eycap/recipes/backgroundrb.rb
+lib/eycap/recipes/database.rb
+lib/eycap/recipes/deploy.rb
+lib/eycap/recipes/ferret.rb
+lib/eycap/recipes/juggernaut.rb
+lib/eycap/recipes/memcached.rb
+lib/eycap/recipes/mongrel.rb
+lib/eycap/recipes/monit.rb
+lib/eycap/recipes/nginx.rb
+lib/eycap/recipes/slice.rb
+lib/eycap/recipes/solr.rb
+lib/eycap/recipes/sphinx.rb
+lib/eycap/recipes/templates/maintenance.rhtml
+lib/eycap/recipes/tomcat.rb
+lib/eycap/recipes/passenger.rb
+lib/eycap/recipes/apache.rb
+test/test_eycap.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,65 @@
+= eycap
+
+== DESCRIPTION:
+
+Engine Yard capistrano tasks for use specifically with Engine Yard slices. They include convenience methods for managed a database, mongrel, nginx or other services.
+
+Also included is a deployment strategy, :filtered_remote_cache, which speeds up deployment like :remote_cache, but filters out .svn directory which are a security risk and write slowly to shared disks.
+
+== REQUIREMENTS:
+
+* capistrano (http://capify.org) > 2.0.0, but recommended with > 2.2.0
+
+* NOTE: If you're using a git repository we recommend capistrano 2.5.3 and greater.
+
+== INSTALL:
+
+  $ gem sources -a http://gems.github.com/ (you only need to do this once)
+  $ gem install engineyard-eycap
+
+== SOURCE:
+ 
+eycap's git repo is available on GitHub, which can be browsed at:
+ 
+  http://github.com/engineyard/eycap
+   
+and cloned from:
+   
+  git://github.com/engineyard/eycap.git
+
+== USAGE:
+
+= Include in capistrano
+
+In your deploy.rb, simply include this line at the top:
+
+require 'eycap/recipes'
+
+= Filtered remote cache
+
+To use filtered_remote_cache, simply:
+
+set :deploy_via, :filtered_remote_cache
+
+== LICENSE:
+
+Copyright (c) 2008 Engine Yard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'hoe'
+require './lib/eycap'
+
+Hoe.new('eycap', Eycap::VERSION) do |p|
+  p.author = 'Engine Yard'
+  p.email = 'tech@engineyard.com'
+  p.summary = 'Capistrano tasks for Engine Yard slices'
+  p.description = 'A bunch of useful recipes to help deployment to Engine Yard slices'
+  p.url = 'http://github.com/engineyard/eycap/tree/master'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['capistrano', '>= 2.2.0']
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/eycap.rb"
+end
+
+task :coverage do
+  system("rm -fr coverage")
+  system("rcov test/test_*.rb")
+  system("open coverage/index.html")
+end
+
+desc "Upload site to Rubyforge"
+task :site do
+end
+
+desc 'Install the package as a gem.'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE}gem install --local --no-rdoc --no-ri pkg/*.gem"
+end

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

@@ -0,0 +1,57 @@
+require 'capistrano/recipes/deploy/scm/base'
+require 'capistrano/recipes/deploy/strategy/remote'
+
+module Capistrano
+  module Deploy
+    module SCM
+      class Subversion < Base
+        def switch(revision, checkout)
+          "cd #{checkout} && #{scm :switch, verbose, authentication, "-r#{revision}", repository}"
+        end
+      end
+    end
+    
+    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 filters a copy through tar to remove unwanted .svn directories,
+      # finally leaving a pristeen, export-like copy at the destination.
+      class FilteredRemoteCache < Remote
+        # Executes the SCM command for this strategy and writes the REVISION
+        # mark file to each host.
+        def deploy!
+          update_repository_cache
+          tar_copy_repository_cache
+        end
+
+        def check!
+          super.check do |d|
+            d.remote.writable(shared_path)
+          end
+        end
+
+        private
+
+          def repository_cache
+            configuration[:repository_cache] || "/var/cache/engineyard/#{configuration[:application]}"
+          end
+
+          def update_repository_cache
+            logger.trace "checking if the cached copy repository root matches this deploy, then updating it"
+            command = "if [ -d #{repository_cache} ] && ! echo '#{configuration[:repository]}' | grep -q `svn info #{repository_cache} | grep 'Repository Root' | awk '{print $3}'`; then " + 
+              "rm -rf #{repository_cache} && #{source.checkout(revision, repository_cache)}; " + 
+              "elif [ -d #{repository_cache} ]; then #{source.switch(revision, repository_cache)}; " +
+              "else #{source.checkout(revision, repository_cache)}; fi"
+            scm_run(command)
+          end
+
+          def tar_copy_repository_cache
+            logger.trace "copying and filtering .svn via tar from cached version to #{configuration[:release_path]}"
+            run "mkdir #{configuration[:release_path]} && tar c --exclude=#{configuration[:filter_spec] || ".svn"} -C #{repository_cache} . | tar xC #{configuration[:release_path]} && #{mark}"
+          end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'capistrano/recipes/deploy/strategy/remote_cache'
+
+module Capistrano
+  module Deploy
+    module Strategy
+      class UnsharedRemoteCache < RemoteCache
+        def check!
+          super.check do |d|
+            d.remote.writable(repository_cache)
+          end
+        end
+
+        private
+
+        def repository_cache
+          configuration[:repository_cache]
+        end
+      end
+    end
+  end
+end

data/lib/eycap.rb

@@ -0,0 +1,3 @@
+module Eycap
+  VERSION = '0.4.12'
+end

data/lib/eycap/lib/ey_logger.rb

@@ -0,0 +1,125 @@
+require 'tmpdir'
+require 'fileutils'
+module Capistrano
+  
+  class Logger  
+    
+    def ey_log(level, message, line_prefix = nil)
+      EYLogger.log(level, message, line_prefix) if EYLogger.setup?
+      log_without_ey_logging(level, message, line_prefix)
+    end
+    
+    unless method_defined?(:log_without_ey_logging)
+      alias_method :log_without_ey_logging, :log 
+      alias_method :log, :ey_log
+    end
+    
+    def close
+      device.close if @needs_close
+      EYLogger.close if EYLogger.setup?
+    end
+  end
+  
+  class EYLogger
+    
+    # Sets up the EYLogger to beging capturing capistrano's logging.  You should pass the capistrno configuration
+    # and the deploy type as a string.  The deploy type is for reporting purposes only but must be included.  
+    def self.setup(configuration, deploy_type, options = {})
+      @_configuration = configuration
+      @_deploy_type = deploy_type.gsub(/:/, "_")
+      @_log_path = options[:deploy_log_path] || Dir.tmpdir
+      @_log_path << "/" unless @_log_path =~ /\/$/
+      FileUtils.mkdir_p(@_log_path)
+      @_setup = true
+      @_success = true
+    end
+    
+    def self.log(level, message, line_prefix=nil)
+      return nil unless setup?
+      @release_name = @_configuration[:release_name] if @release_name.nil?
+      @_log_file_path = @_log_path + @release_name + ".log" unless @_log_file_path
+      @_deploy_log_file = File.open(@_log_file_path, "w") if @_deploy_log_file.nil?
+       
+      indent = "%*s" % [Logger::MAX_LEVEL, "*" * (Logger::MAX_LEVEL - level)]
+      message.each do |line|
+        if line_prefix
+          @_deploy_log_file << "#{indent} [#{line_prefix}] #{line.strip}\n"
+        else
+          @_deploy_log_file << "#{indent} #{line.strip}\n"
+        end
+      end
+    end
+    
+    def self.post_process      
+      unless ::Interrupt === $!
+        puts "\n\nPlease wait while the log file is processed\n"
+        # Should dump the stack trace of an exception if there is one
+        error = $!
+        unless error.nil?
+          @_deploy_log_file << error.message << "\n"
+          @_deploy_log_file << error.backtrace.join("\n")
+          @_success = false
+        end
+        self.close
+
+        hooks = [:any]
+        hooks << self.successful? ? :success : :failure
+        puts "Executing Post Processing Hooks"
+        hooks.each do |h|
+          @_post_process_hooks[h].each do |key|
+            @_configuration.parent.find_and_execute_task(key)
+          end
+        end
+        puts "Finished Post Processing Hooks"
+      end
+    end
+    
+    # Adds a post processing hook.  
+    #
+    # Provide a task name to execute.  These tasks are executed after capistrano has actually run its course. 
+    #
+    # Takes a key to control when the hook is executed.'
+    # :any - always executed
+    # :success - only execute on success
+    # :failure - only execute on failure
+    #
+    # ==== Example
+    #  Capistrano::EYLogger.post_process_hook( "ey_logger:upload_log_to_slice", :any) 
+    #
+    def self.post_process_hook(task, key = :any)
+      @_post_process_hooks ||= Hash.new{|h,k| h[k] = []}
+      @_post_process_hooks[key] << task
+    end
+
+    def self.setup?
+      !!@_setup
+    end   
+    
+    def self.deploy_type
+      @_deploy_type
+    end
+    
+    def self.successful?
+      !!@_success
+    end
+    
+    def self.failure?
+      !@_success
+    end
+    
+    def self.log_file_path
+      @_log_file_path
+    end
+    
+    def self.remote_log_file_name
+      @_log_file_name ||= "#{@_configuration[:release_name]}-#{@_deploy_type}-#{self.successful? ? "SUCCESS" : "FAILURE"}.log"
+    end
+    
+    def self.close
+      @_deploy_log_file.flush unless @_deploy_log_file.nil?
+      @_deploy_log_file.close unless @_deploy_log_file.nil?
+      @_setup = false
+    end
+    
+  end
+end