kaykay-vlad 1.2.0.1

data/lib/vlad/mongrel.rb

@@ -0,0 +1,61 @@
+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
+    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

data/lib/vlad/perforce.rb

@@ -0,0 +1,117 @@
+class Vlad::Perforce
+
+  set :p4_cmd, "p4"
+  set :source, Vlad::Perforce.new
+
+  ##
+  # Returns the p4 command that will checkout +revision+ into the directory
+  # +destination+.
+
+  def checkout(revision, destination)
+    "#{p4_cmd} sync ...#{rev_no(revision)}"
+  end
+
+  ##
+  # Returns the p4 command that will export +revision+ into the directory
+  # +directory+.
+
+  def export(revision_or_source, destination)
+    if revision_or_source =~ /^(\d+|head)$/i then
+      "(cd #{destination} && #{p4_cmd} sync ...#{rev_no(revision_or_source)})"
+    else
+      "cp -r #{revision_or_source} #{destination}"
+    end
+  end
+
+  ##
+  # Returns a command that maps human-friendly revision identifier +revision+
+  # into a Perforce revision specification.
+
+  def revision(revision)
+    "`#{p4_cmd} changes -s submitted -m 1 ...#{rev_no(revision)} | cut -f 2 -d\\ `"
+  end
+
+  ##
+  # Maps revision +revision+ into a Perforce revision.
+
+  def rev_no(revision)
+    case revision.to_s
+    when /head/i then
+      "#head"
+    when /^\d+$/ then
+      "@#{revision}"
+    else
+      revision
+    end
+  end
+end
+
+namespace :vlad do
+  remote_task :setup_app, :roles => :app do
+    p4data = p4port = p4user = p4passwd = nil
+
+    if ENV['P4CONFIG'] then
+      p4config_name = ENV['P4CONFIG']
+      p4config = nil
+      orig_dir = Dir.pwd.split File::SEPARATOR
+
+      until orig_dir.length == 1 do
+        p4config = orig_dir + [p4config_name]
+        p4config = File.join p4config
+        break if File.exist? p4config
+        orig_dir.pop
+      end
+
+      raise "couldn't find .p4config" unless File.exist? p4config
+
+      p4data = File.readlines(p4config).map { |line| line.strip.split '=', 2 }
+      p4data = Hash[*p4data.flatten]
+    else
+      p4data = ENV
+    end
+
+    p4port = p4data['P4PORT']
+    p4user = p4data['P4USER']
+    p4passwd = p4data['P4PASSWD']
+
+    raise "couldn't get P4PORT" if p4port.nil?
+    raise "couldn't get P4USER" if p4user.nil?
+    raise "couldn't get P4PASSWD" if p4passwd.nil?
+
+    p4client = [p4user, target_host, application].join '-'
+
+    require 'tmpdir'
+    require 'tempfile'
+
+    put File.join(scm_path, '.p4config'), 'vlad.p4config' do
+      [ "P4PORT=#{p4port}",
+        "P4USER=#{p4user}",
+        "P4PASSWD=#{p4passwd}",
+        "P4CLIENT=#{p4client}" ].join("\n")
+    end
+
+    p4client_path = File.join deploy_to, 'p4client.tmp'
+
+    put p4client_path, 'vlad.p4client' do
+      conf = <<-"CLIENT"
+Client:	#{p4client}
+
+Owner:	#{p4user}
+
+Root:	#{scm_path}
+
+View:
+  #{repository}/... //#{p4client}/...
+      CLIENT
+    end
+
+    cmds = [
+      "cd #{scm_path}",
+      "p4 client -i < #{p4client_path}",
+      "rm #{p4client_path}",
+    ]
+
+    run cmds.join(' && ')
+  end
+end
+

data/lib/vlad/subversion.rb

@@ -0,0 +1,34 @@
+class Vlad::Subversion
+
+  set :source, Vlad::Subversion.new
+  set :svn_cmd, "svn"
+
+  ##
+  # Returns the command that will check out +revision+ from the repository
+  # into directory +destination+
+
+  def checkout(revision, destination)
+    "#{svn_cmd} co -r #{revision} #{repository} #{destination}"
+  end
+
+  ##
+  # Returns the command that will export +revision+ from the repository into
+  # the directory +destination+.
+
+  def export(revision_or_source, destination)
+    if revision_or_source =~ /^(\d+|head)$/i then
+      "#{svn_cmd} export -r #{revision_or_source} #{repository} #{destination}"
+    else
+      "#{svn_cmd} export #{revision_or_source} #{destination}"
+    end
+  end
+
+  ##
+  # Returns a command that maps human-friendly revision identifier +revision+
+  # into a subversion revision specification.
+
+  def revision(revision)
+    "`#{svn_cmd} info #{repository} | grep 'Revision:' | cut -f2 -d\\ `"
+  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.repository }
+    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
+