isst-vlad 2.0.1

data/lib/test_case.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'rake'
+require 'remote_task'
+require 'stringio'
+
+class StringIO
+  def readpartial(size) read end # suck!
+end
+
+module Process
+  def self.expected status
+    @@expected ||= []
+    @@expected << status
+  end
+
+  class << self
+    alias :waitpid2_old :waitpid2
+
+    def waitpid2(pid)
+      [ @@expected.shift ]
+    end
+  end
+end
+
+class Rake::RemoteTask
+  attr_accessor :commands, :action, :input, :output, :error
+
+  Status = Struct.new :exitstatus
+
+  class Status
+    def success?() exitstatus == 0 end
+  end
+
+  def system *command
+    @commands << command
+    self.action ? self.action[command.join(' ')] : true
+  end
+
+  def popen4 *command
+    @commands << command
+
+    @input = StringIO.new
+    out = StringIO.new @output.shift.to_s
+    err = StringIO.new @error.shift.to_s
+
+    raise if block_given?
+
+    status = self.action ? self.action[command.join(' ')] : 0
+    Process.expected Status.new(status)
+
+    return 42, @input, out, err
+  end
+
+  def select reads, writes, errs, timeout
+    [reads, writes, errs]
+  end
+end
+
+class Rake::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @rake = Rake::RemoteTask
+    @rake.reset
+    Rake.application.clear
+    @task_count = Rake.application.tasks.size
+    @rake.set :domain, "example.com"
+  end
+
+  def util_set_hosts
+    @rake.host "app.example.com", :app
+    @rake.host "db.example.com", :db
+  end
+end

data/lib/vlad.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'thread'
+require '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 = '2.0.0'
+
+  ##
+  # Loads tasks file +tasks_file+ and various recipe styles as a hash
+  # of category/style pairs. Recipes default to:
+  #
+  #     :app    => :passenger
+  #     :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 = [:core, :type, :app, :config, :scm, :web]
+    order += options.keys - order
+
+    recipes = {
+      :app    => :passenger,
+      :type   => :sinatra,
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :subversion,
+      :web    => :nginx,
+    }.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,163 @@
+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 += shared_paths.keys.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, scm_path}",
+            "#{source.export revision, release_path}",
+            "chmod -R g+w #{latest_release}",
+            "rm -rf #{shared_paths.values.map { |p| File.join(latest_release, p) }.join(' ')}",
+            "mkdir -p #{mkdirs.map { |d| File.join(latest_release, d) }.join(' ')}"
+          ].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
+    ops = shared_paths.map do |sp, rp|
+      "ln -s #{shared_path}/#{sp} #{latest_release}/#{rp}"
+    end
+    run ops.join(' && ')
+  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
+    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 -f #{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,86 @@
+class Vlad::Git
+
+  # Duh.
+  VERSION = "2.1.0"
+
+  set :source,  Vlad::Git.new
+  set :git_cmd, "git"
+
+  ##
+  # Returns the command that will check out +revision+ from the
+  # repository into directory +destination+.  +revision+ can be any
+  # SHA1 or equivalent (e.g. branch, tag, etc...)
+
+  def checkout(revision, destination)
+    destination = File.join(destination, 'repo')
+    revision = 'HEAD' if revision =~ /head/i
+
+    if fast_checkout_applicable?(revision, destination)
+      [ "cd #{destination}",
+        "#{git_cmd} checkout -q origin",
+        "#{git_cmd} fetch",
+        "#{git_cmd} reset --hard #{revision}",
+        "#{git_cmd} submodule init",
+        "#{git_cmd} submodule update",
+        "#{git_cmd} branch -f deployed-#{revision} #{revision}",
+        "#{git_cmd} checkout deployed-#{revision}",
+        "cd -"
+      ].join(" && ")
+    else
+      [ "rm -rf #{destination}",
+        "#{git_cmd} clone #{repository} #{destination}",
+        "cd #{destination}",
+        "#{git_cmd} submodule init",
+        "#{git_cmd} submodule update",
+        "#{git_cmd} checkout -f -b deployed-#{revision} #{revision}",
+        "cd -"
+      ].join(" && ")
+    end
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the current directory
+  # into the directory +destination+.
+  # Expects to be run from +scm_path+ after Vlad::Git#checkout
+
+  def export(revision, destination)
+    revision = 'HEAD' if revision =~ /head/i
+    revision = "deployed-#{revision}"
+
+    [ "mkdir -p #{destination}",
+      "cd repo",
+      "#{git_cmd} archive --format=tar #{revision} | (cd #{destination} && tar xf -)",
+      "#{git_cmd} submodule foreach '#{git_cmd} archive --format=tar $sha1 | (cd #{destination}/$path && tar xf -)'",
+      "cd -",
+      "cd .."
+    ].join(" && ")
+  end
+
+  ##
+  # Returns a command that maps human-friendly revision identifier +revision+
+  # into a git SHA1.
+
+  def revision(revision)
+    revision = 'HEAD' if revision =~ /head/i
+
+    "`#{git_cmd} rev-parse #{revision}`"
+  end
+
+  private
+
+  # Checks if fast-checkout is applicable
+  def fast_checkout_applicable?(revision, destination)
+    revision = 'HEAD' if revision =~ /head/i
+
+    begin
+      cmd = [ "if cd #{destination}",
+              "#{git_cmd} rev-parse #{revision}",
+              "#{git_cmd} remote -v | grep -q #{repository}",
+              "cd -; then exit 0; else exit 1; fi &>/dev/null" ].join(" && ")
+      run cmd
+      return true
+    rescue Vlad::CommandFailedError
+      return false
+    end
+  end
+end

data/lib/vlad/maintenance.rb

@@ -0,0 +1,20 @@
+require 'vlad'
+
+##
+# See the following documents for recipes:
+#
+# * http://clarkware.com/cgi/blosxom/2007/01/05/CustomMaintenancePages
+# * http://blog.nodeta.fi/2009/03/11/stopping-your-rails-application-with-phusion-passenger/
+#
+
+namespace :vlad do
+  namespace :maintenance do
+    remote_task :on, :roles => [:web] do
+      run "cp -f #{shared_path}/config/maintenance.html #{shared_path}/system/"
+    end
+
+    remote_task :off, :roles => [:web] do
+      run "rm -f #{shared_path}/system/maintenance.html"
+    end
+  end
+end