ktheory-vlad 2.0.0

data/lib/vlad/thin.rb

@@ -0,0 +1,63 @@
+# $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
+    run thin("restart -s #{thin_servers}")
+  end
+
+  desc "Stop the app servers"
+
+  remote_task :stop_app, :roles => :app do
+    run thin("stop -s #{thin_servers}")
+  end
+end

data/lib/vlad_test_case.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'stringio'
+require 'vlad'
+
+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 VladTestCase < MiniTest::Unit::TestCase
+  def setup
+    @vlad = Rake::RemoteTask
+    @vlad.reset
+    Rake.application.clear
+    @task_count = Rake.application.tasks.size
+    @vlad.set :domain, "example.com"
+  end
+
+  def util_set_hosts
+    @vlad.host "app.example.com", :app
+    @vlad.host "db.example.com", :db
+  end
+end

data/test/test_rake_remote_task.rb

@@ -0,0 +1,279 @@
+require 'vlad_test_case'
+require 'vlad'
+
+class TestRakeRemoteTask < VladTestCase
+  # TODO: move to minitest
+  def assert_silent
+    out, err = capture_io do
+      yield
+    end
+
+    assert_empty err
+    assert_empty out
+  end
+
+  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
+    set :can_set_nil, nil
+    set :lies_are, false
+    x = 5
+    task = @vlad.remote_task(:some_task) { x += some_variable }
+    task.execute nil
+    assert_equal 1, task.some_variable
+    assert_equal 7, x
+    assert task.can_set_nil.nil?
+    assert_equal false, task.lies_are
+  end
+
+  def test_set_false
+    set :can_set_nil, nil
+    set :lies_are, false
+
+    assert_equal nil,   task.can_set_nil
+
+    assert_equal false, task.lies_are
+    assert_equal false, Rake::RemoteTask.fetch(:lies_are)
+  end
+
+
+  def test_fetch_false
+    assert_equal false, Rake::RemoteTask.fetch(:unknown, false)
+  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_raises(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:db]",
+                 e.message
+  end
+
+  def test_execute_with_no_roles
+    t = @vlad.remote_task(:flunk, :roles => :junk) { flunk "should not have run" }
+    e = assert_raises(Vlad::ConfigurationError) { t.execute nil }
+    assert_equal "No target hosts specified on task flunk for roles [:junk]",
+                 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"
+
+    assert_silent do
+      @task.rsync 'localfile', 'host:remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile host:remotefile],
+                 commands.first)
+  end
+
+  def test_rsync_fail
+    util_setup_task
+    @task.target_host = "app.example.com"
+    @task.action = lambda { false }
+
+    e = assert_raises Vlad::CommandFailedError do
+      assert_silent do
+        @task.rsync 'local', 'host:remote'
+      end
+    end
+    exp = "execution failed: rsync -azP --delete local host:remote"
+    assert_equal exp, e.message
+  end
+
+  def test_rsync_deprecation
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    out, err = capture_io do
+      @task.rsync 'localfile', 'remotefile'
+    end
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal(%w[rsync -azP --delete localfile app.example.com:remotefile],
+                 commands.first)
+
+    assert_equal("rsync deprecation: pass target_host:remote_path explicitly\n",
+                 err)
+    assert_empty out
+    # flunk "not yet"
+  end
+
+  def test_get
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.get 'tmp', "remote1", "remote2"
+    end
+
+    commands = @task.commands
+
+    expected = %w[rsync -azP --delete app.example.com:remote1 app.example.com:remote2 tmp]
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_put
+    util_setup_task
+    @task.target_host = "app.example.com"
+
+    assert_silent do
+      @task.put 'dest' do
+        "whatever"
+      end
+    end
+
+    commands = @task.commands
+
+    expected  = %w[rsync -azP --delete HAPPY app.example.com:dest]
+    commands.first[3] = 'HAPPY'
+
+    assert_equal 1, commands.size
+    assert_equal expected, commands.first
+  end
+
+  def test_run
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+
+    out, err = capture_io 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
+    assert_equal '', err
+  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_raises(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_with_prefix_output
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+
+    set :prefix_output, true
+
+    out, err = capture_io do
+      result = @task.run("ls")
+    end
+
+    assert_equal "app.example.com: file1\napp.example.com: file2\n", result
+    assert_equal "app.example.com: file1\napp.example.com: file2\n", out
+    # Reset to false
+    set :prefix_output, false
+  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 = capture_io 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
+    assert_equal "Password:\n", err
+  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 -p Password: ls"],
+                 commands.first, 'app'
+  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,210 @@
+require '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_raises(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]
+    refute_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_raises(Vlad::ConfigurationError) { @vlad.repository }
+    assert_raises(Vlad::ConfigurationError) { @vlad.deploy_to }
+    assert_raises(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({ :roles => [] }, 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 :win, 5
+    assert_equal 5, @vlad.win
+  end
+
+  def test_set_lazy_block_evaluation
+    set(:lose) { raise "lose" }
+    assert_raises(RuntimeError) { @vlad.lose }
+  end
+
+  def test_set_with_block
+    x = 1
+    set(:win) { x += 2 }
+
+    assert_equal 3, @vlad.win
+    assert_equal 3, @vlad.win
+  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_raises(ArgumentError) do
+      set(:loser, 5) { 6 }
+    end
+    assert_equal "cannot provide both a value and a block", e.message
+  end
+
+  def test_set_with_nil
+    set(:win, nil)
+    assert_equal nil, @vlad.win
+  end
+
+  def test_set_with_reserved_name
+    $TESTING = false
+    e = assert_raises(ArgumentError) { set(:all_hosts, []) }
+    assert_equal "cannot set reserved name: 'all_hosts'", e.message
+  ensure
+    $TESTING = true
+  end
+end
+