vlad 1.0.0 → 1.1.0

data/lib/vlad.rb

@@ -1,76 +1,87 @@
 require 'rubygems'
-require 'rake'
 require 'thread'
 require 'rake_remote_task'
 
-# Declare a remote host and its roles. 
-# Equivalent to <tt>role</tt>, but shorter for multiple roles. 
-def host host_name, *roles
-  Rake::RemoteTask.host host_name, *roles
-end
-
-# Declare a Vlad task that will execute on all hosts by default.
-# To limit that task to specific roles, use:
-# remote_task :example, :roles => [:app, :web] do
-def remote_task name, options = {}, &b
-  Rake::RemoteTask.remote_task name, options, &b
-end
-
-# Declare a role and assign a remote host to it.
-# Equivalent to the <tt>host</tt> method; provided for capistrano compatibility.
-def role role_name, host, args = {}
-  Rake::RemoteTask.role role_name, host, args
-end
-
-# Execute the given command on the <tt>target_host</tt> for the current task.
-def run *args, &b
-  Thread.current[:task].run(*args, &b)
-end
-
-# rsync the given files to <tt>target_host</tt>.
-def rsync local, remote
-  Thread.current[:task].rsync local, remote
-end
-
-# Declare a variable called +name+ and assign it a value.
-# A globally-visible method with the name of the variable is defined.
-# If a block is given, it will be called when the variable is first accessed.
-# Subsequent references to the variable will always return the same value.
-# Raises <tt>ArgumentError</tt> if the +name+ would conflict with an existing method.
-def set name, val = nil, &b
-  Rake::RemoteTask.set name, val, &b
-end
+$TESTING ||= false
 
-# Returns the name of the host that the current task is executing on.
-# <tt>target_host</tt> can uniquely identify a particular task/host combination.
-def target_host
-  Thread.current[:task].target_host
-end
+##
+# Vlad the Deployer - Pragmatic application deployment automation, without mercy.
+#
+# Please read doco/getting_started.txt or http://rubyhitsquad.com/
+#
+# === Basic scenario:
+#
+# 1. rake vlad:setup   (first time only)
+# 2. rake vlad:update
+# 3. rake vlad:migrate (optional)
+# 4. rake vlad:start
 
 module Vlad
 
+  ##
   # This is the version of Vlad you are running.
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
+  ##
   # Base error class for all Vlad errors.
   class Error < RuntimeError; end
 
+  ##
   # Raised when you have incorrectly configured Vlad.
   class ConfigurationError < Error; end
 
+  ##
   # Raised when a remote command fails.
   class CommandFailedError < Error; end
 
+  ##
   # Raised when an environment variable hasn't been set.
   class FetchError < Error; end
 
-  # Loads tasks file +tasks_file+ and the vlad_tasks file.
-  def self.load tasks_file = 'config/deploy.rb'
-    Kernel.load tasks_file
-    require 'vlad_tasks'
+  ##
+  # Loads tasks file +tasks_file+ and various recipe styles as a hash
+  # of category/style pairs. Recipes default to:
+  #
+  #     :app    => :mongrel
+  #     :config => 'config/deploy.rb'
+  #     :core   => :core
+  #     :scm    => :subversion
+  #     :web    => :apache
+  #
+  # You can override individual values and/or set to nil to
+  # deactivate. :config will get loaded last to ensure that user
+  # variables override default values.
+  #
+  # And by all means, feel free to skip this entirely if it doesn't
+  # fit for you. All it does is a fancy-pants require. Require
+  # whatever files you need as you see fit straight from your
+  # Rakefile. YAY for simple and clean!
+  def self.load options = {}
+    options = {:config => options} if String === options
+
+    recipes = {
+      :app    => :mongrel,
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :subversion,
+      :web    => :apache,
+    }.merge(options)
+
+    recipes.each do |flavor, recipe|
+      next if recipe.nil? or flavor == :config
+      require "vlad/#{recipe}"
+    end
+
+    Kernel.load recipes[:config]
   end
-
 end
 
-Rake::RemoteTask.reset
-
+class String #:nodoc:
+  def cleanup
+    if ENV['FULL'] then
+      gsub(/\s+/, ' ').strip
+    else
+      self[/\A.*?\./]
+    end
+  end
+end

data/lib/vlad/apache.rb

@@ -0,0 +1,37 @@
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Apache web server
+
+  set :web_command, "apachectl"
+
+  desc "(Re)Start the web servers"
+
+  remote_task :start_web, :roles => :web  do
+    run "#{web_command} restart"
+  end
+
+  desc "Stop the web servers"
+
+  remote_task :stop_web, :roles => :web  do
+    run "#{web_command} stop"
+  end
+
+  ##
+  # Everything HTTP.
+
+  desc "(Re)Start the web and app servers"
+
+  remote_task :start do
+    Rake::Task['vlad:start_app'].invoke
+    Rake::Task['vlad:start_web'].invoke
+  end
+
+  desc "Stop the web and app servers"
+
+  remote_task :stop do
+    Rake::Task['vlad:stop_app'].invoke
+    Rake::Task['vlad:stop_web'].invoke
+  end
+end

data/lib/{vlad_tasks.rb → vlad/core.rb}

@@ -1,30 +1,10 @@
 require 'vlad'
 
-class String #:nodoc:
-  def cleanup
-    if ENV['FULL'] then
-      gsub(/\s+/, ' ').strip
-    else
-      self[/\A.*?\./]
-    end
-  end
-end
-
 ##
-# Ideal scenarios:
-#
-# Initial:
-#
-# 1) rake vlad:setup
-# 2) rake vlad:update
-# 3) rake vlad:migrate
-# 4) rake vlad:start
-#
-# Subsequent:
-#
-# 1) rake vlad:update
-# 2) rake vlad:migrate (optional)
-# 3) rake vlad:start
+# used by update, out here so we can ensure all threads have the same value
+def now
+  @now ||= Time.now.utc.strftime("%Y%m%d%H%M.%S")
+end
 
 namespace :vlad do
   desc "Show the vlad setup.  This is all the default variables for vlad
@@ -32,15 +12,20 @@ namespace :vlad do
 
   task :debug do
     require 'yaml'
+
+    # force them into values
+    Rake::RemoteTask.env.keys.each do |key|
+      next if key =~ /_release|releases|sudo_password/
+      Rake::RemoteTask.fetch key
+    end
+
     puts "# Environment:"
+    puts
     y Rake::RemoteTask.env
     puts "# Roles:"
     y Rake::RemoteTask.roles
   end
 
-  # used by update, out here so we can ensure all threads have the same value
-  now = Time.now.utc.strftime("%Y%m%d%H%M.%S")
-
   desc "Setup your servers. Before you can use any of the deployment
     tasks with your project, you will need to make sure all of your
     servers have been prepared with 'rake vlad:setup'. It is safe to
@@ -51,10 +36,10 @@ namespace :vlad do
     Rake::Task['vlad:setup_app'].invoke
   end
 
-  desc "Updates your application server to the latest revision.  Syncs a copy
-    of the repository, exports it as the latest release, fixes up your
-    symlinks, touches your assets, symlinks the latest revision to current and
-    logs the update.".cleanup
+  desc "Updates your application server to the latest revision.  Syncs
+    a copy of the repository, exports it as the latest release, fixes
+    up your symlinks, symlinks the latest revision to current and logs
+    the update.".cleanup
 
   remote_task :update, :roles => :app do
     symlink = false
@@ -71,12 +56,8 @@ namespace :vlad do
             "ln -s #{shared_path}/pids #{latest_release}/tmp/pids",
           ].join(" && ")
 
-      asset_paths = %w(images stylesheets javascripts).map { |p| "#{latest_release}/public/#{p}" }.join(" ")
-      run "find #{asset_paths} -exec touch -t #{now} {} ';'; true"
-
       symlink = true
       run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
-      # Rake::Task["vlad:migrate"].invoke
 
       run "echo #{now} $USER #{'head'} #{File.basename release_path} >> #{deploy_to}/revisions.log" # FIX shouldn't be head
     rescue => e
@@ -92,7 +73,6 @@ namespace :vlad do
     directory by setting :migrate_target to :current.  Additional environment
     variables can be passed to rake via the migrate_env variable.".cleanup
 
-  # HACK :only => { :primary => true }
   # No application files are on the DB machine, also migrations should only be
   # run once.
   remote_task :migrate, :roles => :app do
@@ -104,7 +84,7 @@ namespace :vlad do
                 else raise ArgumentError, "unknown migration target #{migrate_target.inspect}"
                 end
 
-    run "cd #{directory}; #{rake} RAILS_ENV=#{rails_env} #{migrate_args} db:migrate"
+    run "cd #{current_path}; #{rake_cmd} RAILS_ENV=#{rails_env} db:migrate #{migrate_args}"
   end
 
   desc "Invoke a single command on every remote server. This is useful for
@@ -122,9 +102,9 @@ namespace :vlad do
     puts run(command)
   end
 
-  desc "Copy files to the currently deployed version. This is useful for
-    updating files piecemeal when you need to quickly deploy only a single
-    file.
+  desc "Copy arbitrary files to the currently deployed version using
+    FILES=a,b,c. This is useful for updating files piecemeal when you
+    need to quickly deploy only a single file.
 
     To use this task, specify the files and directories you want to copy as a
     comma-delimited list in the FILES environment variable. All directories
@@ -172,7 +152,7 @@ namespace :vlad do
 
   remote_task :cleanup do
     count = keep_releases
-    if count >= releases.length then
+    unless count >= releases.length then
       puts "no old releases to clean up"
     else
       puts "keeping #{count} of #{releases.length} deployed releases"
@@ -185,98 +165,4 @@ namespace :vlad do
     end
   end
 
-  ##
-  # Mongrel app server
-
-  set :mongrel_address, "127.0.0.1"
-  set :mongrel_clean, false
-  set :mongrel_command, 'mongrel_rails'
-  set :mongrel_conf, "#{shared_path}/mongrel_cluster.conf"
-  set :mongrel_config_script, nil
-  set :mongrel_environment, "production"
-  set :mongrel_group, nil
-  set :mongrel_log_file, nil
-  set :mongrel_pid_file, nil
-  set :mongrel_port, 8000
-  set :mongrel_prefix, nil
-  set :mongrel_servers, 2
-  set :mongrel_user, nil
-
-  desc "Prepares application servers for deployment. Mongrel configuration is set via the mongrel_*
-    variables.".cleanup
-
-  remote_task :setup_app, :roles => :app do
-    dirs = [deploy_to, releases_path, scm_path, shared_path]
-    dirs += %w(system log pids).map { |d| File.join(shared_path, d) }
-    run "umask 02 && mkdir -p #{dirs.join(' ')}"
-
-    cmd = [
-           "#{mongrel_command} cluster::configure",
-           "-N #{mongrel_servers}",
-           "-p #{mongrel_port}",
-           "-e #{mongrel_environment}",
-           "-a #{mongrel_address}",
-           "-c #{current_path}",
-           "-C #{mongrel_conf}",
-           ("-P #{mongrel_pid_file}" if mongrel_pid_file),
-           ("-l #{mongrel_log_file}" if mongrel_log_file),
-           ("--user #{mongrel_user}" if mongrel_user),
-           ("--group #{mongrel_group}" if mongrel_group),
-           ("--prefix #{mongrel_prefix}" if mongrel_prefix),
-           ("-S #{mongrel_config_script}" if mongrel_config_script),
-            ].compact.join ' '
-
-    run cmd
-  end
-
-  desc "Restart the app servers"
-
-  remote_task :start_app, :roles => :app do
-    cmd = "#{mongrel_command} cluster::restart -C #{mongrel_conf}"
-    cmd << ' --clean' if mongrel_clean
-    run cmd
-  end
-
-  desc "Stop the app servers"
-
-  remote_task :stop_app, :roles => :app do
-    cmd = "#{mongrel_command} cluster::stop -C #{mongrel_conf}"
-    cmd << ' --clean' if mongrel_clean
-    run cmd
-  end
-
-  ##
-  # Apache web server
-
-  set :web_command, "apachectl"
-
-  desc "Restart the web servers"
-
-  remote_task :start_web, :roles => :web  do
-    run "#{web_command} restart"
-  end
-
-  desc "Stop the web servers"
-
-  remote_task :stop_web, :roles => :web  do
-    run "#{web_command} stop"
-  end
-
-  ##
-  # Everything HTTP.
-
-  desc "Restart the web and app servers"
-
-  remote_task :start do
-    Rake::Task['vlad:start_app'].invoke
-    Rake::Task['vlad:start_web'].invoke
-  end
-
-  desc "Stop the web and app servers"
-
-  remote_task :stop do
-    Rake::Task['vlad:stop_app'].invoke
-    Rake::Task['vlad:stop_web'].invoke
-  end
-
 end # namespace vlad

data/lib/vlad/mongrel.rb

@@ -0,0 +1,65 @@
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Mongrel app server
+
+  set :mongrel_address,       "127.0.0.1"
+  set :mongrel_clean,         false
+  set :mongrel_command,       'mongrel_rails'
+  set(:mongrel_conf)          { "#{shared_path}/mongrel_cluster.conf" }
+  set :mongrel_config_script, nil
+  set :mongrel_environment,   "production"
+  set :mongrel_group,         nil
+  set :mongrel_log_file,      nil
+  set :mongrel_pid_file,      nil
+  set :mongrel_port,          8000
+  set :mongrel_prefix,        nil
+  set :mongrel_servers,       2
+  set :mongrel_user,          nil
+
+  desc "Prepares application servers for deployment. Mongrel
+configuration is set via the mongrel_* variables.".cleanup
+
+  remote_task :setup_app, :roles => :app do
+    dirs = [deploy_to, releases_path, scm_path, shared_path]
+    dirs += %w(system log pids).map { |d| File.join(shared_path, d) }
+    run "umask 02 && mkdir -p #{dirs.join(' ')}"
+
+    cmd = [
+           "#{mongrel_command} cluster::configure",
+           "-N #{mongrel_servers}",
+           "-p #{mongrel_port}",
+           "-e #{mongrel_environment}",
+           "-a #{mongrel_address}",
+           "-c #{current_path}",
+           "-C #{mongrel_conf}",
+           ("-P #{mongrel_pid_file}" if mongrel_pid_file),
+           ("-l #{mongrel_log_file}" if mongrel_log_file),
+           ("--user #{mongrel_user}" if mongrel_user),
+           ("--group #{mongrel_group}" if mongrel_group),
+           ("--prefix #{mongrel_prefix}" if mongrel_prefix),
+           ("-S #{mongrel_config_script}" if mongrel_config_script),
+          ].compact.join ' '
+
+    run cmd
+  end
+
+  def mongrel(cmd) # :nodoc:
+    cmd = "#{mongrel_command} #{cmd} -C #{mongrel_conf}"
+    cmd << ' --clean' if mongrel_clean
+    cmd
+  end
+
+  desc "Restart the app servers"
+
+  remote_task :start_app, :roles => :app do
+    run mongrel("cluster::restart")
+  end
+
+  desc "Stop the app servers"
+
+  remote_task :stop_app, :roles => :app do
+    run mongrel("cluster::stop")
+  end
+end