m7d-vlad 1.2.0.4

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.3'
+
+  ##
+  # 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
+
+    recipes = {
+      :app    => 'merb',
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :git,
+      :web    => :maintenance,
+    }.merge(options)
+    
+    # be sure core comes first so base tasks aren't clobbered
+    if core = recipes.delete(:core)
+      require "vlad/#{core}"
+    end
+    recipes.each do |flavor, recipe|
+      next if recipe.nil? or flavor == :config
+      require "vlad/#{recipe}"
+    end
+
+    Kernel.load recipes[:config]
+  end
+end
+
+class String #:nodoc:
+  def cleanup
+    if ENV['FULL'] then
+      gsub(/\s+/, ' ').strip
+    else
+      self[/\A.*?\./]
+    end
+  end
+end

data/lib/vlad/core.rb

@@ -0,0 +1,175 @@
+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 02 && 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",
+            "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(" && ")
+
+      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 "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,43 @@
+class Vlad::Git
+
+  set :source, Vlad::Git.new
+  set :git_cmd, "git"
+
+  ##
+  # Returns the command that will check out +revision+ from the
+  # code repo into directory +destination+.  +revision+ can be any
+  # SHA1 or equivalent (e.g. branch, tag, etc...)
+
+  def checkout(revision, destination)
+    destination = 'repo' if destination == '.'
+    revision = 'HEAD' if revision =~ /head/i
+
+    [ "rm -rf #{destination}",
+      "#{git_cmd} clone #{code_repo} #{destination}",
+      "cd #{destination}",
+      "#{git_cmd} checkout -f -b deployed-#{revision} #{revision}"
+    ].join(" && ")
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the code repo into
+  # the directory +destination+.
+
+  def export(revision, destination)
+    revision = 'HEAD' if revision == "."
+
+    [ "mkdir -p #{destination}",
+      "#{git_cmd} archive --format=tar #{revision} | (cd #{destination} && tar xf -)"
+    ].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
+end

data/lib/vlad/maintenance.rb

@@ -0,0 +1,23 @@
+namespace :vlad do
+  desc "Remove the maintenance page"
+  remote_task :start_web, :roles => [:web] do
+    run "if [ -f #{shared_path}/system/maintenance.html ]; then rm -f #{shared_path}/system/maintenance.html; fi"
+  end
+
+  desc "Put the maintenance page in place"
+  remote_task :stop_web, :roles => [:web] do
+    run "cp -f #{shared_path}/config/maintenance.html #{shared_path}/system/"
+  end
+
+  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/test/test_rake_remote_task.rb

@@ -0,0 +1,186 @@
+require 'test/vlad_test_case'
+require 'vlad'
+
+class TestRakeRemoteTask < VladTestCase
+  def test_enhance
+    util_set_hosts
+    body = Proc.new { 5 }
+    task = @vlad.remote_task(:some_task => :foo, &body)
+    action = Rake::RemoteTask::Action.new(task, body)
+    assert_equal [action], task.remote_actions
+    assert_equal task, action.task
+    assert_equal ["foo"], task.prerequisites
+  end
+
+  def test_enhance_with_no_task_body
+    util_set_hosts
+    util_setup_task
+    assert_equal [], @task.remote_actions
+    assert_equal [], @task.prerequisites
+  end
+
+  def test_execute
+    util_set_hosts
+    set :some_variable, 1
+    x = 5
+    task = @vlad.remote_task(:some_task) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 2, task.remote_actions.first.workers.size
+    assert_equal 7, x
+  end
+
+  def test_execute_exposes_target_host
+    host "app.example.com", :app
+    task = remote_task(:target_task) { set(:test_target_host, target_host) }
+    task.execute nil
+    assert_equal "app.example.com", Rake::RemoteTask.fetch(:test_target_host)
+  end
+
+  def test_execute_with_no_hosts
+    @vlad.host "app.example.com", :app
+    t = @vlad.remote_task(:flunk, :roles => :db) { flunk "should not have run" }
+    e = assert_raise(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified for task: flunk", e.message
+  end
+
+  def test_execute_with_no_roles
+    t = @vlad.remote_task(:flunk, :roles => :junk) { flunk "should not have run" }
+    e = assert_raise(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified for task: flunk", e.message
+  end
+
+  def test_execute_with_roles
+    util_set_hosts
+    set :some_variable, 1
+    x = 5
+    task = @vlad.remote_task(:some_task, :roles => :db) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 6, x
+  end
+
+  def test_rsync
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    @task.rsync 'localfile', 'remotefile'
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal %w[rsync -azP --delete localfile app.example.com:remotefile],
+                 commands.first, 'rsync'
+  end
+
+  def test_rsync_fail
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.action = lambda { false }
+
+    e = assert_raise(Vlad::CommandFailedError) { @task.rsync 'local', 'remote' }
+    assert_equal "execution failed: rsync -azP --delete local app.example.com:remote", e.message
+  end
+
+  def test_run
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+
+    out, err = util_capture do
+      result = @task.run("ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ["ssh", "app.example.com", "ls"],
+                 commands.first, 'app'
+    assert_equal "file1\nfile2\n", result
+
+    assert_equal "file1\nfile2\n", out.read
+    assert_equal '', err.read
+  end
+
+  def test_run_failing_command
+    util_set_hosts
+    util_setup_task
+    @task.input = StringIO.new "file1\nfile2\n"
+    @task.target_host =  'app.example.com'
+    @task.action = lambda { 1 }
+
+    e = assert_raise(Vlad::CommandFailedError) { @task.run("ls") }
+    assert_equal "execution failed with status 1: ssh app.example.com ls", e.message
+
+    assert_equal 1, @task.commands.size
+  end
+
+  def test_run_sudo
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.error << 'Password:'
+    @task.target_host = "app.example.com"
+    def @task.sudo_password() "my password" end # gets defined by set
+    result = nil
+
+    out, err = util_capture do
+      result = @task.run("sudo ls")
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal ['ssh', 'app.example.com', 'sudo ls'],
+                 commands.first
+
+    assert_equal "my password\n", @task.input.string
+
+    # WARN: Technically incorrect, the password line should be
+    # first... this is an artifact of changes to the IO code in run
+    # and the fact that we have a very simplistic (non-blocking)
+    # testing model.
+    assert_equal "file1\nfile2\nPassword:\n", result
+
+    assert_equal "file1\nfile2\n", out.read
+    assert_equal "Password:\n", err.read
+  end
+
+  def test_sudo
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.sudo "ls" 
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'wrong number of commands'
+    assert_equal ["ssh", "app.example.com", "sudo ls"],
+                 commands.first, 'app'
+  end
+
+  def util_capture
+    require 'stringio'
+    orig_stdout = $stdout.dup
+    orig_stderr = $stderr.dup
+    captured_stdout = StringIO.new
+    captured_stderr = StringIO.new
+    $stdout = captured_stdout
+    $stderr = captured_stderr
+    yield
+    captured_stdout.rewind
+    captured_stderr.rewind
+    return captured_stdout, captured_stderr
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+
+  def util_setup_task(options = {})
+    @task = @vlad.remote_task :test_task, options
+    @task.commands = []
+    @task.output = []
+    @task.error = []
+    @task.action = nil
+    @task
+  end
+end