vlad 1.0.0

data/lib/vlad.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rake'
+require 'thread'
+require 'rake_remote_task'
+
+# Declare a remote host and its roles. 
+# Equivalent to <tt>role</tt>, but shorter for multiple roles. 
+def host host_name, *roles
+  Rake::RemoteTask.host host_name, *roles
+end
+
+# Declare a Vlad task that will execute on all hosts by default.
+# To limit that task to specific roles, use:
+# remote_task :example, :roles => [:app, :web] do
+def remote_task name, options = {}, &b
+  Rake::RemoteTask.remote_task name, options, &b
+end
+
+# Declare a role and assign a remote host to it.
+# Equivalent to the <tt>host</tt> method; provided for capistrano compatibility.
+def role role_name, host, args = {}
+  Rake::RemoteTask.role role_name, host, args
+end
+
+# Execute the given command on the <tt>target_host</tt> for the current task.
+def run *args, &b
+  Thread.current[:task].run(*args, &b)
+end
+
+# rsync the given files to <tt>target_host</tt>.
+def rsync local, remote
+  Thread.current[:task].rsync local, remote
+end
+
+# Declare a variable called +name+ and assign it a value.
+# A globally-visible method with the name of the variable is defined.
+# If a block is given, it will be called when the variable is first accessed.
+# Subsequent references to the variable will always return the same value.
+# Raises <tt>ArgumentError</tt> if the +name+ would conflict with an existing method.
+def set name, val = nil, &b
+  Rake::RemoteTask.set name, val, &b
+end
+
+# Returns the name of the host that the current task is executing on.
+# <tt>target_host</tt> can uniquely identify a particular task/host combination.
+def target_host
+  Thread.current[:task].target_host
+end
+
+module Vlad
+
+  # This is the version of Vlad you are running.
+  VERSION = '1.0.0'
+
+  # 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 the vlad_tasks file.
+  def self.load tasks_file = 'config/deploy.rb'
+    Kernel.load tasks_file
+    require 'vlad_tasks'
+  end
+
+end
+
+Rake::RemoteTask.reset
+

data/lib/vlad/perforce.rb

@@ -0,0 +1,51 @@
+class Vlad::Perforce
+
+  def self.reset
+    set :p4cmd, "p4" unless respond_to? :p4cmd
+    set :p4config, ".p4config" unless respond_to? :p4config
+  end
+
+  reset
+
+  ##
+  # Returns the p4 command that will checkout +revision+ into the directory
+  # +destination+.
+
+  def checkout(revision, destination)
+    "#{p4cmd} 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} && #{p4cmd} 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)
+    "`#{p4cmd} 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

data/lib/vlad/subversion.rb

@@ -0,0 +1,30 @@
+class Vlad::Subversion
+
+  ##
+  # Returns the command that will check out +revision+ from the repository
+  # into directory +destination+
+
+  def checkout(revision, destination)
+    "svn 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 export -r #{revision_or_source} #{repository} #{destination}"
+    else
+      "svn 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 info #{repository} | grep 'Revision:' | cut -f2 -d\\ `"
+  end
+end

data/lib/vlad_tasks.rb

@@ -0,0 +1,282 @@
+require 'vlad'
+
+class String #:nodoc:
+  def cleanup
+    if ENV['FULL'] then
+      gsub(/\s+/, ' ').strip
+    else
+      self[/\A.*?\./]
+    end
+  end
+end
+
+##
+# Ideal scenarios:
+#
+# Initial:
+#
+# 1) rake vlad:setup
+# 2) rake vlad:update
+# 3) rake vlad:migrate
+# 4) rake vlad:start
+#
+# Subsequent:
+#
+# 1) rake vlad:update
+# 2) rake vlad:migrate (optional)
+# 3) rake vlad:start
+
+namespace :vlad do
+  desc "Show the vlad setup.  This is all the default variables for vlad
+    tasks.".cleanup
+
+  task :debug do
+    require 'yaml'
+    puts "# Environment:"
+    y Rake::RemoteTask.env
+    puts "# Roles:"
+    y Rake::RemoteTask.roles
+  end
+
+  # used by update, out here so we can ensure all threads have the same value
+  now = Time.now.utc.strftime("%Y%m%d%H%M.%S")
+
+  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 "Updates your application server to the latest revision.  Syncs a copy
+    of the repository, exports it as the latest release, fixes up your
+    symlinks, touches your assets, symlinks the latest revision to current and
+    logs the update.".cleanup
+
+  remote_task :update, :roles => :app do
+    symlink = false
+    begin
+      # TODO: head/version should be parameterized
+      run [ "cd #{scm_path}",
+            "#{source.checkout "head", '.'}",
+            "#{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(" && ")
+
+      asset_paths = %w(images stylesheets javascripts).map { |p| "#{latest_release}/public/#{p}" }.join(" ")
+      run "find #{asset_paths} -exec touch -t #{now} {} ';'; true"
+
+      symlink = true
+      run "rm -f #{current_path} && ln -s #{latest_release} #{current_path}"
+      # Rake::Task["vlad:migrate"].invoke
+
+      run "echo #{now} $USER #{'head'} #{File.basename release_path} >> #{deploy_to}/revisions.log" # FIX shouldn't be head
+    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
+
+  # HACK :only => { :primary => true }
+  # 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} RAILS_ENV=#{rails_env} #{migrate_args} db:migrate"
+  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 files to the currently deployed version. 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
+    count = keep_releases
+    if count >= releases.length then
+      puts "no old releases to clean up"
+    else
+      puts "keeping #{count} of #{releases.length} deployed releases"
+
+      directories = (releases - releases.last(count)).map { |release|
+        File.join(releases_path, release)
+      }.join(" ")
+
+      run "rm -rf #{directories}"
+    end
+  end
+
+  ##
+  # 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
+    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(' ')}"
+
+    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
+
+  desc "Restart the app servers"
+
+  remote_task :start_app, :roles => :app do
+    cmd = "#{mongrel_command} cluster::restart -C #{mongrel_conf}"
+    cmd << ' --clean' if mongrel_clean
+    run cmd
+  end
+
+  desc "Stop the app servers"
+
+  remote_task :stop_app, :roles => :app do
+    cmd = "#{mongrel_command} cluster::stop -C #{mongrel_conf}"
+    cmd << ' --clean' if mongrel_clean
+    run cmd
+  end
+
+  ##
+  # Apache web server
+
+  set :web_command, "apachectl"
+
+  desc "Restart 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 "Restart 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 # namespace vlad

data/test/test_rake_remote_task.rb

@@ -0,0 +1,181 @@
+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
+    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
+    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 }
+    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 }
+    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
+    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
+    assert_equal "Password:\nfile1\nfile2\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