isst-vlad 2.0.1

data/lib/vlad/merb.rb

@@ -0,0 +1,51 @@
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Merb app server
+
+  set :merb_address,       "127.0.0.1"
+  set :merb_command,       'merb'
+  set :merb_environment,   "production"
+  set :merb_port,          8000
+  set :merb_servers,       2
+
+  # maybe needed later
+  #set :merb_clean,         false
+  #set(:merb_conf)          { "#{current_path}/config/merb.yml" }
+  #set :merb_config_script, nil
+  #set :merb_group,         nil
+  #set :merb_log_file,      nil
+  #set :merb_pid_file,      nil
+  #set :merb_prefix,        nil
+  #set :merb_user,          nil
+
+  desc "Start the app servers"
+  remote_task :start_app, :roles => :app do
+    cmd = [
+            "cd #{current_path} &&", # work around merb bug,
+                                     # http://merb.devjavu.com/ticket/469
+            "#{merb_command}",
+          #"-m #{current_path}",     # the buggy behaviour
+            "-e #{merb_environment}",
+            "-p #{merb_port}",
+            "-c #{merb_servers}"
+          ].compact.join ' '
+    run cmd
+  end
+
+  desc "Stop the app servers"
+  remote_task :stop_app, :roles => :app do
+    merb_servers.times do |i|
+      cmd = "#{current_path}/script/stop_merb #{merb_port + i}"
+      puts "$ #{cmd}"
+      run cmd
+    end
+  end
+  
+  desc "Stop, then restart the app servers"
+  remote_task :restart_app, :roles => :app do
+    Rake::Task['vlad:stop_app'].invoke
+    Rake::Task['vlad:start_app'].invoke
+  end
+end

data/lib/vlad/nginx.rb

@@ -0,0 +1,37 @@
+require 'vlad'
+
+namespace :vlad do
+  ##
+  # Nginx web server
+
+  set :web_command, "/sbin/service nginx"
+
+  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/passenger.rb

@@ -0,0 +1,8 @@
+require 'vlad'
+
+namespace :vlad do
+  desc 'Restart Passenger'
+  remote_task :start_app, :roles => :app do
+    run "touch #{current_release}/tmp/restart.txt"
+  end
+end

data/lib/vlad/rails.rb

@@ -0,0 +1,34 @@
+namespace :vlad do
+  set :rails_env,      "production"
+  set :migrate_args,   ""
+  set :migrate_target, :latest
+  set :mkdirs,         %w(tmp db)
+  set :shared_paths, {
+    'log'    => 'log',
+    'system' => 'public/system',
+    'pids'   => 'tmp/pids',
+  }
+
+  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 #{directory}",
+         "#{rake_cmd} RAILS_ENV=#{rails_env} db:migrate #{migrate_args}"
+        ].join(" ")
+  end
+end

data/lib/vlad/sequel.rb

@@ -0,0 +1,28 @@
+namespace :vlad do
+  set :rack_env,      "production"
+  set :migrate_args,   ""
+  set :migrate_target, :latest
+
+  desc "Run the sq: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 #{directory}",
+         "#{rake_cmd} RACK_ENV=#{rack_env} sq:db:migrate #{migrate_args}"
+        ].join(" ")
+  end
+end

data/lib/vlad/sinatra.rb

@@ -0,0 +1,7 @@
+namespace :vlad do
+  set :rack_env,      "production"
+  set :mkdirs,         %w(tmp db)
+  set :shared_paths, {
+    'log'    => 'log',
+  }
+end

data/lib/vlad/subversion.rb

@@ -0,0 +1,35 @@
+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)
+    "#{svn_cmd} #{deploy_via} " +
+      if revision_or_source =~ /^(\d+|head)$/i then
+        "-r #{revision_or_source} #{repository} #{destination}"
+      else
+        "#{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/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/test/test_remote_task.rb

@@ -0,0 +1,316 @@
+require 'test_case'
+
+class TestRakeRemoteTask < Rake::TestCase
+  # 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 = @rake.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 = @rake.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
+    @rake.host "app.example.com", :app
+    t = @rake.remote_task(:flunk, :roles => :db) { flunk "should not have run" }
+    e = assert_raises(Rake::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 = @rake.remote_task(:flunk, :roles => :junk) { flunk "should not have run" }
+    e = assert_raises(Rake::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 = @rake.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 Rake::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_dir
+    util_setup_task
+    @task.target_host = "app.example.com:/www/dir1"
+
+    @task.run("ls")
+
+    commands = @task.commands
+
+    assert_equal 1, commands.size, 'not enough commands'
+    assert_equal [["ssh", "app.example.com", "cd /www/dir1 && ls"]], commands
+  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(Rake::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_with_prepend_command
+    util_setup_task
+    @task.output << "file1\nfile2\n"
+    @task.target_host = "app.example.com"
+    result = nil
+    
+    set :prepend_cmd, "sudo bash -cl"
+
+    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", "sudo bash -cl 'ls'"],
+                 commands.first, 'app'
+    assert_equal "file1\nfile2\n", result
+
+    assert_equal "file1\nfile2\n", out
+    assert_equal '', err
+    
+    # Reset to false
+    set :prepend_cmd, 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 = @rake.remote_task :test_task, options
+    @task.commands = []
+    @task.output = []
+    @task.error = []
+    @task.action = nil
+    @task
+  end
+end