rick-vlad 1.2.0.4

data/lib/vlad/thin.rb

@@ -0,0 +1,71 @@
+# $GEM_HOME/gems/vlad-1.2.0/lib/vlad/thin.rb
+# Thin tasks for Vlad the Deployer
+# By cnantais
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Thin app server
+
+  set :thin_address,       "127.0.0.1"
+  set :thin_command,       'thin'
+  set(:thin_conf)          { "#{shared_path}/thin_cluster.conf" }
+  set :thin_environment,   "production"
+  set :thin_group,         nil
+  set :thin_log_file,      nil
+  set :thin_pid_file,      nil
+  set :thin_port,          nil
+  set :thin_socket,        "/tmp/thin.sock"
+  set :thin_prefix,        nil
+  set :thin_servers,       2
+  set :thin_user,          nil
+  set :thin_rackup,        nil
+
+  desc "Prepares application servers for deployment. thin
+configuration is set via the thin_* variables.".cleanup
+
+  remote_task :setup_app, :roles => :app do
+    cmd = [
+           "#{thin_command} config",
+           "-s #{thin_servers}",
+           "-S #{thin_socket}",
+           "-e #{thin_environment}",
+           "-c #{current_path}",
+           "-C #{thin_conf}",
+           ("-a #{thin_address}" if thin_address),
+           ("-R #{thin_rackup}" if thin_rackup ),
+           ("-P #{thin_pid_file}" if thin_pid_file),
+           ("-l #{thin_log_file}" if thin_log_file),
+           ("--user #{thin_user}" if thin_user),
+           ("--group #{thin_group}" if thin_group),
+           ("--prefix #{thin_prefix}" if thin_prefix),
+           ("-p #{thin_port}" if thin_port),
+          ].compact.join ' '
+
+    run cmd
+  end
+
+  def thin(cmd) # :nodoc:
+    "#{thin_command} #{cmd} -C #{thin_conf}"
+  end
+
+  desc "Restart the app servers"
+
+  remote_task :start_app, :roles => :app do
+    if (use_sudo)
+      sudo thin("restart -s #{thin_servers}")
+    else
+      run thin("restart -s #{thin_servers}")
+    end
+  end
+
+  desc "Stop the app servers"
+
+  remote_task :stop_app, :roles => :app do
+    if (use_sudo)
+      sudo thin("stop -s #{thin_servers}")
+    else
+      run thin("stop -s #{thin_servers}")
+    end
+  end
+end

data/lib/vlad/web.rb

@@ -0,0 +1,12 @@
+require 'vlad'
+
+namespace :vlad do
+  namespace :web do
+    remote_task :enable, :roles => [:web] do
+      run "if [ -f #{shared_path}/system/maintenance.html ]; then rm -f #{shared_path}/system/maintenance.html; fi"
+    end
+    remote_task :disable, :roles => [:web] do
+      run "cp -f #{shared_path}/config/maintenance.html #{shared_path}/system/"
+    end
+  end
+end

data/lib/vlad.rb

@@ -0,0 +1,90 @@
+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 = {
+      :config => 'config/deploy.rb',
+      :core   => :core,
+      :scm    => :git,
+      :app    => :passenger
+    }.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/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

data/test/test_vlad.rb

@@ -0,0 +1,211 @@
+require 'test/vlad_test_case'
+require 'vlad'
+
+$TESTING = true
+
+class TestVlad < VladTestCase
+  def test_all_hosts
+    util_set_hosts
+    assert_equal %w[app.example.com db.example.com], @vlad.all_hosts
+  end
+
+  def test_fetch
+    set :foo, 5
+    assert_equal 5, @vlad.fetch(:foo)
+  end
+
+  def test_fetch_with_default
+    assert_equal 5, @vlad.fetch(:not_here, 5)
+  end
+
+  def test_host
+    @vlad.host "test.example.com", :app, :db
+    expected = {"test.example.com" => {}}
+    assert_equal expected, @vlad.roles[:app]
+    assert_equal expected, @vlad.roles[:db]
+  end
+
+  def test_host_invalid
+    assert_raise(ArgumentError) { @vlad.host "", :app, :db }
+    assert_raise(ArgumentError) { @vlad.host nil, :web }
+  end
+
+  def test_host_multiple_hosts
+    @vlad.host "test.example.com", :app, :db
+    @vlad.host "yarr.example.com", :app, :db, :no_release => true
+
+    expected = {
+      "test.example.com" => {},
+      "yarr.example.com" => {:no_release => true}
+    }
+
+    assert_equal expected, @vlad.roles[:app]
+    assert_equal expected, @vlad.roles[:db]
+    assert_not_equal(@vlad.roles[:db]["test.example.com"].object_id,
+                     @vlad.roles[:app]["test.example.com"].object_id)
+  end
+
+  def test_hosts_for_array_of_roles
+    util_set_hosts
+    assert_equal %w[app.example.com db.example.com], @vlad.hosts_for([:app, :db])
+  end
+
+  def test_hosts_for_one_role
+    util_set_hosts
+    @vlad.host "app2.example.com", :app
+    assert_equal %w[app.example.com app2.example.com], @vlad.hosts_for(:app)
+  end
+
+  def test_hosts_for_multiple_roles
+    util_set_hosts
+    assert_equal %w[app.example.com db.example.com], @vlad.hosts_for(:app, :db)
+  end
+
+  def test_hosts_for_unique
+    util_set_hosts
+    @vlad.host "app.example.com", :web
+    assert_equal %w[app.example.com db.example.com], @vlad.hosts_for(:app, :db, :web)
+  end
+
+  def test_initialize
+    @vlad.set_defaults # ensure these three are virginal
+    assert_raise(Vlad::ConfigurationError) { @vlad.code_repo }
+    assert_raise(Vlad::ConfigurationError) { @vlad.deploy_to }
+    assert_raise(Vlad::ConfigurationError) { @vlad.domain }
+  end
+
+  def test_role
+    @vlad.role :app, "test.example.com"
+    expected = {"test.example.com" => {}}
+    assert_equal expected, @vlad.roles[:app]
+  end
+
+  def test_role_multiple_hosts
+    @vlad.role :app, "test.example.com"
+    @vlad.role :app, "yarr.example.com", :no_release => true
+    expected = {
+      "test.example.com" => {},
+      "yarr.example.com" => {:no_release => true}
+    }
+    assert_equal expected, @vlad.roles[:app]
+  end
+
+  def test_role_multiple_roles
+    @vlad.role :app, "test.example.com", :primary => true
+    @vlad.role :db, "yarr.example.com", :no_release => true
+    expected_db = { "yarr.example.com" => {:no_release => true} }
+    assert_equal expected_db, @vlad.roles[:db]
+    expected_app = { "test.example.com" => {:primary => true} }
+    assert_equal expected_app, @vlad.roles[:app]
+  end
+
+  def test_remote_task
+    t = @vlad.remote_task(:test_task) { 5 }
+    assert_equal @task_count + 1, Rake.application.tasks.size
+    assert_equal Hash.new, t.options
+  end
+
+  def test_remote_task_all_hosts_by_default
+    util_set_hosts
+    t = @vlad.remote_task(:test_task) { 5 }
+    assert_equal %w[app.example.com db.example.com], t.target_hosts
+  end
+
+  def test_remote_task_environment_override
+    old_env_hosts = ENV["HOSTS"]
+    ENV["HOSTS"] = 'other1.example.com,   other2.example.com'
+    util_set_hosts
+    t = @vlad.remote_task(:test_task) { 5 }
+    assert_equal %w[other1.example.com other2.example.com], t.target_hosts
+  ensure 
+    ENV["HOSTS"] = old_env_hosts
+  end
+
+  def test_remote_task_body_set
+    set(:some_variable, 5)
+    @vlad.host 'www.example.com', :app
+    @vlad.remote_task(:some_task) do $some_task_result = some_variable end
+
+    Rake::Task['some_task'].execute nil
+    assert_equal @vlad.fetch(:some_variable), $some_task_result
+  end
+
+  def test_remote_task_with_options
+    t = @vlad.remote_task :test_task, :roles => [:app, :db] do
+      fail "should not run"
+    end
+    assert_equal({:roles => [:app, :db]}, t.options)
+  end
+
+  def test_remote_task_before_host_declaration
+    t = @vlad.remote_task :test_task, :roles => :web do 5 end
+    @vlad.host 'www.example.com', :web
+    assert_equal %w[www.example.com], t.target_hosts
+  end
+
+  def test_remote_task_role_override
+    host "db1", :db
+    host "db2", :db
+    host "db3", :db
+    host "master", :master_db
+
+    remote_task(:migrate_the_db, :roles => [:db]) { flunk "bad!" }
+    task = Rake::Task["migrate_the_db"]
+    assert_equal %w[db1 db2 db3], task.target_hosts
+
+    task.options[:roles] = :master_db
+    assert_equal %w[master], task.target_hosts
+
+    task.options[:roles] = [:master_db]
+    assert_equal %w[master], task.target_hosts
+  end
+
+  def test_set
+    set :test, 5
+    assert_equal 5, @vlad.test
+  end
+
+  def test_set_lazy_block_evaluation
+    set(:test) { fail "lose" }
+    assert_raise(RuntimeError) { @vlad.test }
+  end
+
+  def test_set_with_block
+    x = 1
+    set(:test) { x += 2 }
+
+    assert_equal 3, @vlad.test
+    assert_equal 3, @vlad.test
+  end
+
+  def test_set_with_reference
+    @vlad.instance_eval do
+      set(:var_one) { var_two }
+      set(:var_two) { var_three }
+      set(:var_three) { 5 }
+    end
+
+    assert_equal 5, @vlad.var_one
+  end
+
+  def test_set_with_block_and_value
+    e = assert_raise(ArgumentError) do
+      set(:test, 5) { 6 }
+    end
+    assert_equal "cannot provide both a value and a block", e.message
+  end
+
+  def test_set_with_nil
+    set(:test, nil)
+    assert_equal nil, @vlad.test
+  end
+
+  def test_set_with_reserved_name
+    $TESTING = false
+    e = assert_raise(ArgumentError) { set(:all_hosts, []) }
+    assert_equal "cannot set reserved name: 'all_hosts'", e.message
+  ensure
+    $TESTING = true
+  end
+end
+

data/test/test_vlad_git.rb

@@ -0,0 +1,39 @@
+require 'test/vlad_test_case'
+require 'vlad'
+require 'vlad/git'
+
+class TestVladGit < VladTestCase
+  def setup
+    super
+    @scm = Vlad::Git.new
+    set :code_repo, "git@myhost:/home/john/project1"
+  end
+
+  def test_checkout
+    # Checkout to the current directory (which is what the :update task passes)
+    cmd = @scm.checkout 'master', '.'
+    assert_equal 'rm -rf repo && git clone git@myhost:/home/john/project1 repo && cd repo && git checkout -f -b deployed-master master', cmd
+
+    # Mimic :update task
+    # 'head' should become HEAD
+    cmd = @scm.checkout 'head', '.'
+    assert_equal 'rm -rf repo && git clone git@myhost:/home/john/project1 repo && cd repo && git checkout -f -b deployed-HEAD HEAD', cmd
+
+    # Checkout to a relative path
+    cmd = @scm.checkout 'master', 'some/relative/path'
+    assert_equal 'rm -rf some/relative/path && git clone git@myhost:/home/john/project1 some/relative/path && cd some/relative/path && git checkout -f -b deployed-master master', cmd
+  end
+
+  def test_export
+    cmd = @scm.export 'master', 'the/release/path'
+    assert_equal 'mkdir -p the/release/path && git archive --format=tar master | (cd the/release/path && tar xf -)', cmd
+  end
+
+  def test_revision
+    ['head', 'HEAD'].each do |head|
+      cmd = @scm.revision(head)
+      expected = "`git rev-parse HEAD`"
+      assert_equal expected, cmd
+    end
+  end
+end

data/test/test_vlad_mercurial.rb

@@ -0,0 +1,26 @@
+require 'test/vlad_test_case'
+require 'vlad'
+require 'vlad/mercurial'
+
+class TestVladMercurial < Test::Unit::TestCase
+  def setup
+    @scm = Vlad::Mercurial.new
+    set :code_repo, "http://repo/project"
+  end
+
+  def test_checkout
+    cmd = @scm.checkout 'head', '/the/place'
+    assert_equal 'hg pull -r tip -R /the/place http://repo/project', cmd
+  end
+
+  def test_export
+    cmd = @scm.export 'head', '/the/place'
+    assert_equal 'hg archive -r tip -R http://repo/project /the/place', cmd
+  end
+
+  def test_revision
+    cmd = @scm.revision('tip')
+    expected = "`hg identify -R http://repo/project | cut -f1 -d\\ `"
+    assert_equal expected, cmd
+  end
+end

data/test/test_vlad_perforce.rb

@@ -0,0 +1,37 @@
+require 'test/vlad_test_case'
+require 'vlad'
+require 'vlad/perforce'
+
+class TestVladPerforce < VladTestCase
+  def setup
+    super
+    @scm = Vlad::Perforce.new
+  end
+
+  def test_checkout
+    cmd = @scm.checkout 'head', '/the/place'
+    assert_equal 'p4 sync ...#head', cmd
+  end
+
+  def test_checkout_revision
+    cmd = @scm.checkout 555, '/the/place'
+    assert_equal 'p4 sync ...@555', cmd
+  end
+
+  def test_export
+    cmd = @scm.export 'head', '/the/place'
+    assert_equal '(cd /the/place && p4 sync ...#head)', cmd
+  end
+
+  def test_revision
+    cmd = @scm.revision('head')
+    assert_equal '`p4 changes -s submitted -m 1 ...#head | cut -f 2 -d\\ `', cmd
+  end
+
+  def test_rev_no
+    assert_equal "@555", @scm.rev_no(555)
+    assert_equal "#head", @scm.rev_no('head')
+    assert_equal "#head", @scm.rev_no('HEAD')
+    assert_equal "@666", @scm.rev_no("@666")
+  end
+end

data/test/test_vlad_subversion.rb

@@ -0,0 +1,27 @@
+require 'test/vlad_test_case'
+require 'vlad'
+require 'vlad/subversion'
+
+class TestVladSubversion < VladTestCase
+  def setup
+    super
+    @scm = Vlad::Subversion.new
+    set :code_repo, "svn+ssh://repo/myproject"
+  end
+
+  def test_checkout
+    cmd = @scm.checkout 'HEAD', '/the/place'
+    assert_equal 'svn co -r HEAD svn+ssh://repo/myproject /the/place', cmd
+  end
+
+  def test_export
+    cmd = @scm.export 'HEAD', '/the/place'
+    assert_equal 'svn export -r HEAD svn+ssh://repo/myproject /the/place', cmd
+  end
+
+  def test_revision
+    cmd = @scm.revision('HEAD')
+    expected = "`svn info svn+ssh://repo/myproject | grep 'Revision:' | cut -f2 -d\\ `"
+    assert_equal expected, cmd
+  end
+end