gabrielg-vlad 1.2.0

data/lib/vlad.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'thread'
+require 'rake_remote_task'
+
+$TESTING ||= false
+
+##
+# 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.2.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 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
+    order = [:app, :config, :core, :scm, :web]
+    order += options.keys - order
+
+    recipes = {
+      :app    => :mongrel,
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :subversion,
+      :web    => :apache,
+    }.merge(options)
+
+    order.each do |flavor|
+      recipe = recipes[flavor]
+      next if recipe.nil? or flavor == :config
+      require "vlad/#{recipe}"
+    end
+
+    Kernel.load recipes[:config]
+    Kernel.load "config/deploy_#{ENV['to']}.rb" if ENV['to']
+  end
+end
+
+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/core.rb

@@ -0,0 +1,181 @@
+require 'vlad'
+
+##
+# 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
+    tasks.".cleanup
+
+  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
+
+  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
+    run this task on servers that have already been set up; it will
+    not destroy any deployed revisions or data.".cleanup
+
+  task :setup do
+    Rake::Task['vlad:setup_app'].invoke
+  end
+
+  desc "Prepares application servers for deployment.".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 #{umask} && mkdir -p #{dirs.join(' ')}"
+  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, symlinks the latest revision to current and logs
+    the update.".cleanup
+
+  remote_task :update, :roles => :app do
+    symlink = false
+    begin
+      run [ "cd #{scm_path}",
+            "#{source.checkout revision, '.'}",
+            "#{source.export ".", release_path}",
+            "chmod -R g+w #{latest_release}",
+            "rm -rf #{latest_release}/log #{latest_release}/public/system #{latest_release}/tmp/pids",
+            "mkdir -p #{latest_release}/db #{latest_release}/tmp"
+          ].join(" && ")
+      Rake::Task['vlad:update_symlinks'].invoke
+
+      symlink = true
+      run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+
+      run "echo #{now} $USER #{revision} #{File.basename release_path} >> #{deploy_to}/revisions.log"
+    rescue => e
+      run "rm -f #{current_path} && ln -s #{previous_release} #{current_path}" if
+        symlink
+      run "rm -rf #{release_path}"
+      raise e
+    end
+  end
+
+  desc "Updates the symlinks for shared paths".cleanup
+
+  remote_task :update_symlinks, :roles => :app do
+    run [ "ln -s #{shared_path}/log #{latest_release}/log",
+          "ln -s #{shared_path}/system #{latest_release}/public/system",
+          "ln -s #{shared_path}/pids #{latest_release}/tmp/pids" ].join(" && ")
+  end
+
+  desc "Run the migrate rake task for the the app. By default this is run in
+    the latest app directory.  You can run migrations for the current app
+    directory by setting :migrate_target to :current.  Additional environment
+    variables can be passed to rake via the migrate_env variable.".cleanup
+
+  # No application files are on the DB machine, also migrations should only be
+  # run once.
+  remote_task :migrate, :roles => :app do
+    break unless target_host == Rake::RemoteTask.hosts_for(:app).first
+
+    directory = case migrate_target.to_sym
+                when :current then current_path
+                when :latest  then current_release
+                else raise ArgumentError, "unknown migration target #{migrate_target.inspect}"
+                end
+
+    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
+    performing one-off commands that may not require a full task to be written
+    for them.  Simply specify the command to execute via the COMMAND
+    environment variable.  To execute the command only on certain roles,
+    specify the ROLES environment variable as a comma-delimited list of role
+    names.
+
+      $ rake vlad:invoke COMMAND='uptime'".cleanup
+
+  remote_task :invoke do
+    command = ENV["COMMAND"]
+    abort "Please specify a command to execute on the remote servers (via the COMMAND environment variable)" unless command
+    puts run(command)
+  end
+
+  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
+    will be processed recursively, with all files being pushed to the
+    deployment servers. Any file or directory starting with a '.' character
+    will be ignored.
+
+      $ rake vlad:upload FILES=templates,controller.rb".cleanup
+
+  remote_task :upload do
+    file_list = (ENV["FILES"] || "").split(",")
+
+    files = file_list.map do |f|
+      f = f.strip
+      File.directory?(f) ? Dir["#{f}/**/*"] : f
+    end.flatten
+
+    files = files.reject { |f| File.directory?(f) || File.basename(f)[0] == ?. }
+
+    abort "Please specify at least one file to update (via the FILES environment variable)" if files.empty?
+
+    files.each do |file|
+      rsync file, File.join(current_path, file)
+    end
+  end
+
+  desc "Rolls back to a previous version and restarts. This is handy if you
+    ever discover that you've deployed a lemon; 'rake vlad:rollback' and
+    you're right back where you were, on the previously deployed
+    version.".cleanup
+
+  remote_task :rollback do
+    if releases.length < 2 then
+      abort "could not rollback the code because there is no prior release"
+    else
+      run "rm #{current_path}; ln -s #{previous_release} #{current_path} && rm -rf #{current_release}"
+    end
+
+    Rake::Task['vlad:start'].invoke
+  end
+
+  desc "Clean up old releases. By default, the last 5 releases are kept on
+    each server (though you can change this with the keep_releases variable).
+    All other deployed revisions are removed from the servers.".cleanup
+
+  remote_task :cleanup do
+    max = keep_releases
+    if releases.length <= max then
+      puts "no old releases to clean up #{releases.length} <= #{max}"
+    else
+      puts "keeping #{max} of #{releases.length} deployed releases"
+
+      directories = (releases - releases.last(max)).map { |release|
+        File.join(releases_path, release)
+      }.join(" ")
+
+      run "rm -rf #{directories}"
+    end
+  end
+
+end # namespace vlad

data/lib/vlad/git.rb

@@ -0,0 +1,54 @@
+class Vlad::Git
+
+  set :source, Vlad::Git.new
+  set :git_cmd, "git"
+
+  ## 
+  # Sets up a repository on the remote server to fetch changes to and
+  # to deploy new releases from
+  
+  def setup
+    ["cd #{scm_path}",
+     "#{git_cmd} clone #{repository} repo"].join(" && ")
+  end
+  
+  ##
+  # Returns the command that will check out +revision+ from the
+  # repository. +revision+ can be any SHA1 or equivalent 
+  # (e.g. branch, tag, etc...)
+
+  def checkout(revision, whatever)
+    revision = 'HEAD' if revision =~ /head/i
+    
+    ["cd #{scm_path}/repo",
+     "#{git_cmd} fetch",
+     "#{git_cmd} fetch --tags",
+     "#{git_cmd} checkout -f #{revision}",
+     "#{git_cmd} submodule init",
+     "#{git_cmd} submodule update"
+    ].join(" && ")
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the repository into
+  # the directory +destination+.
+
+  def export(revision, destination)
+    revision = 'HEAD' if revision == "."
+
+    ["mkdir -p #{destination}",
+     "cd #{scm_path}/repo && find . | grep -v '/.git' | cpio -p --make-directories #{destination}"
+    ].join(" && ")
+  end
+  
+  def self.setup_rake_tasks
+    desc "Sets up a Git clone to deploy from on the remote host"
+    remote_task 'vlad:setup:git', :roles => :app do
+      run source.setup
+    end
+    
+    task('vlad:setup') { Rake::Task['vlad:setup:git'].invoke }
+  end
+  
+  setup_rake_tasks
+end

data/lib/vlad/lighttpd.rb

@@ -0,0 +1,85 @@
+require 'vlad'
+
+namespace :vlad do
+
+  set :lighttpd_port, 65536
+  set :web_command, "lighttpd"
+  set :lighttpd_user, "nobody"
+  set :lighttpd_group, "nobody"
+  set(:lighttpd_init) { "#{shared_path}/lighttpd.sh" }
+  set(:lighttpd_conf) { "#{shared_path}/lighttpd.conf" }
+
+  desc "Prepares application servers for deployment. Lighttpd
+configuration is set via the lighttpd_* variables.".cleanup
+
+  remote_task :setup_lighttpd, :roles => :app do
+    require 'tempfile'
+
+    put lighttpd_conf, 'vlad.lighttpd_config' do
+      conf = <<-"EOF"
+server.modules = ( "mod_rewrite",
+                   "mod_access",
+                   "mod_fastcgi",
+                   "mod_compress",
+                   "mod_accesslog" )
+
+server.document-root     = "#{current_path}/public"
+server.errorlog          = "#{shared_path}/log/lighttpd.error.log"
+accesslog.filename       = "#{shared_path}/log/lighttpd.access.log"
+server.pid-file          = "#{shared_path}/pids/lighttpd.pid"
+server.port              =  #{lighttpd_port}
+server.username          = "#{lighttpd_user}"
+server.groupname         = "#{lighttpd_group}"
+server.error-handler-404 = "/dispatch.fcgi"
+server.indexfiles        = ( "index.html", "index.rb" )
+url.access-deny          = ( "~", ".inc" )
+compress.cache-dir       = "#{shared_path}/tmp/cache/compress"
+compress.filetype        = ("text/html","text/plain","text/javascript","text/css")
+server.tag               = "lighttpd | TextDriven"
+
+fastcgi.server = (
+  ".fcgi" => (
+    "localhost" => (
+      "min-procs" => 1,
+      "max-procs" => 1,
+      "socket"    => "#{shared_path}/pids/rubyholic.socket",
+      "bin-path"  => "#{current_path}/public/dispatch.fcgi",
+      "bin-environment" => ( "RAILS_ENV" => "production" ) ) ) )
+      EOF
+    end
+
+    run "mkdir -p \"#{shared_path}/tmp/cache/compress\""
+  end
+
+  desc "(Re)Start the web servers"
+
+  remote_task :start_web, :roles => :web  do
+    cmd = %w(lighttpd ruby).map {|app| "(killall #{app} || true)"}.join(" && ")
+    cmd += " && #{web_command} -f #{lighttpd_conf} </dev/null >/dev/null 2>&1"
+    run cmd
+  end
+
+  desc "Stop the web servers"
+  remote_task :stop_web, :roles => :web  do
+    cmd = %w(lighttpd ruby).map {|app| "(killall #{app} || true)"}.join(" && ")
+
+    run cmd
+  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